Function CommentsApiFp

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

• commentsCreate:function

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

    Parameters

    • commentWriteRequest: CommentWriteRequest
    • OptionalxOrganization: string

      Organization unique slug
    • Optionalorg: string

      Organization unique slug
    • OptionalorgId: number

      Organization identifier
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• commentsDestroy:function

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

    Parameters

    • id: number

      A unique integer value identifying this comment.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• commentsList:function

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

    Parameters

    • OptionalxOrganization: string

      Organization unique slug
    • Optionalfilter: 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;].
    • OptionalframeId: number

      A simple equality filter for the frame_id field
    • OptionalissueId: number

      A simple equality filter for the issue_id field
    • OptionaljobId: number

      A simple equality filter for the job_id field
    • Optionalorg: string

      Organization unique slug
    • OptionalorgId: number

      Organization identifier
    • Optionalowner: string

      A simple equality filter for the owner field
    • Optionalpage: number

      A page number within the paginated result set.
    • OptionalpageSize: number

      Number of results to return per page.
    • Optionalsearch: string

      A search term. Available search_fields: (&#39;owner&#39;,)
    • Optionalsort: 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;]
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• commentsPartialUpdate:function

  • commentsPartialUpdate(
        id: number,
        patchedCommentWriteRequest?: PatchedCommentWriteRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommentRead>,
    >

    Parameters

    • id: number

      A unique integer value identifying this comment.
    • OptionalpatchedCommentWriteRequest: PatchedCommentWriteRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• commentsRetrieve:function

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

    Parameters

    • id: number

      A unique integer value identifying this comment.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws