From 9fe09d67c575036b7eb1cde0b3d0856229a36405 Mon Sep 17 00:00:00 2001 From: Ben Chypak Date: Wed, 15 Jan 2020 12:59:16 -0800 Subject: [PATCH 1/7] Create formatter for refinements --- src/ApiClient.js | 21 +++++++++++++++++++++ src/api/ContentSearchApi.js | 4 ++-- src/api/ProductSearchApi.js | 20 ++++++++++---------- 3 files changed, 33 insertions(+), 12 deletions(-) diff --git a/src/ApiClient.js b/src/ApiClient.js index e3ae210..501e24f 100644 --- a/src/ApiClient.js +++ b/src/ApiClient.js @@ -301,6 +301,27 @@ export default class ApiClient { return newParams } + /** + * Builds an object with refinement keys 1..n given a an array of refinements. + * A numbered suffix will not be applied if the number of refinements is equal to 1. + * @param {Array} refinements Optional parameters + * @returns {Object} An object with refinement keys numbered 1 ... n with their + * string representation value. + */ + buildRefineParams(refinements) { + refinements = refinements || [] + + return refinements.length + ? refinements.reduce( + (acc, curr, idx, arr) => ({ + ...acc, + [arr.length > 1 ? `refine_${idx + 1}` : 'refine']: curr + }), + {} // Reduce array to populate a new object with formatted key/values. + ) + : {} + } + /** * Builds a string representation of an array-type actual parameter, according to the given collection format. * @param {Array} param An array parameter. diff --git a/src/api/ContentSearchApi.js b/src/api/ContentSearchApi.js index 83525fc..87535a3 100644 --- a/src/api/ContentSearchApi.js +++ b/src/api/ContentSearchApi.js @@ -65,11 +65,11 @@ export default class ContentSearchApi { const pathParams = {} const queryParams = { q: opts.q, - refine: this.apiClient.buildCollectionParam(opts.refine, 'csv'), sort: this.apiClient.buildCollectionParam(opts.sort, 'csv'), start: opts.start, count: opts.count, - locale: opts.locale + locale: opts.locale, + ...this.apiClient.buildRefineParams(opts.refine) } const headerParams = {} const formParams = {} diff --git a/src/api/ProductSearchApi.js b/src/api/ProductSearchApi.js index 906606e..11bfbc0 100644 --- a/src/api/ProductSearchApi.js +++ b/src/api/ProductSearchApi.js @@ -67,13 +67,13 @@ export default class ProductSearchApi { const pathParams = {} const queryParams = { q: opts.q, - refine: this.apiClient.buildCollectionParam(opts.refine, 'csv'), sort: opts.sort, start: opts.start, count: opts.count, expand: this.apiClient.buildCollectionParam(opts.expand, 'csv'), currency: opts.currency, - locale: opts.locale + locale: opts.locale, + ...this.apiClient.buildRefineParams(opts.refine) } const headerParams = {} const formParams = {} @@ -155,11 +155,11 @@ export default class ProductSearchApi { const pathParams = {} const queryParams = { q: opts.q, - refine: this.apiClient.buildCollectionParam(opts.refine, 'csv'), sort: opts.sort, start: opts.start, count: opts.count, - locale: opts.locale + locale: opts.locale, + ...this.apiClient.buildRefineParams(opts.refine) } const headerParams = {} const formParams = {} @@ -236,11 +236,11 @@ export default class ProductSearchApi { const pathParams = {} const queryParams = { q: opts.q, - refine: this.apiClient.buildCollectionParam(opts.refine, 'csv'), sort: opts.sort, start: opts.start, count: opts.count, - locale: opts.locale + locale: opts.locale, + ...this.apiClient.buildRefineParams(opts.refine) } const headerParams = {} const formParams = {} @@ -318,12 +318,12 @@ export default class ProductSearchApi { const pathParams = {} const queryParams = { q: opts.q, - refine: this.apiClient.buildCollectionParam(opts.refine, 'csv'), sort: opts.sort, start: opts.start, count: opts.count, currency: opts.currency, - locale: opts.locale + locale: opts.locale, + ...this.apiClient.buildRefineParams(opts.refine) } const headerParams = {} const formParams = {} @@ -399,11 +399,11 @@ export default class ProductSearchApi { const pathParams = {} const queryParams = { q: opts.q, - refine: this.apiClient.buildCollectionParam(opts.refine, 'csv'), sort: opts.sort, start: opts.start, count: opts.count, - locale: opts.locale + locale: opts.locale, + ...this.apiClient.buildRefineParams(opts.refine) } const headerParams = {} const formParams = {} From 37185966565c921da14785825cdfb2855804dde7 Mon Sep 17 00:00:00 2001 From: Ben Chypak Date: Wed, 15 Jan 2020 13:19:59 -0800 Subject: [PATCH 2/7] ensure we paramToString the refine values --- src/ApiClient.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/ApiClient.js b/src/ApiClient.js index 501e24f..e64e318 100644 --- a/src/ApiClient.js +++ b/src/ApiClient.js @@ -315,7 +315,7 @@ export default class ApiClient { ? refinements.reduce( (acc, curr, idx, arr) => ({ ...acc, - [arr.length > 1 ? `refine_${idx + 1}` : 'refine']: curr + [arr.length > 1 ? `refine_${idx + 1}` : 'refine']: this.paramToString(curr) }), {} // Reduce array to populate a new object with formatted key/values. ) From 3202280c9cb44126188141e69152a706624908ab Mon Sep 17 00:00:00 2001 From: Ben Chypak Date: Wed, 15 Jan 2020 13:27:23 -0800 Subject: [PATCH 3/7] Update param description --- src/ApiClient.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/ApiClient.js b/src/ApiClient.js index e64e318..f1833c8 100644 --- a/src/ApiClient.js +++ b/src/ApiClient.js @@ -304,7 +304,7 @@ export default class ApiClient { /** * Builds an object with refinement keys 1..n given a an array of refinements. * A numbered suffix will not be applied if the number of refinements is equal to 1. - * @param {Array} refinements Optional parameters + * @param {Array} refinements Array of refinement strings * @returns {Object} An object with refinement keys numbered 1 ... n with their * string representation value. */ From 05c12dc15cf49e02addfa3cbef1c05243eec7461 Mon Sep 17 00:00:00 2001 From: Ben Chypak Date: Wed, 15 Jan 2020 13:30:39 -0800 Subject: [PATCH 4/7] Compile docs --- docs/ApiClient.js.html | 68 ++- docs/api_BasketsApi.js.html | 4 +- docs/api_CategoriesApi.js.html | 4 +- docs/api_ContentApi.js.html | 4 +- docs/api_ContentSearchApi.js.html | 8 +- docs/api_CustomObjectsApi.js.html | 4 +- docs/api_CustomersApi.js.html | 4 +- docs/api_FoldersApi.js.html | 4 +- docs/api_GiftCertificateApi.js.html | 4 +- docs/api_OrderSearchApi.js.html | 4 +- docs/api_OrdersApi.js.html | 4 +- docs/api_PriceAdjustmentLimitsApi.js.html | 4 +- docs/api_ProductListsApi.js.html | 4 +- docs/api_ProductSearchApi.js.html | 24 +- docs/api_ProductsApi.js.html | 4 +- docs/api_PromotionsApi.js.html | 4 +- docs/api_SearchSuggestionApi.js.html | 4 +- docs/api_SessionsApi.js.html | 4 +- docs/api_SiteApi.js.html | 4 +- docs/api_StoresApi.js.html | 4 +- docs/index.html | 76 ++- docs/index.js.html | 4 +- docs/models_AuthRequest.js.html | 4 +- docs/models_Basket.js.html | 4 +- ...els_BasketPaymentInstrumentRequest.js.html | 4 +- docs/models_BasketsResult.js.html | 4 +- docs/models_BonusDiscountLineItem.js.html | 4 +- docs/models_BoolFilter.js.html | 4 +- docs/models_BoolQuery.js.html | 4 +- docs/models_BundledProduct.js.html | 4 +- docs/models_Category.js.html | 4 +- docs/models_CategoryResult.js.html | 4 +- docs/models_Content.js.html | 4 +- docs/models_ContentFolder.js.html | 4 +- docs/models_ContentFolderResult.js.html | 4 +- docs/models_ContentResult.js.html | 4 +- docs/models_ContentSearchRefinement.js.html | 4 +- ...odels_ContentSearchRefinementValue.js.html | 4 +- docs/models_ContentSearchResult.js.html | 4 +- docs/models_CouponItem.js.html | 4 +- docs/models_CustomObject.js.html | 4 +- docs/models_Customer.js.html | 4 +- docs/models_CustomerAddress.js.html | 4 +- docs/models_CustomerAddressLink.js.html | 4 +- docs/models_CustomerAddressResult.js.html | 4 +- docs/models_CustomerInfo.js.html | 4 +- docs/models_CustomerOrderResult.js.html | 4 +- .../models_CustomerPaymentCardRequest.js.html | 4 +- docs/models_CustomerPaymentInstrument.js.html | 4 +- ...s_CustomerPaymentInstrumentRequest.js.html | 4 +- ...ls_CustomerPaymentInstrumentResult.js.html | 4 +- docs/models_CustomerProductList.js.html | 4 +- docs/models_CustomerProductListItem.js.html | 4 +- ...models_CustomerProductListItemLink.js.html | 4 +- ...dels_CustomerProductListItemResult.js.html | 4 +- ...dels_CustomerProductListRegistrant.js.html | 4 +- docs/models_CustomerProductListResult.js.html | 4 +- docs/models_CustomerRegistration.js.html | 4 +- docs/models_Discount.js.html | 4 +- docs/models_Fault.js.html | 13 +- docs/models_Filter.js.html | 4 +- docs/models_FilteredQuery.js.html | 4 +- docs/models_GiftCertificate.js.html | 4 +- docs/models_GiftCertificateItem.js.html | 4 +- docs/models_GiftCertificateRequest.js.html | 4 +- docs/models_Image.js.html | 4 +- docs/models_ImageGroup.js.html | 4 +- docs/models_Inventory.js.html | 4 +- docs/models_Locale.js.html | 4 +- docs/models_Master.js.html | 4 +- docs/models_NestedQuery.js.html | 4 +- docs/models_Note.js.html | 4 +- docs/models_NotesResult.js.html | 4 +- docs/models_Option.js.html | 4 +- docs/models_OptionItem.js.html | 4 +- docs/models_OptionValue.js.html | 60 +- docs/models_Order.js.html | 4 +- docs/models_OrderAddress.js.html | 4 +- docs/models_OrderPaymentCardRequest.js.html | 4 +- docs/models_OrderPaymentInstrument.js.html | 4 +- ...dels_OrderPaymentInstrumentRequest.js.html | 4 +- docs/models_OrderSearchHit.js.html | 4 +- docs/models_OrderSearchRequest.js.html | 4 +- docs/models_OrderSearchResult.js.html | 4 +- docs/models_PasswordChangeRequest.js.html | 4 +- docs/models_PasswordReset.js.html | 4 +- docs/models_PaymentBankAccount.js.html | 4 +- docs/models_PaymentBankAccountRequest.js.html | 4 +- docs/models_PaymentCard.js.html | 4 +- docs/models_PaymentCardSpec.js.html | 6 +- docs/models_PaymentMethod.js.html | 4 +- docs/models_PaymentMethodResult.js.html | 4 +- docs/models_PriceAdjustment.js.html | 4 +- docs/models_PriceAdjustmentLimit.js.html | 4 +- docs/models_PriceAdjustmentLimits.js.html | 4 +- docs/models_Product.js.html | 4 +- docs/models_ProductDetailsLink.js.html | 4 +- docs/models_ProductItem.js.html | 4 +- docs/models_ProductLink.js.html | 4 +- docs/models_ProductListEvent.js.html | 4 +- docs/models_ProductListItemReference.js.html | 4 +- docs/models_ProductListLink.js.html | 4 +- docs/models_ProductListRegistrant.js.html | 4 +- .../models_ProductListShippingAddress.js.html | 4 +- docs/models_ProductPromotion.js.html | 4 +- docs/models_ProductRef.js.html | 119 ++++ docs/models_ProductResult.js.html | 4 +- docs/models_ProductSearchHit.js.html | 23 +- docs/models_ProductSearchRefinement.js.html | 4 +- ...odels_ProductSearchRefinementValue.js.html | 4 +- docs/models_ProductSearchResult.js.html | 4 +- .../models_ProductSearchSortingOption.js.html | 4 +- docs/models_ProductSimpleLink.js.html | 4 +- docs/models_ProductType.js.html | 4 +- docs/models_Promotion.js.html | 4 +- docs/models_PromotionResult.js.html | 4 +- docs/models_PublicProductList.js.html | 4 +- docs/models_PublicProductListItem.js.html | 4 +- ...models_PublicProductListItemResult.js.html | 4 +- docs/models_PublicProductListLink.js.html | 4 +- docs/models_PublicProductListResult.js.html | 4 +- docs/models_Query.js.html | 4 +- docs/models_QueryFilter.js.html | 4 +- docs/models_Range2Filter.js.html | 4 +- docs/models_RangeFilter.js.html | 4 +- docs/models_Recommendation.js.html | 4 +- docs/models_RecommendationType.js.html | 4 +- docs/models_ResultPage.js.html | 4 +- docs/models_Shipment.js.html | 4 +- docs/models_ShippingItem.js.html | 4 +- docs/models_ShippingMethod.js.html | 4 +- docs/models_ShippingMethodResult.js.html | 4 +- docs/models_ShippingPromotion.js.html | 4 +- docs/models_SimpleLink.js.html | 4 +- docs/models_Site.js.html | 4 +- docs/models_Sort.js.html | 4 +- docs/models_Status.js.html | 4 +- docs/models_Store.js.html | 4 +- docs/models_StoreResult.js.html | 4 +- docs/models_SuggestedCategory.js.html | 4 +- docs/models_SuggestedContent.js.html | 4 +- docs/models_SuggestedPhrase.js.html | 4 +- docs/models_SuggestedProduct.js.html | 4 +- docs/models_SuggestedTerm.js.html | 4 +- docs/models_SuggestedTerms.js.html | 4 +- docs/models_Suggestion.js.html | 4 +- docs/models_SuggestionResult.js.html | 4 +- docs/models_TermFilter.js.html | 4 +- docs/models_TermQuery.js.html | 4 +- docs/models_TextQuery.js.html | 4 +- docs/models_Variant.js.html | 4 +- docs/models_VariationAttribute.js.html | 4 +- docs/models_VariationAttributeValue.js.html | 21 +- docs/models_VariationGroup.js.html | 4 +- docs/module-ApiClient.html | 501 +++++++++++++++- docs/module-api_BasketsApi.html | 122 +++- docs/module-api_CategoriesApi.html | 14 +- docs/module-api_ContentApi.html | 14 +- docs/module-api_ContentSearchApi.html | 30 +- docs/module-api_CustomObjectsApi.html | 10 +- docs/module-api_CustomersApi.html | 154 ++++- docs/module-api_FoldersApi.html | 14 +- docs/module-api_GiftCertificateApi.html | 10 +- docs/module-api_OrderSearchApi.html | 26 +- docs/module-api_OrdersApi.html | 54 +- docs/module-api_PriceAdjustmentLimitsApi.html | 10 +- docs/module-api_ProductListsApi.html | 22 +- docs/module-api_ProductSearchApi.html | 86 ++- docs/module-api_ProductsApi.html | 50 +- docs/module-api_PromotionsApi.html | 18 +- docs/module-api_SearchSuggestionApi.html | 10 +- docs/module-api_SessionsApi.html | 10 +- docs/module-api_SiteApi.html | 10 +- docs/module-api_StoresApi.html | 38 +- docs/module-index.html | 10 +- docs/module-models_AuthRequest.html | 8 +- docs/module-models_Basket.html | 8 +- ...models_BasketPaymentInstrumentRequest.html | 8 +- docs/module-models_BasketsResult.html | 8 +- docs/module-models_BonusDiscountLineItem.html | 8 +- docs/module-models_BoolFilter.html | 8 +- docs/module-models_BoolQuery.html | 8 +- docs/module-models_BundledProduct.html | 8 +- docs/module-models_Category.html | 8 +- docs/module-models_CategoryResult.html | 8 +- docs/module-models_Content.html | 8 +- docs/module-models_ContentFolder.html | 8 +- docs/module-models_ContentFolderResult.html | 8 +- docs/module-models_ContentResult.html | 8 +- ...module-models_ContentSearchRefinement.html | 12 +- ...e-models_ContentSearchRefinementValue.html | 8 +- docs/module-models_ContentSearchResult.html | 8 +- docs/module-models_CouponItem.html | 8 +- docs/module-models_CustomObject.html | 8 +- docs/module-models_Customer.html | 12 +- docs/module-models_CustomerAddress.html | 8 +- docs/module-models_CustomerAddressLink.html | 8 +- docs/module-models_CustomerAddressResult.html | 8 +- docs/module-models_CustomerInfo.html | 8 +- docs/module-models_CustomerOrderResult.html | 8 +- ...ule-models_CustomerPaymentCardRequest.html | 8 +- ...dule-models_CustomerPaymentInstrument.html | 8 +- ...dels_CustomerPaymentInstrumentRequest.html | 8 +- ...odels_CustomerPaymentInstrumentResult.html | 8 +- docs/module-models_CustomerProductList.html | 8 +- ...module-models_CustomerProductListItem.html | 8 +- ...le-models_CustomerProductListItemLink.html | 8 +- ...-models_CustomerProductListItemResult.html | 8 +- ...-models_CustomerProductListRegistrant.html | 8 +- ...dule-models_CustomerProductListResult.html | 8 +- docs/module-models_CustomerRegistration.html | 8 +- docs/module-models_Discount.html | 8 +- docs/module-models_Fault.html | 82 ++- docs/module-models_Filter.html | 8 +- docs/module-models_FilteredQuery.html | 8 +- docs/module-models_GiftCertificate.html | 8 +- docs/module-models_GiftCertificateItem.html | 8 +- .../module-models_GiftCertificateRequest.html | 8 +- docs/module-models_Image.html | 8 +- docs/module-models_ImageGroup.html | 8 +- docs/module-models_Inventory.html | 8 +- docs/module-models_Locale.html | 10 +- docs/module-models_Master.html | 8 +- docs/module-models_NestedQuery.html | 10 +- docs/module-models_Note.html | 8 +- docs/module-models_NotesResult.html | 8 +- docs/module-models_Option.html | 8 +- docs/module-models_OptionItem.html | 8 +- docs/module-models_OptionValue.html | 8 +- docs/module-models_Order.html | 8 +- docs/module-models_OrderAddress.html | 8 +- ...module-models_OrderPaymentCardRequest.html | 8 +- .../module-models_OrderPaymentInstrument.html | 8 +- ...-models_OrderPaymentInstrumentRequest.html | 8 +- docs/module-models_OrderSearchHit.html | 8 +- docs/module-models_OrderSearchRequest.html | 8 +- docs/module-models_OrderSearchResult.html | 8 +- docs/module-models_PasswordChangeRequest.html | 8 +- docs/module-models_PasswordReset.html | 8 +- docs/module-models_PaymentBankAccount.html | 8 +- ...dule-models_PaymentBankAccountRequest.html | 8 +- docs/module-models_PaymentCard.html | 8 +- docs/module-models_PaymentCardSpec.html | 8 +- docs/module-models_PaymentMethod.html | 8 +- docs/module-models_PaymentMethodResult.html | 8 +- docs/module-models_PriceAdjustment.html | 8 +- docs/module-models_PriceAdjustmentLimit.html | 12 +- docs/module-models_PriceAdjustmentLimits.html | 8 +- docs/module-models_Product.html | 8 +- docs/module-models_ProductDetailsLink.html | 8 +- docs/module-models_ProductItem.html | 8 +- docs/module-models_ProductLink.html | 8 +- docs/module-models_ProductListEvent.html | 8 +- ...odule-models_ProductListItemReference.html | 8 +- docs/module-models_ProductListLink.html | 8 +- docs/module-models_ProductListRegistrant.html | 10 +- ...ule-models_ProductListShippingAddress.html | 8 +- docs/module-models_ProductPromotion.html | 8 +- docs/module-models_ProductRef.html | 555 ++++++++++++++++++ docs/module-models_ProductResult.html | 8 +- docs/module-models_ProductSearchHit.html | 178 +++++- ...module-models_ProductSearchRefinement.html | 18 +- ...e-models_ProductSearchRefinementValue.html | 10 +- docs/module-models_ProductSearchResult.html | 8 +- ...ule-models_ProductSearchSortingOption.html | 8 +- docs/module-models_ProductSimpleLink.html | 8 +- docs/module-models_ProductType.html | 8 +- docs/module-models_Promotion.html | 8 +- docs/module-models_PromotionResult.html | 8 +- docs/module-models_PublicProductList.html | 8 +- docs/module-models_PublicProductListItem.html | 8 +- ...le-models_PublicProductListItemResult.html | 8 +- docs/module-models_PublicProductListLink.html | 8 +- ...module-models_PublicProductListResult.html | 8 +- docs/module-models_Query.html | 8 +- docs/module-models_QueryFilter.html | 8 +- docs/module-models_Range2Filter.html | 10 +- docs/module-models_RangeFilter.html | 8 +- docs/module-models_Recommendation.html | 8 +- docs/module-models_RecommendationType.html | 8 +- docs/module-models_ResultPage.html | 8 +- docs/module-models_Shipment.html | 14 +- docs/module-models_ShippingItem.html | 8 +- docs/module-models_ShippingMethod.html | 8 +- docs/module-models_ShippingMethodResult.html | 8 +- docs/module-models_ShippingPromotion.html | 8 +- docs/module-models_SimpleLink.html | 8 +- docs/module-models_Site.html | 8 +- docs/module-models_Sort.html | 8 +- docs/module-models_Status.html | 8 +- docs/module-models_Store.html | 8 +- docs/module-models_StoreResult.html | 8 +- docs/module-models_SuggestedCategory.html | 8 +- docs/module-models_SuggestedContent.html | 8 +- docs/module-models_SuggestedPhrase.html | 8 +- docs/module-models_SuggestedProduct.html | 8 +- docs/module-models_SuggestedTerm.html | 8 +- docs/module-models_SuggestedTerms.html | 8 +- docs/module-models_Suggestion.html | 8 +- docs/module-models_SuggestionResult.html | 8 +- docs/module-models_TermFilter.html | 8 +- docs/module-models_TermQuery.html | 12 +- docs/module-models_TextQuery.html | 8 +- docs/module-models_Variant.html | 8 +- docs/module-models_VariationAttribute.html | 8 +- ...module-models_VariationAttributeValue.html | 156 ++++- docs/module-models_VariationGroup.html | 8 +- docs/scripts/linenumber.js | 18 +- docs/styles/jsdoc-default.css | 4 +- 309 files changed, 3432 insertions(+), 834 deletions(-) create mode 100644 docs/models_ProductRef.js.html create mode 100644 docs/module-models_ProductRef.html diff --git a/docs/ApiClient.js.html b/docs/ApiClient.js.html index 935e180..94e650c 100644 --- a/docs/ApiClient.js.html +++ b/docs/ApiClient.js.html @@ -54,10 +54,11 @@

Source: ApiClient.js

const defaultConfig = { basePath: 'https://localhost/s/siteId/dw/shop/v17_8', - defaultHeaders: {}, - timeout: 60000, cache: true, + defaultHeaders: {}, enableCookies: false, + overrideHttpPut: true, + timeout: 60000, } /** @@ -78,7 +79,8 @@

Source: ApiClient.js

enableCookies, clientUsername, clientPassword, - oauth2AccessToken + oauth2AccessToken, + overrideHttpPut } = Object.assign(defaultConfig, config) // verify the required parameter 'basepath' is set @@ -122,6 +124,16 @@

Source: ApiClient.js

customers_auth.password = clientPassword } + /** + * If set to true, endpoints that normally use HTTP `PUT` will + * be sent using `POST` with an aditional header (x-dw-http-method-override: `PUT`). + * Please refer to the following Salesforce documentation {@link https://documentation.demandware.com/DOC1/topic/com.demandware.dochelp/OCAPI/18.8/usage/HttpMethods.html} + * for more information. + * @type {Boolean} + * @default true + */ + this.overrideHttpPut = overrideHttpPut + /** * The default HTTP headers to be included for all API calls. * @type {Array.<String>} @@ -317,6 +329,27 @@

Source: ApiClient.js

return newParams } + /** + * Builds an object with refinement keys 1..n given a an array of refinements. + * A numbered suffix will not be applied if the number of refinements is equal to 1. + * @param {Array} refinements Array of refinement strings + * @returns {Object} An object with refinement keys numbered 1 ... n with their + * string representation value. + */ + buildRefineParams(refinements) { + refinements = refinements || [] + + return refinements.length + ? refinements.reduce( + (acc, curr, idx, arr) => ({ + ...acc, + [arr.length > 1 ? `refine_${idx + 1}` : 'refine']: this.paramToString(curr) + }), + {} // Reduce array to populate a new object with formatted key/values. + ) + : {} + } + /** * Builds a string representation of an array-type actual parameter, according to the given collection format. * @param {Array} param An array parameter. @@ -437,6 +470,12 @@

Source: ApiClient.js

queryParams, headerParams, formParams, bodyParam, authNames, contentTypes, accepts, returnType) { + // emulate PUT method because they are not allowed on staging and production environments + if (this.overrideHttpPut && httpMethod.toUpperCase() === 'PUT') { + httpMethod = 'POST' + headerParams = Object.assign(headerParams || {}, {'x-dw-http-method-override': 'PUT'}) + } + const url = this.buildUrl(path, pathParams) const request = superagent(httpMethod, url) @@ -504,6 +543,16 @@

Source: ApiClient.js

} } + return this.sendApiRequest(request, returnType) + } + + /** + * Sends the generated superagent request and deserializes the response. + * @param {module:superagent.Request} request The superagent request to send. + * @param {String} returnType The type to deserialize the response into. + * @returns {Promise} A {@link https://www.promisejs.org/|Promise} object. + */ + sendApiRequest(request, returnType) { return new Promise((resolve, reject) => { request.end((error, response) => { if (error) { @@ -511,8 +560,13 @@

Source: ApiClient.js

// Looks like there was an fault returned from the API const hasErrorMessage = error.response && error.response.text if (hasErrorMessage) { - const fault = Fault.constructFromObject(JSON.parse(error.response.text).fault) - reject(fault) + try { + const fault = Fault.constructFromObject(JSON.parse(error.response.text).fault) + reject(fault) + } catch (err) { + // Reject immediately on parsing error. + reject(err) + } } // Most likely a network error has happened here so include entire error. @@ -700,13 +754,13 @@

Source: ApiClient.js


diff --git a/docs/api_BasketsApi.js.html b/docs/api_BasketsApi.js.html index b67ecbc..282a39c 100644 --- a/docs/api_BasketsApi.js.html +++ b/docs/api_BasketsApi.js.html @@ -1574,13 +1574,13 @@

Source: api/BasketsApi.js


diff --git a/docs/api_CategoriesApi.js.html b/docs/api_CategoriesApi.js.html index 3f183f9..e3806bc 100644 --- a/docs/api_CategoriesApi.js.html +++ b/docs/api_CategoriesApi.js.html @@ -184,13 +184,13 @@

Source: api/CategoriesApi.js


diff --git a/docs/api_ContentApi.js.html b/docs/api_ContentApi.js.html index 070ad10..3825bea 100644 --- a/docs/api_ContentApi.js.html +++ b/docs/api_ContentApi.js.html @@ -183,13 +183,13 @@

Source: api/ContentApi.js


diff --git a/docs/api_ContentSearchApi.js.html b/docs/api_ContentSearchApi.js.html index 91e96da..07a91fb 100644 --- a/docs/api_ContentSearchApi.js.html +++ b/docs/api_ContentSearchApi.js.html @@ -93,11 +93,11 @@

Source: api/ContentSearchApi.js

const pathParams = {} const queryParams = { q: opts.q, - refine: this.apiClient.buildCollectionParam(opts.refine, 'csv'), sort: this.apiClient.buildCollectionParam(opts.sort, 'csv'), start: opts.start, count: opts.count, - locale: opts.locale + locale: opts.locale, + ...this.apiClient.buildRefineParams(opts.refine) } const headerParams = {} const formParams = {} @@ -153,13 +153,13 @@

Source: api/ContentSearchApi.js


diff --git a/docs/api_CustomObjectsApi.js.html b/docs/api_CustomObjectsApi.js.html index 5b4567b..572115b 100644 --- a/docs/api_CustomObjectsApi.js.html +++ b/docs/api_CustomObjectsApi.js.html @@ -130,13 +130,13 @@

Source: api/CustomObjectsApi.js


diff --git a/docs/api_CustomersApi.js.html b/docs/api_CustomersApi.js.html index 711cf3e..4482ac7 100644 --- a/docs/api_CustomersApi.js.html +++ b/docs/api_CustomersApi.js.html @@ -1880,13 +1880,13 @@

Source: api/CustomersApi.js


diff --git a/docs/api_FoldersApi.js.html b/docs/api_FoldersApi.js.html index c26a2a0..94a457c 100644 --- a/docs/api_FoldersApi.js.html +++ b/docs/api_FoldersApi.js.html @@ -193,13 +193,13 @@

Source: api/FoldersApi.js


diff --git a/docs/api_GiftCertificateApi.js.html b/docs/api_GiftCertificateApi.js.html index 0a26fbe..52914d5 100644 --- a/docs/api_GiftCertificateApi.js.html +++ b/docs/api_GiftCertificateApi.js.html @@ -113,13 +113,13 @@

Source: api/GiftCertificateApi.js


diff --git a/docs/api_OrderSearchApi.js.html b/docs/api_OrderSearchApi.js.html index 5ee2acb..f041b2a 100644 --- a/docs/api_OrderSearchApi.js.html +++ b/docs/api_OrderSearchApi.js.html @@ -147,13 +147,13 @@

Source: api/OrderSearchApi.js


diff --git a/docs/api_OrdersApi.js.html b/docs/api_OrdersApi.js.html index 4ba3a1e..f8c1d60 100644 --- a/docs/api_OrdersApi.js.html +++ b/docs/api_OrdersApi.js.html @@ -684,13 +684,13 @@

Source: api/OrdersApi.js


diff --git a/docs/api_PriceAdjustmentLimitsApi.js.html b/docs/api_PriceAdjustmentLimitsApi.js.html index 3e62c46..ae68a65 100644 --- a/docs/api_PriceAdjustmentLimitsApi.js.html +++ b/docs/api_PriceAdjustmentLimitsApi.js.html @@ -112,13 +112,13 @@

Source: api/PriceAdjustmentLimitsApi.js


diff --git a/docs/api_ProductListsApi.js.html b/docs/api_ProductListsApi.js.html index a58e58c..20aef7c 100644 --- a/docs/api_ProductListsApi.js.html +++ b/docs/api_ProductListsApi.js.html @@ -285,13 +285,13 @@

Source: api/ProductListsApi.js


diff --git a/docs/api_ProductSearchApi.js.html b/docs/api_ProductSearchApi.js.html index ca0527a..82df1a9 100644 --- a/docs/api_ProductSearchApi.js.html +++ b/docs/api_ProductSearchApi.js.html @@ -95,13 +95,13 @@

Source: api/ProductSearchApi.js

const pathParams = {} const queryParams = { q: opts.q, - refine: this.apiClient.buildCollectionParam(opts.refine, 'csv'), sort: opts.sort, start: opts.start, count: opts.count, expand: this.apiClient.buildCollectionParam(opts.expand, 'csv'), currency: opts.currency, - locale: opts.locale + locale: opts.locale, + ...this.apiClient.buildRefineParams(opts.refine) } const headerParams = {} const formParams = {} @@ -183,11 +183,11 @@

Source: api/ProductSearchApi.js

const pathParams = {} const queryParams = { q: opts.q, - refine: this.apiClient.buildCollectionParam(opts.refine, 'csv'), sort: opts.sort, start: opts.start, count: opts.count, - locale: opts.locale + locale: opts.locale, + ...this.apiClient.buildRefineParams(opts.refine) } const headerParams = {} const formParams = {} @@ -264,11 +264,11 @@

Source: api/ProductSearchApi.js

const pathParams = {} const queryParams = { q: opts.q, - refine: this.apiClient.buildCollectionParam(opts.refine, 'csv'), sort: opts.sort, start: opts.start, count: opts.count, - locale: opts.locale + locale: opts.locale, + ...this.apiClient.buildRefineParams(opts.refine) } const headerParams = {} const formParams = {} @@ -346,12 +346,12 @@

Source: api/ProductSearchApi.js

const pathParams = {} const queryParams = { q: opts.q, - refine: this.apiClient.buildCollectionParam(opts.refine, 'csv'), sort: opts.sort, start: opts.start, count: opts.count, currency: opts.currency, - locale: opts.locale + locale: opts.locale, + ...this.apiClient.buildRefineParams(opts.refine) } const headerParams = {} const formParams = {} @@ -427,11 +427,11 @@

Source: api/ProductSearchApi.js

const pathParams = {} const queryParams = { q: opts.q, - refine: this.apiClient.buildCollectionParam(opts.refine, 'csv'), sort: opts.sort, start: opts.start, count: opts.count, - locale: opts.locale + locale: opts.locale, + ...this.apiClient.buildRefineParams(opts.refine) } const headerParams = {} const formParams = {} @@ -487,13 +487,13 @@

Source: api/ProductSearchApi.js


diff --git a/docs/api_ProductsApi.js.html b/docs/api_ProductsApi.js.html index 121fc05..c9cab05 100644 --- a/docs/api_ProductsApi.js.html +++ b/docs/api_ProductsApi.js.html @@ -681,13 +681,13 @@

Source: api/ProductsApi.js


diff --git a/docs/api_PromotionsApi.js.html b/docs/api_PromotionsApi.js.html index 815113e..cbdf72a 100644 --- a/docs/api_PromotionsApi.js.html +++ b/docs/api_PromotionsApi.js.html @@ -242,13 +242,13 @@

Source: api/PromotionsApi.js


diff --git a/docs/api_SearchSuggestionApi.js.html b/docs/api_SearchSuggestionApi.js.html index c5f5924..2617076 100644 --- a/docs/api_SearchSuggestionApi.js.html +++ b/docs/api_SearchSuggestionApi.js.html @@ -133,13 +133,13 @@

Source: api/SearchSuggestionApi.js


diff --git a/docs/api_SessionsApi.js.html b/docs/api_SessionsApi.js.html index 14956a8..4c41f6e 100644 --- a/docs/api_SessionsApi.js.html +++ b/docs/api_SessionsApi.js.html @@ -121,13 +121,13 @@

Source: api/SessionsApi.js


diff --git a/docs/api_SiteApi.js.html b/docs/api_SiteApi.js.html index f7af752..850b5d6 100644 --- a/docs/api_SiteApi.js.html +++ b/docs/api_SiteApi.js.html @@ -108,13 +108,13 @@

Source: api/SiteApi.js


diff --git a/docs/api_StoresApi.js.html b/docs/api_StoresApi.js.html index 8d3b901..b76f4ea 100644 --- a/docs/api_StoresApi.js.html +++ b/docs/api_StoresApi.js.html @@ -247,13 +247,13 @@

Source: api/StoresApi.js


diff --git a/docs/index.html b/docs/index.html index d527085..0779d0c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -43,21 +43,29 @@

-

Salesforce Commerce Cloud OCAPI Client

_______________________________________________________________________________________________________________________________________________________
+        
Salesforce Commerce Cloud OCAPI Client

+
_______________________________________________________________________________________________________________________________________________________
 
                                                             /                    /                                 ,             /   ,                 
 ----__----__---_--_---_--_----__---)__----__----__----__---/----__-----------__-/--------__----__----__------__------------__---/--------__----__--_/_-
   /   ' /   ) / /  ) / /  ) /___) /   ) /   ' /___) /   ' /   /   ) /   /  /   /       /   ) /   ' /   )   /   ) /       /   ' /   /   /___) /   ) /   
 _(___ _(___/_/_/__/_/_/__/_(___ _/_____(___ _(___ _(___ _/___(___/_(___(__(___/_______(___/_(___ _(___(___/___/_/_______(___ _/___/___(___ _/___/_(_ __
                                                                                                          /                                             
-                                                                                                        /
NPM

+                                                                                                        /                                              
+
+

NPM

CircleCI

-

🙌 Introduction

Salesforce Commerce Cloud Open Commerce API (OCAPI) for Node and browsers.

+

🙌 Introduction

+

Salesforce Commerce Cloud Open Commerce API (OCAPI) for Node and browsers.

  • API version: 17.8
-

⚒ Installation

This library is distributed on npm, in order to add it as a dependency, run the following command:

-
npm install commercecloud-ocapi-client --save

🔦 Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: +

⚒ Installation

+

This library is distributed on npm, in order to add it as a dependency, run the following command:

+
npm install commercecloud-ocapi-client --save
+
+

🔦 Webpack Configuration

+

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
@@ -68,7 +76,11 @@ 
⚒ Installation
This library is distributed on npm, in order to add
       }
     }
   ]
-}

👨🏻‍💻 Getting Started

💡 Usage

Please follow the installation instruction and execute the following JS code:

+} + +

👨🏻‍💻 Getting Started

+

💡 Usage

+

Please follow the installation instruction and execute the following JS code:

import ShopApi from 'commercecloud-ocapi-client'
 
 ShopApi.ApiClient.instance = new ShopApi.ApiClient()
@@ -81,7 +93,10 @@ 
⚒ Installation
This library is distributed on npm, in order to add
     })
     .catch((fault) => {
         console.error(fault)
-    })

🔌 Configuration

The API client accepts an configuration object, example:

+ }) + +

🔌 Configuration

+

The API client accepts an configuration object, example:

import ShopApi from 'commercecloud-ocapi-client'
 
 const config = {
@@ -90,9 +105,13 @@ 
⚒ Installation
This library is distributed on npm, in order to add
   timeout: 60000, // Request timeout in milliseconds
   cache: true, // If set to false an additional timestamp parameter is added to all API GET calls to prevent browser caching
   enableCookies: false, //If set to true, the client will save the cookies from each server response, and return them in the next request.
+  overrideHttpPut: true // If set to true, any methods specified as using http PUT will be sent using POST along the header value 'x-dw-http-method-override' set to 'PUT'.
 }
 
-ShopApi.ApiClient.instance = new ShopApi.ApiClient(config)

🔐 Authorization

To access secure end points, you can pass the username, password in the configuration, example:

+ShopApi.ApiClient.instance = new ShopApi.ApiClient(config) + +

🔐 Authorization

+

To access secure end points, you can pass the username, password in the configuration, example:

import ShopApi from 'commercecloud-ocapi-client'
 
 const config = {
@@ -100,27 +119,39 @@ 
⚒ Installation
This library is distributed on npm, in order to add
   clientPassword: 'password',
 }
 
-ShopApi.ApiClient.instance = new ShopApi.ApiClient(config)

Or to use oAuth token:

+ShopApi.ApiClient.instance = new ShopApi.ApiClient(config) + +

Or to use oAuth token:

import ShopApi from 'commercecloud-ocapi-client'
 
 const config = {
   oauth2AccessToken: 'token'
 }
 
-ShopApi.ApiClient.instance = new ShopApi.ApiClient(config)

✅ Testing

Because Salesforce OCAPI is not publicly available, you need to have a running instance that you can test against. In the test folder, there is a file config.json that has the example configuration for your environment. Simply update the file with your instance information

-

Example:

+ShopApi.ApiClient.instance = new ShopApi.ApiClient(config) + +

✅ Testing

+

Because Salesforce OCAPI is not publicly available, you need to have a running instance that you can test against. In the test folder, there is a file config.json that has the example configuration for your environment. Simply update the file with your instance information

+

Example:

{
   "clientId": "5640cc6b-f5e9-466e-9134-9853e9f9db93",
   "baseUrl": "https://localhost/s/siteId/dw/shop/v17_8"
-}

Then run the following command:

-
npm test

♻️ Continuous Integration

We use Circle CI to protect the develop and master branch to make sure the builds follows the code style and passes all tests. For every pull request, it is required to pass ALL checks including the following tests:

+} + +

Then run the following command:

+
npm test
+
+

♻️ Continuous Integration

+

We use Circle CI to protect the develop and master branch to make sure the builds follows the code style and passes all tests. For every pull request, it is required to pass ALL checks including the following tests:

  • Linting: npm run lint
  • Unit Tests: npm run test
-

📦 Build and Deployment

At Mobify, we practice several branching strategies, Release Deployment is a strategy for projects where feature gets bundled into a release periodically. master contains the code for current version, develop has the features that is under development and waiting to be released. For new features and bug fixes, please propose pull requests to merge into develop.

+

📦 Build and Deployment

+

At Mobify, we practice several branching strategies, Release Deployment is a strategy for projects where feature gets bundled into a release periodically. master contains the code for current version, develop has the features that is under development and waiting to be released. For new features and bug fixes, please propose pull requests to merge into develop.

This package is distributed on npm, on every release, we run scripts to automatically merge develop into master, test the build in Circle CI as well as publish the package on NPM.

-

Changelog

To understand the change between versions, please read CHANGELOG.md. Note that it is required to have a # To be released section filled out if you are planning to make pull requests that include new features or bug fixes.

+

Changelog

+

To understand the change between versions, please read CHANGELOG.md. Note that it is required to have a # To be released section filled out if you are planning to make pull requests that include new features or bug fixes.

Example:

## To be released
 - Update npm package to ship with three builds: `UMD`, `CommonJS` and `ES2015` [#4](https://github.com/mobify/commercecloud-ocapi-client/pull/4)
@@ -128,12 +159,17 @@ 
Changelog
To understand the change between versions, please read

📖 Documentation

@@ -122,13 +122,13 @@

Source: models/OptionValue.js


diff --git a/docs/models_Order.js.html b/docs/models_Order.js.html index ab3fa03..3e7bfcf 100644 --- a/docs/models_Order.js.html +++ b/docs/models_Order.js.html @@ -688,13 +688,13 @@

Source: models/Order.js


diff --git a/docs/models_OrderAddress.js.html b/docs/models_OrderAddress.js.html index 0ab661e..35f9695 100644 --- a/docs/models_OrderAddress.js.html +++ b/docs/models_OrderAddress.js.html @@ -300,13 +300,13 @@

Source: models/OrderAddress.js


diff --git a/docs/models_OrderPaymentCardRequest.js.html b/docs/models_OrderPaymentCardRequest.js.html index 31b6dd5..1d6e840 100644 --- a/docs/models_OrderPaymentCardRequest.js.html +++ b/docs/models_OrderPaymentCardRequest.js.html @@ -175,13 +175,13 @@

Source: models/OrderPaymentCardRequest.js


diff --git a/docs/models_OrderPaymentInstrument.js.html b/docs/models_OrderPaymentInstrument.js.html index 7a4bea9..009a3ce 100644 --- a/docs/models_OrderPaymentInstrument.js.html +++ b/docs/models_OrderPaymentInstrument.js.html @@ -160,13 +160,13 @@

Source: models/OrderPaymentInstrument.js


diff --git a/docs/models_OrderPaymentInstrumentRequest.js.html b/docs/models_OrderPaymentInstrumentRequest.js.html index 6df85fb..c9fcf57 100644 --- a/docs/models_OrderPaymentInstrumentRequest.js.html +++ b/docs/models_OrderPaymentInstrumentRequest.js.html @@ -159,13 +159,13 @@

Source: models/OrderPaymentInstrumentRequest.js


diff --git a/docs/models_OrderSearchHit.js.html b/docs/models_OrderSearchHit.js.html index 1a2472c..793d38c 100644 --- a/docs/models_OrderSearchHit.js.html +++ b/docs/models_OrderSearchHit.js.html @@ -104,13 +104,13 @@

Source: models/OrderSearchHit.js


diff --git a/docs/models_OrderSearchRequest.js.html b/docs/models_OrderSearchRequest.js.html index 552fefd..4941baa 100644 --- a/docs/models_OrderSearchRequest.js.html +++ b/docs/models_OrderSearchRequest.js.html @@ -142,13 +142,13 @@

Source: models/OrderSearchRequest.js


diff --git a/docs/models_OrderSearchResult.js.html b/docs/models_OrderSearchResult.js.html index 768c5c8..9d13da7 100644 --- a/docs/models_OrderSearchResult.js.html +++ b/docs/models_OrderSearchResult.js.html @@ -187,13 +187,13 @@

Source: models/OrderSearchResult.js


diff --git a/docs/models_PasswordChangeRequest.js.html b/docs/models_PasswordChangeRequest.js.html index 49f0212..6342bdc 100644 --- a/docs/models_PasswordChangeRequest.js.html +++ b/docs/models_PasswordChangeRequest.js.html @@ -105,13 +105,13 @@

Source: models/PasswordChangeRequest.js


diff --git a/docs/models_PasswordReset.js.html b/docs/models_PasswordReset.js.html index 285111d..0af69b2 100644 --- a/docs/models_PasswordReset.js.html +++ b/docs/models_PasswordReset.js.html @@ -123,13 +123,13 @@

Source: models/PasswordReset.js


diff --git a/docs/models_PaymentBankAccount.js.html b/docs/models_PaymentBankAccount.js.html index d210997..6de4d79 100644 --- a/docs/models_PaymentBankAccount.js.html +++ b/docs/models_PaymentBankAccount.js.html @@ -139,13 +139,13 @@

Source: models/PaymentBankAccount.js


diff --git a/docs/models_PaymentBankAccountRequest.js.html b/docs/models_PaymentBankAccountRequest.js.html index 29e44f5..3083a75 100644 --- a/docs/models_PaymentBankAccountRequest.js.html +++ b/docs/models_PaymentBankAccountRequest.js.html @@ -121,13 +121,13 @@

Source: models/PaymentBankAccountRequest.js


diff --git a/docs/models_PaymentCard.js.html b/docs/models_PaymentCard.js.html index 2c53df5..f3d19f9 100644 --- a/docs/models_PaymentCard.js.html +++ b/docs/models_PaymentCard.js.html @@ -184,13 +184,13 @@

Source: models/PaymentCard.js


diff --git a/docs/models_PaymentCardSpec.js.html b/docs/models_PaymentCardSpec.js.html index 569a32c..6e5b498 100644 --- a/docs/models_PaymentCardSpec.js.html +++ b/docs/models_PaymentCardSpec.js.html @@ -99,7 +99,7 @@

Source: models/PaymentCardSpec.js

* @member {Array.<String>} number_prefixes */ this - .number_prefixes = undefined + .number_prefixes = undefined /** * The length of the security code for this card. * @member {Number} security_code_length @@ -157,13 +157,13 @@

Source: models/PaymentCardSpec.js


diff --git a/docs/models_PaymentMethod.js.html b/docs/models_PaymentMethod.js.html index 29d003d..26f0a98 100644 --- a/docs/models_PaymentMethod.js.html +++ b/docs/models_PaymentMethod.js.html @@ -132,13 +132,13 @@

Source: models/PaymentMethod.js


diff --git a/docs/models_PaymentMethodResult.js.html b/docs/models_PaymentMethodResult.js.html index d4455fe..e24fb9f 100644 --- a/docs/models_PaymentMethodResult.js.html +++ b/docs/models_PaymentMethodResult.js.html @@ -96,13 +96,13 @@

Source: models/PaymentMethodResult.js


diff --git a/docs/models_PriceAdjustment.js.html b/docs/models_PriceAdjustment.js.html index a376bde..e8eea20 100644 --- a/docs/models_PriceAdjustment.js.html +++ b/docs/models_PriceAdjustment.js.html @@ -240,13 +240,13 @@

Source: models/PriceAdjustment.js


diff --git a/docs/models_PriceAdjustmentLimit.js.html b/docs/models_PriceAdjustmentLimit.js.html index db8a919..34c1d55 100644 --- a/docs/models_PriceAdjustmentLimit.js.html +++ b/docs/models_PriceAdjustmentLimit.js.html @@ -151,13 +151,13 @@

Source: models/PriceAdjustmentLimit.js


diff --git a/docs/models_PriceAdjustmentLimits.js.html b/docs/models_PriceAdjustmentLimits.js.html index 62c06a4..323e02d 100644 --- a/docs/models_PriceAdjustmentLimits.js.html +++ b/docs/models_PriceAdjustmentLimits.js.html @@ -95,13 +95,13 @@

Source: models/PriceAdjustmentLimits.js


diff --git a/docs/models_Product.js.html b/docs/models_Product.js.html index 284b472..8e0ce46 100644 --- a/docs/models_Product.js.html +++ b/docs/models_Product.js.html @@ -420,13 +420,13 @@

Source: models/Product.js


diff --git a/docs/models_ProductDetailsLink.js.html b/docs/models_ProductDetailsLink.js.html index 46cf101..6ff7394 100644 --- a/docs/models_ProductDetailsLink.js.html +++ b/docs/models_ProductDetailsLink.js.html @@ -131,13 +131,13 @@

Source: models/ProductDetailsLink.js


diff --git a/docs/models_ProductItem.js.html b/docs/models_ProductItem.js.html index 523d527..be6c9ca 100644 --- a/docs/models_ProductItem.js.html +++ b/docs/models_ProductItem.js.html @@ -324,13 +324,13 @@

Source: models/ProductItem.js


diff --git a/docs/models_ProductLink.js.html b/docs/models_ProductLink.js.html index 06d4a5c..6a3bf94 100644 --- a/docs/models_ProductLink.js.html +++ b/docs/models_ProductLink.js.html @@ -186,13 +186,13 @@

Source: models/ProductLink.js


diff --git a/docs/models_ProductListEvent.js.html b/docs/models_ProductListEvent.js.html index 99a4b2c..6c18b5e 100644 --- a/docs/models_ProductListEvent.js.html +++ b/docs/models_ProductListEvent.js.html @@ -130,13 +130,13 @@

Source: models/ProductListEvent.js


diff --git a/docs/models_ProductListItemReference.js.html b/docs/models_ProductListItemReference.js.html index f52abdc..8fe9f2e 100644 --- a/docs/models_ProductListItemReference.js.html +++ b/docs/models_ProductListItemReference.js.html @@ -173,13 +173,13 @@

Source: models/ProductListItemReference.js


diff --git a/docs/models_ProductListLink.js.html b/docs/models_ProductListLink.js.html index 98ac09e..a90ea4d 100644 --- a/docs/models_ProductListLink.js.html +++ b/docs/models_ProductListLink.js.html @@ -183,13 +183,13 @@

Source: models/ProductListLink.js


diff --git a/docs/models_ProductListRegistrant.js.html b/docs/models_ProductListRegistrant.js.html index eefc52c..127d691 100644 --- a/docs/models_ProductListRegistrant.js.html +++ b/docs/models_ProductListRegistrant.js.html @@ -113,13 +113,13 @@

Source: models/ProductListRegistrant.js


diff --git a/docs/models_ProductListShippingAddress.js.html b/docs/models_ProductListShippingAddress.js.html index 5a856d1..9b02a9d 100644 --- a/docs/models_ProductListShippingAddress.js.html +++ b/docs/models_ProductListShippingAddress.js.html @@ -122,13 +122,13 @@

Source: models/ProductListShippingAddress.js


diff --git a/docs/models_ProductPromotion.js.html b/docs/models_ProductPromotion.js.html index 6e40a4d..fa2e038 100644 --- a/docs/models_ProductPromotion.js.html +++ b/docs/models_ProductPromotion.js.html @@ -121,13 +121,13 @@

Source: models/ProductPromotion.js


diff --git a/docs/models_ProductRef.js.html b/docs/models_ProductRef.js.html new file mode 100644 index 0000000..cfdc4c0 --- /dev/null +++ b/docs/models_ProductRef.js.html @@ -0,0 +1,119 @@ + + + + + JSDoc: Source: models/ProductRef.js + + + + + + + + + + +
+ +

Source: models/ProductRef.js

+ + + + + + +
+
+ 
/* * *  *  * *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  * */
+/* Copyright (c) 2017 Mobify Research & Development Inc. All rights reserved. */
+/* * *  *  * *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  * */
+
+/* eslint-disable dot-notation */
+/**
+ * Shop API
+ * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+ *
+ * OpenAPI spec version: 17.8
+ *
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+import ApiClient from '../ApiClient'
+
+/**
+* The ProductRef model module.
+* @module models/ProductRef
+* @version 17.8
+*/
+export default class ProductRef {
+    /**
+    * Constructs a new <code>ProductRef</code>.
+    * Document representing a product reference.
+    * @alias module:models/ProductRef
+    * @class
+    * @param id {String} The ID of the product reference.
+    */
+    constructor(id) {
+        /**
+        * The ID of the product reference.
+        * @member {String} id
+        */
+        this.id = id
+
+        /**
+        * The link to the product reference.
+        * @member {String} link
+        */
+        this.link = undefined
+    }
+
+    /**
+    * Constructs a <code>ProductRef</code> from a plain JavaScript object, optionally creating a new instance.
+    * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+    * @param {Object} data The plain JavaScript object bearing properties of interest.
+    * @param {module:models/ProductRef} obj Optional instance to populate.
+    * @return {module:models/ProductRef} The populated <code>ProductRef</code> instance.
+    */
+    static constructFromObject(data, obj) {
+        if (data) {
+            obj = obj || new ProductRef()
+
+            if (data.hasOwnProperty('id')) {
+                obj['id'] = ApiClient.convertToType(data['id'], 'String')
+            }
+            if (data.hasOwnProperty('link')) {
+                obj['link'] = ApiClient.convertToType(data['link'], 'String')
+            }
+        }
+
+        return obj
+    }
+}
+
+
+
+ + + + +
+ + + +
+ + + + + + + diff --git a/docs/models_ProductResult.js.html b/docs/models_ProductResult.js.html index be433c4..1f670f7 100644 --- a/docs/models_ProductResult.js.html +++ b/docs/models_ProductResult.js.html @@ -113,13 +113,13 @@

Source: models/ProductResult.js


diff --git a/docs/models_ProductSearchHit.js.html b/docs/models_ProductSearchHit.js.html index 281819e..5becff2 100644 --- a/docs/models_ProductSearchHit.js.html +++ b/docs/models_ProductSearchHit.js.html @@ -46,6 +46,7 @@

Source: models/ProductSearchHit.js

import ApiClient from '../ApiClient' import Image from './Image' import ProductType from './ProductType' +import ProductRef from './ProductRef' import VariationAttribute from './VariationAttribute' /** @@ -121,6 +122,18 @@

Source: models/ProductSearchHit.js

*/ this.product_type = undefined + /** + * The first represented product. + * @member {module:models/ProductRef} represented_product + */ + this.represented_product = undefined + + /** + * All the represented products. + * @member {Array.<module:models/ProductRef>} represented_products + */ + this.represented_products = undefined + /** * The array of represented variation attributes (for the master product only). This array can be empty. * @member {Array.<module:models/VariationAttribute>} variation_attributes @@ -169,6 +182,12 @@

Source: models/ProductSearchHit.js

if (data.hasOwnProperty('product_type')) { obj['product_type'] = ProductType.constructFromObject(data['product_type']) } + if (data.hasOwnProperty('represented_product')) { + obj['represented_product'] = ProductRef.constructFromObject(data['represented_product']) + } + if (data.hasOwnProperty('represented_products')) { + obj['represented_products'] = ApiClient.convertToType(data['represented_products'], [ProductRef]) + } if (data.hasOwnProperty('variation_attributes')) { obj['variation_attributes'] = ApiClient.convertToType(data['variation_attributes'], [VariationAttribute]) } @@ -187,13 +206,13 @@

Source: models/ProductSearchHit.js


diff --git a/docs/models_ProductSearchRefinement.js.html b/docs/models_ProductSearchRefinement.js.html index d37a8af..ad60ccd 100644 --- a/docs/models_ProductSearchRefinement.js.html +++ b/docs/models_ProductSearchRefinement.js.html @@ -120,13 +120,13 @@

Source: models/ProductSearchRefinement.js


diff --git a/docs/models_ProductSearchRefinementValue.js.html b/docs/models_ProductSearchRefinementValue.js.html index 41a0ff9..1a749ad 100644 --- a/docs/models_ProductSearchRefinementValue.js.html +++ b/docs/models_ProductSearchRefinementValue.js.html @@ -144,13 +144,13 @@

Source: models/ProductSearchRefinementValue.js


diff --git a/docs/models_ProductSearchResult.js.html b/docs/models_ProductSearchResult.js.html index 0b8e04e..c48c252 100644 --- a/docs/models_ProductSearchResult.js.html +++ b/docs/models_ProductSearchResult.js.html @@ -213,13 +213,13 @@

Source: models/ProductSearchResult.js


diff --git a/docs/models_ProductSearchSortingOption.js.html b/docs/models_ProductSearchSortingOption.js.html index 34bfc3a..ee9bc40 100644 --- a/docs/models_ProductSearchSortingOption.js.html +++ b/docs/models_ProductSearchSortingOption.js.html @@ -103,13 +103,13 @@

Source: models/ProductSearchSortingOption.js


diff --git a/docs/models_ProductSimpleLink.js.html b/docs/models_ProductSimpleLink.js.html index 0502439..e538bca 100644 --- a/docs/models_ProductSimpleLink.js.html +++ b/docs/models_ProductSimpleLink.js.html @@ -103,13 +103,13 @@

Source: models/ProductSimpleLink.js


diff --git a/docs/models_ProductType.js.html b/docs/models_ProductType.js.html index b0c170e..83f7dfd 100644 --- a/docs/models_ProductType.js.html +++ b/docs/models_ProductType.js.html @@ -148,13 +148,13 @@

Source: models/ProductType.js


diff --git a/docs/models_Promotion.js.html b/docs/models_Promotion.js.html index e21a82d..8b3fe1f 100644 --- a/docs/models_Promotion.js.html +++ b/docs/models_Promotion.js.html @@ -166,13 +166,13 @@

Source: models/Promotion.js


diff --git a/docs/models_PromotionResult.js.html b/docs/models_PromotionResult.js.html index a85c028..4a1b962 100644 --- a/docs/models_PromotionResult.js.html +++ b/docs/models_PromotionResult.js.html @@ -113,13 +113,13 @@

Source: models/PromotionResult.js


diff --git a/docs/models_PublicProductList.js.html b/docs/models_PublicProductList.js.html index 0fc77bd..e63d21c 100644 --- a/docs/models_PublicProductList.js.html +++ b/docs/models_PublicProductList.js.html @@ -250,13 +250,13 @@

Source: models/PublicProductList.js


diff --git a/docs/models_PublicProductListItem.js.html b/docs/models_PublicProductListItem.js.html index 1196cec..655ed27 100644 --- a/docs/models_PublicProductListItem.js.html +++ b/docs/models_PublicProductListItem.js.html @@ -152,13 +152,13 @@

Source: models/PublicProductListItem.js


diff --git a/docs/models_PublicProductListItemResult.js.html b/docs/models_PublicProductListItemResult.js.html index a62f8e9..4c708b0 100644 --- a/docs/models_PublicProductListItemResult.js.html +++ b/docs/models_PublicProductListItemResult.js.html @@ -113,13 +113,13 @@

Source: models/PublicProductListItemResult.js


diff --git a/docs/models_PublicProductListLink.js.html b/docs/models_PublicProductListLink.js.html index af58ab3..e4af1c1 100644 --- a/docs/models_PublicProductListLink.js.html +++ b/docs/models_PublicProductListLink.js.html @@ -174,13 +174,13 @@

Source: models/PublicProductListLink.js


diff --git a/docs/models_PublicProductListResult.js.html b/docs/models_PublicProductListResult.js.html index 8f89863..03a0fa9 100644 --- a/docs/models_PublicProductListResult.js.html +++ b/docs/models_PublicProductListResult.js.html @@ -113,13 +113,13 @@

Source: models/PublicProductListResult.js


diff --git a/docs/models_Query.js.html b/docs/models_Query.js.html index 63de1cf..65f9886 100644 --- a/docs/models_Query.js.html +++ b/docs/models_Query.js.html @@ -116,13 +116,13 @@

Source: models/Query.js


diff --git a/docs/models_QueryFilter.js.html b/docs/models_QueryFilter.js.html index a2e8621..178213b 100644 --- a/docs/models_QueryFilter.js.html +++ b/docs/models_QueryFilter.js.html @@ -96,13 +96,13 @@

Source: models/QueryFilter.js


diff --git a/docs/models_Range2Filter.js.html b/docs/models_Range2Filter.js.html index db5c8f9..7e9895d 100644 --- a/docs/models_Range2Filter.js.html +++ b/docs/models_Range2Filter.js.html @@ -176,13 +176,13 @@

Source: models/Range2Filter.js


diff --git a/docs/models_RangeFilter.js.html b/docs/models_RangeFilter.js.html index fa44bdb..17ae6b2 100644 --- a/docs/models_RangeFilter.js.html +++ b/docs/models_RangeFilter.js.html @@ -132,13 +132,13 @@

Source: models/RangeFilter.js


diff --git a/docs/models_Recommendation.js.html b/docs/models_Recommendation.js.html index 7690d74..4b9613b 100644 --- a/docs/models_Recommendation.js.html +++ b/docs/models_Recommendation.js.html @@ -159,13 +159,13 @@

Source: models/Recommendation.js


diff --git a/docs/models_RecommendationType.js.html b/docs/models_RecommendationType.js.html index 2480614..ad87fbc 100644 --- a/docs/models_RecommendationType.js.html +++ b/docs/models_RecommendationType.js.html @@ -103,13 +103,13 @@

Source: models/RecommendationType.js


diff --git a/docs/models_ResultPage.js.html b/docs/models_ResultPage.js.html index fcea44c..db462df 100644 --- a/docs/models_ResultPage.js.html +++ b/docs/models_ResultPage.js.html @@ -103,13 +103,13 @@

Source: models/ResultPage.js


diff --git a/docs/models_Shipment.js.html b/docs/models_Shipment.js.html index 4212e26..8d49e8d 100644 --- a/docs/models_Shipment.js.html +++ b/docs/models_Shipment.js.html @@ -271,13 +271,13 @@

Source: models/Shipment.js


diff --git a/docs/models_ShippingItem.js.html b/docs/models_ShippingItem.js.html index 8a5db96..beae637 100644 --- a/docs/models_ShippingItem.js.html +++ b/docs/models_ShippingItem.js.html @@ -201,13 +201,13 @@

Source: models/ShippingItem.js


diff --git a/docs/models_ShippingMethod.js.html b/docs/models_ShippingMethod.js.html index 77a535e..1e9bfa8 100644 --- a/docs/models_ShippingMethod.js.html +++ b/docs/models_ShippingMethod.js.html @@ -142,13 +142,13 @@

Source: models/ShippingMethod.js


diff --git a/docs/models_ShippingMethodResult.js.html b/docs/models_ShippingMethodResult.js.html index 49a9df5..c203044 100644 --- a/docs/models_ShippingMethodResult.js.html +++ b/docs/models_ShippingMethodResult.js.html @@ -104,13 +104,13 @@

Source: models/ShippingMethodResult.js


diff --git a/docs/models_ShippingPromotion.js.html b/docs/models_ShippingPromotion.js.html index 937418d..a4efd3a 100644 --- a/docs/models_ShippingPromotion.js.html +++ b/docs/models_ShippingPromotion.js.html @@ -121,13 +121,13 @@

Source: models/ShippingPromotion.js


diff --git a/docs/models_SimpleLink.js.html b/docs/models_SimpleLink.js.html index 1c35bd6..e3ec3bb 100644 --- a/docs/models_SimpleLink.js.html +++ b/docs/models_SimpleLink.js.html @@ -94,13 +94,13 @@

Source: models/SimpleLink.js


diff --git a/docs/models_Site.js.html b/docs/models_Site.js.html index 53eaeab..4588524 100644 --- a/docs/models_Site.js.html +++ b/docs/models_Site.js.html @@ -259,13 +259,13 @@

Source: models/Site.js


diff --git a/docs/models_Sort.js.html b/docs/models_Sort.js.html index 8692fed..3d79377 100644 --- a/docs/models_Sort.js.html +++ b/docs/models_Sort.js.html @@ -123,13 +123,13 @@

Source: models/Sort.js


diff --git a/docs/models_Status.js.html b/docs/models_Status.js.html index 3ff4b4c..8d76fcb 100644 --- a/docs/models_Status.js.html +++ b/docs/models_Status.js.html @@ -111,13 +111,13 @@

Source: models/Status.js


diff --git a/docs/models_Store.js.html b/docs/models_Store.js.html index b615b8e..6a5fd1c 100644 --- a/docs/models_Store.js.html +++ b/docs/models_Store.js.html @@ -301,13 +301,13 @@

Source: models/Store.js


diff --git a/docs/models_StoreResult.js.html b/docs/models_StoreResult.js.html index d1b8590..661162b 100644 --- a/docs/models_StoreResult.js.html +++ b/docs/models_StoreResult.js.html @@ -140,13 +140,13 @@

Source: models/StoreResult.js


diff --git a/docs/models_SuggestedCategory.js.html b/docs/models_SuggestedCategory.js.html index 02a6bca..cb6af82 100644 --- a/docs/models_SuggestedCategory.js.html +++ b/docs/models_SuggestedCategory.js.html @@ -120,13 +120,13 @@

Source: models/SuggestedCategory.js


diff --git a/docs/models_SuggestedContent.js.html b/docs/models_SuggestedContent.js.html index cc6c14a..518b5a1 100644 --- a/docs/models_SuggestedContent.js.html +++ b/docs/models_SuggestedContent.js.html @@ -109,13 +109,13 @@

Source: models/SuggestedContent.js


diff --git a/docs/models_SuggestedPhrase.js.html b/docs/models_SuggestedPhrase.js.html index fafee6d..eb58f35 100644 --- a/docs/models_SuggestedPhrase.js.html +++ b/docs/models_SuggestedPhrase.js.html @@ -103,13 +103,13 @@

Source: models/SuggestedPhrase.js


diff --git a/docs/models_SuggestedProduct.js.html b/docs/models_SuggestedProduct.js.html index 3bff9c5..eff0337 100644 --- a/docs/models_SuggestedProduct.js.html +++ b/docs/models_SuggestedProduct.js.html @@ -141,13 +141,13 @@

Source: models/SuggestedProduct.js


diff --git a/docs/models_SuggestedTerm.js.html b/docs/models_SuggestedTerm.js.html index 86e178e..5490ba7 100644 --- a/docs/models_SuggestedTerm.js.html +++ b/docs/models_SuggestedTerm.js.html @@ -121,13 +121,13 @@

Source: models/SuggestedTerm.js


diff --git a/docs/models_SuggestedTerms.js.html b/docs/models_SuggestedTerms.js.html index 5fb6c8d..ba60c83 100644 --- a/docs/models_SuggestedTerms.js.html +++ b/docs/models_SuggestedTerms.js.html @@ -104,13 +104,13 @@

Source: models/SuggestedTerms.js


diff --git a/docs/models_Suggestion.js.html b/docs/models_Suggestion.js.html index f15904d..ed6abf7 100644 --- a/docs/models_Suggestion.js.html +++ b/docs/models_Suggestion.js.html @@ -153,13 +153,13 @@

Source: models/Suggestion.js


diff --git a/docs/models_SuggestionResult.js.html b/docs/models_SuggestionResult.js.html index b2dd08f..3286025 100644 --- a/docs/models_SuggestionResult.js.html +++ b/docs/models_SuggestionResult.js.html @@ -140,13 +140,13 @@

Source: models/SuggestionResult.js


diff --git a/docs/models_TermFilter.js.html b/docs/models_TermFilter.js.html index 9e2fc5a..44edbbf 100644 --- a/docs/models_TermFilter.js.html +++ b/docs/models_TermFilter.js.html @@ -171,13 +171,13 @@

Source: models/TermFilter.js


diff --git a/docs/models_TermQuery.js.html b/docs/models_TermQuery.js.html index bc3b174..65e8c8e 100644 --- a/docs/models_TermQuery.js.html +++ b/docs/models_TermQuery.js.html @@ -174,13 +174,13 @@

Source: models/TermQuery.js


diff --git a/docs/models_TextQuery.js.html b/docs/models_TextQuery.js.html index 94652aa..6964751 100644 --- a/docs/models_TextQuery.js.html +++ b/docs/models_TextQuery.js.html @@ -108,13 +108,13 @@

Source: models/TextQuery.js


diff --git a/docs/models_Variant.js.html b/docs/models_Variant.js.html index 13b3f3a..3c7e304 100644 --- a/docs/models_Variant.js.html +++ b/docs/models_Variant.js.html @@ -131,13 +131,13 @@

Source: models/Variant.js


diff --git a/docs/models_VariationAttribute.js.html b/docs/models_VariationAttribute.js.html index d229e7a..c38b1a0 100644 --- a/docs/models_VariationAttribute.js.html +++ b/docs/models_VariationAttribute.js.html @@ -109,13 +109,13 @@

Source: models/VariationAttribute.js


diff --git a/docs/models_VariationAttributeValue.js.html b/docs/models_VariationAttributeValue.js.html index 47845ca..2633873 100644 --- a/docs/models_VariationAttributeValue.js.html +++ b/docs/models_VariationAttributeValue.js.html @@ -44,6 +44,7 @@

Source: models/VariationAttributeValue.js

* */ import ApiClient from '../ApiClient' +import Image from './Image' /** * The VariationAttributeValue model module. @@ -63,6 +64,16 @@

Source: models/VariationAttributeValue.js

*/ this.description = undefined + /** + * @member {module:models/Image} image + */ + this.image = undefined + + /** + * @member {module:models/Image} image_swatch + */ + this.image_swatch = undefined + /** * @member {String} name */ @@ -93,6 +104,12 @@

Source: models/VariationAttributeValue.js

if (data.hasOwnProperty('description')) { obj['description'] = ApiClient.convertToType(data['description'], 'String') } + if (data.hasOwnProperty('image')) { + obj['image'] = Image.constructFromObject(data['image']) + } + if (data.hasOwnProperty('image_swatch')) { + obj['image_swatch'] = Image.constructFromObject(data['image_swatch']) + } if (data.hasOwnProperty('name')) { obj['name'] = ApiClient.convertToType(data['name'], 'String') } @@ -117,13 +134,13 @@

Source: models/VariationAttributeValue.js


diff --git a/docs/models_VariationGroup.js.html b/docs/models_VariationGroup.js.html index 307c264..76016d4 100644 --- a/docs/models_VariationGroup.js.html +++ b/docs/models_VariationGroup.js.html @@ -130,13 +130,13 @@

Source: models/VariationGroup.js


diff --git a/docs/module-ApiClient.html b/docs/module-ApiClient.html index 8bd483b..1a30dae 100644 --- a/docs/module-ApiClient.html +++ b/docs/module-ApiClient.html @@ -95,7 +95,7 @@

new m
Source:
@@ -123,6 +123,8 @@

new m + + @@ -197,7 +199,7 @@

Type:
Source:
@@ -274,7 +276,7 @@
Type:
Source:
@@ -352,7 +354,7 @@
Type:
Source:
@@ -429,7 +431,7 @@
Type:
Source:
@@ -497,7 +499,87 @@

enableCo
Source:
+ + + + + + + + + + + + + + + + +

overrideHttpPut :Boolean

+ + + + +
+

If set to true, endpoints that normally use HTTP PUT will +be sent using POST with an aditional header (x-dw-http-method-override: PUT). +Please refer to the following Salesforce documentation https://documentation.demandware.com/DOC1/topic/com.demandware.dochelp/OCAPI/18.8/usage/HttpMethods.html +for more information.

+
+ + + +
Type:
+
    +
  • + +Boolean + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
Default Value:
+
    +
  • true
    • +
+ + + +
Source:
+
@@ -574,7 +656,7 @@
Type:
Source:
@@ -732,7 +814,7 @@
Parameters:
Source:
@@ -760,6 +842,8 @@
Parameters:
+ + @@ -905,7 +989,7 @@
Parameters:
Source:
@@ -928,6 +1012,8 @@
Parameters:
+ +
Returns:
@@ -1050,7 +1136,7 @@
Parameters:
Source:
@@ -1073,6 +1159,8 @@
Parameters:
+ +
Returns:
@@ -1230,7 +1318,7 @@
Parameters:
Source:
@@ -1258,6 +1346,8 @@
Parameters:
+ + @@ -1388,7 +1478,7 @@
Parameters:
Source:
@@ -1411,6 +1501,8 @@
Parameters:
+ +
Returns:
@@ -1448,6 +1540,167 @@
Returns:
+

buildRefineParams(refinements) → {Object}

+ + + + + + +
+

Builds an object with refinement keys 1..n given a an array of refinements. +A numbered suffix will not be applied if the number of refinements is equal to 1.

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
refinements + + +Array + + + +

Array of refinement strings

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+

An object with refinement keys numbered 1 ... n with their +string representation value.

+
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + + + + +

buildUrl(path, pathParams) → {String}

@@ -1573,7 +1826,7 @@
Parameters:
Source:
@@ -1596,6 +1849,8 @@
Parameters:
+ +
Returns:
@@ -1967,7 +2222,7 @@
Parameters:
Source:
@@ -1990,6 +2245,8 @@
Parameters:
+ +
Returns:
@@ -2159,7 +2416,7 @@
Parameters:
Source:
@@ -2182,6 +2439,8 @@
Parameters:
+ +
Returns:
@@ -2299,7 +2558,7 @@
Parameters:
Source:
@@ -2322,6 +2581,8 @@
Parameters:
+ +
Returns:
@@ -2462,7 +2723,7 @@
Parameters:
Source:
@@ -2485,6 +2746,8 @@
Parameters:
+ +
Returns:
@@ -2619,7 +2882,7 @@
Parameters:
Source:
@@ -2642,6 +2905,8 @@
Parameters:
+ +
Returns:
@@ -2687,7 +2952,7 @@

normal
  • remove nils
  • keep files and arrays
    • -
  • format to string with paramToString for other cases
    • +
  • format to string with `paramToString` for other cases
@@ -2781,7 +3046,7 @@

Parameters:
Source:
@@ -2804,6 +3069,8 @@
Parameters:
+ +
Returns:
@@ -2933,7 +3200,7 @@
Parameters:
Source:
@@ -2956,6 +3223,8 @@
Parameters:
+ +
Returns:
@@ -3085,7 +3354,7 @@
Parameters:
Source:
@@ -3108,6 +3377,8 @@
Parameters:
+ +
Returns:
@@ -3136,6 +3407,188 @@
Returns:
+ + + + + +

sendApiRequest(request, returnType) → {Promise}

+ + + + + + +
+

Sends the generated superagent request and deserializes the response.

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
request + + +module:superagent.Request + + + +

The superagent request to send.

returnType + + +String + + + +

The type to deserialize the response into.

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+

A Promise object.

+
+ + + +
+
+ Type +
+
+ +Promise + + +
+
+ + + + + + + + @@ -3151,13 +3604,13 @@
Returns:

diff --git a/docs/module-api_BasketsApi.html b/docs/module-api_BasketsApi.html index eebf832..1e79cfb 100644 --- a/docs/module-api_BasketsApi.html +++ b/docs/module-api_BasketsApi.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -321,6 +323,8 @@
Parameters:
+ +
Returns:
@@ -501,6 +505,8 @@
Parameters:
+ +
Returns:
@@ -681,6 +687,8 @@
Parameters:
+ +
Returns:
@@ -861,6 +869,8 @@
Parameters:
+ +
Returns:
@@ -1041,6 +1051,8 @@
Parameters:
+ +
Returns:
@@ -1221,6 +1233,8 @@
Parameters:
+ +
Returns:
@@ -1401,6 +1415,8 @@
Parameters:
+ +
Returns:
@@ -1581,6 +1597,8 @@
Parameters:
+ +
Returns:
@@ -1761,6 +1779,8 @@
Parameters:
+ +
Returns:
@@ -1941,6 +1961,8 @@
Parameters:
+ +
Returns:
@@ -2121,6 +2143,8 @@
Parameters:
+ +
Returns:
@@ -2278,6 +2302,8 @@
Parameters:
+ +
Returns:
@@ -2435,6 +2461,8 @@
Parameters:
+ +
Returns:
@@ -2592,6 +2620,8 @@
Parameters:
+ +
Returns:
@@ -2749,6 +2779,8 @@
Parameters:
+ +
Returns:
@@ -2906,6 +2938,8 @@
Parameters:
+ +
Returns:
@@ -3063,6 +3097,8 @@
Parameters:
+ +
Returns:
@@ -3243,6 +3279,8 @@
Parameters:
+ +
Returns:
@@ -3423,6 +3461,8 @@
Parameters:
+ +
Returns:
@@ -3580,6 +3620,8 @@
Parameters:
+ +
Returns:
@@ -3760,6 +3802,8 @@
Parameters:
+ +
Returns:
@@ -3809,10 +3853,10 @@

id. +provided in property option_items. Those option_items need to contain option_id and option_value_id. The provided values must be valid for the option product that this product item represents. Otherwise InvalidProductOptionItemException or InvalidProductOptionValueItemException will be thrown. -custom properties c<CUSTOM_NAME>: a value corresponding to the type defined for custom attribute +custom properties c_<CUSTOM_NAME>: a value corresponding to the type defined for custom attribute <CUSTOM_NAME> of ProductLineItem. The purpose of this value is to add or change the value of a custom attribute defined for ProductLineItem.

@@ -3976,6 +4020,8 @@
Parameters:
+ +
Returns:
@@ -4027,9 +4073,9 @@

p option_items/option_value_id: a valid option value id. This is an option value for an option item of an option product. This is only possible if the product item is an option product. To set option values, you must specify a collection of option items in the option_items -property. These option items must contain option_id and option_valueid. Also, +property. These option items must contain option_id and option_value_id. Also, the values you specify must be valid for the option product that this product item represents. Otherwise, the server throws an InvalidProductOptionItemException or an InvalidProductOptionValueItemException. -custom properties in the form c<CUSTOM_NAME>: the custom property must correspond to a custom +custom properties in the form c_<CUSTOM_NAME>: the custom property must correspond to a custom attribute (<CUSTOM_NAME>) defined for ProductLineItem. The value of this property must be valid for the type of custom attribute defined for ProductLineItem.

@@ -6346,6 +6414,8 @@
Parameters:
+ +
Returns:
@@ -6403,10 +6473,10 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-api_CategoriesApi.html b/docs/module-api_CategoriesApi.html index aa27250..a83b127 100644 --- a/docs/module-api_CategoriesApi.html +++ b/docs/module-api_CategoriesApi.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -418,6 +420,8 @@
Properties
+ +
Returns:
@@ -666,6 +670,8 @@
Properties
+ +
Returns:
@@ -914,6 +920,8 @@
Properties
+ +
Returns:
@@ -1168,6 +1176,8 @@
Properties
+ +
Returns:
@@ -1211,13 +1221,13 @@
Returns:

diff --git a/docs/module-api_ContentApi.html b/docs/module-api_ContentApi.html index 3125ba6..1bc355b 100644 --- a/docs/module-api_ContentApi.html +++ b/docs/module-api_ContentApi.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -395,6 +397,8 @@
Properties
+ +
Returns:
@@ -620,6 +624,8 @@
Properties
+ +
Returns:
@@ -845,6 +851,8 @@
Properties
+ +
Returns:
@@ -1076,6 +1084,8 @@
Properties
+ +
Returns:
@@ -1119,13 +1129,13 @@
Returns:

diff --git a/docs/module-api_ContentSearchApi.html b/docs/module-api_ContentSearchApi.html index 03981f2..a9dd93d 100644 --- a/docs/module-api_ContentSearchApi.html +++ b/docs/module-api_ContentSearchApi.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -323,11 +325,11 @@
Properties

Parameter that represents a refinement attribute/value(s) pair. Refinement attribute id and -value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and +value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and can be provided by separating them using a pipe (URL -encoded = \"|\"). Value ranges can be specified like this: refine=foo=(100..500) Multiple refine +encoded = &quot;|&quot;). Value ranges can be specified like this: refine=foo=(100..500) Multiple refine parameters can be provided by adding an underscore in combination with an integer counter right behind -the parameter name and a counter range 1..9. I.e. refine_1=c_refinementType=type1|type2|type3. The +the parameter name and a counter range 1..9. I.e. refine_1=c_refinementType=type1|type2|type3. The following system refinement attribute ids are supported: fdid: Allows to refine per single content folder id. Multiple folder ids are not supported.

@@ -353,8 +355,8 @@
Properties

Parameter that represents a sorting attribute/value(s) pair. Sorting attribute id and value are -separated by '='. The value describes the sort direction. Possible values are 'asc' and 'desc', for -ascending or descending sort direction. I.e. sort=c_myAttribute=desc. Precondition: You have to select +separated by '='. The value describes the sort direction. Possible values are 'asc' and 'desc', for +ascending or descending sort direction. I.e. sort=c_myAttribute=desc. Precondition: You have to select your sorting attributes in Business Manager > YourSite > Search Indexes > Content Index > Sorting Attributes.

@@ -496,6 +498,8 @@
Properties
+ +
Returns:
@@ -655,11 +659,11 @@
Properties

Parameter that represents a refinement attribute/value(s) pair. Refinement attribute id and -value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and +value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and can be provided by separating them using a pipe (URL -encoded = \"|\"). Value ranges can be specified like this: refine=foo=(100..500) Multiple refine +encoded = &quot;|&quot;). Value ranges can be specified like this: refine=foo=(100..500) Multiple refine parameters can be provided by adding an underscore in combination with an integer counter right behind -the parameter name and a counter range 1..9. I.e. refine_1=c_refinementType=type1|type2|type3. The +the parameter name and a counter range 1..9. I.e. refine_1=c_refinementType=type1|type2|type3. The following system refinement attribute ids are supported: fdid: Allows to refine per single content folder id. Multiple folder ids are not supported.

@@ -685,8 +689,8 @@
Properties

Parameter that represents a sorting attribute/value(s) pair. Sorting attribute id and value are -separated by '='. The value describes the sort direction. Possible values are 'asc' and 'desc', for -ascending or descending sort direction. I.e. sort=c_myAttribute=desc. Precondition: You have to select +separated by '='. The value describes the sort direction. Possible values are 'asc' and 'desc', for +ascending or descending sort direction. I.e. sort=c_myAttribute=desc. Precondition: You have to select your sorting attributes in Business Manager > YourSite > Search Indexes > Content Index > Sorting Attributes.

@@ -828,6 +832,8 @@
Properties
+ +
Returns:
@@ -871,13 +877,13 @@
Returns:

diff --git a/docs/module-api_CustomObjectsApi.html b/docs/module-api_CustomObjectsApi.html index d9ae9e0..7add968 100644 --- a/docs/module-api_CustomObjectsApi.html +++ b/docs/module-api_CustomObjectsApi.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -344,6 +346,8 @@
Parameters:
+ +
Returns:
@@ -524,6 +528,8 @@
Parameters:
+ +
Returns:
@@ -567,13 +573,13 @@
Returns:

diff --git a/docs/module-api_CustomersApi.html b/docs/module-api_CustomersApi.html index 34239c1..9c83c7a 100644 --- a/docs/module-api_CustomersApi.html +++ b/docs/module-api_CustomersApi.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -370,6 +372,8 @@
Properties
+ +
Returns:
@@ -576,6 +580,8 @@
Properties
+ +
Returns:
@@ -756,6 +762,8 @@
Parameters:
+ +
Returns:
@@ -936,6 +944,8 @@
Parameters:
+ +
Returns:
@@ -1116,6 +1126,8 @@
Parameters:
+ +
Returns:
@@ -1296,6 +1308,8 @@
Parameters:
+ +
Returns:
@@ -1476,6 +1490,8 @@
Parameters:
+ +
Returns:
@@ -1679,6 +1695,8 @@
Parameters:
+ +
Returns:
@@ -1882,6 +1900,8 @@
Parameters:
+ +
Returns:
@@ -2062,6 +2082,8 @@
Parameters:
+ +
Returns:
@@ -2291,6 +2313,8 @@
Properties
+ +
Returns:
@@ -2547,6 +2571,8 @@
Properties
+ +
Returns:
@@ -2727,6 +2753,8 @@
Parameters:
+ +
Returns:
@@ -2907,6 +2935,8 @@
Parameters:
+ +
Returns:
@@ -3163,6 +3193,8 @@
Properties
+ +
Returns:
@@ -3320,6 +3352,8 @@
Parameters:
+ +
Returns:
@@ -3477,6 +3511,8 @@
Parameters:
+ +
Returns:
@@ -3821,6 +3857,8 @@
Properties
+ +
Returns:
@@ -4165,6 +4203,8 @@
Properties
+ +
Returns:
@@ -4397,6 +4437,8 @@
Properties
+ +
Returns:
@@ -4577,6 +4619,8 @@
Parameters:
+ +
Returns:
@@ -4757,6 +4801,8 @@
Parameters:
+ +
Returns:
@@ -4989,6 +5035,8 @@
Properties
+ +
Returns:
@@ -5218,6 +5266,8 @@
Properties
+ +
Returns:
@@ -5470,6 +5520,8 @@
Properties
+ +
Returns:
@@ -5768,6 +5820,8 @@
Properties
+ +
Returns:
@@ -6043,6 +6097,8 @@
Properties
+ +
Returns:
@@ -6318,6 +6374,8 @@
Properties
+ +
Returns:
@@ -6616,6 +6674,8 @@
Properties
+ +
Returns:
@@ -6868,6 +6928,8 @@
Properties
+ +
Returns:
@@ -7097,6 +7159,8 @@
Properties
+ +
Returns:
@@ -7326,6 +7390,8 @@
Properties
+ +
Returns:
@@ -7506,6 +7572,8 @@
Parameters:
+ +
Returns:
@@ -7709,6 +7777,8 @@
Parameters:
+ +
Returns:
@@ -7912,6 +7982,8 @@
Parameters:
+ +
Returns:
@@ -8115,6 +8187,8 @@
Parameters:
+ +
Returns:
@@ -8347,6 +8421,8 @@
Parameters:
+ +
Returns:
@@ -8579,6 +8655,8 @@
Parameters:
+ +
Returns:
@@ -8782,6 +8860,8 @@
Parameters:
+ +
Returns:
@@ -8962,6 +9042,8 @@
Parameters:
+ +
Returns:
@@ -9121,6 +9203,8 @@
Parameters:
+ +
Returns:
@@ -9173,10 +9257,10 @@

post AuthenticationFailedException. Type refresh - examines the token passed in the HTTP Authorization:Bearer request header and when valid returns a new token with an updated expiry time. For a request of type credentials: -Updates profile attributes for the customer (for example, \"last-visited\"). +Updates profile attributes for the customer (for example, &quot;last-visited&quot;). Handles the maximum number of failed login attempts. For a request of type session: -Does not touch profile attributes for the registered customer (for example, \"last-visited\"), since this is not a real login. +Does not touch profile attributes for the registered customer (for example, &quot;last-visited&quot;), since this is not a real login. Returns different tokens for multiple requests with the same session id. Means, there should be only one call per session. About JWT The token contains 3 sections: @@ -9184,12 +9268,12 @@

post the payload section (contains customer information, client id, issue and expiration time) finally the signature section records the token signature. A token is created and returned to the client whenever a registered -customer logs in (type \"credentials\") or a guest customer requests it (type \"guest\"). The token is returned in the response header as Authorization: Bearer --token-- +customer logs in (type &quot;credentials&quot;) or a guest customer requests it (type &quot;guest&quot;). The token is returned in the response header as Authorization: Bearer --token-- The client has to include the token in the request header as Authorization: Bearer --token-- in any follow up request. The server declines any follow up requests without a token or which cannot be verified based on the token signature -or expiration time. A token nearing its expiration time should be exchanged for a new one (type \"refresh\"). -See \"API Usage > JWT\" for more details on using JWT as an authentication mechanism.

+or expiration time. A token nearing its expiration time should be exchanged for a new one (type &quot;refresh&quot;). +See &quot;API Usage > JWT&quot; for more details on using JWT as an authentication mechanism.

@@ -9377,6 +9461,8 @@

Properties
+ +
Returns:
@@ -9428,19 +9514,19 @@

+which cannot be verified based on the token signature or expiration time. A token nearing its expiration time should be exchanged for a new one (type &quot;refresh&quot;). +See &quot;API Usage > JWT&quot; for more details on using JWT as an authentication mechanism.

@@ -9628,6 +9714,8 @@
Properties
+ +
Returns:
@@ -9808,6 +9896,8 @@
Parameters:
+ +
Returns:
@@ -9988,6 +10078,8 @@
Parameters:
+ +
Returns:
@@ -10155,6 +10247,8 @@
Parameters:
+ +
Returns:
@@ -10322,6 +10416,8 @@
Parameters:
+ +
Returns:
@@ -10482,6 +10578,8 @@
Parameters:
+ +
Returns:
@@ -10642,6 +10740,8 @@
Parameters:
+ +
Returns:
@@ -10822,6 +10922,8 @@
Parameters:
+ +
Returns:
@@ -11002,6 +11104,8 @@
Parameters:
+ +
Returns:
@@ -11182,6 +11286,8 @@
Parameters:
+ +
Returns:
@@ -11227,11 +11333,11 @@

id: a valid product id, used for product item type only. This is the id (sku) +product_id: a valid product id, used for product item type only. This is the id (sku) of the product related to the item to be added to the customer's product list. It is mandatory for product item type and it must be a valid product id, otherwise ProductListProductIdMissingException or ProductListProductNotFoundException will be thrown. quantity: used for product item type only. This is the quantity of the item to be added to the customer's product list. -custom properties in the form c<CUSTOM_NAME>: the custom property must correspond to a custom +custom properties in the form c_<CUSTOM_NAME>: the custom property must correspond to a custom attribute (<CUSTOM_NAME>) defined for ProductListItem. The value of this property must be valid for the type of custom attribute defined for ProductListItem.

@@ -11609,6 +11717,8 @@
Parameters:
+ +
Returns:
@@ -11789,6 +11899,8 @@
Parameters:
+ +
Returns:
@@ -11953,6 +12065,8 @@
Parameters:
+ +
Returns:
@@ -12118,6 +12232,8 @@
Parameters:
+ +
Returns:
@@ -12277,6 +12393,8 @@
Parameters:
+ +
Returns:
@@ -12457,6 +12575,8 @@
Parameters:
+ +
Returns:
@@ -12637,6 +12757,8 @@
Parameters:
+ +
Returns:
@@ -12680,13 +12802,13 @@
Returns:

diff --git a/docs/module-api_FoldersApi.html b/docs/module-api_FoldersApi.html index 1c82715..460da6b 100644 --- a/docs/module-api_FoldersApi.html +++ b/docs/module-api_FoldersApi.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -419,6 +421,8 @@
Properties
+ +
Returns:
@@ -667,6 +671,8 @@
Properties
+ +
Returns:
@@ -915,6 +921,8 @@
Properties
+ +
Returns:
@@ -1170,6 +1178,8 @@
Properties
+ +
Returns:
@@ -1213,13 +1223,13 @@
Returns:

diff --git a/docs/module-api_GiftCertificateApi.html b/docs/module-api_GiftCertificateApi.html index 4457e17..13c5814 100644 --- a/docs/module-api_GiftCertificateApi.html +++ b/docs/module-api_GiftCertificateApi.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -370,6 +372,8 @@
Properties
+ +
Returns:
@@ -576,6 +580,8 @@
Properties
+ +
Returns:
@@ -619,13 +625,13 @@
Returns:

diff --git a/docs/module-api_OrderSearchApi.html b/docs/module-api_OrderSearchApi.html index 125664f..049cf49 100644 --- a/docs/module-api_OrderSearchApi.html +++ b/docs/module-api_OrderSearchApi.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -218,10 +220,10 @@

postOr total_gross_price total_net_price order.has_holds coupon_line_items.coupon_code coupon_line_items.coupon_id holds.type invoices.status order_items.status payment_instruments.credit_card_type payment_instruments.payment_method_id product_items.product_id return_cases.return_case_number -shipments.shipping_method_id shipping_orders.shipping_ordernumber -The sort order of the retrieved orders could be specified by the \"sorts\" parameter. It is a list of objects -presenting field name and sort direction (\"asc\" or \"desc\"). -Custom attributes could be used as search fields and as sort fields too. A prefix \"c\" has to be added to them.

+shipments.shipping_method_id shipping_orders.shipping_order_number +The sort order of the retrieved orders could be specified by the &quot;sorts&quot; parameter. It is a list of objects +presenting field name and sort direction (&quot;asc&quot; or &quot;desc&quot;). +Custom attributes could be used as search fields and as sort fields too. A prefix &quot;c_&quot; has to be added to them.

@@ -337,6 +339,8 @@

Parameters:
+ +
Returns:
@@ -391,10 +395,10 @@

< status (String) total_gross_price total_net_price order.has_holds coupon_line_items.coupon_code coupon_line_items.coupon_id holds.type invoices.status order_items.status payment_instruments.credit_card_type payment_instruments.payment_method_id product_items.product_id return_cases.return_case_number -shipments.shipping_method_id shipping_orders.shipping_ordernumber -The sort order of the retrieved orders could be specified by the \"sorts\" parameter. It is a list of objects -presenting field name and sort direction (\"asc\" or \"desc\"). -Custom attributes could be used as search fields and as sort fields too. A prefix \"c\" has to be added to them.

+shipments.shipping_method_id shipping_orders.shipping_order_number +The sort order of the retrieved orders could be specified by the &quot;sorts&quot; parameter. It is a list of objects +presenting field name and sort direction (&quot;asc&quot; or &quot;desc&quot;). +Custom attributes could be used as search fields and as sort fields too. A prefix &quot;c_&quot; has to be added to them.

@@ -510,6 +514,8 @@
Parameters:
+ +
Returns:
@@ -553,13 +559,13 @@
Returns:

diff --git a/docs/module-api_OrdersApi.html b/docs/module-api_OrdersApi.html index 8e92d40..47e3c91 100644 --- a/docs/module-api_OrdersApi.html +++ b/docs/module-api_OrdersApi.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -344,6 +346,8 @@
Parameters:
+ +
Returns:
@@ -524,6 +528,8 @@
Parameters:
+ +
Returns:
@@ -704,6 +710,8 @@
Parameters:
+ +
Returns:
@@ -884,6 +892,8 @@
Parameters:
+ +
Returns:
@@ -1041,6 +1051,8 @@
Parameters:
+ +
Returns:
@@ -1198,6 +1210,8 @@
Parameters:
+ +
Returns:
@@ -1355,6 +1369,8 @@
Parameters:
+ +
Returns:
@@ -1512,6 +1528,8 @@
Parameters:
+ +
Returns:
@@ -1669,6 +1687,8 @@
Parameters:
+ +
Returns:
@@ -1826,6 +1846,8 @@
Parameters:
+ +
Returns:
@@ -2010,6 +2032,8 @@
Parameters:
+ +
Returns:
@@ -2237,6 +2261,8 @@
Parameters:
+ +
Returns:
@@ -2463,6 +2489,8 @@
Parameters:
+ +
Returns:
@@ -2646,6 +2674,8 @@
Parameters:
+ +
Returns:
@@ -2689,8 +2719,8 @@

postOrders<

Submits an order based on a prepared basket. Note: If the basket has been submitted using Order Center (considered by it's client id) the -channel type will be set to \"Call Center\". In case another channel type was set by -a script before submitting the basket, the channel type will be reset to \"Call Center\" +channel type will be set to &quot;Call Center&quot;. In case another channel type was set by +a script before submitting the basket, the channel type will be reset to &quot;Call Center&quot; and a warning will be logged. The only considered value from the request body is basket_id.

@@ -2807,6 +2837,8 @@

Parameters:
+ +
Returns:
@@ -2987,6 +3019,8 @@
Parameters:
+ +
Returns:
@@ -3167,6 +3201,8 @@
Parameters:
+ +
Returns:
@@ -3374,6 +3410,8 @@
Parameters:
+ +
Returns:
@@ -3581,6 +3619,8 @@
Parameters:
+ +
Returns:
@@ -3624,8 +3664,8 @@

Submits an order based on a prepared basket. Note: If the basket has been submitted using Order Center (considered by it's client id) the channel -type will be set to \"Call Center\". In case another channel type was set by a script -before submitting the basket, the channel type will be reset to \"Call Center\" and a warning +type will be set to &quot;Call Center&quot;. In case another channel type was set by a script +before submitting the basket, the channel type will be reset to &quot;Call Center&quot; and a warning will be logged. The only considered value from the request body is basket_id.

@@ -3742,6 +3782,8 @@

Parameters:
+ +
Returns:
@@ -3785,13 +3827,13 @@
Returns:

diff --git a/docs/module-api_PriceAdjustmentLimitsApi.html b/docs/module-api_PriceAdjustmentLimitsApi.html index a42b759..da5546d 100644 --- a/docs/module-api_PriceAdjustmentLimitsApi.html +++ b/docs/module-api_PriceAdjustmentLimitsApi.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -274,6 +276,8 @@

Returns:

@@ -384,6 +388,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-api_ProductListsApi.html b/docs/module-api_ProductListsApi.html index 4f4297f..2af39a2 100644 --- a/docs/module-api_ProductListsApi.html +++ b/docs/module-api_ProductListsApi.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -416,6 +418,8 @@
Properties
+ +
Returns:
@@ -645,6 +649,8 @@
Properties
+ +
Returns:
@@ -874,6 +880,8 @@
Properties
+ +
Returns:
@@ -1126,6 +1134,8 @@
Properties
+ +
Returns:
@@ -1378,6 +1388,8 @@
Properties
+ +
Returns:
@@ -1607,6 +1619,8 @@
Properties
+ +
Returns:
@@ -1836,6 +1850,8 @@
Properties
+ +
Returns:
@@ -2088,6 +2104,8 @@
Properties
+ +
Returns:
@@ -2131,13 +2149,13 @@
Returns:

diff --git a/docs/module-api_ProductSearchApi.html b/docs/module-api_ProductSearchApi.html index bfdd94b..594170c 100644 --- a/docs/module-api_ProductSearchApi.html +++ b/docs/module-api_ProductSearchApi.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -326,11 +328,11 @@
Properties

Parameter that represents a refinement attribute/value(s) pair. Refinement attribute id and -value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and +value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and can be provided by separating them using a pipe (URL -encoded = \"|\"). Value ranges can be specified like this: refine=price=(100..500) Multiple refine +encoded = &quot;|&quot;). Value ranges can be specified like this: refine=price=(100..500) Multiple refine parameters can be provided by adding an underscore in combination with an integer counter right behind -the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The +the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The following system refinement attribute ids are supported: cgid: Allows to refine per single category id. Multiple category ids are not supported. price: Allows to refine per single price range. Multiple price ranges are not supported. @@ -546,6 +548,8 @@

Properties
+ +
Returns:
@@ -706,11 +710,11 @@
Properties

Parameter that represents a refinement attribute/value(s) pair. Refinement attribute id and -value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and +value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and can be provided by separating them using a pipe (URL -encoded = \"|\"). Value ranges can be specified like this: refine=price=(100..500) Multiple refine +encoded = &quot;|&quot;). Value ranges can be specified like this: refine=price=(100..500) Multiple refine parameters can be provided by adding an underscore in combination with an integer counter right behind -the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The +the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The following system refinement attribute ids are supported: cgid: Allows to refine per single category id. Multiple category ids are not supported. price: Allows to refine per single price range. Multiple price ranges are not supported. @@ -879,6 +883,8 @@

Properties
+ +
Returns:
@@ -1039,11 +1045,11 @@
Properties

Parameter that represents a refinement attribute/value(s) pair. Refinement attribute id and -value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and +value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and can be provided by separating them using a pipe (URL -encoded = \"|\"). Value ranges can be specified like this: refine=price=(100..500) Multiple refine +encoded = &quot;|&quot;). Value ranges can be specified like this: refine=price=(100..500) Multiple refine parameters can be provided by adding an underscore in combination with an integer counter right behind -the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The +the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The following system refinement attribute ids are supported: cgid: Allows to refine per single category id. Multiple category ids are not supported. price: Allows to refine per single price range. Multiple price ranges are not supported. @@ -1212,6 +1218,8 @@

Properties
+ +
Returns:
@@ -1372,11 +1380,11 @@
Properties

Parameter that represents a refinement attribute/value(s) pair. Refinement attribute id and -value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and +value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and can be provided by separating them using a pipe (URL -encoded = \"|\"). Value ranges can be specified like this: refine=price=(100..500) Multiple refine +encoded = &quot;|&quot;). Value ranges can be specified like this: refine=price=(100..500) Multiple refine parameters can be provided by adding an underscore in combination with an integer counter right behind -the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The +the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The following system refinement attribute ids are supported: cgid: Allows to refine per single category id. Multiple category ids are not supported. price: Allows to refine per single price range. Multiple price ranges are not supported. @@ -1545,6 +1553,8 @@

Properties
+ +
Returns:
@@ -1705,11 +1715,11 @@
Properties

Parameter that represents a refinement attribute/value(s) pair. Refinement attribute id and -value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and +value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and can be provided by separating them using a pipe (URL -encoded = \"|\"). Value ranges can be specified like this: refine=price=(100..500) Multiple refine +encoded = &quot;|&quot;). Value ranges can be specified like this: refine=price=(100..500) Multiple refine parameters can be provided by adding an underscore in combination with an integer counter right behind -the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The +the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The following system refinement attribute ids are supported: cgid: Allows to refine per single category id. Multiple category ids are not supported. price: Allows to refine per single price range. Multiple price ranges are not supported. @@ -1878,6 +1888,8 @@

Properties
+ +
Returns:
@@ -2037,11 +2049,11 @@
Properties

Parameter that represents a refinement attribute/value(s) pair. Refinement attribute id and -value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and +value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and can be provided by separating them using a pipe (URL -encoded = \"|\"). Value ranges can be specified like this: refine=price=(100..500) Multiple refine +encoded = &quot;|&quot;). Value ranges can be specified like this: refine=price=(100..500) Multiple refine parameters can be provided by adding an underscore in combination with an integer counter right behind -the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The +the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The following system refinement attribute ids are supported: cgid: Allows to refine per single category id. Multiple category ids are not supported. price: Allows to refine per single price range. Multiple price ranges are not supported. @@ -2233,6 +2245,8 @@

Properties
+ +
Returns:
@@ -2393,11 +2407,11 @@
Properties

Parameter that represents a refinement attribute/value(s) pair. Refinement attribute id and -value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and +value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and can be provided by separating them using a pipe (URL -encoded = \"|\"). Value ranges can be specified like this: refine=price=(100..500) Multiple refine +encoded = &quot;|&quot;). Value ranges can be specified like this: refine=price=(100..500) Multiple refine parameters can be provided by adding an underscore in combination with an integer counter right behind -the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The +the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The following system refinement attribute ids are supported: cgid: Allows to refine per single category id. Multiple category ids are not supported. price: Allows to refine per single price range. Multiple price ranges are not supported. @@ -2589,6 +2603,8 @@

Properties
+ +
Returns:
@@ -2748,11 +2764,11 @@
Properties

Parameter that represents a refinement attribute/value(s) pair. Refinement attribute id and -value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and +value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and can be provided by separating them using a pipe (URL -encoded = \"|\"). Value ranges can be specified like this: refine=price=(100..500) Multiple refine +encoded = &quot;|&quot;). Value ranges can be specified like this: refine=price=(100..500) Multiple refine parameters can be provided by adding an underscore in combination with an integer counter right behind -the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The +the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The following system refinement attribute ids are supported: cgid: Allows to refine per single category id. Multiple category ids are not supported. price: Allows to refine per single price range. Multiple price ranges are not supported. @@ -2921,6 +2937,8 @@

Properties
+ +
Returns:
@@ -3080,11 +3098,11 @@
Properties

Parameter that represents a refinement attribute/value(s) pair. Refinement attribute id and -value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and +value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and can be provided by separating them using a pipe (URL -encoded = \"|\"). Value ranges can be specified like this: refine=price=(100..500) Multiple refine +encoded = &quot;|&quot;). Value ranges can be specified like this: refine=price=(100..500) Multiple refine parameters can be provided by adding an underscore in combination with an integer counter right behind -the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The +the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The following system refinement attribute ids are supported: cgid: Allows to refine per single category id. Multiple category ids are not supported. price: Allows to refine per single price range. Multiple price ranges are not supported. @@ -3253,6 +3271,8 @@

Properties
+ +
Returns:
@@ -3414,11 +3434,11 @@
Properties

Parameter that represents a refinement attribute/value(s) pair. Refinement attribute id and -value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and +value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and can be provided by separating them using a pipe (URL -encoded = \"|\"). Value ranges can be specified like this: refine=price=(100..500) Multiple refine +encoded = &quot;|&quot;). Value ranges can be specified like this: refine=price=(100..500) Multiple refine parameters can be provided by adding an underscore in combination with an integer counter right behind -the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The +the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The following system refinement attribute ids are supported: cgid: Allows to refine per single category id. Multiple category ids are not supported. price: Allows to refine per single price range. Multiple price ranges are not supported. @@ -3632,6 +3652,8 @@

Properties
+ +
Returns:
@@ -3675,13 +3697,13 @@
Returns:

diff --git a/docs/module-api_ProductsApi.html b/docs/module-api_ProductsApi.html index 4c772ec..173ce7c 100644 --- a/docs/module-api_ProductsApi.html +++ b/docs/module-api_ProductsApi.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -489,6 +491,8 @@
Properties
+ +
Returns:
@@ -741,6 +745,8 @@
Properties
+ +
Returns:
@@ -993,6 +999,8 @@
Properties
+ +
Returns:
@@ -1222,6 +1230,8 @@
Properties
+ +
Returns:
@@ -1451,6 +1461,8 @@
Properties
+ +
Returns:
@@ -1749,6 +1761,8 @@
Properties
+ +
Returns:
@@ -2047,6 +2061,8 @@
Properties
+ +
Returns:
@@ -2322,6 +2338,8 @@
Properties
+ +
Returns:
@@ -2597,6 +2615,8 @@
Properties
+ +
Returns:
@@ -2826,6 +2846,8 @@
Properties
+ +
Returns:
@@ -3055,6 +3077,8 @@
Properties
+ +
Returns:
@@ -3284,6 +3308,8 @@
Properties
+ +
Returns:
@@ -3513,6 +3539,8 @@
Properties
+ +
Returns:
@@ -3765,6 +3793,8 @@
Properties
+ +
Returns:
@@ -4017,6 +4047,8 @@
Properties
+ +
Returns:
@@ -4334,6 +4366,8 @@
Properties
+ +
Returns:
@@ -4491,6 +4525,8 @@
Parameters:
+ +
Returns:
@@ -4648,6 +4684,8 @@
Parameters:
+ +
Returns:
@@ -4965,6 +5003,8 @@
Properties
+ +
Returns:
@@ -5194,6 +5234,8 @@
Properties
+ +
Returns:
@@ -5423,6 +5465,8 @@
Properties
+ +
Returns:
@@ -5748,6 +5792,8 @@
Properties
+ +
Returns:
@@ -5791,13 +5837,13 @@
Returns:

diff --git a/docs/module-api_PromotionsApi.html b/docs/module-api_PromotionsApi.html index f2bb98d..b29724e 100644 --- a/docs/module-api_PromotionsApi.html +++ b/docs/module-api_PromotionsApi.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -444,6 +446,8 @@
Properties
+ +
Returns:
@@ -674,6 +678,8 @@
Properties
+ +
Returns:
@@ -899,6 +905,8 @@
Properties
+ +
Returns:
@@ -1124,6 +1132,8 @@
Properties
+ +
Returns:
@@ -1354,6 +1364,8 @@
Properties
+ +
Returns:
@@ -1634,6 +1646,8 @@
Properties
+ +
Returns:
@@ -1677,13 +1691,13 @@
Returns:

diff --git a/docs/module-api_SearchSuggestionApi.html b/docs/module-api_SearchSuggestionApi.html index c03a728..da79ad1 100644 --- a/docs/module-api_SearchSuggestionApi.html +++ b/docs/module-api_SearchSuggestionApi.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -441,6 +443,8 @@
Properties
+ +
Returns:
@@ -718,6 +722,8 @@
Properties
+ +
Returns:
@@ -761,13 +767,13 @@
Returns:

diff --git a/docs/module-api_SessionsApi.html b/docs/module-api_SessionsApi.html index e0749cc..447d988 100644 --- a/docs/module-api_SessionsApi.html +++ b/docs/module-api_SessionsApi.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -279,6 +281,8 @@

postSessi + +

Returns:
@@ -394,6 +398,8 @@

Returns:

@@ -437,13 +443,13 @@
Returns:

diff --git a/docs/module-api_SiteApi.html b/docs/module-api_SiteApi.html index 3a94a70..4088a54 100644 --- a/docs/module-api_SiteApi.html +++ b/docs/module-api_SiteApi.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -272,6 +274,8 @@

getSiteReturns:

@@ -380,6 +384,8 @@

ge + +

Returns:
@@ -423,13 +429,13 @@
Returns:

diff --git a/docs/module-api_StoresApi.html b/docs/module-api_StoresApi.html index 18eb424..ad874ac 100644 --- a/docs/module-api_StoresApi.html +++ b/docs/module-api_StoresApi.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -208,7 +210,7 @@

getStoresThis resource retrieves a list of stores, for the given site, that are within a configured distance of a location on the earth. The stores and their distance from the specified location are returned as a result set of Store objects. The distance is interpreted either in miles or -kilometers depending on the \"distance_unit\" input parameter. The location can +kilometers depending on the &quot;distance_unit&quot; input parameter. The location can be specified by either directly providing a latitude/longitude coordinate pair or by providing a country and a postal code: If a postal code is passed, the resource looks in the system's geolocation mappings to find the coordinates for this postal code. If no @@ -355,7 +357,7 @@
Properties
-

The two letter ISO country code e.g. \"US\".

+

The two letter ISO country code e.g. &quot;US&quot;.

@@ -378,7 +380,7 @@
Properties
-

The postal code e.g. \"01801\".

+

The postal code e.g. &quot;01801&quot;.

@@ -401,8 +403,8 @@
Properties
-

The distance unit. Supported values are \"mi\" and \"km\" -(for miles and kilometers respectively, default is \"km\").

+

The distance unit. Supported values are &quot;mi&quot; and &quot;km&quot; +(for miles and kilometers respectively, default is &quot;km&quot;).

@@ -543,6 +545,8 @@
Properties
+ +
Returns:
@@ -700,6 +704,8 @@
Parameters:
+ +
Returns:
@@ -853,6 +859,8 @@
Parameters:
+ +
Returns:
@@ -1006,6 +1014,8 @@
Parameters:
+ +
Returns:
@@ -1163,6 +1173,8 @@
Parameters:
+ +
Returns:
@@ -1207,7 +1219,7 @@

This resource retrieves a list of stores, for the given site, that are within a configured distance of a location on the earth. The stores and their distance from the specified location are returned as a result set of Store objects. The distance is interpreted either in miles or kilometers depending -on the \"distance_unit\" input parameter. The location can be specified by either directly +on the &quot;distance_unit&quot; input parameter. The location can be specified by either directly providing a latitude/longitude coordinate pair or by providing a country and a postal code: If a postal code is passed, the resource looks in the system's geolocation mappings to find the coordinates for this postal code. If no matching geolocation is found, the resource will @@ -1354,7 +1366,7 @@

Properties
-

The two letter ISO country code e.g. \"US\".

+

The two letter ISO country code e.g. &quot;US&quot;.

@@ -1377,7 +1389,7 @@
Properties
-

The postal code e.g. \"01801\".

+

The postal code e.g. &quot;01801&quot;.

@@ -1400,8 +1412,8 @@
Properties
-

The distance unit. Supported values are \"mi\" and \"km\" -(for miles and kilometers respectively, default is \"km\").

+

The distance unit. Supported values are &quot;mi&quot; and &quot;km&quot; +(for miles and kilometers respectively, default is &quot;km&quot;).

@@ -1542,6 +1554,8 @@
Properties
+ +
Returns:
@@ -1585,13 +1599,13 @@
Returns:

diff --git a/docs/module-index.html b/docs/module-index.html index 08ed1b8..3fc016f 100644 --- a/docs/module-index.html +++ b/docs/module-index.html @@ -43,7 +43,7 @@

Module: index

An AMD (recommended!) or CommonJS application will generally do something equivalent to the following: 

-var ShopApi = require('index') // See note below.
+var ShopApi = require('index') // See note below*.
 var xxxSvc = new ShopApi.XxxApi(); // Allocate the API class we're going to use.
 var yyyModel = new ShopApi.Yyy(); // Construct a model instance.
 yyyModel.someProperty = 'someValue'
@@ -51,7 +51,7 @@ 
Module: index

 var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.
 ...
-NOTE: For a top-level AMD script, use require(['index'], function(){...}) +*NOTE: For a top-level AMD script, use require(['index'], function(){...}) and put the application logic within the callback function.

@@ -144,6 +144,8 @@

Module: index

+ + @@ -16571,13 +16573,13 @@
Properties:

diff --git a/docs/module-models_AuthRequest.html b/docs/module-models_AuthRequest.html index 27b4353..a70e6f6 100644 --- a/docs/module-models_AuthRequest.html +++ b/docs/module-models_AuthRequest.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -421,6 +423,8 @@
Parameters:
+ +
Returns:
@@ -464,13 +468,13 @@
Returns:

diff --git a/docs/module-models_Basket.html b/docs/module-models_Basket.html index 62730b1..5944c94 100644 --- a/docs/module-models_Basket.html +++ b/docs/module-models_Basket.html @@ -122,6 +122,8 @@

n + + @@ -2390,6 +2392,8 @@

Parameters:
+ +
Returns:
@@ -2433,13 +2437,13 @@
Returns:

diff --git a/docs/module-models_BasketPaymentInstrumentRequest.html b/docs/module-models_BasketPaymentInstrumentRequest.html index 94bce0f..e3357cb 100644 --- a/docs/module-models_BasketPaymentInstrumentRequest.html +++ b/docs/module-models_BasketPaymentInstrumentRequest.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_BasketsResult.html b/docs/module-models_BasketsResult.html index 560f3da..fa5a893 100644 --- a/docs/module-models_BasketsResult.html +++ b/docs/module-models_BasketsResult.html @@ -122,6 +122,8 @@

< + + @@ -444,6 +446,8 @@
Parameters:
+ +
Returns:
@@ -487,13 +491,13 @@
Returns:

diff --git a/docs/module-models_BonusDiscountLineItem.html b/docs/module-models_BonusDiscountLineItem.html index c170344..02e1d3c 100644 --- a/docs/module-models_BonusDiscountLineItem.html +++ b/docs/module-models_BonusDiscountLineItem.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_BoolFilter.html b/docs/module-models_BoolFilter.html index 1af27fc..dd9bfb5 100644 --- a/docs/module-models_BoolFilter.html +++ b/docs/module-models_BoolFilter.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -493,6 +495,8 @@
Parameters:
+ +
Returns:
@@ -536,13 +540,13 @@
Returns:

diff --git a/docs/module-models_BoolQuery.html b/docs/module-models_BoolQuery.html index a277eeb..e75b44f 100644 --- a/docs/module-models_BoolQuery.html +++ b/docs/module-models_BoolQuery.html @@ -125,6 +125,8 @@

@@ -519,6 +521,8 @@
Parameters:
+ +
Returns:
@@ -562,13 +566,13 @@
Returns:

diff --git a/docs/module-models_BundledProduct.html b/docs/module-models_BundledProduct.html index 2c6903d..24634c4 100644 --- a/docs/module-models_BundledProduct.html +++ b/docs/module-models_BundledProduct.html @@ -122,6 +122,8 @@

+ + @@ -512,6 +514,8 @@
Parameters:
+ +
Returns:
@@ -555,13 +559,13 @@
Returns:

diff --git a/docs/module-models_Category.html b/docs/module-models_Category.html index c109c18..dc3fe06 100644 --- a/docs/module-models_Category.html +++ b/docs/module-models_Category.html @@ -122,6 +122,8 @@

@@ -1020,6 +1022,8 @@

Parameters:
+ +
Returns:
@@ -1063,13 +1067,13 @@
Returns:

diff --git a/docs/module-models_CategoryResult.html b/docs/module-models_CategoryResult.html index cbabb93..e367940 100644 --- a/docs/module-models_CategoryResult.html +++ b/docs/module-models_CategoryResult.html @@ -122,6 +122,8 @@

+ + @@ -516,6 +518,8 @@
Parameters:
+ +
Returns:
@@ -559,13 +563,13 @@
Returns:

diff --git a/docs/module-models_Content.html b/docs/module-models_Content.html index 6433f7b..312ac4d 100644 --- a/docs/module-models_Content.html +++ b/docs/module-models_Content.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -781,6 +783,8 @@
Parameters:
+ +
Returns:
@@ -824,13 +828,13 @@
Returns:

diff --git a/docs/module-models_ContentFolder.html b/docs/module-models_ContentFolder.html index 437489c..c4048ca 100644 --- a/docs/module-models_ContentFolder.html +++ b/docs/module-models_ContentFolder.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -925,6 +927,8 @@
Parameters:
+ +
Returns:
@@ -968,13 +972,13 @@
Returns:

diff --git a/docs/module-models_ContentFolderResult.html b/docs/module-models_ContentFolderResult.html index 75cbb04..2cd6eac 100644 --- a/docs/module-models_ContentFolderResult.html +++ b/docs/module-models_ContentFolderResult.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_ContentResult.html b/docs/module-models_ContentResult.html index b3083bb..9cce77c 100644 --- a/docs/module-models_ContentResult.html +++ b/docs/module-models_ContentResult.html @@ -122,6 +122,8 @@

< + + @@ -516,6 +518,8 @@
Parameters:
+ +
Returns:
@@ -559,13 +563,13 @@
Returns:

diff --git a/docs/module-models_ContentSearchRefinement.html b/docs/module-models_ContentSearchRefinement.html index 0a3961e..b47e0cb 100644 --- a/docs/module-models_ContentSearchRefinement.html +++ b/docs/module-models_ContentSearchRefinement.html @@ -102,7 +102,7 @@
Parameters:
-

The id of the search refinement attribute. In the case of an attribute refinement, this is the attribute id. Custom attributes are marked by the prefix \"c_\".

+

The id of the search refinement attribute. In the case of an attribute refinement, this is the attribute id. Custom attributes are marked by the prefix "c_".

@@ -171,6 +171,8 @@
Parameters:
+ + @@ -197,7 +199,7 @@

(inner)
-

The id of the search refinement attribute. In the case of an attribute refinement, this is the attribute id. Custom attributes are marked by the prefix \"c_\".

+

The id of the search refinement attribute. In the case of an attribute refinement, this is the attribute id. Custom attributes are marked by the prefix "c_".

@@ -565,6 +567,8 @@

Parameters:
+ +
Returns:
@@ -608,13 +612,13 @@
Returns:

diff --git a/docs/module-models_ContentSearchRefinementValue.html b/docs/module-models_ContentSearchRefinementValue.html index f2a8f1a..13c3d9e 100644 --- a/docs/module-models_ContentSearchRefinementValue.html +++ b/docs/module-models_ContentSearchRefinementValue.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_ContentSearchResult.html b/docs/module-models_ContentSearchResult.html index 0c93fae..22dbf20 100644 --- a/docs/module-models_ContentSearchResult.html +++ b/docs/module-models_ContentSearchResult.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_CouponItem.html b/docs/module-models_CouponItem.html index 88a3260..ba9f030 100644 --- a/docs/module-models_CouponItem.html +++ b/docs/module-models_CouponItem.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -637,6 +639,8 @@
Parameters:
+ +
Returns:
@@ -680,13 +684,13 @@
Returns:

diff --git a/docs/module-models_CustomObject.html b/docs/module-models_CustomObject.html index 5f619c9..1538c22 100644 --- a/docs/module-models_CustomObject.html +++ b/docs/module-models_CustomObject.html @@ -122,6 +122,8 @@

@@ -588,6 +590,8 @@
Parameters:
+ +
Returns:
@@ -631,13 +635,13 @@
Returns:

diff --git a/docs/module-models_Customer.html b/docs/module-models_Customer.html index a751451..628f369 100644 --- a/docs/module-models_Customer.html +++ b/docs/module-models_Customer.html @@ -122,6 +122,8 @@

@@ -2164,7 +2166,7 @@

(inner) suffix
-

The customer's suffix (for example, \"Jr.\" or \"Sr.\").

+

The customer's suffix (for example, "Jr." or "Sr.").

@@ -2236,7 +2238,7 @@

(inner) title -

The customer's title (for example, \"Mrs\" or \"Mr\").

+

The customer's title (for example, "Mrs" or "Mr").

@@ -2460,6 +2462,8 @@
Parameters:
+ +
Returns:
@@ -2503,13 +2507,13 @@
Returns:

diff --git a/docs/module-models_CustomerAddress.html b/docs/module-models_CustomerAddress.html index adda2c8..dd22363 100644 --- a/docs/module-models_CustomerAddress.html +++ b/docs/module-models_CustomerAddress.html @@ -122,6 +122,8 @@

@@ -1884,6 +1886,8 @@
Parameters:
+ +
Returns:
@@ -1927,13 +1931,13 @@
Returns:

diff --git a/docs/module-models_CustomerAddressLink.html b/docs/module-models_CustomerAddressLink.html index fe19b34..37e1165 100644 --- a/docs/module-models_CustomerAddressLink.html +++ b/docs/module-models_CustomerAddressLink.html @@ -124,6 +124,8 @@

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_CustomerAddressResult.html b/docs/module-models_CustomerAddressResult.html index 751b5a4..df62146 100644 --- a/docs/module-models_CustomerAddressResult.html +++ b/docs/module-models_CustomerAddressResult.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_CustomerInfo.html b/docs/module-models_CustomerInfo.html index ec9d97a..202593e 100644 --- a/docs/module-models_CustomerInfo.html +++ b/docs/module-models_CustomerInfo.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -633,6 +635,8 @@
Parameters:
+ +
Returns:
@@ -676,13 +680,13 @@
Returns:

diff --git a/docs/module-models_CustomerOrderResult.html b/docs/module-models_CustomerOrderResult.html index 8027d21..07ee5e4 100644 --- a/docs/module-models_CustomerOrderResult.html +++ b/docs/module-models_CustomerOrderResult.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_CustomerPaymentCardRequest.html b/docs/module-models_CustomerPaymentCardRequest.html index 0fa40b0..10989fe 100644 --- a/docs/module-models_CustomerPaymentCardRequest.html +++ b/docs/module-models_CustomerPaymentCardRequest.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_CustomerPaymentInstrument.html b/docs/module-models_CustomerPaymentInstrument.html index d30a760..9b2d5fe 100644 --- a/docs/module-models_CustomerPaymentInstrument.html +++ b/docs/module-models_CustomerPaymentInstrument.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_CustomerPaymentInstrumentRequest.html b/docs/module-models_CustomerPaymentInstrumentRequest.html index f1c1faa..c6a7677 100644 --- a/docs/module-models_CustomerPaymentInstrumentRequest.html +++ b/docs/module-models_CustomerPaymentInstrumentRequest.html @@ -122,6 +122,8 @@

@@ -660,6 +662,8 @@
Parameters:
+ +
Returns:
@@ -703,13 +707,13 @@
Returns:

diff --git a/docs/module-models_CustomerPaymentInstrumentResult.html b/docs/module-models_CustomerPaymentInstrumentResult.html index 939abad..aba823b 100644 --- a/docs/module-models_CustomerPaymentInstrumentResult.html +++ b/docs/module-models_CustomerPaymentInstrumentResult.html @@ -122,6 +122,8 @@

@@ -516,6 +518,8 @@
Parameters:
+ +
Returns:
@@ -559,13 +563,13 @@
Returns:

diff --git a/docs/module-models_CustomerProductList.html b/docs/module-models_CustomerProductList.html index fadaf2c..4a7dd53 100644 --- a/docs/module-models_CustomerProductList.html +++ b/docs/module-models_CustomerProductList.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_CustomerProductListItem.html b/docs/module-models_CustomerProductListItem.html index 06eb0f8..482ed63 100644 --- a/docs/module-models_CustomerProductListItem.html +++ b/docs/module-models_CustomerProductListItem.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_CustomerProductListItemLink.html b/docs/module-models_CustomerProductListItemLink.html index fd0acfb..320d97b 100644 --- a/docs/module-models_CustomerProductListItemLink.html +++ b/docs/module-models_CustomerProductListItemLink.html @@ -122,6 +122,8 @@

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_CustomerProductListItemResult.html b/docs/module-models_CustomerProductListItemResult.html index 5d3e31c..bd78a91 100644 --- a/docs/module-models_CustomerProductListItemResult.html +++ b/docs/module-models_CustomerProductListItemResult.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_CustomerProductListRegistrant.html b/docs/module-models_CustomerProductListRegistrant.html index e31e895..a9dead0 100644 --- a/docs/module-models_CustomerProductListRegistrant.html +++ b/docs/module-models_CustomerProductListRegistrant.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_CustomerProductListResult.html b/docs/module-models_CustomerProductListResult.html index a3ae065..929602a 100644 --- a/docs/module-models_CustomerProductListResult.html +++ b/docs/module-models_CustomerProductListResult.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_CustomerRegistration.html b/docs/module-models_CustomerRegistration.html index 993c177..3d5a076 100644 --- a/docs/module-models_CustomerRegistration.html +++ b/docs/module-models_CustomerRegistration.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -493,6 +495,8 @@
Parameters:
+ +
Returns:
@@ -536,13 +540,13 @@
Returns:

diff --git a/docs/module-models_Discount.html b/docs/module-models_Discount.html index 9e46e09..9d75a69 100644 --- a/docs/module-models_Discount.html +++ b/docs/module-models_Discount.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -637,6 +639,8 @@
Parameters:
+ +
Returns:
@@ -680,13 +684,13 @@
Returns:

diff --git a/docs/module-models_Fault.html b/docs/module-models_Fault.html index 4258a3e..a8dc552 100644 --- a/docs/module-models_Fault.html +++ b/docs/module-models_Fault.html @@ -122,6 +122,8 @@

ne + + @@ -142,6 +144,78 @@

Members

+

(inner) arguments :Object

+ + + + +
+

These are optional arguments returned with fault

+
+ + + +
Type:
+
    +
  • + +Object + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +

(inner) message :String

@@ -421,7 +495,7 @@
Parameters:
Source:
@@ -444,6 +518,8 @@
Parameters:
+ +
Returns:
@@ -487,13 +563,13 @@
Returns:

diff --git a/docs/module-models_Filter.html b/docs/module-models_Filter.html index 1d6ab00..a307635 100644 --- a/docs/module-models_Filter.html +++ b/docs/module-models_Filter.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -421,6 +423,8 @@
Parameters:
+ +
Returns:
@@ -464,13 +468,13 @@
Returns:

diff --git a/docs/module-models_FilteredQuery.html b/docs/module-models_FilteredQuery.html index b03a4d1..7517415 100644 --- a/docs/module-models_FilteredQuery.html +++ b/docs/module-models_FilteredQuery.html @@ -194,6 +194,8 @@
Parameters:
+ + @@ -516,6 +518,8 @@
Parameters:
+ +
Returns:
@@ -559,13 +563,13 @@
Returns:

diff --git a/docs/module-models_GiftCertificate.html b/docs/module-models_GiftCertificate.html index b0128a9..400cad7 100644 --- a/docs/module-models_GiftCertificate.html +++ b/docs/module-models_GiftCertificate.html @@ -122,6 +122,8 @@

@@ -1092,6 +1094,8 @@
Parameters:
+ +
Returns:
@@ -1135,13 +1139,13 @@
Returns:

diff --git a/docs/module-models_GiftCertificateItem.html b/docs/module-models_GiftCertificateItem.html index c1787fc..f39561a 100644 --- a/docs/module-models_GiftCertificateItem.html +++ b/docs/module-models_GiftCertificateItem.html @@ -194,6 +194,8 @@
Parameters:
+ + @@ -876,6 +878,8 @@
Parameters:
+ +
Returns:
@@ -919,13 +923,13 @@
Returns:

diff --git a/docs/module-models_GiftCertificateRequest.html b/docs/module-models_GiftCertificateRequest.html index 6f01bd1..6afd38f 100644 --- a/docs/module-models_GiftCertificateRequest.html +++ b/docs/module-models_GiftCertificateRequest.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_Image.html b/docs/module-models_Image.html index 788f7e7..c857f9f 100644 --- a/docs/module-models_Image.html +++ b/docs/module-models_Image.html @@ -170,6 +170,8 @@
Parameters:
+ + @@ -620,6 +622,8 @@
Parameters:
+ +
Returns:
@@ -663,13 +667,13 @@
Returns:

diff --git a/docs/module-models_ImageGroup.html b/docs/module-models_ImageGroup.html index 02197b1..ddc6dd9 100644 --- a/docs/module-models_ImageGroup.html +++ b/docs/module-models_ImageGroup.html @@ -122,6 +122,8 @@

@@ -516,6 +518,8 @@
Parameters:
+ +
Returns:
@@ -559,13 +563,13 @@
Returns:

diff --git a/docs/module-models_Inventory.html b/docs/module-models_Inventory.html index a49fda8..3587415 100644 --- a/docs/module-models_Inventory.html +++ b/docs/module-models_Inventory.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -853,6 +855,8 @@
Parameters:
+ +
Returns:
@@ -896,13 +900,13 @@
Returns:

diff --git a/docs/module-models_Locale.html b/docs/module-models_Locale.html index 590b0c4..5919e82 100644 --- a/docs/module-models_Locale.html +++ b/docs/module-models_Locale.html @@ -122,6 +122,8 @@

n + + @@ -515,7 +517,7 @@

(inner) id

The identifier of the Locale. Contains a combination of the language and the country key, -concatenated by \"-\", e.g. \"en-US\". This attribute is the primary key of the class.

+concatenated by "-", e.g. "en-US". This attribute is the primary key of the class.

@@ -1029,6 +1031,8 @@
Parameters:
+ +
Returns:
@@ -1072,13 +1076,13 @@
Returns:

diff --git a/docs/module-models_Master.html b/docs/module-models_Master.html index 11b91f8..1bd6669 100644 --- a/docs/module-models_Master.html +++ b/docs/module-models_Master.html @@ -193,6 +193,8 @@
Parameters:
+ + @@ -779,6 +781,8 @@
Parameters:
+ +
Returns:
@@ -822,13 +826,13 @@
Returns:

diff --git a/docs/module-models_NestedQuery.html b/docs/module-models_NestedQuery.html index a05853f..b02c42b 100644 --- a/docs/module-models_NestedQuery.html +++ b/docs/module-models_NestedQuery.html @@ -52,7 +52,7 @@

Constructs a new NestedQuery. Nested query allows to query upon nested documents that are part of a larger document. The classical example is a product master with variants (in one big document) where you want to constraint a search -to masters that have variants that match multiple constraints (like color = blue AND size = M).

+to masters that have variants that match multiple constraints (like color = blue AND size = M).

@@ -196,6 +196,8 @@

Parameters:
+ + @@ -578,6 +580,8 @@

Parameters:
+ +

Returns:
@@ -621,13 +625,13 @@

Returns:

diff --git a/docs/module-models_Note.html b/docs/module-models_Note.html index 5b32243..f2c1bd7 100644 --- a/docs/module-models_Note.html +++ b/docs/module-models_Note.html @@ -122,6 +122,8 @@

new + + @@ -660,6 +662,8 @@

Parameters:
+ +

Returns:
@@ -703,13 +707,13 @@

Returns:

diff --git a/docs/module-models_NotesResult.html b/docs/module-models_NotesResult.html index 7ba590e..31f7648 100644 --- a/docs/module-models_NotesResult.html +++ b/docs/module-models_NotesResult.html @@ -122,6 +122,8 @@

@@ -372,6 +374,8 @@
Parameters:
+ +
Returns:
@@ -415,13 +419,13 @@
Returns:

diff --git a/docs/module-models_Option.html b/docs/module-models_Option.html index c4ae6f0..cfa4a81 100644 --- a/docs/module-models_Option.html +++ b/docs/module-models_Option.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -709,6 +711,8 @@
Parameters:
+ +
Returns:
@@ -752,13 +756,13 @@
Returns:

diff --git a/docs/module-models_OptionItem.html b/docs/module-models_OptionItem.html index 3f2f46e..a6069e8 100644 --- a/docs/module-models_OptionItem.html +++ b/docs/module-models_OptionItem.html @@ -194,6 +194,8 @@
Parameters:
+ + @@ -2322,6 +2324,8 @@
Parameters:
+ +
Returns:
@@ -2365,13 +2369,13 @@
Returns:

diff --git a/docs/module-models_OptionValue.html b/docs/module-models_OptionValue.html index 02fa063..cf399c4 100644 --- a/docs/module-models_OptionValue.html +++ b/docs/module-models_OptionValue.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -637,6 +639,8 @@
Parameters:
+ +
Returns:
@@ -680,13 +684,13 @@
Returns:

diff --git a/docs/module-models_Order.html b/docs/module-models_Order.html index 1103f0a..8f65616 100644 --- a/docs/module-models_Order.html +++ b/docs/module-models_Order.html @@ -122,6 +122,8 @@

ne + + @@ -2969,6 +2971,8 @@

Parameters:
+ +
Returns:
@@ -3012,13 +3016,13 @@
Returns:

diff --git a/docs/module-models_OrderAddress.html b/docs/module-models_OrderAddress.html index df512b8..3911a6d 100644 --- a/docs/module-models_OrderAddress.html +++ b/docs/module-models_OrderAddress.html @@ -122,6 +122,8 @@

@@ -1668,6 +1670,8 @@
Parameters:
+ +
Returns:
@@ -1711,13 +1715,13 @@
Returns:

diff --git a/docs/module-models_OrderPaymentCardRequest.html b/docs/module-models_OrderPaymentCardRequest.html index 85aee1a..bd1c0f9 100644 --- a/docs/module-models_OrderPaymentCardRequest.html +++ b/docs/module-models_OrderPaymentCardRequest.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_OrderPaymentInstrument.html b/docs/module-models_OrderPaymentInstrument.html index a4b8188..ed6bb3f 100644 --- a/docs/module-models_OrderPaymentInstrument.html +++ b/docs/module-models_OrderPaymentInstrument.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_OrderPaymentInstrumentRequest.html b/docs/module-models_OrderPaymentInstrumentRequest.html index 877bb0b..40b819a 100644 --- a/docs/module-models_OrderPaymentInstrumentRequest.html +++ b/docs/module-models_OrderPaymentInstrumentRequest.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_OrderSearchHit.html b/docs/module-models_OrderSearchHit.html index 76b5d0b..0401218 100644 --- a/docs/module-models_OrderSearchHit.html +++ b/docs/module-models_OrderSearchHit.html @@ -122,6 +122,8 @@

+ + @@ -440,6 +442,8 @@
Parameters:
+ +
Returns:
@@ -483,13 +487,13 @@
Returns:

diff --git a/docs/module-models_OrderSearchRequest.html b/docs/module-models_OrderSearchRequest.html index 2bd3d6b..516c5b8 100644 --- a/docs/module-models_OrderSearchRequest.html +++ b/docs/module-models_OrderSearchRequest.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -781,6 +783,8 @@
Parameters:
+ +
Returns:
@@ -824,13 +828,13 @@
Returns:

diff --git a/docs/module-models_OrderSearchResult.html b/docs/module-models_OrderSearchResult.html index b5d4fe7..1ccc9c9 100644 --- a/docs/module-models_OrderSearchResult.html +++ b/docs/module-models_OrderSearchResult.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_PasswordChangeRequest.html b/docs/module-models_PasswordChangeRequest.html index 1ad5fdc..3bd2da2 100644 --- a/docs/module-models_PasswordChangeRequest.html +++ b/docs/module-models_PasswordChangeRequest.html @@ -194,6 +194,8 @@
Parameters:
+ + @@ -516,6 +518,8 @@
Parameters:
+ +
Returns:
@@ -559,13 +563,13 @@
Returns:

diff --git a/docs/module-models_PasswordReset.html b/docs/module-models_PasswordReset.html index c136a88..07ceece 100644 --- a/docs/module-models_PasswordReset.html +++ b/docs/module-models_PasswordReset.html @@ -122,6 +122,8 @@

< + + @@ -444,6 +446,8 @@
Parameters:
+ +
Returns:
@@ -487,13 +491,13 @@
Returns:

diff --git a/docs/module-models_PaymentBankAccount.html b/docs/module-models_PaymentBankAccount.html index e1a0234..06734bb 100644 --- a/docs/module-models_PaymentBankAccount.html +++ b/docs/module-models_PaymentBankAccount.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_PaymentBankAccountRequest.html b/docs/module-models_PaymentBankAccountRequest.html index a4c1aa3..70f6183 100644 --- a/docs/module-models_PaymentBankAccountRequest.html +++ b/docs/module-models_PaymentBankAccountRequest.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_PaymentCard.html b/docs/module-models_PaymentCard.html index ae4a38a..b02a424 100644 --- a/docs/module-models_PaymentCard.html +++ b/docs/module-models_PaymentCard.html @@ -122,6 +122,8 @@

@@ -1092,6 +1094,8 @@
Parameters:
+ +
Returns:
@@ -1135,13 +1139,13 @@
Returns:

diff --git a/docs/module-models_PaymentCardSpec.html b/docs/module-models_PaymentCardSpec.html index 55dec3b..8e92e03 100644 --- a/docs/module-models_PaymentCardSpec.html +++ b/docs/module-models_PaymentCardSpec.html @@ -122,6 +122,8 @@

@@ -876,6 +878,8 @@
Parameters:
+ +
Returns:
@@ -919,13 +923,13 @@
Returns:

diff --git a/docs/module-models_PaymentMethod.html b/docs/module-models_PaymentMethod.html index 9f47ea2..96b8e9a 100644 --- a/docs/module-models_PaymentMethod.html +++ b/docs/module-models_PaymentMethod.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -709,6 +711,8 @@
Parameters:
+ +
Returns:
@@ -752,13 +756,13 @@
Returns:

diff --git a/docs/module-models_PaymentMethodResult.html b/docs/module-models_PaymentMethodResult.html index 1c01ce4..f32d1a4 100644 --- a/docs/module-models_PaymentMethodResult.html +++ b/docs/module-models_PaymentMethodResult.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_PriceAdjustment.html b/docs/module-models_PriceAdjustment.html index 521d250..835bce7 100644 --- a/docs/module-models_PriceAdjustment.html +++ b/docs/module-models_PriceAdjustment.html @@ -126,6 +126,8 @@

@@ -1247,6 +1249,8 @@
Parameters:
+ +
Returns:
@@ -1290,13 +1294,13 @@
Returns:

diff --git a/docs/module-models_PriceAdjustmentLimit.html b/docs/module-models_PriceAdjustmentLimit.html index c1f5317..acb8f2c 100644 --- a/docs/module-models_PriceAdjustmentLimit.html +++ b/docs/module-models_PriceAdjustmentLimit.html @@ -50,8 +50,8 @@

Constructs a new PriceAdjustmentLimit. - A price adjustment limit specifies the amount of manual adjustment that can be applied by a user at - the specified level.

+A price adjustment limit specifies the amount of manual adjustment that can be applied by a user at +the specified level.

@@ -123,6 +123,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_PriceAdjustmentLimits.html b/docs/module-models_PriceAdjustmentLimits.html index e36350a..c6614c3 100644 --- a/docs/module-models_PriceAdjustmentLimits.html +++ b/docs/module-models_PriceAdjustmentLimits.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_Product.html b/docs/module-models_Product.html index 489a377..0f785ef 100644 --- a/docs/module-models_Product.html +++ b/docs/module-models_Product.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -2937,6 +2939,8 @@
Parameters:
+ +
Returns:
@@ -2980,13 +2984,13 @@
Returns:

diff --git a/docs/module-models_ProductDetailsLink.html b/docs/module-models_ProductDetailsLink.html index 8d82b1e..16eea96 100644 --- a/docs/module-models_ProductDetailsLink.html +++ b/docs/module-models_ProductDetailsLink.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -709,6 +711,8 @@
Parameters:
+ +
Returns:
@@ -752,13 +756,13 @@
Returns:

diff --git a/docs/module-models_ProductItem.html b/docs/module-models_ProductItem.html index f27e9b9..b50f76b 100644 --- a/docs/module-models_ProductItem.html +++ b/docs/module-models_ProductItem.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -2151,6 +2153,8 @@
Parameters:
+ +
Returns:
@@ -2194,13 +2198,13 @@
Returns:

diff --git a/docs/module-models_ProductLink.html b/docs/module-models_ProductLink.html index a7de854..7a9e794 100644 --- a/docs/module-models_ProductLink.html +++ b/docs/module-models_ProductLink.html @@ -122,6 +122,8 @@

+ + + + + + + + +

(inner) represented_product :module:models/ProductRef

+ + + + +
+

The first represented product.

+
+ + + +
Type:
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

(inner) represented_products :Array.<module:models/ProductRef>

+ + + + +
+

All the represented products.

+
+ + + +
Type:
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -916,7 +1062,7 @@
Type:
Source:
@@ -1069,7 +1215,7 @@
Parameters:
Source:
@@ -1092,6 +1238,8 @@
Parameters:
+ +
Returns:
@@ -1135,13 +1283,13 @@
Returns:

diff --git a/docs/module-models_ProductSearchRefinement.html b/docs/module-models_ProductSearchRefinement.html index 7194542..79e7f1f 100644 --- a/docs/module-models_ProductSearchRefinement.html +++ b/docs/module-models_ProductSearchRefinement.html @@ -104,8 +104,8 @@
Parameters:

The id of the search refinement attribute. In the case of an attribute refinement, this is the attribute id. Custom attributes are marked by the -prefix \"c_\" (for example, \"c_refinementColor\"). In the case of a category refinement, -the id must be \"cgid\". In the case of a price refinement, the id must be \"price\".

+prefix "c_" (for example, "c_refinementColor"). In the case of a category refinement, +the id must be "cgid". In the case of a price refinement, the id must be "price".

@@ -174,6 +174,8 @@
Parameters:
+ + @@ -201,9 +203,9 @@

(inner)

The id of the search refinement attribute. In the case of an attribute refinement, this is -the attribute id. Custom attributes are marked by the prefix \"c_\" (for example, \"c_refinementColor\"). -In the case of a category refinement, the id must be \"cgid\". In the case of a price refinement, -the id must be \"price\".

+the attribute id. Custom attributes are marked by the prefix "c_" (for example, "c_refinementColor"). +In the case of a category refinement, the id must be "cgid". In the case of a price refinement, +the id must be "price".

@@ -571,6 +573,8 @@

Parameters:
+ +
Returns:
@@ -614,13 +618,13 @@
Returns:

diff --git a/docs/module-models_ProductSearchRefinementValue.html b/docs/module-models_ProductSearchRefinementValue.html index d0543b9..795dd08 100644 --- a/docs/module-models_ProductSearchRefinementValue.html +++ b/docs/module-models_ProductSearchRefinementValue.html @@ -122,6 +122,8 @@

(inner) valueThe refinement value. In the case of an attribute refinement, this is the bucket, the attribute value, or a value range. In the case of a category refinement, this is the category id. In the case of a price refinement,k this is the price range. Ranges are enclosed by parentheses and separated -by \"..\"; for example, \"(100..999)\" and \"(Aa..Fa)\" are valid ranges.

+by ".."; for example, "(100..999)" and "(Aa..Fa)" are valid ranges.

@@ -736,6 +738,8 @@
Parameters:
+ +
Returns:
@@ -779,13 +783,13 @@
Returns:

diff --git a/docs/module-models_ProductSearchResult.html b/docs/module-models_ProductSearchResult.html index 1fa055f..50b301a 100644 --- a/docs/module-models_ProductSearchResult.html +++ b/docs/module-models_ProductSearchResult.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_ProductSearchSortingOption.html b/docs/module-models_ProductSearchSortingOption.html index 274e3fc..a372325 100644 --- a/docs/module-models_ProductSearchSortingOption.html +++ b/docs/module-models_ProductSearchSortingOption.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_ProductSimpleLink.html b/docs/module-models_ProductSimpleLink.html index 8471a4a..552d689 100644 --- a/docs/module-models_ProductSimpleLink.html +++ b/docs/module-models_ProductSimpleLink.html @@ -122,6 +122,8 @@

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_ProductType.html b/docs/module-models_ProductType.html index da92e75..3c23b1b 100644 --- a/docs/module-models_ProductType.html +++ b/docs/module-models_ProductType.html @@ -122,6 +122,8 @@

@@ -804,6 +806,8 @@

Parameters:
+ +
Returns:
@@ -847,13 +851,13 @@
Returns:

diff --git a/docs/module-models_Promotion.html b/docs/module-models_Promotion.html index 6aaf2cf..8ce771d 100644 --- a/docs/module-models_Promotion.html +++ b/docs/module-models_Promotion.html @@ -122,6 +122,8 @@

@@ -948,6 +950,8 @@
Parameters:
+ +
Returns:
@@ -991,13 +995,13 @@
Returns:

diff --git a/docs/module-models_PromotionResult.html b/docs/module-models_PromotionResult.html index 32b8ac9..a80755d 100644 --- a/docs/module-models_PromotionResult.html +++ b/docs/module-models_PromotionResult.html @@ -122,6 +122,8 @@

@@ -516,6 +518,8 @@
Parameters:
+ +
Returns:
@@ -559,13 +563,13 @@
Returns:

diff --git a/docs/module-models_PublicProductList.html b/docs/module-models_PublicProductList.html index 6301e57..61861e5 100644 --- a/docs/module-models_PublicProductList.html +++ b/docs/module-models_PublicProductList.html @@ -121,6 +121,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_PublicProductListItem.html b/docs/module-models_PublicProductListItem.html index cf1b46e..c655f28 100644 --- a/docs/module-models_PublicProductListItem.html +++ b/docs/module-models_PublicProductListItem.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_PublicProductListItemResult.html b/docs/module-models_PublicProductListItemResult.html index 96e9d5a..9dcb809 100644 --- a/docs/module-models_PublicProductListItemResult.html +++ b/docs/module-models_PublicProductListItemResult.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_PublicProductListLink.html b/docs/module-models_PublicProductListLink.html index 96bdb7d..3656f0f 100644 --- a/docs/module-models_PublicProductListLink.html +++ b/docs/module-models_PublicProductListLink.html @@ -122,6 +122,8 @@

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_PublicProductListResult.html b/docs/module-models_PublicProductListResult.html index 2610e8d..47bed98 100644 --- a/docs/module-models_PublicProductListResult.html +++ b/docs/module-models_PublicProductListResult.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_Query.html b/docs/module-models_Query.html index 9b5992c..0776e19 100644 --- a/docs/module-models_Query.html +++ b/docs/module-models_Query.html @@ -125,6 +125,8 @@

ne + + @@ -519,6 +521,8 @@

Parameters:
+ +
Returns:
@@ -562,13 +566,13 @@
Returns:

diff --git a/docs/module-models_QueryFilter.html b/docs/module-models_QueryFilter.html index f7a232e..e37b4c3 100644 --- a/docs/module-models_QueryFilter.html +++ b/docs/module-models_QueryFilter.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -421,6 +423,8 @@
Parameters:
+ +
Returns:
@@ -464,13 +468,13 @@
Returns:

diff --git a/docs/module-models_Range2Filter.html b/docs/module-models_Range2Filter.html index d3109e2..7ab3806 100644 --- a/docs/module-models_Range2Filter.html +++ b/docs/module-models_Range2Filter.html @@ -194,6 +194,8 @@
Parameters:
+ + @@ -220,7 +222,7 @@

(inner) f
-

compare mode: overlap, containing, contained (default to \"overlap\"). It is optional.

+

compare mode: overlap, containing, contained (default to "overlap"). It is optional.

@@ -876,6 +878,8 @@

Parameters:
+ +
Returns:
@@ -919,13 +923,13 @@
Returns:

diff --git a/docs/module-models_RangeFilter.html b/docs/module-models_RangeFilter.html index 318180d..4dc1764 100644 --- a/docs/module-models_RangeFilter.html +++ b/docs/module-models_RangeFilter.html @@ -171,6 +171,8 @@
Parameters:
+ + @@ -709,6 +711,8 @@
Parameters:
+ +
Returns:
@@ -752,13 +756,13 @@
Returns:

diff --git a/docs/module-models_Recommendation.html b/docs/module-models_Recommendation.html index d6674a5..2382c46 100644 --- a/docs/module-models_Recommendation.html +++ b/docs/module-models_Recommendation.html @@ -122,6 +122,8 @@

+ + @@ -876,6 +878,8 @@
Parameters:
+ +
Returns:
@@ -919,13 +923,13 @@
Returns:

diff --git a/docs/module-models_RecommendationType.html b/docs/module-models_RecommendationType.html index aa09b88..24a9f5d 100644 --- a/docs/module-models_RecommendationType.html +++ b/docs/module-models_RecommendationType.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_ResultPage.html b/docs/module-models_ResultPage.html index d6277c4..0409e67 100644 --- a/docs/module-models_ResultPage.html +++ b/docs/module-models_ResultPage.html @@ -122,6 +122,8 @@

@@ -444,6 +446,8 @@
Parameters:
+ +
Returns:
@@ -487,13 +491,13 @@
Returns:

diff --git a/docs/module-models_Shipment.html b/docs/module-models_Shipment.html index 5dd5eb9..bea760a 100644 --- a/docs/module-models_Shipment.html +++ b/docs/module-models_Shipment.html @@ -122,6 +122,8 @@

@@ -151,7 +153,7 @@

(inner) tax

The total tax amount of the shipment. Note that order level adjustments are -considered if Discount Taxation preference is set to \"Tax Products and Shipping Only -Based on Adjusted Price\".

+considered if Discount Taxation preference is set to "Tax Products and Shipping Only +Based on Adjusted Price".

@@ -1535,6 +1537,8 @@
Parameters:
+ +
Returns:
@@ -1578,13 +1582,13 @@
Returns:

diff --git a/docs/module-models_ShippingItem.html b/docs/module-models_ShippingItem.html index 4bfd4bc..7d49711 100644 --- a/docs/module-models_ShippingItem.html +++ b/docs/module-models_ShippingItem.html @@ -122,6 +122,8 @@

@@ -1171,6 +1173,8 @@
Parameters:
+ +
Returns:
@@ -1214,13 +1218,13 @@
Returns:

diff --git a/docs/module-models_ShippingMethod.html b/docs/module-models_ShippingMethod.html index d182714..8ade1bb 100644 --- a/docs/module-models_ShippingMethod.html +++ b/docs/module-models_ShippingMethod.html @@ -194,6 +194,8 @@
Parameters:
+ + @@ -804,6 +806,8 @@
Parameters:
+ +
Returns:
@@ -847,13 +851,13 @@
Returns:

diff --git a/docs/module-models_ShippingMethodResult.html b/docs/module-models_ShippingMethodResult.html index ea59cfc..1b9cd0e 100644 --- a/docs/module-models_ShippingMethodResult.html +++ b/docs/module-models_ShippingMethodResult.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_ShippingPromotion.html b/docs/module-models_ShippingPromotion.html index 3182d61..4100ada 100644 --- a/docs/module-models_ShippingPromotion.html +++ b/docs/module-models_ShippingPromotion.html @@ -122,6 +122,8 @@

Home

Modules

Classes

+

Home

Modules

Classes


diff --git a/docs/module-models_SimpleLink.html b/docs/module-models_SimpleLink.html index b8ddaf6..6ea1702 100644 --- a/docs/module-models_SimpleLink.html +++ b/docs/module-models_SimpleLink.html @@ -122,6 +122,8 @@

+ + + + + + + + +

(inner) image :module:models/Image

+ + + + + + +
Type:
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

(inner) image_swatch :module:models/Image

+ + + + + + +
Type:
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -308,7 +446,7 @@
Type:
Source:
@@ -376,7 +514,7 @@
Type:
Source:
@@ -444,7 +582,7 @@
Type:
Source:
@@ -597,7 +735,7 @@
Parameters:
Source:
@@ -620,6 +758,8 @@
Parameters:
+ +
Returns:
@@ -663,13 +803,13 @@
Returns:

diff --git a/docs/module-models_VariationGroup.html b/docs/module-models_VariationGroup.html index f1c0066..70b9317 100644 --- a/docs/module-models_VariationGroup.html +++ b/docs/module-models_VariationGroup.html @@ -122,6 +122,8 @@

+ + @@ -660,6 +662,8 @@
Parameters:
+ +
Returns:
@@ -703,13 +707,13 @@
Returns:

diff --git a/docs/scripts/linenumber.js b/docs/scripts/linenumber.js index 8d52f7e..4354785 100644 --- a/docs/scripts/linenumber.js +++ b/docs/scripts/linenumber.js @@ -1,12 +1,12 @@ /*global document */ -(function() { - var source = document.getElementsByClassName('prettyprint source linenums'); - var i = 0; - var lineNumber = 0; - var lineId; - var lines; - var totalLines; - var anchorHash; +(() => { + const source = document.getElementsByClassName('prettyprint source linenums'); + let i = 0; + let lineNumber = 0; + let lineId; + let lines; + let totalLines; + let anchorHash; if (source && source[0]) { anchorHash = document.location.hash.substring(1); @@ -15,7 +15,7 @@ for (; i < totalLines; i++) { lineNumber++; - lineId = 'line' + lineNumber; + lineId = `line${lineNumber}`; lines[i].id = lineId; if (lineId === anchorHash) { lines[i].className += ' selected'; diff --git a/docs/styles/jsdoc-default.css b/docs/styles/jsdoc-default.css index 9207bc8..7d1729d 100644 --- a/docs/styles/jsdoc-default.css +++ b/docs/styles/jsdoc-default.css @@ -273,7 +273,7 @@ tr > th:last-child { border-right: 1px solid #ddd; } margin: 0; } -.prettyprint +.source { border: 1px solid #ddd; width: 80%; @@ -284,7 +284,7 @@ tr > th:last-child { border-right: 1px solid #ddd; } width: inherit; } -.prettyprint code +.source code { font-size: 100%; line-height: 18px; From 344e943ec8eeee259ecde77ff409140867a5a857 Mon Sep 17 00:00:00 2001 From: Ben Chypak Date: Wed, 15 Jan 2020 13:31:25 -0800 Subject: [PATCH 5/7] Update changelog --- CHANGELOG.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1c2a5f7..f728930 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,6 @@ +## To be released +- Fix refine option processing to include refine_1 ... refine_n alternatives + ## v0.1.11 (August 22, 2019) - Use NPM authentication token for circleci publishing. - Fix `callApi` JSON error parsing never settling its Promise. From 765fe8def7be9f67c909537ab8e63408cbefc2af Mon Sep 17 00:00:00 2001 From: Ben Chypak Date: Wed, 15 Jan 2020 14:16:01 -0800 Subject: [PATCH 6/7] Don't use spread operator (not supported), add test --- src/ApiClient.js | 8 ++++---- src/api/ContentSearchApi.js | 6 ++++-- src/api/ProductSearchApi.js | 30 ++++++++++++++++++++---------- test/api/ApiClient.spec.js | 20 ++++++++++++++++++++ 4 files changed, 48 insertions(+), 16 deletions(-) diff --git a/src/ApiClient.js b/src/ApiClient.js index f1833c8..3c8a83d 100644 --- a/src/ApiClient.js +++ b/src/ApiClient.js @@ -313,10 +313,10 @@ export default class ApiClient { return refinements.length ? refinements.reduce( - (acc, curr, idx, arr) => ({ - ...acc, - [arr.length > 1 ? `refine_${idx + 1}` : 'refine']: this.paramToString(curr) - }), + (acc, curr, idx, arr) => { + Object.assign(acc, {[arr.length > 1 ? `refine_${idx + 1}` : 'refine']: this.paramToString(curr)}) + return acc + }, {} // Reduce array to populate a new object with formatted key/values. ) : {} diff --git a/src/api/ContentSearchApi.js b/src/api/ContentSearchApi.js index 87535a3..70dc02a 100644 --- a/src/api/ContentSearchApi.js +++ b/src/api/ContentSearchApi.js @@ -68,8 +68,7 @@ export default class ContentSearchApi { sort: this.apiClient.buildCollectionParam(opts.sort, 'csv'), start: opts.start, count: opts.count, - locale: opts.locale, - ...this.apiClient.buildRefineParams(opts.refine) + locale: opts.locale } const headerParams = {} const formParams = {} @@ -79,6 +78,9 @@ export default class ContentSearchApi { const accepts = ['application/json', 'text/xml', 'application/xml'] const returnType = ContentSearchResult + // Update queryParams with parsed refinements + Object.assign(queryParams, this.apiClient.buildRefineParams(opts.refine)) + return this.apiClient.callApi( '/content_search', 'GET', pathParams, queryParams, headerParams, formParams, postBody, diff --git a/src/api/ProductSearchApi.js b/src/api/ProductSearchApi.js index 11bfbc0..a0ddfcb 100644 --- a/src/api/ProductSearchApi.js +++ b/src/api/ProductSearchApi.js @@ -72,8 +72,7 @@ export default class ProductSearchApi { count: opts.count, expand: this.apiClient.buildCollectionParam(opts.expand, 'csv'), currency: opts.currency, - locale: opts.locale, - ...this.apiClient.buildRefineParams(opts.refine) + locale: opts.locale } const headerParams = {} const formParams = {} @@ -83,6 +82,9 @@ export default class ProductSearchApi { const accepts = ['application/json', 'text/xml', 'application/xml'] const returnType = ProductSearchResult + // Update queryParams with parsed refinements + Object.assign(queryParams, this.apiClient.buildRefineParams(opts.refine)) + return this.apiClient.callApi( '/product_search', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -158,8 +160,7 @@ export default class ProductSearchApi { sort: opts.sort, start: opts.start, count: opts.count, - locale: opts.locale, - ...this.apiClient.buildRefineParams(opts.refine) + locale: opts.locale } const headerParams = {} const formParams = {} @@ -169,6 +170,9 @@ export default class ProductSearchApi { const accepts = ['application/json', 'text/xml', 'application/xml'] const returnType = ProductSearchResult + // Update queryParams with parsed refinements + Object.assign(queryParams, this.apiClient.buildRefineParams(opts.refine)) + return this.apiClient.callApi( '/product_search/availability', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -239,8 +243,7 @@ export default class ProductSearchApi { sort: opts.sort, start: opts.start, count: opts.count, - locale: opts.locale, - ...this.apiClient.buildRefineParams(opts.refine) + locale: opts.locale } const headerParams = {} const formParams = {} @@ -250,6 +253,9 @@ export default class ProductSearchApi { const accepts = ['application/json', 'text/xml', 'application/xml'] const returnType = ProductSearchResult + // Update queryParams with parsed refinements + Object.assign(queryParams, this.apiClient.buildRefineParams(opts.refine)) + return this.apiClient.callApi( '/product_search/images', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -322,8 +328,7 @@ export default class ProductSearchApi { start: opts.start, count: opts.count, currency: opts.currency, - locale: opts.locale, - ...this.apiClient.buildRefineParams(opts.refine) + locale: opts.locale } const headerParams = {} const formParams = {} @@ -333,6 +338,9 @@ export default class ProductSearchApi { const accepts = ['application/json', 'text/xml', 'application/xml'] const returnType = ProductSearchResult + // Update queryParams with parsed refinements + Object.assign(queryParams, this.apiClient.buildRefineParams(opts.refine)) + return this.apiClient.callApi( '/product_search/prices', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -402,8 +410,7 @@ export default class ProductSearchApi { sort: opts.sort, start: opts.start, count: opts.count, - locale: opts.locale, - ...this.apiClient.buildRefineParams(opts.refine) + locale: opts.locale } const headerParams = {} const formParams = {} @@ -413,6 +420,9 @@ export default class ProductSearchApi { const accepts = ['application/json', 'text/xml', 'application/xml'] const returnType = ProductSearchResult + // Update queryParams with parsed refinements + Object.assign(queryParams, this.apiClient.buildRefineParams(opts.refine)) + return this.apiClient.callApi( '/product_search/variations', 'GET', pathParams, queryParams, headerParams, formParams, postBody, diff --git a/test/api/ApiClient.spec.js b/test/api/ApiClient.spec.js index a0bcab3..1c7fdd5 100644 --- a/test/api/ApiClient.spec.js +++ b/test/api/ApiClient.spec.js @@ -18,6 +18,26 @@ beforeEach(() => { }) describe('ApiClient', () => { + describe('utilities', () => { + it('buildRefineParams returns an object with keyed refinements', () => { + const tests = new Map() + tests.set(undefined, {}) + tests.set([], {}) + tests.set(['foo=bar'], {refine: 'foo=bar'}) + tests.set( + ['foo1=bar1', 'foo2=bar2'], + { + refine_1: 'foo1=bar1', + refine_2: 'foo2=bar2' + } + ) + + for(let [input, result] of tests) { + expect(client.buildRefineParams(input)).to.eql(result) + } + }) + }) + describe('sendApiRequest', () => { let mockRequest From 95b81627d7ac65abe85f6fab18e4f4b5f37105d7 Mon Sep 17 00:00:00 2001 From: Ben Chypak Date: Wed, 15 Jan 2020 14:18:21 -0800 Subject: [PATCH 7/7] Update docs --- docs/ApiClient.js.html | 8 +++---- docs/api_ContentSearchApi.js.html | 6 ++++-- docs/api_ProductSearchApi.js.html | 30 ++++++++++++++++++--------- docs/module-api_ContentSearchApi.html | 2 +- docs/module-api_ProductSearchApi.html | 18 ++++++++-------- 5 files changed, 38 insertions(+), 26 deletions(-) diff --git a/docs/ApiClient.js.html b/docs/ApiClient.js.html index 94e650c..8990269 100644 --- a/docs/ApiClient.js.html +++ b/docs/ApiClient.js.html @@ -341,10 +341,10 @@

Source: ApiClient.js

return refinements.length ? refinements.reduce( - (acc, curr, idx, arr) => ({ - ...acc, - [arr.length > 1 ? `refine_${idx + 1}` : 'refine']: this.paramToString(curr) - }), + (acc, curr, idx, arr) => { + Object.assign(acc, {[arr.length > 1 ? `refine_${idx + 1}` : 'refine']: this.paramToString(curr)}) + return acc + }, {} // Reduce array to populate a new object with formatted key/values. ) : {} diff --git a/docs/api_ContentSearchApi.js.html b/docs/api_ContentSearchApi.js.html index 07a91fb..867ac35 100644 --- a/docs/api_ContentSearchApi.js.html +++ b/docs/api_ContentSearchApi.js.html @@ -96,8 +96,7 @@

Source: api/ContentSearchApi.js

sort: this.apiClient.buildCollectionParam(opts.sort, 'csv'), start: opts.start, count: opts.count, - locale: opts.locale, - ...this.apiClient.buildRefineParams(opts.refine) + locale: opts.locale } const headerParams = {} const formParams = {} @@ -107,6 +106,9 @@

Source: api/ContentSearchApi.js

const accepts = ['application/json', 'text/xml', 'application/xml'] const returnType = ContentSearchResult + // Update queryParams with parsed refinements + Object.assign(queryParams, this.apiClient.buildRefineParams(opts.refine)) + return this.apiClient.callApi( '/content_search', 'GET', pathParams, queryParams, headerParams, formParams, postBody, diff --git a/docs/api_ProductSearchApi.js.html b/docs/api_ProductSearchApi.js.html index 82df1a9..5a4c118 100644 --- a/docs/api_ProductSearchApi.js.html +++ b/docs/api_ProductSearchApi.js.html @@ -100,8 +100,7 @@

Source: api/ProductSearchApi.js

count: opts.count, expand: this.apiClient.buildCollectionParam(opts.expand, 'csv'), currency: opts.currency, - locale: opts.locale, - ...this.apiClient.buildRefineParams(opts.refine) + locale: opts.locale } const headerParams = {} const formParams = {} @@ -111,6 +110,9 @@

Source: api/ProductSearchApi.js

const accepts = ['application/json', 'text/xml', 'application/xml'] const returnType = ProductSearchResult + // Update queryParams with parsed refinements + Object.assign(queryParams, this.apiClient.buildRefineParams(opts.refine)) + return this.apiClient.callApi( '/product_search', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -186,8 +188,7 @@

Source: api/ProductSearchApi.js

sort: opts.sort, start: opts.start, count: opts.count, - locale: opts.locale, - ...this.apiClient.buildRefineParams(opts.refine) + locale: opts.locale } const headerParams = {} const formParams = {} @@ -197,6 +198,9 @@

Source: api/ProductSearchApi.js

const accepts = ['application/json', 'text/xml', 'application/xml'] const returnType = ProductSearchResult + // Update queryParams with parsed refinements + Object.assign(queryParams, this.apiClient.buildRefineParams(opts.refine)) + return this.apiClient.callApi( '/product_search/availability', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -267,8 +271,7 @@

Source: api/ProductSearchApi.js

sort: opts.sort, start: opts.start, count: opts.count, - locale: opts.locale, - ...this.apiClient.buildRefineParams(opts.refine) + locale: opts.locale } const headerParams = {} const formParams = {} @@ -278,6 +281,9 @@

Source: api/ProductSearchApi.js

const accepts = ['application/json', 'text/xml', 'application/xml'] const returnType = ProductSearchResult + // Update queryParams with parsed refinements + Object.assign(queryParams, this.apiClient.buildRefineParams(opts.refine)) + return this.apiClient.callApi( '/product_search/images', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -350,8 +356,7 @@

Source: api/ProductSearchApi.js

start: opts.start, count: opts.count, currency: opts.currency, - locale: opts.locale, - ...this.apiClient.buildRefineParams(opts.refine) + locale: opts.locale } const headerParams = {} const formParams = {} @@ -361,6 +366,9 @@

Source: api/ProductSearchApi.js

const accepts = ['application/json', 'text/xml', 'application/xml'] const returnType = ProductSearchResult + // Update queryParams with parsed refinements + Object.assign(queryParams, this.apiClient.buildRefineParams(opts.refine)) + return this.apiClient.callApi( '/product_search/prices', 'GET', pathParams, queryParams, headerParams, formParams, postBody, @@ -430,8 +438,7 @@

Source: api/ProductSearchApi.js

sort: opts.sort, start: opts.start, count: opts.count, - locale: opts.locale, - ...this.apiClient.buildRefineParams(opts.refine) + locale: opts.locale } const headerParams = {} const formParams = {} @@ -441,6 +448,9 @@

Source: api/ProductSearchApi.js

const accepts = ['application/json', 'text/xml', 'application/xml'] const returnType = ProductSearchResult + // Update queryParams with parsed refinements + Object.assign(queryParams, this.apiClient.buildRefineParams(opts.refine)) + return this.apiClient.callApi( '/product_search/variations', 'GET', pathParams, queryParams, headerParams, formParams, postBody, diff --git a/docs/module-api_ContentSearchApi.html b/docs/module-api_ContentSearchApi.html index a9dd93d..f9c581c 100644 --- a/docs/module-api_ContentSearchApi.html +++ b/docs/module-api_ContentSearchApi.html @@ -475,7 +475,7 @@
Properties
Source:
diff --git a/docs/module-api_ProductSearchApi.html b/docs/module-api_ProductSearchApi.html index 594170c..627c75a 100644 --- a/docs/module-api_ProductSearchApi.html +++ b/docs/module-api_ProductSearchApi.html @@ -525,7 +525,7 @@
Properties
Source:
@@ -860,7 +860,7 @@
Properties
Source:
@@ -1195,7 +1195,7 @@
Properties
Source:
@@ -1530,7 +1530,7 @@
Properties
Source:
@@ -1865,7 +1865,7 @@
Properties
Source:
@@ -2222,7 +2222,7 @@
Properties
Source:
@@ -2580,7 +2580,7 @@
Properties
Source:
@@ -2914,7 +2914,7 @@
Properties
Source:
@@ -3248,7 +3248,7 @@
Properties
Source: