Function CommentsApiFactory

Returns {
    commentsCreate(requestParameters, options?) => AxiosPromise<CommentRead>;
    commentsDestroy(requestParameters, options?) => AxiosPromise<void>;
    commentsList(requestParameters?, options?) => AxiosPromise<PaginatedCommentReadList>;
    commentsPartialUpdate(requestParameters, options?) => AxiosPromise<CommentRead>;
    commentsRetrieve(requestParameters, options?) => AxiosPromise<CommentRead>;
}

• commentsCreate:function

  • commentsCreate(requestParameters, options?): AxiosPromise<CommentRead>

  • Parameters

    • requestParameters: CommentsApiCommentsCreateRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<CommentRead>

    Summary

    Method creates a comment

    Throws

• commentsDestroy:function

  • commentsDestroy(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: CommentsApiCommentsDestroyRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Method deletes a comment

    Throws

• commentsList:function

  • commentsList(requestParameters?, options?): AxiosPromise<PaginatedCommentReadList>

  • Parameters

    • requestParameters: CommentsApiCommentsListRequest = {}

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<PaginatedCommentReadList>

    Summary

    Method returns a paginated list of comments

    Throws

• commentsPartialUpdate:function

  • commentsPartialUpdate(requestParameters, options?): AxiosPromise<CommentRead>

  • Parameters

    • requestParameters: CommentsApiCommentsPartialUpdateRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<CommentRead>

    Summary

    Methods does a partial update of chosen fields in a comment

    Throws

• commentsRetrieve:function

  • commentsRetrieve(requestParameters, options?): AxiosPromise<CommentRead>

  • Parameters

    • requestParameters: CommentsApiCommentsRetrieveRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<CommentRead>

    Summary

    Method returns details of a comment

    Throws