IdeaCommentService

Index

Constructors

• constructor

Properties

• httpRequest

Methods

• ideaCommentCreate
• ideaCommentList
• ideaCommentRemove

Constructors

constructor

• new IdeaCommentService(httpRequest: BaseHttpRequest): IdeaCommentService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns IdeaCommentService

Properties

publicreadonlyhttpRequest

httpRequest: BaseHttpRequest

Methods

publicideaCommentCreate

• ideaCommentCreate(__namedParameters: { requestBody: CreateIdeaCommentParam }): CancelablePromise<{ data?: CreateIdeaCommentResponse }>

• Comment on an idea Bot-compatible Posts a comment on an idea.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: CreateIdeaCommentParam }

  Returns CancelablePromise<{ data?: CreateIdeaCommentResponse }>

  any Successfully commented on the idea.

publicideaCommentList

• ideaCommentList(__namedParameters: { ideaId: string; limit?: number; offset?: string }): CancelablePromise<{ data?: GetIdeaCommentListResponse }>

• List out idea comments Bot-compatible Lists out a given number of comments on an idea. This method uses the Swit API's pagination scheme.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { ideaId: string; limit?: number; offset?: string }

  Returns CancelablePromise<{ data?: GetIdeaCommentListResponse }>

  any Successfully retrieved the comments.

publicideaCommentRemove

• ideaCommentRemove(__namedParameters: { requestBody: DelIdeaCommentParam }): CancelablePromise<any>

• Delete an idea comment Bot-compatible Deletes a comment on an idea.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: DelIdeaCommentParam }

  Returns CancelablePromise<any>

  any Successfully deleted the comment.