inventora-shopify-admin-api/dist/services/blogs.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 { Blog } from '../interfaces';
/**
 * A service for manipulating a Shopify shop's blogs. For manipulating a blog's posts, use the Articles class instead.
 */
export declare class Blogs extends BaseService {
    constructor(shopDomain: string, accessToken: string);
    /**
     * Creates a new blog.
     * @param blog The Blog being created.
     */
    create(blog: Partial<Blog>): Promise<Blog>;
    /**
     * Gets a blog with the given id.
     * @param id Id of the blog to retrieve.
     * @param options Options for filtering the result.
     */
    get(id: number, options?: Options.BlogGetOptions): Promise<Blog>;
    /**
     * Updates the blog with the given id.
     * @param id Id of the blog being updated.
     * @param blog The updated blog.
     */
    update(id: number, blog: Partial<Blog>): Promise<Blog>;
    /**
     * Gets a list of all blogs on the shop.
     * @param options Options for filtering the results.
     */
    list(options?: Options.BlogListOptions): Promise<Blog[]>;
    /**
     * Gets a count of all blogs on the shop.
     */
    count(options?: Options.BlogCountOptions): Promise<number>;
    /**
     * Deletes the blog with the given id.
     * @param id Id of the blog being deleted.
     */
    delete(id: number): Promise<void>;
}
export default Blogs;