inventora-shopify-admin-api/dist/services/pages.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 { Page } from '../interfaces';
/**
 * A service for manipulating Shopify pages.
 */
export declare class Pages extends BaseService {
    constructor(shopDomain: string, accessToken: string);
    /**
     * Creates a new page.
     * @param page The page being created.
     */
    create(page: Partial<Page>): Promise<Page>;
    /**
     * Retrieves a single page by its ID.
     * @param id Id of the page to retrieve.
     * @param options Options for filtering the result.
     */
    get(id: number, options?: Options.PageGetOptions): Promise<Partial<Page>>;
    /**
     * Updates a page with the given id.
     * @param id Id of the page being updated.
     * @param page The updated page.
     */
    update(id: number, page: Partial<Page>): Promise<Page>;
    /**
     * Retrieve a list of all pages.
     * @param options Options for filtering the results.
     */
    list(options?: Options.PageListOptions): Promise<Partial<Page>[]>;
    /**
     * Retrieves a page count.
     */
    count(options?: Options.PageCountOptions): Promise<number>;
    /**
     * Deletes a page with the given id.
     * @param id Id of the page being deleted.
     */
    delete(id: number): Promise<{
        id: number;
    }>;
}
export default Page;