Function CommentsApiFp

Returns {
    commentsCreate(commentWriteRequest, xOrganization?, org?, orgId?, options?) => Promise<((axios?, basePath?) => AxiosPromise<CommentRead>)>;
    commentsDestroy(id, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    commentsList(xOrganization?, filter?, frameId?, issueId?, jobId?, org?, orgId?, owner?, page?, pageSize?, search?, sort?, options?) => Promise<((axios?, basePath?) => AxiosPromise<PaginatedCommentReadList>)>;
    commentsPartialUpdate(id, patchedCommentWriteRequest?, options?) => Promise<((axios?, basePath?) => AxiosPromise<CommentRead>)>;
    commentsRetrieve(id, options?) => Promise<((axios?, basePath?) => AxiosPromise<CommentRead>)>;
}

• commentsCreate:function

  • commentsCreate(commentWriteRequest, xOrganization?, org?, orgId?, options?): Promise<((axios?, basePath?) => AxiosPromise<CommentRead>)>

  • Parameters

    • commentWriteRequest: CommentWriteRequest

    • Optional xOrganization: string

      Organization unique slug

    • Optional org: string

      Organization unique slug

    • Optional orgId: number

      Organization identifier

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<CommentRead>)>

    Summary

    Method creates a comment

    Throws

• commentsDestroy:function

  • commentsDestroy(id, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Parameters

    • id: number

      A unique integer value identifying this comment.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Method deletes a comment

    Throws

• commentsList:function

  • commentsList(xOrganization?, filter?, frameId?, issueId?, jobId?, org?, orgId?, owner?, page?, pageSize?, search?, sort?, options?): Promise<((axios?, basePath?) => AxiosPromise<PaginatedCommentReadList>)>

  • Parameters

    • Optional xOrganization: string

      Organization unique slug

    • Optional filter: string

      JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. For example, using such a filter you can get all resources created by you: - {&quot;and&quot;:[{&quot;==&quot;:[{&quot;var&quot;:&quot;owner&quot;},&quot;<user>&quot;]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [&#39;owner&#39;, &#39;id&#39;, &#39;issue_id&#39;, &#39;frame_id&#39;, &#39;job_id&#39;].

    • Optional frameId: number

      A simple equality filter for the frame_id field

    • Optional issueId: number

      A simple equality filter for the issue_id field

    • Optional jobId: number

      A simple equality filter for the job_id field

    • Optional org: string

      Organization unique slug

    • Optional orgId: number

      Organization identifier

    • Optional owner: string

      A simple equality filter for the owner field

    • Optional page: number

      A page number within the paginated result set.

    • Optional pageSize: number

      Number of results to return per page.

    • Optional search: string

      A search term. Available search_fields: (&#39;owner&#39;,)

    • Optional sort: string

      Which field to use when ordering the results. Available ordering_fields: [&#39;owner&#39;, &#39;id&#39;, &#39;issue_id&#39;, &#39;frame_id&#39;, &#39;job_id&#39;]

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<PaginatedCommentReadList>)>

    Summary

    Method returns a paginated list of comments

    Throws

• commentsPartialUpdate:function

  • commentsPartialUpdate(id, patchedCommentWriteRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<CommentRead>)>

  • Parameters

    • id: number

      A unique integer value identifying this comment.

    • Optional patchedCommentWriteRequest: PatchedCommentWriteRequest

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<CommentRead>)>

    Summary

    Methods does a partial update of chosen fields in a comment

    Throws

• commentsRetrieve:function

  • commentsRetrieve(id, options?): Promise<((axios?, basePath?) => AxiosPromise<CommentRead>)>

  • Parameters

    • id: number

      A unique integer value identifying this comment.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<CommentRead>)>

    Summary

    Method returns details of a comment

    Throws