Class CommentApi

Hierarchy

BaseAPI
- CommentApi

Constructors

constructor

new CommentApi(configuration?: Configuration): CommentApi
Parameters
- configuration: Configuration = DefaultConfig
Returns CommentApi
Inherited from BaseAPI.constructor
- Defined in runtime.ts:96

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

addAttachment

addAttachment(requestParameters: AddAttachmentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTCommentInfo>
Update a user’s comment by comment ID.
Parameters
- requestParameters: AddAttachmentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTCommentInfo>
- Defined in apis/CommentApi.ts:145

addAttachmentRaw

addAttachmentRaw(requestParameters: AddAttachmentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTCommentInfo>>
Update a user’s comment by comment ID.
Parameters
- requestParameters: AddAttachmentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTCommentInfo>>
- Defined in apis/CommentApi.ts:90

createComment

createComment(requestParameters: CreateCommentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTCommentInfo>
Update a document with a new comment.
Parameters
- requestParameters: CreateCommentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTCommentInfo>
- Defined in apis/CommentApi.ts:186

createCommentRaw

createCommentRaw(requestParameters: CreateCommentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTCommentInfo>>
Update a document with a new comment.
Parameters
- requestParameters: CreateCommentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTCommentInfo>>
- Defined in apis/CommentApi.ts:153

deleteAttachments

deleteAttachments(requestParameters: DeleteAttachmentsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Delete an attachment from a comment by comment ID.
Parameters
- requestParameters: DeleteAttachmentsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/CommentApi.ts:224

deleteAttachmentsRaw

deleteAttachmentsRaw(requestParameters: DeleteAttachmentsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Delete an attachment from a comment by comment ID.
Parameters
- requestParameters: DeleteAttachmentsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/CommentApi.ts:194

deleteComment

deleteComment(requestParameters: DeleteCommentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Delete a comment by comment ID.
Parameters
- requestParameters: DeleteCommentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/CommentApi.ts:262

deleteCommentRaw

deleteCommentRaw(requestParameters: DeleteCommentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Delete a comment by comment ID.
Parameters
- requestParameters: DeleteCommentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/CommentApi.ts:232

getAttachment

getAttachment(requestParameters: GetAttachmentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Retrieve an attachment associated with a comment by comment ID and file document ID (and extension).
Parameters
- requestParameters: GetAttachmentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/CommentApi.ts:308

getAttachmentRaw

getAttachmentRaw(requestParameters: GetAttachmentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Retrieve an attachment associated with a comment by comment ID and file document ID (and extension).
Parameters
- requestParameters: GetAttachmentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/CommentApi.ts:270

getComment

getComment(requestParameters: GetCommentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTCommentInfo>
Retrieve details for a comment by comment ID.
Parameters
- requestParameters: GetCommentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTCommentInfo>
- Defined in apis/CommentApi.ts:346

getCommentRaw

getCommentRaw(requestParameters: GetCommentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTCommentInfo>>
Retrieve details for a comment by comment ID.
Parameters
- requestParameters: GetCommentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTCommentInfo>>
- Defined in apis/CommentApi.ts:316

getComments

getComments(requestParameters?: GetCommentsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTListResponseBTCommentInfo>
Retrieve a list of comments for a document.
Parameters
- requestParameters: GetCommentsRequest = {}
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTListResponseBTCommentInfo>
- Defined in apis/CommentApi.ts:412

getCommentsRaw

getCommentsRaw(requestParameters: GetCommentsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTListResponseBTCommentInfo>>
Retrieve a list of comments for a document.
Parameters
- requestParameters: GetCommentsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTListResponseBTCommentInfo>>
- Defined in apis/CommentApi.ts:354

reopen

reopen(requestParameters: ReopenRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTCommentInfo>
Reopen a resolved comment by comment ID.
Parameters
- requestParameters: ReopenRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTCommentInfo>
- Defined in apis/CommentApi.ts:450

reopenRaw

reopenRaw(requestParameters: ReopenRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTCommentInfo>>
Reopen a resolved comment by comment ID.
Parameters
- requestParameters: ReopenRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTCommentInfo>>
- Defined in apis/CommentApi.ts:420

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in runtime.ts:116

resolve

resolve(requestParameters: ResolveRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTCommentInfo>
Resolve a comment by comment ID.
Parameters
- requestParameters: ResolveRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTCommentInfo>
- Defined in apis/CommentApi.ts:488

resolveRaw

resolveRaw(requestParameters: ResolveRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTCommentInfo>>
Resolve a comment by comment ID.
Parameters
- requestParameters: ResolveRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTCommentInfo>>
- Defined in apis/CommentApi.ts:458

updateComment

updateComment(requestParameters: UpdateCommentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTCommentInfo>
Update a user’s comment by comment ID.
Parameters
- requestParameters: UpdateCommentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTCommentInfo>
- Defined in apis/CommentApi.ts:533

updateCommentRaw

updateCommentRaw(requestParameters: UpdateCommentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTCommentInfo>>
Update a user’s comment by comment ID.
Parameters
- requestParameters: UpdateCommentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTCommentInfo>>
- Defined in apis/CommentApi.ts:496

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in runtime.ts:100

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in runtime.ts:111

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in runtime.ts:106

Generated using TypeDoc