gohl/dist/classes/blogs.d.ts

Go Highlevel Node Js ease of use library implementation to their API

import { AuthData } from "../interfaces/auth/authdata";
import { IBlog } from "../interfaces/blog";
export declare class Blog {
    private authData?;
    /**
     * Endpoints For Blogs
     * https://highlevel.stoplight.io/docs/integrations/4c364bc1d8c73-blogs-api
     */
    constructor(authData?: AuthData);
    /**
     * Get All Blog Categories. The "Get all categories" Api return the blog categoies for a given location ID. Please use "blogs/category.readonly"
     * Documentation - https://highlevel.stoplight.io/docs/integrations/8ebd3128ee462-get-all-categories
     * @param locationId
     * @param limit Number of categories to show in the listing
     * @param offset Number of categories to skip in listing
     */
    getAllCategories(locationId: string, limit?: number, offset?: number): Promise<any[]>;
    /**
     * Get All Blog Authors. The "Get all authors" Api return the blog authors for a given location ID. Please use "blogs/author.readonly"
     * Documentation - https://highlevel.stoplight.io/docs/integrations/8ebd3128ee462-get-all-categories
     * @param locationId
     * @param limit Number of categories to show in the listing
     * @param offset Number of categories to skip in listing
     */
    getAllAuthors(locationId: string, limit?: number, offset?: number): Promise<any[]>;
    /**
     * Create Blog
     * Documentation - https://highlevel.stoplight.io/docs/integrations/c24ff055e7cf8-create-blog-post
     * @param blog
     * @returns
     */
    add(blog: IBlog): Promise<any>;
    /**
     * Update Blog. The "Update Blog Post" API allows you create blog post for any given blog site. Please use blogs/post-update.write
     * Documentation - https://highlevel.stoplight.io/docs/integrations/9ac5fb40f9fb4-update-blog-post
     * @param blogId
     * @param blog
     * @returns
     */
    update(blogId: string, blog: IBlog): Promise<IBlog>;
    /**
     * Check url slug. The "Check url slug" API allows check the blog slug validation which is needed before publishing any blog post. Please use blogs/check-slug.readonly. you can find the POST ID from the post edit url.
     * Documentation - https://highlevel.stoplight.io/docs/integrations/6f776fbd6dd1f-delete-blog
     * @param blogId
     * @returns
     */
    isSlugUrlExists(locationId: string, urlSlug: string, postId?: string): Promise<boolean>;
}