@gradientedge/commercetools-utils 5.9.1 → 5.11.0

package/dist/mjs/api/CommercetoolsApi.js

@@ -0,0 +1,2102 @@
+import { CommercetoolsAuth, } from '../index.js';
+import { CommercetoolsError } from '../error/index.js';
+import { REGION_URLS } from '../auth/constants.js';
+import { ensureNonEmptyString } from '../utils/index.js';
+import { getRequestExecutor } from '../request/request-executor.js';
+/**
+ * A collection of convenience methods for interacting with the
+ * commercetools API.
+ */
+export class CommercetoolsApi {
+    /**
+     * This is the instance of the {@see CommercetoolsAuth} class that
+     * this class uses internally. It's exposed publicly so that it can
+     * be used by consumer's of this class in order to access authorization
+     * API related functionality.
+     */
+    auth;
+    /**
+     * The configuration passed in to the constructor.
+     */
+    config;
+    /**
+     * The Auth and API endpoints driven by the user's setting of {@link CommercetoolsApiConfig.region}
+     * https://docs.commercetools.com/api/general-concepts#regions
+     */
+    endpoints;
+    /**
+     * The request executor that's responsible for making the request to commercetools
+     */
+    requestExecutor;
+    constructor(config) {
+        CommercetoolsApi.validateConfig(config);
+        this.config = config;
+        this.auth = new CommercetoolsAuth(config);
+        this.endpoints = REGION_URLS[this.config.region];
+        this.requestExecutor = getRequestExecutor({
+            timeoutMs: config.timeoutMs,
+            httpsAgent: config.httpsAgent,
+            systemIdentifier: config.systemIdentifier,
+            onBeforeRequest: config.onBeforeRequest,
+            onAfterResponse: config.onAfterResponse,
+            retry: config.retry,
+        });
+    }
+    /**
+     * Get a store given it's id
+     * https://docs.commercetools.com/api/projects/stores#get-a-store-by-id
+     */
+    getStoreById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/stores/${encodeURIComponent(options.id)}`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Get a store given it's key
+     * https://docs.commercetools.com/api/projects/stores#get-a-store-by-key
+     */
+    getStoreByKey(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/stores/key=${encodeURIComponent(options.key)}`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Query stores
+     * https://docs.commercetools.com/api/projects/stores#get-a-store-by-key
+     */
+    queryStores(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: '/stores',
+            method: 'GET',
+        });
+    }
+    /**
+     * Create a store:
+     * https://docs.commercetools.com/api/projects/stores#create-a-store
+     */
+    createStore(options) {
+        return this.request({
+            path: `/stores`,
+            method: 'POST',
+            data: options.data,
+        });
+    }
+    /**
+     * Update a store by id:
+     * https://docs.commercetools.com/api/projects/stores#update-store-by-id
+     */
+    updateStoreById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/stores/${encodeURIComponent(options.id)}`,
+            method: 'POST',
+            data: options.data,
+        });
+    }
+    /**
+     * Update a store by key:
+     * https://docs.commercetools.com/api/projects/stores#update-store-by-key
+     */
+    updateStoreByKey(options) {
+        return this.request({
+            path: `/stores/key=${encodeURIComponent(options.key)}`,
+            method: 'POST',
+            data: options.data,
+        });
+    }
+    /**
+     * Delete a store by id:
+     * https://docs.commercetools.com/api/projects/stores#delete-store-by-id
+     */
+    deleteStoreById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/stores/${encodeURIComponent(options.id)}`,
+            method: 'DELETE',
+            params: {
+                ...options.params,
+                version: options.version,
+            },
+        });
+    }
+    /**
+     * Delete a store by key:
+     * https://docs.commercetools.com/api/projects/stores#delete-store-by-key
+     */
+    deleteStoreByKey(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/stores/key=${encodeURIComponent(options.key)}`,
+            method: 'DELETE',
+            params: {
+                ...options.params,
+                version: options.version,
+            },
+        });
+    }
+    /**
+     * Get an individual category by id:
+     * https://docs.commercetools.com/api/projects/categories#get-category-by-id
+     */
+    getCategoryById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/categories/${encodeURIComponent(options.id)}`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Get an individual category by key:
+     * https://docs.commercetools.com/api/projects/categories#get-category-by-key
+     */
+    getCategoryByKey(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/categories/key=${encodeURIComponent(options.key)}`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Query channels:
+     * https://docs.commercetools.com/api/projects/channels#query-channels
+     */
+    queryChannels(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/channels`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Import an order.
+     * https://docs.commercetools.com/api/projects/orders-import#orderimportdraft
+     */
+    async importOrder(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: '/orders/import',
+            method: 'POST',
+            data: options.data,
+        });
+    }
+    /**
+     * Get channel by id:
+     * https://docs.commercetools.com/api/projects/channels#get-channel-by-id
+     */
+    getChannelById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/channels/${encodeURIComponent(options.id)}`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Get channel by key:
+     * https://docs.commercetools.com/api/projects/channels#get-channel-by-key
+     */
+    async getChannelByKey(options) {
+        const response = await this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/channels`,
+            method: 'GET',
+            params: {
+                where: `key="${encodeURIComponent(options.key)}"`,
+                limit: 1,
+            },
+        });
+        if (!response?.count) {
+            throw new CommercetoolsError(`No channel found with key [${options.key}]`, null, 404);
+        }
+        return response.results[0];
+    }
+    /**
+     * Get an category by id or key. Either the id or the key must be provided.
+     */
+    getCategory(options) {
+        if (!options.id && !options.key) {
+            throw new CommercetoolsError('Either an id, key or slug must be provided');
+        }
+        if (options.id) {
+            ensureNonEmptyString({ value: options.id, name: 'id' });
+            return this.request({
+                ...this.extractCommonRequestOptions(options),
+                path: `/categories/${encodeURIComponent(options.id)}`,
+                method: 'GET',
+            });
+        }
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/categories/key=${encodeURIComponent(options.key ?? '')}`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Get a category projection by slug and locale
+     * Queries the categories for the given slug + locale using:
+     * https://docs.commercetools.com/api/projects/categories#query-categories
+     */
+    async getCategoryBySlug(options) {
+        if (!options.languageCode && !options.languageCodes) {
+            throw new CommercetoolsError('Either the `languageCode` or `languageCodes` property must be provided');
+        }
+        const languageCodes = [];
+        if (options.languageCodes) {
+            languageCodes.push(...options.languageCodes);
+        }
+        else if (options.languageCode) {
+            languageCodes.push(options.languageCode);
+        }
+        const data = await this.request({
+            ...this.extractCommonRequestOptions({
+                ...options,
+                params: {
+                    ...options?.params,
+                    where: `slug(${languageCodes.map((code) => `${code}="${options.slug}"`).join(' or ')})`,
+                },
+            }),
+            path: `/categories`,
+            method: 'GET',
+        });
+        if (!data.count) {
+            throw new CommercetoolsError(`No category found with slug [${options.slug}] and language code [${options.languageCode}]`, { options }, 404);
+        }
+        return data.results[0];
+    }
+    /**
+     * Query categories
+     * https://docs.commercetools.com/api/projects/categories#query-categories
+     */
+    queryCategories(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/categories`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Get the parent categories of a given category. This method returns an array
+     * of {@see Category} items representing the ancestry of categories for the given
+     * category id. The list is ordered from top down. In other words, the root
+     * category is always the first item in the list.
+     */
+    async getCategoryParents(options) {
+        const category = await this.getCategory({
+            ...options,
+            params: {
+                ...options.params,
+                expand: 'ancestors[*]',
+            },
+        });
+        const ancestors = category.ancestors.map((ref) => ref.obj);
+        ancestors.push({
+            ...category,
+            ancestors: category.ancestors.map((ancestor) => ({ id: ancestor.id, typeId: ancestor.typeId })),
+        });
+        return ancestors;
+    }
+    /**
+     * Get an individual product by id:
+     * https://docs.commercetools.com/api/projects/products#get-product-by-id
+     */
+    getProductById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/products/${encodeURIComponent(options.id)}`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Get an individual product by key:
+     * https://docs.commercetools.com/api/projects/products#get-product-by-key
+     */
+    getProductByKey(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/products/key=${encodeURIComponent(options.key)}`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Get a product projection by id
+     * https://docs.commercetools.com/api/projects/productProjections#get-productprojection-by-id
+     */
+    getProductProjectionById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/product-projections/${encodeURIComponent(options.id)}`, options.storeKey),
+            method: 'GET',
+        });
+    }
+    /**
+     * Get a product projection by key
+     * https://docs.commercetools.com/api/projects/productProjections#get-productprojection-by-key
+     */
+    getProductProjectionByKey(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/product-projections/key=${encodeURIComponent(options.key)}`, options.storeKey),
+            method: 'GET',
+        });
+    }
+    /**
+     * Get a product projection by searching the slug with a given locale or array of locales
+     *
+     * Utilises the product projection query endpoint:
+     * https://docs.commercetools.com/api/projects/productProjections#query-productprojections
+     *
+     * You must pass either the {@see options.languageCode} or {@see options.languageCodes}
+     * property in the {@see options} parameter. If both are provided, only the {@see options.languageCodes}
+     * is actually used.
+     */
+    async getProductProjectionBySlug(options) {
+        if (!options.languageCode && !options.languageCodes) {
+            throw new CommercetoolsError('Either the `languageCode` or `languageCodes` property must be provided');
+        }
+        const languageCodes = [];
+        if (options.languageCodes) {
+            languageCodes.push(...options.languageCodes);
+        }
+        else if (options.languageCode) {
+            languageCodes.push(options.languageCode);
+        }
+        const data = await this.request({
+            ...this.extractCommonRequestOptions({
+                ...options,
+                params: {
+                    ...options?.params,
+                    where: `slug(${languageCodes.map((code) => `${code}="${options.slug}"`).join(' or ')})`,
+                },
+            }),
+            path: `/product-projections`,
+            method: 'GET',
+        });
+        if (!data.count) {
+            throw new CommercetoolsError(`No product projection found with slug [${options.slug}] and language code [${options.languageCode}]`, { options }, 404);
+        }
+        return data.results[0];
+    }
+    /**
+     * Query product projections
+     * https://docs.commercetools.com/api/projects/productProjections#query-productprojections
+     */
+    queryProductProjections(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/product-projections`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Search product projections
+     * https://docs.commercetools.com/api/projects/products-search#search-productprojections
+     */
+    searchProductProjections(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/product-projections/search`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Get a product selection by id
+     * https://docs.commercetools.com/api/projects/product-selections#get-product-selection
+     */
+    getProductSelectionById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/product-selections/${encodeURIComponent(options.id)}`, options.storeKey),
+            method: 'GET',
+        });
+    }
+    /**
+     * Get a product selection by key
+     * https://docs.commercetools.com/api/projects/product-selections#get-product-selection-by-key
+     */
+    getProductSelectionByKey(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/product-selections/key=${encodeURIComponent(options.key)}`, options.storeKey),
+            method: 'GET',
+        });
+    }
+    /**
+     * Query product selections
+     * https://docs.commercetools.com/api/projects/product-selections#query-product-selections
+     */
+    queryProductSelections(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/product-selections`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Create a product selection
+     * https://docs.commercetools.com/api/projects/product-selections#create-product-selection
+     */
+    createProductSelection(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/product-selections`,
+            method: 'POST',
+            data: options.data,
+        });
+    }
+    /**
+     * Update a product selection by key
+     * https://docs.commercetools.com/api/projects/product-selections#update-product-selection-by-key
+     */
+    updateProductSelectionByKey(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/product-selections/key=${encodeURIComponent(options.key)}`,
+            method: 'POST',
+            data: { version: options.version, actions: options.actions },
+        });
+    }
+    /**
+     * Delete a product selection by key
+     * https://docs.commercetools.com/api/projects/product-selections#delete-product-selection-by-key
+     */
+    deleteProductSelectionByKey(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/product-selections/key=${encodeURIComponent(options.key)}&version=${encodeURIComponent(options.version)}`,
+            method: 'DELETE',
+        });
+    }
+    /**
+     * Query the products available in a store through active Product Selections
+     * https://docs.commercetools.com/api/projects/product-selections#query-products-available-in-a-store-through-active-product-selections
+     */
+    queryProductsInStore(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/in-store/key=${encodeURIComponent(options.storeKey ?? '')}/product-selection-assignments`,
+            method: `GET`,
+        });
+    }
+    /**
+     * Get an InventoryEntry by id
+     * https://docs.commercetools.com/api/projects/inventory#get-inventoryentry-by-id
+     */
+    getInventoryEntryById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/inventory/${options.id}`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Get an InventoryEntry by key
+     * https://docs.commercetools.com/api/projects/inventory#get-inventoryentry-by-key
+     */
+    getInventoryEntryByKey(options) {
+        ensureNonEmptyString({ value: options.key, name: 'key' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/inventory/key=${encodeURIComponent(options.key)}`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Query the inventory of Skus
+     * https://docs.commercetools.com/api/projects/inventory#query-inventory
+     */
+    queryInventory(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/inventory`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Create InventoryEntry
+     * https://docs.commercetools.com/api/projects/inventory#create-inventoryentry
+     */
+    createInventoryEntry(options) {
+        ensureNonEmptyString({ value: options.data.sku, name: 'sku' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: '/inventory',
+            data: options.data,
+            method: 'POST',
+        });
+    }
+    /**
+     * Update InventoryEntry by id
+     * https://docs.commercetools.com/api/projects/inventory#update-inventoryentry-by-id
+     */
+    updateInventoryEntryById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/inventory/${options.id}`,
+            method: 'POST',
+            data: {
+                ...options.data,
+            },
+        });
+    }
+    /**
+     * Update InventoryEntry by key
+     * https://docs.commercetools.com/api/projects/inventory#update-inventoryentry-by-key
+     */
+    updateInventoryEntryByKey(options) {
+        ensureNonEmptyString({ value: options.key, name: 'key' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/inventory/key=${options.key}`,
+            method: 'POST',
+            data: {
+                ...options.data,
+            },
+        });
+    }
+    /**
+     * Delete InventoryEntry by id
+     * https://docs.commercetools.com/api/projects/inventory#delete-inventoryentry-by-id
+     */
+    deleteInventoryEntryById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/inventory/${options.id}`,
+            params: {
+                ...options.params,
+                version: options.version,
+            },
+            method: 'DELETE',
+        });
+    }
+    /**
+     * Delete InventoryEntry by key
+     * https://docs.commercetools.com/api/projects/inventory#delete-inventoryentry-by-key
+     */
+    deleteInventoryEntryByKey(options) {
+        ensureNonEmptyString({ value: options.key, name: 'key' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/inventory/key=${options.key}`,
+            params: {
+                ...options.params,
+                version: options.version,
+            },
+            method: 'DELETE',
+        });
+    }
+    /**
+     * Get a cart by id
+     * https://docs.commercetools.com/api/projects/carts#update-a-cart-by-id
+     */
+    getCartById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/carts/${encodeURIComponent(options.id)}`, options.storeKey),
+            method: 'GET',
+        });
+    }
+    /**
+     * Query carts
+     * https://docs.commercetools.com/api/projects/carts#query-carts-1
+     */
+    async queryCarts(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/carts`, options?.storeKey),
+            method: 'GET',
+        });
+    }
+    /**
+     * Query my carts
+     * https://docs.commercetools.com/api/projects/me-carts#query-carts-1
+     */
+    async queryMyCarts(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/me/carts`, options.storeKey),
+            method: 'GET',
+            accessToken: options.accessToken,
+        });
+    }
+    /**
+     * Create a new cart:
+     * https://docs.commercetools.com/api/projects/carts#create-a-cart-1
+     */
+    async createCart(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/carts`, options.storeKey),
+            method: 'POST',
+            data: options.data,
+        });
+    }
+    /**
+     * Update a cart by id
+     * https://docs.commercetools.com/api/projects/carts#update-a-cart-by-id
+     */
+    async updateCartById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/carts/${encodeURIComponent(options.id)}`, options.storeKey),
+            method: 'POST',
+            data: {
+                version: options.version,
+                actions: options.actions,
+            },
+        });
+    }
+    /**
+     * Get the active cart. Requires a logged in or anonymous customer access token:
+     * https://docs.commercetools.com/api/projects/me-carts#get-active-cart
+     */
+    async getMyActiveCart(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/me/active-cart`, options.storeKey),
+            method: 'GET',
+            accessToken: options.accessToken,
+        });
+    }
+    /**
+     * Get my cart. Requires a logged in or anonymous customer access token:
+     * https://docs.commercetools.com/api/projects/me-carts#get-cart-by-id
+     */
+    async getMyCartById(options) {
+        ensureNonEmptyString({ value: options.cartId, name: 'cartId' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/me/carts/${encodeURIComponent(options.cartId)}`, options.storeKey),
+            method: 'GET',
+            accessToken: options.accessToken,
+        });
+    }
+    /**
+     * Create a new cart for the customer associated with the given `accessToken` parameter:
+     * https://docs.commercetools.com/api/projects/me-carts#create-a-cart-1
+     */
+    async createMyCart(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/me/carts`, options.storeKey),
+            method: 'POST',
+            data: options.data,
+            accessToken: options.accessToken,
+        });
+    }
+    /**
+     * Update a customer's cart with the given actions:
+     * https://docs.commercetools.com/api/projects/me-carts#update-cart
+     * https://docs.commercetools.com/api/projects/me-carts#update-actions
+     */
+    async updateMyCart(options) {
+        ensureNonEmptyString({ value: options.cartId, name: 'cartId' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/me/carts/${encodeURIComponent(options.cartId)}`, options.storeKey),
+            method: 'POST',
+            data: {
+                version: options.cartVersion,
+                actions: options.actions,
+            },
+            accessToken: options.accessToken,
+        });
+    }
+    /**
+     * Delete the active cart This method uses {@see getMyActiveCart} to first
+     * get the active cart, in order to find the cart id and version:
+     * https://docs.commercetools.com/api/projects/me-carts#delete-a-cart
+     */
+    async deleteMyActiveCart(options) {
+        const cart = await this.getMyActiveCart(options);
+        return await this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/me/carts/${encodeURIComponent(cart.id)}`, options.storeKey),
+            method: 'DELETE',
+            params: {
+                ...options.params,
+                version: cart.version,
+            },
+            accessToken: options.accessToken,
+        });
+    }
+    /**
+     * Delete my cart by id
+     * https://docs.commercetools.com/api/projects/me-carts#delete-a-cart
+     */
+    async deleteMyCartById(options) {
+        ensureNonEmptyString({ value: options.cartId, name: 'cartId' });
+        const cart = await this.getMyCartById(options);
+        return await this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/me/carts/${encodeURIComponent(options.cartId)}`, options.storeKey),
+            method: 'DELETE',
+            params: {
+                ...options.params,
+                version: cart.version,
+            },
+            accessToken: options.accessToken,
+        });
+    }
+    /**
+     * Update a customer's cart with the given actions. Note that we automatically
+     * retrieve the customer's active cart using the given access token:
+     * https://docs.commercetools.com/api/projects/me-carts#update-cart
+     * https://docs.commercetools.com/api/projects/me-carts#update-actions
+     */
+    async updateMyActiveCart(options) {
+        const cart = await this.getMyActiveCart(options);
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/me/carts/${encodeURIComponent(cart.id)}`, options.storeKey),
+            method: 'POST',
+            data: {
+                version: cart.version,
+                actions: options.actions,
+            },
+            accessToken: options.accessToken,
+        });
+    }
+    /**
+     * Create an order from the given cart id. The cart id and version are automatically
+     * retrieved by looking up the customers active cart:
+     * https://docs.commercetools.com/api/projects/me-orders#create-order-from-a-cart
+     */
+    async createMyOrderFromActiveCart(options) {
+        const cart = await this.getMyActiveCart(options);
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore('/me/orders', options.storeKey),
+            method: 'POST',
+            data: {
+                version: cart.version,
+                id: cart.id,
+            },
+            accessToken: options.accessToken,
+        });
+    }
+    /**
+     * Create an order from the given cart id. The cart id and version are automatically
+     * retrieved by looking up the cart:
+     * https://docs.commercetools.com/api/projects/orders#create-order
+     */
+    async createOrderFromCart(options) {
+        const cart = await this.getCartById(options);
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore('/orders', options.storeKey),
+            method: 'POST',
+            data: {
+                version: cart.version,
+                id: cart.id,
+            },
+        });
+    }
+    /**
+     * Delete a cart by the given id:
+     * https://docs.commercetools.com/api/projects/carts#delete-a-cart-by-id
+     */
+    async deleteCartById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return await this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/carts/${encodeURIComponent(options.id)}`, options.storeKey),
+            method: 'DELETE',
+            params: {
+                ...options.params,
+                version: options.version,
+            },
+        });
+    }
+    /**
+     * Create a payment object:
+     * https://docs.commercetools.com/api/projects/payments#create-a-payment
+     */
+    createPayment(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: '/payments',
+            method: 'POST',
+            data: options.data,
+        });
+    }
+    /**
+     * Delete a payment object by id:
+     * https://docs.commercetools.com/api/projects/payments#delete-payment-by-id
+     */
+    deletePaymentById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/payments/${encodeURIComponent(options.id)}`,
+            method: 'DELETE',
+            params: {
+                ...options.params,
+                version: options.version,
+            },
+        });
+    }
+    /**
+     * Update a payment object by id:
+     * https://docs.commercetools.com/api/projects/payments#update-payment-by-id
+     */
+    updatePaymentById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/payments/${encodeURIComponent(options.id)}`,
+            method: 'POST',
+            data: options.data,
+        });
+    }
+    /**
+     * Get a payment object by id:
+     * https://docs.commercetools.com/api/projects/payments#get-payment-by-id
+     */
+    getPaymentById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/payments/${encodeURIComponent(options.id)}`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Query payment objects:
+     * https://docs.commercetools.com/api/projects/payments#query-payments
+     */
+    queryPayments(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: '/payments',
+            method: 'GET',
+        });
+    }
+    /**
+     * Create a payment object using the customer's access token:
+     * https://docs.commercetools.com/api/projects/me-payments#create-mypayment
+     */
+    createMyPayment(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: '/me/payments',
+            method: 'POST',
+            data: options.data,
+            accessToken: options.accessToken,
+        });
+    }
+    /**
+     * Update a payment object using the customer's access token:
+     * https://docs.commercetools.com/api/projects/me-payments#update-mypayment
+     */
+    updateMyPaymentById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/me/payments/${encodeURIComponent(options.id)}`,
+            method: 'POST',
+            data: options.data,
+            accessToken: options.accessToken,
+        });
+    }
+    /**
+     * Get a payment object by id using the customer's access token:
+     * https://docs.commercetools.com/api/projects/me-payments#get-mypayment-by-id
+     */
+    getMyPaymentById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/me/payments/${encodeURIComponent(options.id)}`,
+            method: 'GET',
+            accessToken: options.accessToken,
+        });
+    }
+    /**
+     * Query payment objects using the customer's access token:
+     * https://docs.commercetools.com/api/projects/me-payments#query-mypayments
+     */
+    queryMyPayments(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: '/me/payments',
+            method: 'GET',
+            accessToken: options.accessToken,
+        });
+    }
+    /**
+     * Delete payment object using the customer's access token:
+     * https://docs.commercetools.com/api/projects/me-payments#delete-mypayment
+     */
+    deleteMyPaymentById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/me/payments/${encodeURIComponent(options.id)}`,
+            method: 'DELETE',
+            params: {
+                version: options.version,
+            },
+            accessToken: options.accessToken,
+        });
+    }
+    /**
+     * Get an order by id using the customer's access token:
+     * https://docs.commercetools.com/api/projects/me-orders#get-order-by-id
+     */
+    getMyOrderById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/me/orders/${encodeURIComponent(options.id)}`, options.storeKey),
+            method: 'GET',
+            accessToken: options.accessToken,
+        });
+    }
+    /**
+     * Query my orders:
+     * https://docs.commercetools.com/api/projects/me-orders#query-orders-1
+     */
+    queryMyOrders(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/me/orders`, options.storeKey),
+            method: 'GET',
+            accessToken: options.accessToken,
+        });
+    }
+    /**
+     * Update an order by id:
+     * https://docs.commercetools.com/api/projects/orders#update-order-by-id
+     */
+    updateOrderById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/orders/${encodeURIComponent(options.id)}`, options.storeKey),
+            method: 'POST',
+            data: options.data,
+        });
+    }
+    /**
+     * Update an order by order number:
+     * https://docs.commercetools.com/api/projects/orders#update-order-by-ordernumber
+     */
+    updateOrderByOrderNumber(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/orders/order-number=${encodeURIComponent(options.orderNumber)}`, options.storeKey),
+            method: 'POST',
+            data: options.data,
+        });
+    }
+    /**
+     * Get an order by id:
+     * https://docs.commercetools.com/api/projects/orders#get-order-by-id
+     */
+    getOrderById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/orders/${encodeURIComponent(options.id)}`, options.storeKey),
+            method: 'GET',
+        });
+    }
+    /**
+     * Get an order by order number:
+     * https://docs.commercetools.com/api/projects/orders#get-order-by-ordernumber
+     */
+    getOrderByOrderNumber(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/orders/order-number=${encodeURIComponent(options.orderNumber)}`, options.storeKey),
+            method: 'GET',
+        });
+    }
+    /**
+     * Delete an order by id:
+     * https://docs.commercetools.com/api/projects/orders#delete-order-by-id
+     */
+    deleteOrderById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/orders/${encodeURIComponent(options.id)}`, options.storeKey),
+            method: 'DELETE',
+            params: {
+                ...options.params,
+                version: options.version,
+                dataErasure: options.dataErasure,
+            },
+        });
+    }
+    /**
+     * Delete an order by order number:
+     * https://docs.commercetools.com/api/projects/orders#delete-order-by-ordernumber
+     */
+    deleteOrderByOrderNumber(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/orders/order-number=${encodeURIComponent(options.orderNo)}`, options.storeKey),
+            method: 'DELETE',
+            params: {
+                ...options.params,
+                version: options.version,
+                dataErasure: options.dataErasure,
+            },
+        });
+    }
+    /**
+     * Query orders:
+     * https://docs.commercetools.com/api/projects/orders#query-orders-1
+     */
+    queryOrders(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/orders`, options.storeKey),
+            method: 'GET',
+        });
+    }
+    /**
+     * Create a product:
+     * https://docs.commercetools.com/api/projects/products#create-a-product
+     */
+    createProduct(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/products`,
+            method: 'POST',
+            data: options.data,
+        });
+    }
+    /**
+     * Update a product by key:
+     * https://docs.commercetools.com/api/projects/products#update-product-by-key
+     */
+    updateProductByKey(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/products/key=${encodeURIComponent(options.key)}`,
+            method: 'POST',
+            data: options.data,
+        });
+    }
+    /**
+     * Update a product by id:
+     * https://docs.commercetools.com/api/projects/products#update-product-by-id
+     */
+    updateProductById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/products/${encodeURIComponent(options.id)}`,
+            method: 'POST',
+            data: options.data,
+        });
+    }
+    /**
+     * Delete a product by id:
+     * https://docs.commercetools.com/api/projects/products#delete-product-by-id
+     *
+     * @param {object} options Request options
+     * @param {boolean} options.unpublish If true, the product will be unpublished before being deleted
+     */
+    async deleteProductById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        let version = options.version;
+        if (options.unpublish) {
+            const product = await this.unpublishProductById({
+                id: options.id,
+                version: options.version,
+            });
+            version = product.version;
+        }
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/products/${encodeURIComponent(options.id)}`,
+            method: 'DELETE',
+            params: {
+                ...options.params,
+                version,
+            },
+        });
+    }
+    /**
+     * Delete a product by key:
+     * https://docs.commercetools.com/api/projects/products#delete-product-by-key
+     *
+     * @param {object} options Request options
+     * @param {boolean} options.unpublish If true, the product will be unpublished before being deleted
+     */
+    async deleteProductByKey(options) {
+        let version = options.version;
+        if (options.unpublish) {
+            const product = await this.unpublishProductByKey({
+                key: options.key,
+                version: options.version,
+            });
+            version = product.version;
+        }
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/products/key=${encodeURIComponent(options.key)}`,
+            method: 'DELETE',
+            params: {
+                ...options.params,
+                version,
+            },
+        });
+    }
+    /**
+     * Unpublish a product by key
+     *
+     * Issues an 'unpublish' action for the given product:
+     * https://docs.commercetools.com/api/projects/products#unpublish
+     */
+    unpublishProductByKey(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/products/key=${encodeURIComponent(options.key)}`,
+            method: 'POST',
+            params: options.params,
+            data: {
+                version: options.version,
+                actions: [{ action: 'unpublish' }],
+            },
+        });
+    }
+    /**
+     * Unpublish a product by id
+     *
+     * Issues an 'unpublish' action for the given product:
+     * https://docs.commercetools.com/api/projects/products#unpublish
+     */
+    unpublishProductById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/products/${encodeURIComponent(options.id)}`,
+            method: 'POST',
+            params: options.params,
+            data: {
+                version: options.version,
+                actions: [{ action: 'unpublish' }],
+            },
+        });
+    }
+    /**
+     * Create a category:
+     * https://docs.commercetools.com/api/projects/categories#create-a-category
+     */
+    createCategory(options) {
+        return this.request({
+            path: `/categories`,
+            method: 'POST',
+            data: options.data,
+        });
+    }
+    /**
+     * Update a category by key:
+     * https://docs.commercetools.com/api/projects/categories#update-category-by-key
+     */
+    updateCategoryByKey(options) {
+        return this.request({
+            path: `/categories/key=${encodeURIComponent(options.key)}`,
+            method: 'POST',
+            data: options.data,
+        });
+    }
+    /**
+     * Update a category by id:
+     * https://docs.commercetools.com/api/projects/categories#update-category-by-id
+     */
+    updateCategoryById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/categories/${encodeURIComponent(options.id)}`,
+            method: 'POST',
+            data: options.data,
+        });
+    }
+    /**
+     * Delete a category by id:
+     * https://docs.commercetools.com/api/projects/categories#delete-category-by-id
+     */
+    deleteCategoryById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/categories/${encodeURIComponent(options.id)}`,
+            method: 'DELETE',
+            params: {
+                ...options.params,
+                version: options.version,
+            },
+        });
+    }
+    /**
+     * Delete a category by key:
+     * https://docs.commercetools.com/api/projects/categories#delete-category-by-key
+     */
+    deleteCategoryByKey(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/categories/key=${encodeURIComponent(options.key)}`,
+            method: 'DELETE',
+            params: {
+                ...options.params,
+                version: options.version,
+            },
+        });
+    }
+    /**
+     * Create a customer account:
+     * https://docs.commercetools.com/api/projects/customers#create-customer-sign-up
+     */
+    createAccount(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/customers`, options.storeKey),
+            method: 'POST',
+            data: options.data,
+        });
+    }
+    /**
+     * Delete a customer account by id
+     * https://docs.commercetools.com/api/projects/customers#delete-customer-by-id
+     */
+    deleteCustomerById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/customers/${encodeURIComponent(options.id)}`, options.storeKey),
+            method: 'DELETE',
+            params: {
+                ...options.params,
+                version: options.version,
+                dataErasure: options.dataErasure,
+            },
+        });
+    }
+    /**
+     * Delete a customer account by key
+     * https://docs.commercetools.com/api/projects/customers#delete-customer-by-key
+     */
+    deleteCustomerByKey(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/customers/key=${encodeURIComponent(options.key)}`, options.storeKey),
+            method: 'DELETE',
+            params: {
+                ...options.params,
+                version: options.version,
+                dataErasure: options.dataErasure,
+            },
+        });
+    }
+    /**
+     * Create a customer account given an (optional) anonymous access token:
+     * https://docs.commercetools.com/api/projects/me-profile#create-customer-sign-up
+     */
+    createMyAccount(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/me/signup`, options.storeKey),
+            method: 'POST',
+            data: options.data,
+            accessToken: options.accessToken,
+        });
+    }
+    /**
+     * Login to customer's account given an (optional) anonymous access token:
+     * https://docs.commercetools.com/api/projects/me-profile#authenticate-customer-sign-in
+     */
+    loginMyAccount(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/me/login`, options.storeKey),
+            method: 'POST',
+            data: options.data,
+            accessToken: options.accessToken,
+        });
+    }
+    /**
+     * Login to customer's account:
+     * https://docs.commercetools.com/api/projects/customers#authenticate-customer-sign-in
+     */
+    login(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/login`, options.storeKey),
+            method: 'POST',
+            data: options.data,
+        });
+    }
+    /**
+     * Get a customer's account/profile:
+     * https://docs.commercetools.com/api/projects/me-profile#get-customer
+     */
+    getMyAccount(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/me`, options.storeKey),
+            method: 'GET',
+            accessToken: options.accessToken,
+        });
+    }
+    /**
+     * Update a customer's account/profile:
+     * https://docs.commercetools.com/api/projects/me-profile#update-customer
+     */
+    updateMyAccount(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/me`, options.storeKey),
+            method: 'POST',
+            accessToken: options.accessToken,
+            data: options.data,
+        });
+    }
+    /**
+     * Change the customer's password:
+     * https://docs.commercetools.com/api/projects/me-profile#change-customers-password
+     */
+    changeMyPassword(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/me/password`, options.storeKey),
+            method: 'POST',
+            accessToken: options.accessToken,
+            data: options.data,
+        });
+    }
+    /**
+     * Reset the customer's password:
+     * https://docs.commercetools.com/api/projects/me-profile#reset-customers-password
+     */
+    resetMyPassword(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/me/password/reset`, options.storeKey),
+            method: 'POST',
+            accessToken: options.accessToken,
+            data: options.data,
+        });
+    }
+    /**
+     * Get a password reset token
+     * https://docs.commercetools.com/api/projects/customers#create-a-token-for-resetting-the-customers-password
+     */
+    getPasswordResetToken(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/customers/password-token`, options.storeKey),
+            method: 'POST',
+            data: options.data,
+        });
+    }
+    /**
+     * Get a customer by id:
+     * https://docs.commercetools.com/api/projects/customers#get-customer-by-id
+     */
+    getCustomerById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/customers/${encodeURIComponent(options.id)}`, options.storeKey),
+            method: 'GET',
+        });
+    }
+    /**
+     * Get a customer by key:
+     * https://docs.commercetools.com/api/projects/customers#get-customer-by-key
+     */
+    getCustomerByKey(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/customers/key=${encodeURIComponent(options.key)}`, options.storeKey),
+            method: 'GET',
+        });
+    }
+    /**
+     * Get a customer by password token:
+     * https://docs.commercetools.com/api/projects/customers#get-customer-by-password-token
+     */
+    getCustomerByPasswordToken(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/customers/password-token=${encodeURIComponent(options.token)}`, options.storeKey),
+            method: 'GET',
+        });
+    }
+    /**
+     * Query customers:
+     * https://docs.commercetools.com/api/projects/customers#query-customers
+     */
+    queryCustomers(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: this.applyStore(`/customers`, options.storeKey),
+            method: 'GET',
+        });
+    }
+    /**
+     * Update a customer by id:
+     * https://docs.commercetools.com/api/projects/customers#update-customer-by-id
+     */
+    updateCustomerById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/customers/${encodeURIComponent(options.id)}`,
+            method: 'POST',
+            data: options.data,
+        });
+    }
+    /**
+     * Update a customer by key:
+     * https://docs.commercetools.com/api/projects/customers#update-customer-by-key
+     */
+    updateCustomerByKey(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/customers/key=${encodeURIComponent(options.key)}`,
+            method: 'POST',
+            data: options.data,
+        });
+    }
+    /**
+     * Get a product type by id:
+     * https://docs.commercetools.com/api/projects/productTypes#get-a-producttype-by-id
+     */
+    getProductTypeById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/product-types/${encodeURIComponent(options.id)}`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Get a product type by key:
+     * https://docs.commercetools.com/api/projects/productTypes#get-a-producttype-by-key
+     */
+    getProductTypeByKey(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/product-types/key=${encodeURIComponent(options.key)}`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Query product types:
+     * https://docs.commercetools.com/api/projects/productTypes#query-producttypes
+     */
+    queryProductTypes(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/product-types`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Get a type by id:
+     * https://docs.commercetools.com/api/projects/types#get-type-by-id
+     */
+    getTypeById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/types/${encodeURIComponent(options.id)}`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Get a type by key:
+     * https://docs.commercetools.com/api/projects/types#get-type-by-key
+     */
+    getTypeByKey(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/types/key=${encodeURIComponent(options.key)}`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Query types:
+     * https://docs.commercetools.com/api/projects/types#query-types
+     */
+    queryTypes(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/types`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Get a discount code by id:
+     * https://docs.commercetools.com/api/projects/discountCodes#get-discountcode-by-id
+     */
+    getDiscountCodeById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/discount-codes/${encodeURIComponent(options.id)}`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Get a cart discount code by id:
+     * https://docs.commercetools.com/api/projects/cartDiscounts#get-cartdiscount-by-id
+     */
+    getCartDiscountById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/cart-discounts/${encodeURIComponent(options.id)}`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Get a cart discount by key:
+     * https://docs.commercetools.com/api/projects/cartDiscounts#get-cartdiscount-by-key
+     */
+    getCartDiscountByKey(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/cart-discounts/key=${encodeURIComponent(options.key)}`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Query cart discounts:
+     * https://docs.commercetools.com/api/projects/cartDiscounts#query-cartdiscounts
+     */
+    queryCartDiscounts(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/cart-discounts`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Get a custom object
+     * https://docs.commercetools.com/api/projects/custom-objects#get-customobject-by-container-and-key
+     */
+    getCustomObject(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/custom-objects/${encodeURIComponent(options.container)}/${encodeURIComponent(options.key)}`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Get a custom object by id
+     * https://docs.commercetools.com/api/projects/custom-objects#get-customobject
+     */
+    getCustomObjectById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/custom-objects/${encodeURIComponent(options.id)}`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Save a custom object
+     * https://docs.commercetools.com/api/projects/custom-objects#create-or-update-a-customobject
+     */
+    saveCustomObject(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/custom-objects`,
+            method: 'POST',
+            data: options.data,
+        });
+    }
+    /**
+     * Delete a custom object
+     * https://docs.commercetools.com/api/projects/custom-objects#delete-customobject-by-container-and-key
+     */
+    deleteCustomObject(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/custom-objects/${encodeURIComponent(options.container)}/${encodeURIComponent(options.key)}`,
+            method: 'DELETE',
+        });
+    }
+    /**
+     * Get a shipping method by id:
+     * https://docs.commercetools.com/api/projects/shippingMethods#get-shippingmethod-by-id
+     */
+    getShippingMethodById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/shipping-methods/${encodeURIComponent(options.id)}`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Get a shipping method by key:
+     * https://docs.commercetools.com/api/projects/shippingMethods#get-shippingmethod-by-key
+     */
+    getShippingMethodByKey(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/shipping-methods/key=${encodeURIComponent(options.key)}`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Get shipping method by location:
+     * https://docs.commercetools.com/api/projects/shippingMethods#get-shippingmethods-for-a-location
+     */
+    getShippingMethodsForLocation(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions({
+                ...options,
+                params: {
+                    ...options?.params,
+                    country: options.country,
+                    state: options.state,
+                    currency: options.currency,
+                },
+            }),
+            path: `/shipping-methods/matching-location`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Get shipping methods applicable to a given cart id:
+     * https://docs.commercetools.com/api/projects/shippingMethods#get-shippingmethods-for-a-cart
+     */
+    getShippingMethodsForCart(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions({
+                ...options,
+                params: {
+                    ...options?.params,
+                    cartId: options.cartId,
+                },
+            }),
+            path: `/shipping-methods/matching-cart`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Get shipping methods applicable for a Cart and Location:
+     * https://docs.commercetools.com/api/projects/shippingMethods#for-a-cart-and-location
+     */
+    getShippingMethodsForCartAndLocation(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions({
+                ...options,
+                params: {
+                    ...options?.params,
+                    cartId: options.cartId,
+                    country: options.country,
+                    state: options.state,
+                },
+            }),
+            path: `/shipping-methods/matching-cart-location`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Query shipping methods:
+     * https://docs.commercetools.com/api/projects/shippingMethods#query-shippingmethods
+     */
+    queryShippingMethods(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/shipping-methods`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Get an individual customer group by id:
+     * https://docs.commercetools.com/api/projects/customerGroups#get-customergroup-by-id
+     */
+    getCustomerGroupById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/customer-groups/${encodeURIComponent(options.id)}`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Get an individual customer group by key:
+     * https://docs.commercetools.com/api/projects/customerGroups#get-customergroup-by-key
+     */
+    getCustomerGroupByKey(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/customer-groups/key=${encodeURIComponent(options.key)}`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Query customer groups:
+     * https://docs.commercetools.com/api/projects/customerGroups#query-customergroups
+     */
+    queryCustomerGroups(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/customer-groups`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Create a customer group:
+     * https://docs.commercetools.com/api/projects/customerGroups#create-a-customergroup
+     */
+    createCustomerGroup(options) {
+        return this.request({
+            path: `/customer-groups`,
+            method: 'POST',
+            data: options.data,
+        });
+    }
+    /**
+     * Update a customer group by key:
+     * https://docs.commercetools.com/api/projects/customerGroups#update-customergroup-by-key
+     */
+    updateCustomerGroupByKey(options) {
+        return this.request({
+            path: `/customer-groups/key=${encodeURIComponent(options.key)}`,
+            method: 'POST',
+            data: options.data,
+        });
+    }
+    /**
+     * Update a customer group by id:
+     * https://docs.commercetools.com/api/projects/customerGroups#update-customergroup-by-id
+     */
+    updateCustomerGroupById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/customer-groups/${encodeURIComponent(options.id)}`,
+            method: 'POST',
+            data: options.data,
+        });
+    }
+    /**
+     * Delete a customer group by id:
+     * https://docs.commercetools.com/api/projects/customerGroups#delete-customergroup-by-id
+     */
+    deleteCustomerGroupById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/customer-groups/${encodeURIComponent(options.id)}`,
+            method: 'DELETE',
+            params: {
+                ...options.params,
+                version: options.version,
+            },
+        });
+    }
+    /**
+     * Delete a customer group by key:
+     * https://docs.commercetools.com/api/projects/customerGroups#delete-customergroup-by-key
+     */
+    deleteCustomerGroupByKey(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/customer-groups/key=${encodeURIComponent(options.key)}`,
+            method: 'DELETE',
+            params: {
+                ...options.params,
+                version: options.version,
+            },
+        });
+    }
+    /**
+     * Get a state given it's id
+     * https://docs.commercetools.com/api/projects/states#get-state-by-id
+     */
+    getStateById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/states/${encodeURIComponent(options.id)}`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Get a state given it's key
+     * https://docs.commercetools.com/api/projects/states#get-state-by-key
+     */
+    getStateByKey(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/states/key=${encodeURIComponent(options.key)}`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Query state
+     * https://docs.commercetools.com/api/projects/states#query-states
+     */
+    queryStates(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: '/states',
+            method: 'GET',
+        });
+    }
+    /**
+     * Get a standalone price given it's id
+     * https://docs.commercetools.com/api/projects/standalone-prices#get-standaloneprice-by-id
+     */
+    getStandalonePriceById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/standalone-prices/${encodeURIComponent(options.id)}`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Get a standalone price given it's key
+     * https://docs.commercetools.com/api/projects/standalone-prices#get-standaloneprice-by-key
+     */
+    getStandalonePriceByKey(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/standalone-prices/key=${encodeURIComponent(options.key)}`,
+            method: 'GET',
+        });
+    }
+    /**
+     * Query standalone prices
+     * https://docs.commercetools.com/api/projects/standalone-prices#query-standaloneprices
+     */
+    queryStandalonePrices(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: '/standalone-prices',
+            method: 'GET',
+        });
+    }
+    /**
+     * Create a standalone price object:
+     * https://docs.commercetools.com/api/projects/standalone-prices#create-standaloneprice
+     */
+    createStandalonePrice(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: '/standalone-prices',
+            method: 'POST',
+            data: options.data,
+        });
+    }
+    /**
+     * Update a standalone price object by id:
+     * https://docs.commercetools.com/api/projects/standalone-prices#update-standaloneprice-by-id
+     */
+    updateStandalonePriceById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/standalone-prices/${encodeURIComponent(options.id)}`,
+            method: 'POST',
+            data: options.data,
+        });
+    }
+    /**
+     * Update a standalone price object by key:
+     * https://docs.commercetools.com/api/projects/standalone-prices#update-standaloneprice-by-key
+     */
+    updateStandalonePriceByKey(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/standalone-prices/key=${encodeURIComponent(options.key)}`,
+            method: 'POST',
+            data: options.data,
+        });
+    }
+    /**
+     * Delete a standalone price object by id:
+     * https://docs.commercetools.com/api/projects/standalone-prices#delete-standaloneprice-by-id
+     */
+    deleteStandalonePriceById(options) {
+        ensureNonEmptyString({ value: options.id, name: 'id' });
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/standalone-prices/${encodeURIComponent(options.id)}`,
+            method: 'DELETE',
+            params: {
+                ...options.params,
+                version: options.version,
+            },
+        });
+    }
+    /**
+     * Delete a standalone price object by key:
+     * https://docs.commercetools.com/api/projects/standalone-prices#delete-standaloneprice-by-key
+     */
+    deleteStandalonePriceByKey(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/standalone-prices/key=${encodeURIComponent(options.key)}`,
+            method: 'DELETE',
+            params: {
+                ...options.params,
+                version: options.version,
+            },
+        });
+    }
+    /**
+     * Execute a GraphQL statement:
+     * https://docs.commercetools.com/api/graphql
+     */
+    graphql(options) {
+        return this.request({
+            ...this.extractCommonRequestOptions(options),
+            path: `/graphql`,
+            method: 'POST',
+            data: options.data,
+            accessToken: options.accessToken,
+        });
+    }
+    /**
+     * Make the request to the commercetools REST API.
+     */
+    async request(options) {
+        const requestOptions = await this.getRequestOptions(options);
+        return await this.requestExecutor(requestOptions);
+    }
+    /**
+     * Generate request options. These are then fed in to axios when
+     * making the request to commercetools.
+     */
+    async getRequestOptions(options) {
+        let params;
+        let accessToken = options.accessToken;
+        const url = `${this.endpoints.api}/${this.config.projectKey}${options.path}`;
+        if (!accessToken) {
+            const grant = await this.auth.getClientGrant();
+            accessToken = grant.accessToken;
+        }
+        const headers = {
+            ...options.headers,
+            Authorization: `Bearer ${accessToken}`,
+        };
+        if (typeof options.correlationId === 'string' && options.correlationId !== '') {
+            headers['X-Correlation-ID'] = options.correlationId;
+            delete options.correlationId;
+        }
+        if (options.params && Object.keys(options.params).length) {
+            params = options.params;
+        }
+        return {
+            method: options.method,
+            data: options.data,
+            url,
+            headers,
+            params,
+        };
+    }
+    /**
+     * Type-guard against any additional unexpected properties being passed in.
+     */
+    extractCommonRequestOptions(options) {
+        if (!options) {
+            return {};
+        }
+        return {
+            correlationId: options.correlationId,
+            params: options.params,
+            retry: options.retry,
+        };
+    }
+    /**
+     * Applies the store key to a given path
+     */
+    applyStore(path, storeKey) {
+        if (typeof storeKey === 'string' && storeKey !== '') {
+            return `/in-store/key=${storeKey}${path}`;
+        }
+        else if (this.config.storeKey) {
+            return `/in-store/key=${this.config.storeKey}${path}`;
+        }
+        return path;
+    }
+    /**
+     * Ensure that all required properties on the {@see CommercetoolsApiConfig}
+     * object have been populated. These are currently:
+     *
+     *   projectKey: string
+     *   clientId: string
+     *   clientSecret: string
+     *   region: Region
+     *   clientScopes: string[]
+     */
+    static validateConfig(config) {
+        const errors = [];
+        if (!config) {
+            errors.push('The config object missing or empty');
+        }
+        else {
+            if (!config.projectKey) {
+                errors.push('The `projectKey` property is empty');
+            }
+            else if (typeof config.projectKey !== 'string') {
+                errors.push('The `projectKey` property must be a string');
+            }
+            if (!config.clientId) {
+                errors.push('The `clientId` property is empty');
+            }
+            else if (typeof config.clientId !== 'string') {
+                errors.push('The `clientId` property must be a string');
+            }
+            if (!config.clientSecret) {
+                errors.push('The `clientSecret` property is empty');
+            }
+            else if (typeof config.clientSecret !== 'string') {
+                errors.push('The `clientSecret` property must be a string');
+            }
+            if (!Array.isArray(config.clientScopes)) {
+                errors.push('The `clientScopes` property must be an array');
+            }
+            else if (config.clientScopes.length === 0) {
+                errors.push('The `clientScopes` property must have at least 1 scope defined');
+            }
+            if (!config.region) {
+                errors.push('The `region` property is empty');
+            }
+            else if (typeof config.region !== 'string') {
+                errors.push('The `region` property must be a string');
+            }
+            else if (!Object.prototype.hasOwnProperty.call(REGION_URLS, config.region)) {
+                errors.push(`The \`region\` property value is not valid: ${config.region}. Must be one of: ${Object.keys(REGION_URLS).join(', ')}`);
+            }
+        }
+        if (errors.length) {
+            throw new CommercetoolsError('The configuration object passed in to the `CommercetoolsApi` constructor is not valid: \n' +
+                errors.map((error) => `• ${error}`).join('\n'));
+        }
+    }
+}
+//# sourceMappingURL=CommercetoolsApi.js.map