Class Blogs

Blogs resource handler

Index

Constructors

Methods

create createArticle createComment delete deleteArticle deleteComment get getArticle getComment getCommentCount list listArticles listComments spamCheck update updateArticle updateComment

Constructors

constructor

new Blogs(client): Blogs
Parameters
- client: SapoClient
Returns Blogs
- Defined in resources/blogs.ts:20

Methods

create

create(data): Promise<Blog>
Create a new blog
Parameters
- data: CreateBlogData
  Blog creation data
Returns Promise<Blog>
- Defined in resources/blogs.ts:43

createArticle

createArticle(blogId, data): Promise<Article>
Create an article
Parameters
- blogId: number
  Blog ID
- data: CreateArticleData
  Article creation data
Returns Promise<Article>
- Defined in resources/blogs.ts:99

createComment

createComment(blogId, articleId, data): Promise<Comment>
Create a comment
Parameters
- blogId: number
  Blog ID
- articleId: number
  Article ID
- data: CreateCommentData
  Comment creation data
Returns Promise<Comment>
- Defined in resources/blogs.ts:167

delete

delete(id): Promise<void>
Delete a blog
Parameters
- id: number
  Blog ID
Returns Promise<void>
- Defined in resources/blogs.ts:66

deleteArticle

deleteArticle(blogId, id): Promise<void>
Delete an article
Parameters
- blogId: number
  Blog ID
- id: number
  Article ID
Returns Promise<void>
- Defined in resources/blogs.ts:130

deleteComment

deleteComment(blogId, articleId, id): Promise<void>
Delete a comment
Parameters
- blogId: number
  Blog ID
- articleId: number
  Article ID
- id: number
  Comment ID
Returns Promise<void>
- Defined in resources/blogs.ts:205

get

get(id): Promise<Blog>
Get a single blog
Parameters
- id: number
  Blog ID
Returns Promise<Blog>
- Defined in resources/blogs.ts:34

getArticle

getArticle(blogId, id): Promise<Article>
Get a single article
Parameters
- blogId: number
  Blog ID
- id: number
  Article ID
Returns Promise<Article>
- Defined in resources/blogs.ts:87

getComment

getComment(blogId, articleId, id): Promise<Comment>
Get a single comment
Parameters
- blogId: number
  Blog ID
- articleId: number
  Article ID
- id: number
  Comment ID
Returns Promise<Comment>
- Defined in resources/blogs.ts:154

getCommentCount

getCommentCount(blogId, articleId, params?): Promise<number>
Get comment count for an article
Parameters
- blogId: number
  Blog ID
- articleId: number
  Article ID
- Optional params: Partial<CommentListParams>
  Filter parameters
Returns Promise<number>
- Defined in resources/blogs.ts:215

list

list(params?): Promise<PaginatedResponse<Blog>>
List blogs
Parameters
- Optional params: BlogListParams
  Query parameters
Returns Promise<PaginatedResponse<Blog>>
- Defined in resources/blogs.ts:26

listArticles

listArticles(blogId, params?): Promise<PaginatedResponse<Article>>
List articles for a blog
Parameters
- blogId: number
  Blog ID
- Optional params: ArticleListParams
  Query parameters
Returns Promise<PaginatedResponse<Article>>
- Defined in resources/blogs.ts:75

listComments

listComments(blogId, articleId, params?): Promise<PaginatedResponse<Comment>>
List comments for an article
Parameters
- blogId: number
  Blog ID
- articleId: number
  Article ID
- Optional params: CommentListParams
  Query parameters
Returns Promise<PaginatedResponse<Comment>>
- Defined in resources/blogs.ts:140

spamCheck

spamCheck(blogId, articleId, id): Promise<{
score: number;
spam: boolean;
}>
Spam check a comment
Parameters
- blogId: number
  Blog ID
- articleId: number
  Article ID
- id: number
  Comment ID
Returns Promise<{
score: number;
spam: boolean;
}>
- Defined in resources/blogs.ts:233

update

update(id, data): Promise<Blog>
Update a blog
Parameters
- id: number
  Blog ID
- data: Partial<CreateBlogData>
  Blog update data
Returns Promise<Blog>
- Defined in resources/blogs.ts:55

updateArticle

updateArticle(blogId, id, data): Promise<Article>
Update an article
Parameters
- blogId: number
  Blog ID
- id: number
  Article ID
- data: Partial<CreateArticleData>
  Article update data
Returns Promise<Article>
- Defined in resources/blogs.ts:113

updateComment

updateComment(blogId, articleId, id, data): Promise<Comment>
Update a comment
Parameters
- blogId: number
  Blog ID
- articleId: number
  Article ID
- id: number
  Comment ID
- data: Partial<CreateCommentData>
  Comment update data
Returns Promise<Comment>
- Defined in resources/blogs.ts:186