Class CommentsApi

CommentsApi - object-oriented interface

Export

Hierarchy

BaseAPI
- CommentsApi

Index

Constructors

constructor

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

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

commentsCreate

commentsCreate(requestParameters, options?): Promise<AxiosResponse<CommentRead, any>>
Parameters
- requestParameters: CommentsApiCommentsCreateRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<CommentRead, any>>

Summary
Method creates a comment

Throws

Memberof
CommentsApi
- Defined in api-client/comments-api.ts:691

commentsDestroy

commentsDestroy(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: CommentsApiCommentsDestroyRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
Method deletes a comment

Throws

Memberof
CommentsApi
- Defined in api-client/comments-api.ts:703

commentsList

commentsList(requestParameters?, options?): Promise<AxiosResponse<PaginatedCommentReadList, any>>
Parameters
- requestParameters: CommentsApiCommentsListRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<PaginatedCommentReadList, any>>

Summary
Method returns a paginated list of comments

Throws

Memberof
CommentsApi
- Defined in api-client/comments-api.ts:715

commentsPartialUpdate

commentsPartialUpdate(requestParameters, options?): Promise<AxiosResponse<CommentRead, any>>
Parameters
- requestParameters: CommentsApiCommentsPartialUpdateRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<CommentRead, any>>

Summary
Methods does a partial update of chosen fields in a comment

Throws

Memberof
CommentsApi
- Defined in api-client/comments-api.ts:727

commentsRetrieve

commentsRetrieve(requestParameters, options?): Promise<AxiosResponse<CommentRead, any>>
Parameters
- requestParameters: CommentsApiCommentsRetrieveRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<CommentRead, any>>

Summary
Method returns details of a comment

Throws

Memberof
CommentsApi
- Defined in api-client/comments-api.ts:739

Class CommentsApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional configuration: Configuration

basePath: string = BASE_PATH

axios: AxiosInstance = globalAxios

Returns CommentsApi

Properties

Protected axios

Protected basePath

Protected configuration

Methods

commentsCreate

Parameters

requestParameters: CommentsApiCommentsCreateRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<CommentRead, any>>

Summary

Throws

Memberof

commentsDestroy

Parameters

requestParameters: CommentsApiCommentsDestroyRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

commentsList

Parameters

requestParameters: CommentsApiCommentsListRequest = {}

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<PaginatedCommentReadList, any>>

Summary

Throws

Memberof

commentsPartialUpdate

Parameters

requestParameters: CommentsApiCommentsPartialUpdateRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<CommentRead, any>>

Summary

Throws

Memberof

commentsRetrieve

Parameters

requestParameters: CommentsApiCommentsRetrieveRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<CommentRead, any>>

Summary

Throws

Memberof

Settings

Member Visibility

Theme

On This Page

`Optional` configuration: Configuration

`Protected` axios

`Protected` basePath

`Protected` configuration

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>