Class CommentsApi

CommentsApi - object-oriented interface

Export

CommentsApi

Hierarchy

BaseAPI
- CommentsApi

Index

Constructors

constructor

new CommentsApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): CommentsApi
Parameters
- Optionalconfiguration: 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: CommentsApiCommentsCreateRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<CommentRead, any>>
Parameters
- requestParameters: CommentsApiCommentsCreateRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CommentRead, any>>
Throws
Memberof
CommentsApi
- Defined in api-client/comments-api.ts:699

commentsDestroy

commentsDestroy(
requestParameters: CommentsApiCommentsDestroyRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: CommentsApiCommentsDestroyRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
CommentsApi
- Defined in api-client/comments-api.ts:711

commentsList

commentsList(
requestParameters?: CommentsApiCommentsListRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PaginatedCommentReadList, any>>
Parameters
- requestParameters: CommentsApiCommentsListRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PaginatedCommentReadList, any>>
Throws
Memberof
CommentsApi
- Defined in api-client/comments-api.ts:723

commentsPartialUpdate

commentsPartialUpdate(
requestParameters: CommentsApiCommentsPartialUpdateRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<CommentRead, any>>
Parameters
- requestParameters: CommentsApiCommentsPartialUpdateRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CommentRead, any>>
Throws
Memberof
CommentsApi
- Defined in api-client/comments-api.ts:735

commentsRetrieve

commentsRetrieve(
requestParameters: CommentsApiCommentsRetrieveRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<CommentRead, any>>
Parameters
- requestParameters: CommentsApiCommentsRetrieveRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CommentRead, any>>
Throws
Memberof
CommentsApi
- Defined in api-client/comments-api.ts:747

Class CommentsApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CommentsApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

commentsCreate

Parameters

Returns Promise<AxiosResponse<CommentRead, any>>

Throws

Memberof

commentsDestroy

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

commentsList

Parameters

Returns Promise<AxiosResponse<PaginatedCommentReadList, any>>

Throws

Memberof

commentsPartialUpdate

Parameters

Returns Promise<AxiosResponse<CommentRead, any>>

Throws

Memberof

commentsRetrieve

Parameters

Returns Promise<AxiosResponse<CommentRead, any>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration