Function QualityApiFp

QualityApi - functional programming interface

Export

QualityApiFp(
    configuration?: Configuration,
): {
    qualityCreateReport(
        rqId?: string,
        qualityReportCreateRequest?: QualityReportCreateRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<QualityReport>,
    >;
    qualityListConflicts(
        xOrganization?: string,
        filter?: string,
        frame?: number,
        jobId?: number,
        org?: string,
        orgId?: number,
        page?: number,
        pageSize?: number,
        reportId?: number,
        severity?: QualityListConflictsSeverityEnum,
        sort?: string,
        taskId?: number,
        type?: QualityListConflictsTypeEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedAnnotationConflictList>,
    >;
    qualityListReports(
        xOrganization?: string,
        filter?: string,
        jobId?: number,
        org?: string,
        orgId?: number,
        page?: number,
        pageSize?: number,
        parentId?: number,
        sort?: string,
        target?: string,
        taskId?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedQualityReportList>,
    >;
    qualityListSettings(
        xOrganization?: string,
        filter?: string,
        org?: string,
        orgId?: number,
        page?: number,
        pageSize?: number,
        sort?: string,
        taskId?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedQualitySettingsList>,
    >;
    qualityPartialUpdateSettings(
        id: number,
        patchedQualitySettingsRequest?: PatchedQualitySettingsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<QualitySettings>,
    >;
    qualityRetrieveReport(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<QualityReport>,
    >;
    qualityRetrieveReportData(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>,
    >;
    qualityRetrieveSettings(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<QualitySettings>,
    >;
}
Parameters
- Optionalconfiguration: Configuration
Returns {
    qualityCreateReport(
        rqId?: string,
        qualityReportCreateRequest?: QualityReportCreateRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<QualityReport>,
    >;
    qualityListConflicts(
        xOrganization?: string,
        filter?: string,
        frame?: number,
        jobId?: number,
        org?: string,
        orgId?: number,
        page?: number,
        pageSize?: number,
        reportId?: number,
        severity?: QualityListConflictsSeverityEnum,
        sort?: string,
        taskId?: number,
        type?: QualityListConflictsTypeEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedAnnotationConflictList>,
    >;
    qualityListReports(
        xOrganization?: string,
        filter?: string,
        jobId?: number,
        org?: string,
        orgId?: number,
        page?: number,
        pageSize?: number,
        parentId?: number,
        sort?: string,
        target?: string,
        taskId?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedQualityReportList>,
    >;
    qualityListSettings(
        xOrganization?: string,
        filter?: string,
        org?: string,
        orgId?: number,
        page?: number,
        pageSize?: number,
        sort?: string,
        taskId?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedQualitySettingsList>,
    >;
    qualityPartialUpdateSettings(
        id: number,
        patchedQualitySettingsRequest?: PatchedQualitySettingsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<QualitySettings>,
    >;
    qualityRetrieveReport(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<QualityReport>,
    >;
    qualityRetrieveReportData(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>,
    >;
    qualityRetrieveSettings(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<QualitySettings>,
    >;
}
- qualityCreateReport:function
  - qualityCreateReport(
        rqId?: string,
        qualityReportCreateRequest?: QualityReportCreateRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<QualityReport>,
    >
    Parameters
    OptionalrqId: string
    The report creation request id. Can be specified to check the report creation status.
    
    OptionalqualityReportCreateRequest: QualityReportCreateRequest
    Optionaloptions: RawAxiosRequestConfig
    Override http request option.
    
    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<QualityReport>,
    >
    Throws
    Defined in api-client/quality-api.ts:605
- qualityListConflicts:function
  - qualityListConflicts(
        xOrganization?: string,
        filter?: string,
        frame?: number,
        jobId?: number,
        org?: string,
        orgId?: number,
        page?: number,
        pageSize?: number,
        reportId?: number,
        severity?: QualityListConflictsSeverityEnum,
        sort?: string,
        taskId?: number,
        type?: QualityListConflictsTypeEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedAnnotationConflictList>,
    >
    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: - {"and":[{"==":[{"var":"owner"},"<user>"]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: ['id', 'frame', 'type', 'job_id', 'task_id', 'severity'].
    
    Optionalframe: number
    A simple equality filter for the frame field
    
    OptionaljobId: number
    A simple equality filter for the job_id field
    
    Optionalorg: string
    Organization unique slug
    
    OptionalorgId: number
    Organization identifier
    
    Optionalpage: number
    A page number within the paginated result set.
    
    OptionalpageSize: number
    Number of results to return per page.
    
    OptionalreportId: number
    A simple equality filter for report id
    
    Optionalseverity: QualityListConflictsSeverityEnum
    A simple equality filter for the severity field
    
    Optionalsort: string
    Which field to use when ordering the results. Available ordering_fields: ['id', 'frame', 'type', 'job_id', 'task_id', 'severity']
    
    OptionaltaskId: number
    A simple equality filter for the task_id field
    
    Optionaltype: QualityListConflictsTypeEnum
    A simple equality filter for the type field
    
    Optionaloptions: RawAxiosRequestConfig
    Override http request option.
    
    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedAnnotationConflictList>,
    >
    Throws
    Defined in api-client/quality-api.ts:630
- qualityListReports:function
  - qualityListReports(
        xOrganization?: string,
        filter?: string,
        jobId?: number,
        org?: string,
        orgId?: number,
        page?: number,
        pageSize?: number,
        parentId?: number,
        sort?: string,
        target?: string,
        taskId?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedQualityReportList>,
    >
    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: - {"and":[{"==":[{"var":"owner"},"<user>"]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: ['id', 'job_id', 'created_date', 'gt_last_updated', 'target_last_updated', 'parent_id'].
    
    OptionaljobId: number
    A simple equality filter for the job_id field
    
    Optionalorg: string
    Organization unique slug
    
    OptionalorgId: number
    Organization identifier
    
    Optionalpage: number
    A page number within the paginated result set.
    
    OptionalpageSize: number
    Number of results to return per page.
    
    OptionalparentId: number
    A simple equality filter for the parent_id field
    
    Optionalsort: string
    Which field to use when ordering the results. Available ordering_fields: ['id', 'job_id', 'created_date', 'gt_last_updated', 'target_last_updated', 'parent_id']
    
    Optionaltarget: string
    A simple equality filter for target
    
    OptionaltaskId: number
    A simple equality filter for task id
    
    Optionaloptions: RawAxiosRequestConfig
    Override http request option.
    
    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedQualityReportList>,
    >
    Throws
    Defined in api-client/quality-api.ts:653
- qualityListSettings:function
  - qualityListSettings(
        xOrganization?: string,
        filter?: string,
        org?: string,
        orgId?: number,
        page?: number,
        pageSize?: number,
        sort?: string,
        taskId?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedQualitySettingsList>,
    >
    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: - {"and":[{"==":[{"var":"owner"},"<user>"]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: ['id', 'task_id'].
    
    Optionalorg: string
    Organization unique slug
    
    OptionalorgId: number
    Organization identifier
    
    Optionalpage: number
    A page number within the paginated result set.
    
    OptionalpageSize: number
    Number of results to return per page.
    
    Optionalsort: string
    Which field to use when ordering the results. Available ordering_fields: ['id']
    
    OptionaltaskId: number
    A simple equality filter for the task_id field
    
    Optionaloptions: RawAxiosRequestConfig
    Override http request option.
    
    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedQualitySettingsList>,
    >
    Throws
    Defined in api-client/quality-api.ts:673
- qualityPartialUpdateSettings:function
  - qualityPartialUpdateSettings(
        id: number,
        patchedQualitySettingsRequest?: PatchedQualitySettingsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<QualitySettings>,
    >
    Parameters
    id: number
    An id of a quality settings instance
    
    OptionalpatchedQualitySettingsRequest: PatchedQualitySettingsRequest
    Optionaloptions: RawAxiosRequestConfig
    Override http request option.
    
    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<QualitySettings>,
    >
    Throws
    Defined in api-client/quality-api.ts:687
- qualityRetrieveReport:function
  - qualityRetrieveReport(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<QualityReport>,
    >
    Parameters
    id: number
    A unique integer value identifying this quality report.
    
    Optionaloptions: RawAxiosRequestConfig
    Override http request option.
    
    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<QualityReport>,
    >
    Throws
    Defined in api-client/quality-api.ts:700
- qualityRetrieveReportData:function
  - qualityRetrieveReportData(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>,
    >
    Parameters
    id: number
    A unique integer value identifying this quality report.
    
    Optionaloptions: RawAxiosRequestConfig
    Override http request option.
    
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>
    Throws
    Defined in api-client/quality-api.ts:713
- qualityRetrieveSettings:function
  - qualityRetrieveSettings(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<QualitySettings>,
    >
    Parameters
    id: number
    An id of a quality settings instance
    
    Optionaloptions: RawAxiosRequestConfig
    Override http request option.
    
    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<QualitySettings>,
    >
    Throws
    Defined in api-client/quality-api.ts:726
- Defined in api-client/quality-api.ts:594

Function QualityApiFp

Export

Parameters

qualityCreateReport:function

Parameters

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

Throws

qualityListConflicts:function

Parameters

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

Throws

qualityListReports:function

Parameters

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

Throws

qualityListSettings:function

Parameters

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

Throws

qualityPartialUpdateSettings:function

Parameters

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

Throws

qualityRetrieveReport:function

Parameters

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

Throws

qualityRetrieveReportData:function

Parameters

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

Throws

qualityRetrieveSettings:function

Parameters

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

Throws

Settings

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

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

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

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

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

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

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