inventora-shopify-admin-api/dist/services/smart_collections.d.ts

Shopify Admin API is a NodeJS library built to help developers easily authenticate and make calls against the Shopify API. It was inspired by and borrows heavily from ShopifySharp.

import * as Options from '../options';
import { BaseService } from '../infrastructure';
import { SmartCollection } from '../interfaces';
export declare class SmartCollections extends BaseService {
    constructor(shopDomain: string, accessToken: string);
    /**
     * Get a count of all smart collections that contain a given product
     * @param options Options for filtering the results.
     * @see https://help.shopify.com/api/reference/smartcollection#count
     */
    count(options?: Options.CollectionCountOptions): Promise<number>;
    /**
     * Get a list of all smart collections that contain a given product
     * @param options Options for filtering the results.
     */
    list(options?: Options.CollectionListOptions): Promise<SmartCollection[]>;
    /**
     * Get a single collection
     * @param id The collection's id.
     * @param options Options for filtering the results.
     */
    get(id: number, options?: Options.CollectionGetOptions): Promise<SmartCollection>;
    /**
     * Create a new smart collection.
     * @param collection The collection being created.
     * @param options Options for creating the collection.
     */
    create(collection: Partial<SmartCollection>): Promise<SmartCollection>;
    /**
     * Updates an collection with the given id.
     * @param id The collection's id.
     * @param collection The updated collection.
     */
    update(id: number, collection: Partial<SmartCollection>): Promise<SmartCollection>;
    /**
     * Deletes an collection with the given id.
     * @param id The collection's id.
     */
    delete(id: number): Promise<void>;
}
export default SmartCollections;