@veeroute/lss-agro-angular/api/planService.d.ts

OpenAPI client for @veeroute/lss-agro-angular

import { HttpClient, HttpResponse, HttpEvent, HttpContext } from '@angular/common/http';
import { Observable } from 'rxjs';
import { AgroPlanResultAgro } from '../model/agroPlanResult';
import { AgroPlanTaskAgro } from '../model/agroPlanTask';
import { AgroValidateResultAgro } from '../model/agroValidateResult';
import { CalculationAsyncResultAgro } from '../model/calculationAsyncResult';
import { CalculationStateAgro } from '../model/calculationState';
import { Configuration } from '../configuration';
import { BaseService } from '../api.base.service';
import { PlanServiceInterface, CancelPlanCalculationRequestParams, DeletePlanResultRequestParams, ReadAlgoDataRequestParams, ReadPlanResultRequestParams, ReadPlanStateRequestParams, RunPlanCalculationRequestParams, RunPlanCalculationAsyncRequestParams, RunPlanClipRequestParams, RunPlanValidationRequestParams } from './planServiceInterface';
import * as i0 from "@angular/core";
export declare class PlanService extends BaseService implements PlanServiceInterface {
    protected httpClient: HttpClient;
    constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
    /**
     * Cancel calculation
     * Cancel calculation process by the calculation identifier.
     * @param requestParameters
     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
     * @param reportProgress flag to report request and response progress.
     */
    cancelPlanCalculation(requestParameters: CancelPlanCalculationRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<any>;
    cancelPlanCalculation(requestParameters: CancelPlanCalculationRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<any>>;
    cancelPlanCalculation(requestParameters: CancelPlanCalculationRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<any>>;
    /**
     * Result removal
     * Removal of the planning result by the calculation identifier.
     * @param requestParameters
     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
     * @param reportProgress flag to report request and response progress.
     */
    deletePlanResult(requestParameters: DeletePlanResultRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<any>;
    deletePlanResult(requestParameters: DeletePlanResultRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<any>>;
    deletePlanResult(requestParameters: DeletePlanResultRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<any>>;
    /**
     * Algo data
     * Receiving algo data by &#x60;tracedata.process_code&#x60;.
     * @param requestParameters
     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
     * @param reportProgress flag to report request and response progress.
     */
    readAlgoData(requestParameters: ReadAlgoDataRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/octet-stream' | 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<string>;
    readAlgoData(requestParameters: ReadAlgoDataRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/octet-stream' | 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<string>>;
    readAlgoData(requestParameters: ReadAlgoDataRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/octet-stream' | 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<string>>;
    /**
     * Getting the result
     * Getting the result based on the calculation identifier.
     * @param requestParameters
     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
     * @param reportProgress flag to report request and response progress.
     */
    readPlanResult(requestParameters: ReadPlanResultRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<AgroPlanResultAgro>;
    readPlanResult(requestParameters: ReadPlanResultRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<AgroPlanResultAgro>>;
    readPlanResult(requestParameters: ReadPlanResultRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<AgroPlanResultAgro>>;
    /**
     * Calculation state
     * Read calculation state by the calculation identifier.
     * @param requestParameters
     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
     * @param reportProgress flag to report request and response progress.
     */
    readPlanState(requestParameters: ReadPlanStateRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<CalculationStateAgro>;
    readPlanState(requestParameters: ReadPlanStateRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<CalculationStateAgro>>;
    readPlanState(requestParameters: ReadPlanStateRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<CalculationStateAgro>>;
    /**
     * Planning (SYNC)
     * Production plan calculation.
     * @param requestParameters
     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
     * @param reportProgress flag to report request and response progress.
     */
    runPlanCalculation(requestParameters: RunPlanCalculationRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<AgroPlanResultAgro>;
    runPlanCalculation(requestParameters: RunPlanCalculationRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<AgroPlanResultAgro>>;
    runPlanCalculation(requestParameters: RunPlanCalculationRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<AgroPlanResultAgro>>;
    /**
     * Planning (ASYNC)
     * The result can be obtained using the [result](#operation/read_plan_result) method, removing - with [delete](#operation/delete_plan_result).
     * @param requestParameters
     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
     * @param reportProgress flag to report request and response progress.
     */
    runPlanCalculationAsync(requestParameters: RunPlanCalculationAsyncRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<CalculationAsyncResultAgro>;
    runPlanCalculationAsync(requestParameters: RunPlanCalculationAsyncRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<CalculationAsyncResultAgro>>;
    runPlanCalculationAsync(requestParameters: RunPlanCalculationAsyncRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<CalculationAsyncResultAgro>>;
    /**
     * Clipping (SYNC)
     * Data clipping.
     * @param requestParameters
     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
     * @param reportProgress flag to report request and response progress.
     */
    runPlanClip(requestParameters: RunPlanClipRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<AgroPlanTaskAgro>;
    runPlanClip(requestParameters: RunPlanClipRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<AgroPlanTaskAgro>>;
    runPlanClip(requestParameters: RunPlanClipRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<AgroPlanTaskAgro>>;
    /**
     * Data validation
     * Checking data before planning.
     * @param requestParameters
     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
     * @param reportProgress flag to report request and response progress.
     */
    runPlanValidation(requestParameters: RunPlanValidationRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<AgroValidateResultAgro>;
    runPlanValidation(requestParameters: RunPlanValidationRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<AgroValidateResultAgro>>;
    runPlanValidation(requestParameters: RunPlanValidationRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<AgroValidateResultAgro>>;
    static ɵfac: i0.ɵɵFactoryDeclaration<PlanService, [null, { optional: true; }, { optional: true; }]>;
    static ɵprov: i0.ɵɵInjectableDeclaration<PlanService>;
}