intercom-client
Version:
Official Node bindings to the Intercom API
36 lines (35 loc) • 1.97 kB
TypeScript
import type * as Intercom from "../index.js";
/**
* You can create an Article
*/
export interface CreateArticleRequest {
/** The title of the article.For multilingual articles, this will be the title of the default language's content. */
title: string;
/** The description of the article. For multilingual articles, this will be the description of the default language's content. */
description?: string;
/** The content of the article. For multilingual articles, this will be the body of the default language's content. */
body?: string;
/** The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace. */
author_id: number;
/** Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content. */
state?: CreateArticleRequest.State;
/** The id of the article's parent collection or section. An article without this field stands alone. */
parent_id?: number;
/** The type of parent, which can either be a `collection` or `section`. */
parent_type?: CreateArticleRequest.ParentType;
translated_content?: Intercom.ArticleTranslatedContent;
}
export declare namespace CreateArticleRequest {
/** Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content. */
const State: {
readonly Published: "published";
readonly Draft: "draft";
};
type State = (typeof State)[keyof typeof State];
/** The type of parent, which can either be a `collection` or `section`. */
const ParentType: {
readonly Collection: "collection";
readonly Section: "section";
};
type ParentType = (typeof ParentType)[keyof typeof ParentType];
}