Function IssuesApiAxiosParamCreator

  • IssuesApi - axios parameter creator

    Parameters

    Returns {
        issuesCreate: ((issueWriteRequest, xOrganization?, org?, orgId?, options?) => Promise<RequestArgs>);
        issuesDestroy: ((id, options?) => Promise<RequestArgs>);
        issuesList: ((xOrganization?, assignee?, filter?, frameId?, jobId?, org?, orgId?, owner?, page?, pageSize?, resolved?, search?, sort?, taskId?, options?) => Promise<RequestArgs>);
        issuesPartialUpdate: ((id, patchedIssueWriteRequest?, options?) => Promise<RequestArgs>);
        issuesRetrieve: ((id, options?) => Promise<RequestArgs>);
    }

    • issuesCreate: ((issueWriteRequest, xOrganization?, org?, orgId?, options?) => Promise<RequestArgs>)
        • (issueWriteRequest, xOrganization?, org?, orgId?, options?): Promise<RequestArgs>
        • Parameters

          • issueWriteRequest: IssueWriteRequest
          • 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 an issue

          Throws

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

          • id: number

            A unique integer value identifying this issue.

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          Method deletes an issue

          Throws

    • issuesList: ((xOrganization?, assignee?, filter?, frameId?, jobId?, org?, orgId?, owner?, page?, pageSize?, resolved?, search?, sort?, taskId?, options?) => Promise<RequestArgs>)
        • (xOrganization?, assignee?, filter?, frameId?, jobId?, org?, orgId?, owner?, page?, pageSize?, resolved?, search?, sort?, taskId?, options?): Promise<RequestArgs>
        • Parameters

          • Optional xOrganization: string

            Organization unique slug

          • Optional assignee: string

            A simple equality filter for the assignee field

          • 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;assignee&#39;, &#39;id&#39;, &#39;job_id&#39;, &#39;task_id&#39;, &#39;resolved&#39;, &#39;frame_id&#39;].

          • Optional frameId: number

            A simple equality filter for the frame_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 resolved: boolean

            A simple equality filter for the resolved field

          • Optional search: string

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

          • Optional sort: string

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

          • Optional taskId: number

            A simple equality filter for the task_id field

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          Method returns a paginated list of issues

          Throws

    • issuesPartialUpdate: ((id, patchedIssueWriteRequest?, options?) => Promise<RequestArgs>)
        • (id, patchedIssueWriteRequest?, options?): Promise<RequestArgs>
        • Parameters

          • id: number

            A unique integer value identifying this issue.

          • Optional patchedIssueWriteRequest: PatchedIssueWriteRequest
          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          Methods does a partial update of chosen fields in an issue

          Throws

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

          • id: number

            A unique integer value identifying this issue.

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          Method returns details of an issue

          Throws

    Export

Generated using TypeDoc