ordercloud-javascript-sdk/dist/api/ProductCollections.d.ts

The offical Javascript SDK for the Ordercloud ecommerce API

import { ListPage } from '../models/ListPage';
import { Searchable } from '../models/Searchable';
import { Sortable } from '../models/Sortable';
import { Filters } from '../models/Filters';
import { ProductCollection } from '../models/ProductCollection';
import { ListPageWithFacets } from '../models/ListPageWithFacets';
import { ProductCollectionProduct } from '../models/ProductCollectionProduct';
import { SearchType } from '../models/SearchType';
import { RequiredDeep } from '../models/RequiredDeep';
import { RequestOptions } from '../models/RequestOptions';
declare class ProductCollections {
    private impersonating;
    /**
    * @ignore
    * not part of public api, don't include in generated docs
    */
    constructor();
    /**
     * List product collections
     * Check out the {@link https://ordercloud.io/api-reference/buyer/product-collections/list|api docs} for more info
     *
     * @param buyerID ID of the buyer.
     * @param listOptions.search Word or phrase to search for.
     * @param listOptions.searchOn Comma-delimited list of fields to search on.
     * @param listOptions.sortBy Comma-delimited list of fields to sort by.
     * @param listOptions.page Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
     * @param listOptions.pageSize Number of results to return per page.
     * @param listOptions.filters An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
     * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
     * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
     * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
     */
    List<TProductCollection extends ProductCollection>(buyerID: string, listOptions?: {
        search?: string;
        searchOn?: Searchable<'ProductCollections.List'>;
        sortBy?: Sortable<'ProductCollections.List'>;
        page?: number;
        pageSize?: number;
        filters?: Filters;
    }, requestOptions?: RequestOptions): Promise<RequiredDeep<ListPage<TProductCollection>>>;
    /**
     * Retrieve a product collection
     * Check out the {@link https://ordercloud.io/api-reference/buyer/product-collections/get|api docs} for more info
     *
     * @param buyerID ID of the buyer.
     * @param productCollectionID ID of the product collection.
     * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
     * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
     * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
     */
    Get<TProductCollection extends ProductCollection>(buyerID: string, productCollectionID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TProductCollection>>;
    /**
     * List product collection entries
     * Check out the {@link https://ordercloud.io/api-reference/buyer/product-collections/list-entries|api docs} for more info
     *
     * @param buyerID ID of the buyer.
     * @param productCollectionID ID of the product collection.
     * @param listOptions.search Word or phrase to search for.
     * @param listOptions.searchOn Comma-delimited list of fields to search on.
     * @param listOptions.searchType Type of search to perform.
     * @param listOptions.sortBy Comma-delimited list of fields to sort by.
     * @param listOptions.page Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
     * @param listOptions.pageSize Number of results to return per page.
     * @param listOptions.filters An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
     * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
     * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
     * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
     */
    ListEntries<TProductCollectionProduct extends ProductCollectionProduct>(buyerID: string, productCollectionID: string, listOptions?: {
        search?: string;
        searchOn?: Searchable<'ProductCollections.ListEntries'>;
        searchType?: SearchType;
        sortBy?: Sortable<'ProductCollections.ListEntries'>;
        page?: number;
        pageSize?: number;
        filters?: Filters;
    }, requestOptions?: RequestOptions): Promise<RequiredDeep<ListPageWithFacets<TProductCollectionProduct>>>;
    /**
     * @description
     * enables impersonation by calling the subsequent method with the stored impersonation token
     *
     * @example
     * ProductCollections.As().List() // lists ProductCollections using the impersonated users' token
     */
    As(): this;
}
declare const _default: ProductCollections;
export default _default;