@gradientedge/commercetools-utils 5.9.0 → 5.10.0

package/dist/cjs/api/CommercetoolsApi.d.ts

@@ -0,0 +1,1252 @@
+import { CommercetoolsApiConfig, CommercetoolsRetryConfig } from './types.js';
+import { CommercetoolsAuth, PaymentDraft, ProductTypePagedQueryResponse, TypePagedQueryResponse } from '../index.js';
+import { CommercetoolsRequest, RegionEndpoints } from '../types.js';
+import type { Cart, CartDiscount, CartDiscountPagedQueryResponse, CartDraft, CartPagedQueryResponse, CartUpdateAction, Category, CategoryDraft, CategoryPagedQueryResponse, CategoryUpdate, Channel, ChannelPagedQueryResponse, Customer, CustomerCreatePasswordResetToken, CustomerDraft, CustomerGroup, CustomerGroupDraft, CustomerGroupPagedQueryResponse, CustomerGroupUpdate, CustomerPagedQueryResponse, CustomerResetPassword, CustomerSignin, CustomerSignInResult, CustomerToken, CustomerUpdate, CustomObject, CustomObjectDraft, DiscountCode, GraphQLRequest, GraphQLResponse, InventoryEntry, InventoryEntryDraft, InventoryEntryUpdateAction, InventoryPagedQueryResponse, MyCartDraft, MyCartUpdateAction, MyCustomerDraft, MyPayment, MyPaymentDraft, MyPaymentPagedQueryResponse, MyPaymentUpdate, Order, OrderImportDraft, OrderPagedQueryResponse, OrderUpdate, Payment, PaymentPagedQueryResponse, PaymentUpdate, Product, ProductDraft, ProductProjection, ProductProjectionPagedQueryResponse, ProductSelection, ProductSelectionDraft, ProductSelectionPagedQueryResponse, ProductSelectionUpdateAction, ProductsInStorePagedQueryResponse, ProductType, ProductUpdate, ShippingMethod, ShippingMethodPagedQueryResponse, StandalonePrice, StandalonePriceDraft, StandalonePricePagedQueryResponse, StandalonePriceUpdate, State, StatePagedQueryResponse, Store, StoreDraft, StorePagedQueryResponse, StoreUpdate, Type } from '../models/index.js';
+export interface FetchOptions<T = any> {
+    /**
+     * Path of the REST endpoint
+     *
+     * This is the absolute path, without the host/schema/port etc.
+     * You should not include your project key, as this will be
+     * automatically prepended.
+     *
+     * Example: `/product-projections`
+     *
+     * Note that if you want to create a path that takes in to account
+     * the store key that you defined in {@see CommercetoolsApiConfig}
+     * then you should use the {@see CommercetoolsApi.applyStore} method.
+     */
+    path: string;
+    /**
+     * Key/value pairs representing the HTTP headers to send
+     *
+     * You can pass in any headers you like using this property, however
+     * this is generally not necessary, as the {@see CommercetoolsApi.request}
+     * method applies all necessary headers.
+     *
+     * You should specifically avoid setting values for the following headers:
+     *
+     *  - `Authorization`
+     *  - `Content-Type`
+     *  - `X-Correlation-ID`
+     *  - `User-Agent`
+     *
+     * All of the above are set by the `CommercetoolsApi` class.
+     *
+     * Example value:
+     *
+     * ```
+     * {
+     *   ...
+     *   headers: {
+     *     'X-My-Special-Header': 'MyCustomValue'
+     *   }
+     *   ...
+     * }
+     * ```
+     */
+    headers?: Record<string, string>;
+    /**
+     * HTTP method to use when sending the request
+     */
+    method: 'GET' | 'POST' | 'DELETE' | 'HEAD';
+    /**
+     * Querystring parameters to send with the request
+     *
+     * Key/value pairs that are then converted in to a querystring
+     * using the `qs` npm package. See the `paramSerializer` option
+     * in {@see CommercetoolsApi.createAxiosInstance} for
+     * implementation details.
+     */
+    params?: Record<string, any>;
+    /**
+     * Plain JavaScript object containing the payload to send as JSON
+     *
+     * This object will be converted to a JSON string and sent as the body
+     * of a `POST` or `DELETE` request.
+     */
+    data?: T;
+    /**
+     * Access token to use as the value for the `Authorization` bearer token
+     *
+     * Typically this would be the access token that belongs to a customer.
+     * This must be passed in when using one of the `me` endpoints.
+     *
+     * If this property is not passed in, we fall back to using the client
+     * access token.
+     */
+    accessToken?: string;
+    /**
+     * Value to be passed in the `X-Correlation-ID` HTTP header
+     */
+    correlationId?: string;
+    /**
+     * Request retry configuration
+     *
+     * The request retry configuration can be set on the `CommercetoolsApi`
+     * instance or on a request by request basis. If no value is passed in
+     * here, we fall back to using the configuration provided when constructing
+     * the `CommercetoolsApi` instance. If no value was passed in to the
+     * constructor configuration, then no retries will take place.
+     */
+    retry?: CommercetoolsRetryConfig;
+}
+/**
+ * Options that are available to all requests.
+ */
+export interface CommonRequestOptions {
+    /**
+     * A unique id used to track the source of a request.
+     */
+    correlationId?: string;
+    /**
+     * Query string parameters. For repeated param=value in the query string, define an array with values
+     */
+    params?: Record<string, undefined | string | boolean | number | (string | boolean | number)[]>;
+    /**
+     * Retry configuration
+     */
+    retry?: CommercetoolsRetryConfig;
+}
+/**
+ * Options that are available to all requests that support specifying a store
+ */
+export interface CommonStoreEnabledRequestOptions extends CommonRequestOptions {
+    /**
+     * The key of the store that you want this call to apply to
+     */
+    storeKey?: string;
+}
+/**
+ * A collection of convenience methods for interacting with the
+ * commercetools API.
+ */
+export declare 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.
+     */
+    readonly auth: CommercetoolsAuth;
+    /**
+     * The configuration passed in to the constructor.
+     */
+    readonly config: CommercetoolsApiConfig;
+    /**
+     * The Auth and API endpoints driven by the user's setting of {@link CommercetoolsApiConfig.region}
+     * https://docs.commercetools.com/api/general-concepts#regions
+     */
+    readonly endpoints: RegionEndpoints;
+    /**
+     * The request executor that's responsible for making the request to commercetools
+     */
+    private readonly requestExecutor;
+    constructor(config: CommercetoolsApiConfig);
+    /**
+     * Get a store given it's id
+     * https://docs.commercetools.com/api/projects/stores#get-a-store-by-id
+     */
+    getStoreById(options: CommonRequestOptions & {
+        id: string;
+    }): Promise<Store>;
+    /**
+     * Get a store given it's key
+     * https://docs.commercetools.com/api/projects/stores#get-a-store-by-key
+     */
+    getStoreByKey(options: CommonRequestOptions & {
+        key: string;
+    }): Promise<Store>;
+    /**
+     * Query stores
+     * https://docs.commercetools.com/api/projects/stores#get-a-store-by-key
+     */
+    queryStores(options?: CommonRequestOptions): Promise<StorePagedQueryResponse>;
+    /**
+     * Create a store:
+     * https://docs.commercetools.com/api/projects/stores#create-a-store
+     */
+    createStore(options: CommonRequestOptions & {
+        data: StoreDraft;
+    }): Promise<Store>;
+    /**
+     * Update a store by id:
+     * https://docs.commercetools.com/api/projects/stores#update-store-by-id
+     */
+    updateStoreById(options: CommonRequestOptions & {
+        id: string;
+        data: StoreUpdate;
+    }): Promise<Store>;
+    /**
+     * Update a store by key:
+     * https://docs.commercetools.com/api/projects/stores#update-store-by-key
+     */
+    updateStoreByKey(options: CommonRequestOptions & {
+        key: string;
+        data: StoreUpdate;
+    }): Promise<Store>;
+    /**
+     * Delete a store by id:
+     * https://docs.commercetools.com/api/projects/stores#delete-store-by-id
+     */
+    deleteStoreById(options: CommonRequestOptions & {
+        id: string;
+        version: number;
+    }): Promise<Store>;
+    /**
+     * Delete a store by key:
+     * https://docs.commercetools.com/api/projects/stores#delete-store-by-key
+     */
+    deleteStoreByKey(options: CommonRequestOptions & {
+        key: string;
+        version: number;
+    }): Promise<Store>;
+    /**
+     * Get an individual category by id:
+     * https://docs.commercetools.com/api/projects/categories#get-category-by-id
+     */
+    getCategoryById(options: CommonRequestOptions & {
+        id: string;
+    }): Promise<Category>;
+    /**
+     * Get an individual category by key:
+     * https://docs.commercetools.com/api/projects/categories#get-category-by-key
+     */
+    getCategoryByKey(options: CommonRequestOptions & {
+        key: string;
+    }): Promise<Category>;
+    /**
+     * Query channels:
+     * https://docs.commercetools.com/api/projects/channels#query-channels
+     */
+    queryChannels(options?: CommonRequestOptions): Promise<ChannelPagedQueryResponse>;
+    /**
+     * Import an order.
+     * https://docs.commercetools.com/api/projects/orders-import#orderimportdraft
+     */
+    importOrder(options: CommonRequestOptions & {
+        data: OrderImportDraft;
+    }): Promise<Order>;
+    /**
+     * Get channel by id:
+     * https://docs.commercetools.com/api/projects/channels#get-channel-by-id
+     */
+    getChannelById(options: CommonRequestOptions & {
+        id: string;
+    }): Promise<Channel>;
+    /**
+     * Get channel by key:
+     * https://docs.commercetools.com/api/projects/channels#get-channel-by-key
+     */
+    getChannelByKey(options: CommonRequestOptions & {
+        key: string;
+    }): Promise<Channel>;
+    /**
+     * Get an category by id or key. Either the id or the key must be provided.
+     */
+    getCategory(options: CommonRequestOptions & {
+        id?: string;
+        key?: string;
+    }): Promise<Category>;
+    /**
+     * 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
+     */
+    getCategoryBySlug(options: CommonRequestOptions & {
+        slug: string;
+        languageCode?: string;
+        languageCodes?: string[];
+    }): Promise<Category>;
+    /**
+     * Query categories
+     * https://docs.commercetools.com/api/projects/categories#query-categories
+     */
+    queryCategories(options?: CommonRequestOptions): Promise<CategoryPagedQueryResponse>;
+    /**
+     * 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.
+     */
+    getCategoryParents(options: CommonRequestOptions & {
+        id?: string;
+        key?: string;
+    }): Promise<Array<Category>>;
+    /**
+     * Get an individual product by id:
+     * https://docs.commercetools.com/api/projects/products#get-product-by-id
+     */
+    getProductById(options: CommonRequestOptions & {
+        id: string;
+    }): Promise<Product>;
+    /**
+     * Get an individual product by key:
+     * https://docs.commercetools.com/api/projects/products#get-product-by-key
+     */
+    getProductByKey(options: CommonRequestOptions & {
+        key: string;
+    }): Promise<Product>;
+    /**
+     * Get a product projection by id
+     * https://docs.commercetools.com/api/projects/productProjections#get-productprojection-by-id
+     */
+    getProductProjectionById(options: CommonStoreEnabledRequestOptions & {
+        id: string;
+    }): Promise<ProductProjection>;
+    /**
+     * Get a product projection by key
+     * https://docs.commercetools.com/api/projects/productProjections#get-productprojection-by-key
+     */
+    getProductProjectionByKey(options: CommonStoreEnabledRequestOptions & {
+        key: string;
+    }): Promise<ProductProjection>;
+    /**
+     * 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.
+     */
+    getProductProjectionBySlug(options: CommonRequestOptions & {
+        slug: string;
+        languageCode?: string;
+        languageCodes?: string[];
+    }): Promise<ProductProjection>;
+    /**
+     * Query product projections
+     * https://docs.commercetools.com/api/projects/productProjections#query-productprojections
+     */
+    queryProductProjections(options?: CommonRequestOptions): Promise<ProductProjectionPagedQueryResponse>;
+    /**
+     * Search product projections
+     * https://docs.commercetools.com/api/projects/products-search#search-productprojections
+     */
+    searchProductProjections(options: CommonStoreEnabledRequestOptions): Promise<ProductProjectionPagedQueryResponse>;
+    /**
+     * Get a product selection by id
+     * https://docs.commercetools.com/api/projects/product-selections#get-product-selection
+     */
+    getProductSelectionById(options: CommonStoreEnabledRequestOptions & {
+        id: string;
+    }): Promise<ProductSelection>;
+    /**
+     * Get a product selection by key
+     * https://docs.commercetools.com/api/projects/product-selections#get-product-selection-by-key
+     */
+    getProductSelectionByKey(options: CommonStoreEnabledRequestOptions & {
+        key: string;
+    }): Promise<ProductSelection>;
+    /**
+     * Query product selections
+     * https://docs.commercetools.com/api/projects/product-selections#query-product-selections
+     */
+    queryProductSelections(options?: CommonStoreEnabledRequestOptions): Promise<ProductSelectionPagedQueryResponse>;
+    /**
+     * Create a product selection
+     * https://docs.commercetools.com/api/projects/product-selections#create-product-selection
+     */
+    createProductSelection(options: CommonStoreEnabledRequestOptions & {
+        data: ProductSelectionDraft;
+    }): Promise<ProductSelection>;
+    /**
+     * Update a product selection by key
+     * https://docs.commercetools.com/api/projects/product-selections#update-product-selection-by-key
+     */
+    updateProductSelectionByKey(options: CommonStoreEnabledRequestOptions & {
+        key: string;
+        version: number;
+        actions: ProductSelectionUpdateAction[];
+    }): Promise<ProductSelection>;
+    /**
+     * Delete a product selection by key
+     * https://docs.commercetools.com/api/projects/product-selections#delete-product-selection-by-key
+     */
+    deleteProductSelectionByKey(options: CommonStoreEnabledRequestOptions & {
+        key: string;
+        version: number;
+    }): Promise<ProductSelection>;
+    /**
+     * 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: CommonStoreEnabledRequestOptions): Promise<ProductsInStorePagedQueryResponse>;
+    /**
+     * Get an InventoryEntry by id
+     * https://docs.commercetools.com/api/projects/inventory#get-inventoryentry-by-id
+     */
+    getInventoryEntryById(options: CommonRequestOptions & {
+        id: string;
+    }): Promise<InventoryEntry>;
+    /**
+     * Get an InventoryEntry by key
+     * https://docs.commercetools.com/api/projects/inventory#get-inventoryentry-by-key
+     */
+    getInventoryEntryByKey(options: CommonRequestOptions & {
+        key: string;
+    }): Promise<InventoryEntry>;
+    /**
+     * Query the inventory of Skus
+     * https://docs.commercetools.com/api/projects/inventory#query-inventory
+     */
+    queryInventory(options?: CommonRequestOptions): Promise<InventoryPagedQueryResponse>;
+    /**
+     * Create InventoryEntry
+     * https://docs.commercetools.com/api/projects/inventory#create-inventoryentry
+     */
+    createInventoryEntry(options: CommonRequestOptions & {
+        data: InventoryEntryDraft;
+    }): Promise<InventoryEntry>;
+    /**
+     * Update InventoryEntry by id
+     * https://docs.commercetools.com/api/projects/inventory#update-inventoryentry-by-id
+     */
+    updateInventoryEntryById(options: CommonRequestOptions & {
+        id: string;
+        data: {
+            version: number;
+            actions: InventoryEntryUpdateAction[];
+        };
+    }): Promise<InventoryEntry>;
+    /**
+     * Update InventoryEntry by key
+     * https://docs.commercetools.com/api/projects/inventory#update-inventoryentry-by-key
+     */
+    updateInventoryEntryByKey(options: CommonRequestOptions & {
+        key: string;
+        data: {
+            version: number;
+            actions: InventoryEntryUpdateAction[];
+        };
+    }): Promise<InventoryEntry>;
+    /**
+     * Delete InventoryEntry by id
+     * https://docs.commercetools.com/api/projects/inventory#delete-inventoryentry-by-id
+     */
+    deleteInventoryEntryById(options: CommonRequestOptions & {
+        id: string;
+        version: number;
+    }): Promise<InventoryEntry>;
+    /**
+     * Delete InventoryEntry by key
+     * https://docs.commercetools.com/api/projects/inventory#delete-inventoryentry-by-key
+     */
+    deleteInventoryEntryByKey(options: CommonRequestOptions & {
+        key: string;
+        version: number;
+    }): Promise<InventoryEntry>;
+    /**
+     * Get a cart by id
+     * https://docs.commercetools.com/api/projects/carts#update-a-cart-by-id
+     */
+    getCartById(options: CommonStoreEnabledRequestOptions & {
+        id: string;
+    }): Promise<Cart>;
+    /**
+     * Query carts
+     * https://docs.commercetools.com/api/projects/carts#query-carts-1
+     */
+    queryCarts(options?: CommonStoreEnabledRequestOptions): Promise<CartPagedQueryResponse>;
+    /**
+     * Query my carts
+     * https://docs.commercetools.com/api/projects/me-carts#query-carts-1
+     */
+    queryMyCarts(options: CommonStoreEnabledRequestOptions & {
+        accessToken: string;
+    }): Promise<CartPagedQueryResponse>;
+    /**
+     * Create a new cart:
+     * https://docs.commercetools.com/api/projects/carts#create-a-cart-1
+     */
+    createCart(options: CommonStoreEnabledRequestOptions & {
+        data: CartDraft;
+    }): Promise<Cart>;
+    /**
+     * Update a cart by id
+     * https://docs.commercetools.com/api/projects/carts#update-a-cart-by-id
+     */
+    updateCartById(options: CommonStoreEnabledRequestOptions & {
+        id: string;
+        version: number;
+        actions: CartUpdateAction[];
+    }): Promise<Cart>;
+    /**
+     * Get the active cart. Requires a logged in or anonymous customer access token:
+     * https://docs.commercetools.com/api/projects/me-carts#get-active-cart
+     */
+    getMyActiveCart(options: CommonStoreEnabledRequestOptions & {
+        accessToken: string;
+    }): Promise<Cart>;
+    /**
+     * Get my cart. Requires a logged in or anonymous customer access token:
+     * https://docs.commercetools.com/api/projects/me-carts#get-cart-by-id
+     */
+    getMyCartById(options: CommonStoreEnabledRequestOptions & {
+        accessToken: string;
+        cartId: string;
+    }): Promise<Cart>;
+    /**
+     * 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
+     */
+    createMyCart(options: CommonStoreEnabledRequestOptions & {
+        accessToken: string;
+        data: MyCartDraft;
+    }): Promise<Cart>;
+    /**
+     * 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
+     */
+    updateMyCart(options: CommonStoreEnabledRequestOptions & {
+        accessToken: string;
+        cartId: string;
+        cartVersion: number;
+        actions: MyCartUpdateAction[];
+    }): Promise<Cart>;
+    /**
+     * 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
+     */
+    deleteMyActiveCart(options: CommonStoreEnabledRequestOptions & {
+        accessToken: string;
+    }): Promise<Cart>;
+    /**
+     * Delete my cart by id
+     * https://docs.commercetools.com/api/projects/me-carts#delete-a-cart
+     */
+    deleteMyCartById(options: CommonStoreEnabledRequestOptions & {
+        accessToken: string;
+        cartId: string;
+    }): Promise<Cart>;
+    /**
+     * 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
+     */
+    updateMyActiveCart(options: CommonStoreEnabledRequestOptions & {
+        accessToken: string;
+        actions: MyCartUpdateAction[];
+    }): Promise<Cart>;
+    /**
+     * 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
+     */
+    createMyOrderFromActiveCart(options: CommonStoreEnabledRequestOptions & {
+        accessToken: string;
+    }): Promise<Order>;
+    /**
+     * 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
+     */
+    createOrderFromCart(options: CommonStoreEnabledRequestOptions & {
+        id: string;
+    }): Promise<Order>;
+    /**
+     * Delete a cart by the given id:
+     * https://docs.commercetools.com/api/projects/carts#delete-a-cart-by-id
+     */
+    deleteCartById(options: CommonStoreEnabledRequestOptions & {
+        id: string;
+        version: number;
+    }): Promise<Cart>;
+    /**
+     * Create a payment object:
+     * https://docs.commercetools.com/api/projects/payments#create-a-payment
+     */
+    createPayment(options: CommonRequestOptions & {
+        data: PaymentDraft;
+    }): Promise<Payment>;
+    /**
+     * Delete a payment object by id:
+     * https://docs.commercetools.com/api/projects/payments#delete-payment-by-id
+     */
+    deletePaymentById(options: CommonRequestOptions & {
+        id: string;
+        version: number;
+    }): Promise<Payment>;
+    /**
+     * Update a payment object by id:
+     * https://docs.commercetools.com/api/projects/payments#update-payment-by-id
+     */
+    updatePaymentById(options: CommonRequestOptions & {
+        id: string;
+        data: PaymentUpdate;
+    }): Promise<Payment>;
+    /**
+     * Get a payment object by id:
+     * https://docs.commercetools.com/api/projects/payments#get-payment-by-id
+     */
+    getPaymentById(options: CommonRequestOptions & {
+        id: string;
+    }): Promise<Payment>;
+    /**
+     * Query payment objects:
+     * https://docs.commercetools.com/api/projects/payments#query-payments
+     */
+    queryPayments(options: CommonRequestOptions): Promise<PaymentPagedQueryResponse>;
+    /**
+     * Create a payment object using the customer's access token:
+     * https://docs.commercetools.com/api/projects/me-payments#create-mypayment
+     */
+    createMyPayment(options: CommonRequestOptions & {
+        data: MyPaymentDraft;
+        accessToken: string;
+    }): Promise<MyPayment>;
+    /**
+     * Update a payment object using the customer's access token:
+     * https://docs.commercetools.com/api/projects/me-payments#update-mypayment
+     */
+    updateMyPaymentById(options: CommonRequestOptions & {
+        id: string;
+        data: MyPaymentUpdate;
+        accessToken: string;
+    }): Promise<MyPayment>;
+    /**
+     * 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: CommonRequestOptions & {
+        id: string;
+        accessToken: string;
+    }): Promise<MyPayment>;
+    /**
+     * Query payment objects using the customer's access token:
+     * https://docs.commercetools.com/api/projects/me-payments#query-mypayments
+     */
+    queryMyPayments(options: CommonRequestOptions & {
+        accessToken: string;
+    }): Promise<MyPaymentPagedQueryResponse>;
+    /**
+     * Delete payment object using the customer's access token:
+     * https://docs.commercetools.com/api/projects/me-payments#delete-mypayment
+     */
+    deleteMyPaymentById(options: CommonRequestOptions & {
+        id: string;
+        version: number;
+        accessToken: string;
+    }): Promise<MyPayment>;
+    /**
+     * 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: CommonStoreEnabledRequestOptions & {
+        id: string;
+        accessToken: string;
+    }): Promise<Order>;
+    /**
+     * Query my orders:
+     * https://docs.commercetools.com/api/projects/me-orders#query-orders-1
+     */
+    queryMyOrders(options: CommonStoreEnabledRequestOptions & {
+        accessToken: string;
+    }): Promise<OrderPagedQueryResponse>;
+    /**
+     * Update an order by id:
+     * https://docs.commercetools.com/api/projects/orders#update-order-by-id
+     */
+    updateOrderById(options: CommonStoreEnabledRequestOptions & {
+        id: string;
+        data: OrderUpdate;
+    }): Promise<Order>;
+    /**
+     * Update an order by order number:
+     * https://docs.commercetools.com/api/projects/orders#update-order-by-ordernumber
+     */
+    updateOrderByOrderNumber(options: CommonStoreEnabledRequestOptions & {
+        orderNumber: string;
+        data: OrderUpdate;
+    }): Promise<Order>;
+    /**
+     * Get an order by id:
+     * https://docs.commercetools.com/api/projects/orders#get-order-by-id
+     */
+    getOrderById(options: CommonStoreEnabledRequestOptions & {
+        id: string;
+    }): Promise<Order>;
+    /**
+     * Get an order by order number:
+     * https://docs.commercetools.com/api/projects/orders#get-order-by-ordernumber
+     */
+    getOrderByOrderNumber(options: CommonStoreEnabledRequestOptions & {
+        orderNumber: string;
+    }): Promise<Order>;
+    /**
+     * Delete an order by id:
+     * https://docs.commercetools.com/api/projects/orders#delete-order-by-id
+     */
+    deleteOrderById(options: CommonStoreEnabledRequestOptions & {
+        id: string;
+        version: number;
+        dataErasure?: boolean;
+    }): Promise<Order>;
+    /**
+     * Delete an order by order number:
+     * https://docs.commercetools.com/api/projects/orders#delete-order-by-ordernumber
+     */
+    deleteOrderByOrderNumber(options: CommonStoreEnabledRequestOptions & {
+        orderNo: string;
+        version: number;
+        dataErasure?: boolean;
+    }): Promise<Order>;
+    /**
+     * Query orders:
+     * https://docs.commercetools.com/api/projects/orders#query-orders-1
+     */
+    queryOrders(options: CommonStoreEnabledRequestOptions): Promise<OrderPagedQueryResponse>;
+    /**
+     * Create a product:
+     * https://docs.commercetools.com/api/projects/products#create-a-product
+     */
+    createProduct(options: CommonRequestOptions & {
+        data: ProductDraft;
+    }): Promise<Product>;
+    /**
+     * Update a product by key:
+     * https://docs.commercetools.com/api/projects/products#update-product-by-key
+     */
+    updateProductByKey(options: CommonRequestOptions & {
+        key: string;
+        data: ProductUpdate;
+    }): Promise<Product>;
+    /**
+     * Update a product by id:
+     * https://docs.commercetools.com/api/projects/products#update-product-by-id
+     */
+    updateProductById(options: CommonRequestOptions & {
+        id: string;
+        data: ProductUpdate;
+    }): Promise<Product>;
+    /**
+     * 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
+     */
+    deleteProductById(options: CommonRequestOptions & {
+        id: string;
+        version: number;
+        unpublish?: boolean;
+    }): Promise<Product>;
+    /**
+     * 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
+     */
+    deleteProductByKey(options: CommonRequestOptions & {
+        key: string;
+        version: number;
+        unpublish?: boolean;
+    }): Promise<Product>;
+    /**
+     * Unpublish a product by key
+     *
+     * Issues an 'unpublish' action for the given product:
+     * https://docs.commercetools.com/api/projects/products#unpublish
+     */
+    unpublishProductByKey(options: CommonRequestOptions & {
+        key: string;
+        version: number;
+    }): Promise<Product>;
+    /**
+     * Unpublish a product by id
+     *
+     * Issues an 'unpublish' action for the given product:
+     * https://docs.commercetools.com/api/projects/products#unpublish
+     */
+    unpublishProductById(options: CommonRequestOptions & {
+        id: string;
+        version: number;
+    }): Promise<Product>;
+    /**
+     * Create a category:
+     * https://docs.commercetools.com/api/projects/categories#create-a-category
+     */
+    createCategory(options: CommonRequestOptions & {
+        data: CategoryDraft;
+    }): Promise<Category>;
+    /**
+     * Update a category by key:
+     * https://docs.commercetools.com/api/projects/categories#update-category-by-key
+     */
+    updateCategoryByKey(options: CommonRequestOptions & {
+        key: string;
+        data: CategoryUpdate;
+    }): Promise<Category>;
+    /**
+     * Update a category by id:
+     * https://docs.commercetools.com/api/projects/categories#update-category-by-id
+     */
+    updateCategoryById(options: CommonRequestOptions & {
+        id: string;
+        data: CategoryUpdate;
+    }): Promise<Category>;
+    /**
+     * Delete a category by id:
+     * https://docs.commercetools.com/api/projects/categories#delete-category-by-id
+     */
+    deleteCategoryById(options: CommonRequestOptions & {
+        id: string;
+        version: number;
+    }): Promise<Category>;
+    /**
+     * Delete a category by key:
+     * https://docs.commercetools.com/api/projects/categories#delete-category-by-key
+     */
+    deleteCategoryByKey(options: CommonRequestOptions & {
+        key: string;
+        version: number;
+    }): Promise<Category>;
+    /**
+     * Create a customer account:
+     * https://docs.commercetools.com/api/projects/customers#create-customer-sign-up
+     */
+    createAccount(options: CommonStoreEnabledRequestOptions & {
+        data: CustomerDraft;
+    }): Promise<CustomerSignInResult>;
+    /**
+     * Delete a customer account by id
+     * https://docs.commercetools.com/api/projects/customers#delete-customer-by-id
+     */
+    deleteCustomerById(options: CommonStoreEnabledRequestOptions & {
+        id: string;
+        version: number;
+        dataErasure?: boolean;
+    }): Promise<Customer>;
+    /**
+     * Delete a customer account by key
+     * https://docs.commercetools.com/api/projects/customers#delete-customer-by-key
+     */
+    deleteCustomerByKey(options: CommonStoreEnabledRequestOptions & {
+        key: string;
+        version: number;
+        dataErasure?: boolean;
+    }): Promise<Customer>;
+    /**
+     * Create a customer account given an (optional) anonymous access token:
+     * https://docs.commercetools.com/api/projects/me-profile#create-customer-sign-up
+     */
+    createMyAccount(options: CommonStoreEnabledRequestOptions & {
+        accessToken?: string;
+        data: MyCustomerDraft;
+    }): Promise<CustomerSignInResult>;
+    /**
+     * 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: CommonStoreEnabledRequestOptions & {
+        accessToken?: string;
+        data: CustomerSignin;
+    }): Promise<CustomerSignInResult>;
+    /**
+     * Login to customer's account:
+     * https://docs.commercetools.com/api/projects/customers#authenticate-customer-sign-in
+     */
+    login(options: CommonStoreEnabledRequestOptions & {
+        data: CustomerSignin;
+    }): Promise<CustomerSignInResult>;
+    /**
+     * Get a customer's account/profile:
+     * https://docs.commercetools.com/api/projects/me-profile#get-customer
+     */
+    getMyAccount(options: CommonStoreEnabledRequestOptions & {
+        accessToken: string;
+    }): Promise<Customer>;
+    /**
+     * Update a customer's account/profile:
+     * https://docs.commercetools.com/api/projects/me-profile#update-customer
+     */
+    updateMyAccount(options: CommonStoreEnabledRequestOptions & {
+        accessToken: string;
+        data: CustomerUpdate;
+    }): Promise<Customer>;
+    /**
+     * Change the customer's password:
+     * https://docs.commercetools.com/api/projects/me-profile#change-customers-password
+     */
+    changeMyPassword(options: CommonStoreEnabledRequestOptions & {
+        accessToken: string;
+        data: {
+            version: number;
+            currentPassword: string;
+            newPassword: string;
+        };
+    }): Promise<Customer>;
+    /**
+     * Reset the customer's password:
+     * https://docs.commercetools.com/api/projects/me-profile#reset-customers-password
+     */
+    resetMyPassword(options: CommonStoreEnabledRequestOptions & {
+        accessToken: string;
+        data: CustomerResetPassword;
+    }): Promise<Customer>;
+    /**
+     * Get a password reset token
+     * https://docs.commercetools.com/api/projects/customers#create-a-token-for-resetting-the-customers-password
+     */
+    getPasswordResetToken(options: CommonStoreEnabledRequestOptions & {
+        data: CustomerCreatePasswordResetToken;
+    }): Promise<CustomerToken>;
+    /**
+     * Get a customer by id:
+     * https://docs.commercetools.com/api/projects/customers#get-customer-by-id
+     */
+    getCustomerById(options: CommonStoreEnabledRequestOptions & {
+        id: string;
+    }): Promise<Customer>;
+    /**
+     * Get a customer by key:
+     * https://docs.commercetools.com/api/projects/customers#get-customer-by-key
+     */
+    getCustomerByKey(options: CommonStoreEnabledRequestOptions & {
+        key: string;
+    }): Promise<Customer>;
+    /**
+     * Get a customer by password token:
+     * https://docs.commercetools.com/api/projects/customers#get-customer-by-password-token
+     */
+    getCustomerByPasswordToken(options: CommonStoreEnabledRequestOptions & {
+        token: string;
+    }): Promise<Customer>;
+    /**
+     * Query customers:
+     * https://docs.commercetools.com/api/projects/customers#query-customers
+     */
+    queryCustomers(options: CommonStoreEnabledRequestOptions): Promise<CustomerPagedQueryResponse>;
+    /**
+     * Update a customer by id:
+     * https://docs.commercetools.com/api/projects/customers#update-customer-by-id
+     */
+    updateCustomerById(options: CommonStoreEnabledRequestOptions & {
+        id: string;
+        data: CustomerUpdate;
+    }): Promise<Customer>;
+    /**
+     * Update a customer by key:
+     * https://docs.commercetools.com/api/projects/customers#update-customer-by-key
+     */
+    updateCustomerByKey(options: CommonStoreEnabledRequestOptions & {
+        key: string;
+        data: CustomerUpdate;
+    }): Promise<Customer>;
+    /**
+     * Get a product type by id:
+     * https://docs.commercetools.com/api/projects/productTypes#get-a-producttype-by-id
+     */
+    getProductTypeById(options: CommonRequestOptions & {
+        id: string;
+    }): Promise<ProductType>;
+    /**
+     * Get a product type by key:
+     * https://docs.commercetools.com/api/projects/productTypes#get-a-producttype-by-key
+     */
+    getProductTypeByKey(options: CommonRequestOptions & {
+        key: string;
+    }): Promise<ProductType>;
+    /**
+     * Query product types:
+     * https://docs.commercetools.com/api/projects/productTypes#query-producttypes
+     */
+    queryProductTypes(options: CommonRequestOptions): Promise<ProductTypePagedQueryResponse>;
+    /**
+     * Get a type by id:
+     * https://docs.commercetools.com/api/projects/types#get-type-by-id
+     */
+    getTypeById(options: CommonRequestOptions & {
+        id: string;
+    }): Promise<Type>;
+    /**
+     * Get a type by key:
+     * https://docs.commercetools.com/api/projects/types#get-type-by-key
+     */
+    getTypeByKey(options: CommonRequestOptions & {
+        key: string;
+    }): Promise<Type>;
+    /**
+     * Query types:
+     * https://docs.commercetools.com/api/projects/types#query-types
+     */
+    queryTypes(options: CommonRequestOptions): Promise<TypePagedQueryResponse>;
+    /**
+     * Get a discount code by id:
+     * https://docs.commercetools.com/api/projects/discountCodes#get-discountcode-by-id
+     */
+    getDiscountCodeById(options: CommonRequestOptions & {
+        id: string;
+    }): Promise<DiscountCode>;
+    /**
+     * Get a cart discount code by id:
+     * https://docs.commercetools.com/api/projects/cartDiscounts#get-cartdiscount-by-id
+     */
+    getCartDiscountById(options: CommonRequestOptions & {
+        id: string;
+    }): Promise<CartDiscount>;
+    /**
+     * Get a cart discount by key:
+     * https://docs.commercetools.com/api/projects/cartDiscounts#get-cartdiscount-by-key
+     */
+    getCartDiscountByKey(options: CommonRequestOptions & {
+        key: string;
+    }): Promise<CartDiscount>;
+    /**
+     * Query cart discounts:
+     * https://docs.commercetools.com/api/projects/cartDiscounts#query-cartdiscounts
+     */
+    queryCartDiscounts(options?: CommonRequestOptions): Promise<CartDiscountPagedQueryResponse>;
+    /**
+     * Get a custom object
+     * https://docs.commercetools.com/api/projects/custom-objects#get-customobject-by-container-and-key
+     */
+    getCustomObject(options: CommonRequestOptions & {
+        container: string;
+        key: string;
+    }): Promise<CustomObject>;
+    /**
+     * Get a custom object by id
+     * https://docs.commercetools.com/api/projects/custom-objects#get-customobject
+     */
+    getCustomObjectById(options: CommonRequestOptions & {
+        id: string;
+    }): Promise<CustomObject>;
+    /**
+     * Save a custom object
+     * https://docs.commercetools.com/api/projects/custom-objects#create-or-update-a-customobject
+     */
+    saveCustomObject(options: CommonRequestOptions & {
+        data: CustomObjectDraft;
+    }): Promise<CustomObject>;
+    /**
+     * Delete a custom object
+     * https://docs.commercetools.com/api/projects/custom-objects#delete-customobject-by-container-and-key
+     */
+    deleteCustomObject(options: CommonRequestOptions & {
+        container: string;
+        key: string;
+    }): Promise<CustomObject>;
+    /**
+     * Get a shipping method by id:
+     * https://docs.commercetools.com/api/projects/shippingMethods#get-shippingmethod-by-id
+     */
+    getShippingMethodById(options: CommonRequestOptions & {
+        id: string;
+    }): Promise<ShippingMethod>;
+    /**
+     * Get a shipping method by key:
+     * https://docs.commercetools.com/api/projects/shippingMethods#get-shippingmethod-by-key
+     */
+    getShippingMethodByKey(options: CommonRequestOptions & {
+        key: string;
+    }): Promise<ShippingMethod>;
+    /**
+     * Get shipping method by location:
+     * https://docs.commercetools.com/api/projects/shippingMethods#get-shippingmethods-for-a-location
+     */
+    getShippingMethodsForLocation(options: CommonRequestOptions & {
+        country: string;
+        state?: string;
+        currency?: string;
+    }): Promise<ShippingMethodPagedQueryResponse>;
+    /**
+     * Get shipping methods applicable to a given cart id:
+     * https://docs.commercetools.com/api/projects/shippingMethods#get-shippingmethods-for-a-cart
+     */
+    getShippingMethodsForCart(options: CommonStoreEnabledRequestOptions & {
+        cartId: string;
+    }): Promise<ShippingMethodPagedQueryResponse>;
+    /**
+     * Get shipping methods applicable for a Cart and Location:
+     * https://docs.commercetools.com/api/projects/shippingMethods#for-a-cart-and-location
+     */
+    getShippingMethodsForCartAndLocation(options: CommonStoreEnabledRequestOptions & {
+        cartId: string;
+        country: string;
+        state?: string;
+    }): Promise<ShippingMethodPagedQueryResponse>;
+    /**
+     * Query shipping methods:
+     * https://docs.commercetools.com/api/projects/shippingMethods#query-shippingmethods
+     */
+    queryShippingMethods(options?: CommonRequestOptions): Promise<ShippingMethodPagedQueryResponse>;
+    /**
+     * Get an individual customer group by id:
+     * https://docs.commercetools.com/api/projects/customerGroups#get-customergroup-by-id
+     */
+    getCustomerGroupById(options: CommonRequestOptions & {
+        id: string;
+    }): Promise<CustomerGroup>;
+    /**
+     * Get an individual customer group by key:
+     * https://docs.commercetools.com/api/projects/customerGroups#get-customergroup-by-key
+     */
+    getCustomerGroupByKey(options: CommonRequestOptions & {
+        key: string;
+    }): Promise<CustomerGroup>;
+    /**
+     * Query customer groups:
+     * https://docs.commercetools.com/api/projects/customerGroups#query-customergroups
+     */
+    queryCustomerGroups(options?: CommonRequestOptions): Promise<CustomerGroupPagedQueryResponse>;
+    /**
+     * Create a customer group:
+     * https://docs.commercetools.com/api/projects/customerGroups#create-a-customergroup
+     */
+    createCustomerGroup(options: CommonRequestOptions & {
+        data: CustomerGroupDraft;
+    }): Promise<CustomerGroup>;
+    /**
+     * Update a customer group by key:
+     * https://docs.commercetools.com/api/projects/customerGroups#update-customergroup-by-key
+     */
+    updateCustomerGroupByKey(options: CommonRequestOptions & {
+        key: string;
+        data: CustomerGroupUpdate;
+    }): Promise<CustomerGroup>;
+    /**
+     * Update a customer group by id:
+     * https://docs.commercetools.com/api/projects/customerGroups#update-customergroup-by-id
+     */
+    updateCustomerGroupById(options: CommonRequestOptions & {
+        id: string;
+        data: CustomerGroupUpdate;
+    }): Promise<CustomerGroup>;
+    /**
+     * Delete a customer group by id:
+     * https://docs.commercetools.com/api/projects/customerGroups#delete-customergroup-by-id
+     */
+    deleteCustomerGroupById(options: CommonRequestOptions & {
+        id: string;
+        version: number;
+    }): Promise<CustomerGroup>;
+    /**
+     * Delete a customer group by key:
+     * https://docs.commercetools.com/api/projects/customerGroups#delete-customergroup-by-key
+     */
+    deleteCustomerGroupByKey(options: CommonRequestOptions & {
+        key: string;
+        version: number;
+    }): Promise<CustomerGroup>;
+    /**
+     * Get a state given it's id
+     * https://docs.commercetools.com/api/projects/states#get-state-by-id
+     */
+    getStateById(options: CommonRequestOptions & {
+        id: string;
+    }): Promise<State>;
+    /**
+     * Get a state given it's key
+     * https://docs.commercetools.com/api/projects/states#get-state-by-key
+     */
+    getStateByKey(options: CommonRequestOptions & {
+        key: string;
+    }): Promise<State>;
+    /**
+     * Query state
+     * https://docs.commercetools.com/api/projects/states#query-states
+     */
+    queryStates(options?: CommonRequestOptions): Promise<StatePagedQueryResponse>;
+    /**
+     * Get a standalone price given it's id
+     * https://docs.commercetools.com/api/projects/standalone-prices#get-standaloneprice-by-id
+     */
+    getStandalonePriceById(options: CommonRequestOptions & {
+        id: string;
+    }): Promise<StandalonePrice>;
+    /**
+     * Get a standalone price given it's key
+     * https://docs.commercetools.com/api/projects/standalone-prices#get-standaloneprice-by-key
+     */
+    getStandalonePriceByKey(options: CommonRequestOptions & {
+        key: string;
+    }): Promise<StandalonePrice>;
+    /**
+     * Query standalone prices
+     * https://docs.commercetools.com/api/projects/standalone-prices#query-standaloneprices
+     */
+    queryStandalonePrices(options?: CommonRequestOptions): Promise<StandalonePricePagedQueryResponse>;
+    /**
+     * Create a standalone price object:
+     * https://docs.commercetools.com/api/projects/standalone-prices#create-standaloneprice
+     */
+    createStandalonePrice(options: CommonRequestOptions & {
+        data: StandalonePriceDraft;
+    }): Promise<StandalonePrice>;
+    /**
+     * Update a standalone price object by id:
+     * https://docs.commercetools.com/api/projects/standalone-prices#update-standaloneprice-by-id
+     */
+    updateStandalonePriceById(options: CommonRequestOptions & {
+        id: string;
+        data: StandalonePriceUpdate;
+    }): Promise<StandalonePrice>;
+    /**
+     * Update a standalone price object by key:
+     * https://docs.commercetools.com/api/projects/standalone-prices#update-standaloneprice-by-key
+     */
+    updateStandalonePriceByKey(options: CommonRequestOptions & {
+        key: string;
+        data: StandalonePriceUpdate;
+    }): Promise<StandalonePrice>;
+    /**
+     * Delete a standalone price object by id:
+     * https://docs.commercetools.com/api/projects/standalone-prices#delete-standaloneprice-by-id
+     */
+    deleteStandalonePriceById(options: CommonRequestOptions & {
+        id: string;
+        version: number;
+    }): Promise<StandalonePrice>;
+    /**
+     * Delete a standalone price object by key:
+     * https://docs.commercetools.com/api/projects/standalone-prices#delete-standaloneprice-by-key
+     */
+    deleteStandalonePriceByKey(options: CommonRequestOptions & {
+        key: string;
+        version: number;
+    }): Promise<StandalonePrice>;
+    /**
+     * Execute a GraphQL statement:
+     * https://docs.commercetools.com/api/graphql
+     */
+    graphql(options: CommonRequestOptions & {
+        accessToken?: string;
+        data: GraphQLRequest;
+    }): Promise<GraphQLResponse>;
+    /**
+     * Make the request to the commercetools REST API.
+     */
+    request<T = any, R = any>(options: FetchOptions<T>): Promise<R>;
+    /**
+     * Generate request options. These are then fed in to axios when
+     * making the request to commercetools.
+     */
+    getRequestOptions(options: FetchOptions): Promise<CommercetoolsRequest>;
+    /**
+     * Type-guard against any additional unexpected properties being passed in.
+     */
+    extractCommonRequestOptions(options?: CommonRequestOptions): CommonRequestOptions;
+    /**
+     * Applies the store key to a given path
+     */
+    applyStore(path: string, storeKey: string | undefined | null): string;
+    /**
+     * 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: any): void;
+}
+//# sourceMappingURL=CommercetoolsApi.d.ts.map