Function CommentsApiAxiosParamCreator

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

• commentsCreate: ((commentWriteRequest, xOrganization?, org?, orgId?, options?) => Promise<RequestArgs>)

  • • (commentWriteRequest, xOrganization?, org?, orgId?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

      Summary

      Method creates a comment

      Throws

• commentsDestroy: ((id, options?) => Promise<RequestArgs>)

  • • (id, options?): Promise<RequestArgs>

    • Parameters

      • id: number

        A unique integer value identifying this comment.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method deletes a comment

      Throws

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

  • • (xOrganization?, filter?, frameId?, issueId?, jobId?, org?, orgId?, owner?, page?, pageSize?, search?, sort?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

      Summary

      Method returns a paginated list of comments

      Throws

• commentsPartialUpdate: ((id, patchedCommentWriteRequest?, options?) => Promise<RequestArgs>)

  • • (id, patchedCommentWriteRequest?, options?): Promise<RequestArgs>

    • Parameters

      • id: number

        A unique integer value identifying this comment.

      • Optional patchedCommentWriteRequest: PatchedCommentWriteRequest

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Methods does a partial update of chosen fields in a comment

      Throws

• commentsRetrieve: ((id, options?) => Promise<RequestArgs>)

  • • (id, options?): Promise<RequestArgs>

    • Parameters

      • id: number

        A unique integer value identifying this comment.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method returns details of a comment

      Throws