Class PostApi

PostApi - object-oriented interface

Export

Hierarchy

BaseAPI
- PostApi

Index

Constructors

Properties

axios basePath configuration

Methods

createPost deletePost getPost getPosts updatePost

Constructors

constructor

new PostApi(configuration?, basePath?, axios?): PostApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns PostApi
Inherited from BaseAPI.constructor
- Defined in client/base.ts:51

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

createPost

createPost(requestParameters, options?): Promise<AxiosResponse<Post, any>>
Parameters
- requestParameters: PostApiCreatePostRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<Post, any>>

Summary
記事を投稿する

Throws

Memberof
PostApi
- Defined in client/api/post-api.ts:941

deletePost

deletePost(requestParameters, options?): Promise<AxiosResponse<void, any>>
指定された記事を削除します。
Parameters
- requestParameters: PostApiDeletePostRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
記事を削除する

Throws

Memberof
PostApi
- Defined in client/api/post-api.ts:962

getPost

getPost(requestParameters, options?): Promise<AxiosResponse<Post, any>>
指定された記事を取得します。
Parameters
- requestParameters: PostApiGetPostRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<Post, any>>

Summary
記事を取得する

Throws

Memberof
PostApi
- Defined in client/api/post-api.ts:983

getPosts

getPosts(requestParameters, options?): Promise<AxiosResponse<PaginatedPosts, any>>
Parameters
- requestParameters: PostApiGetPostsRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<PaginatedPosts, any>>

Summary
記事一覧を取得する

Throws

Memberof
PostApi
- Defined in client/api/post-api.ts:1002

updatePost

updatePost(requestParameters, options?): Promise<AxiosResponse<Post, any>>
指定された記事を編集します。
Parameters
- requestParameters: PostApiUpdatePostRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<Post, any>>

Summary
記事を編集する

Throws

Memberof
PostApi
- Defined in client/api/post-api.ts:1025

Generated using TypeDoc