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

OpenAPI client for @veeroute/lss-agro-angular

/**
 * VRt.Agro [AG]
 *
 * The version of the OpenAPI document: 7.18.2755
 * Contact: servicedesk@veeroute.com
 *
 * NOTE: This class is auto generated by OpenAPI Generator.
 * Do not edit the class manually.
 */
import { HttpHeaders } from '@angular/common/http';
import { Observable } from 'rxjs';
import { CalculationAsyncResultAgro } from '../model/models';
import { CalculationStateAgro } from '../model/models';
import { PlanResultAgro } from '../model/models';
import { PlanTaskAgro } from '../model/models';
import { ValidateResultAgro } from '../model/models';
import { Configuration } from '../configuration';
export interface CancelPlanCalculationRequestParams {
    processCode: string;
}
export interface DeletePlanResultRequestParams {
    processCode: string;
}
export interface ReadPlanResultRequestParams {
    processCode: string;
}
export interface ReadPlanStateRequestParams {
    processCode: string;
}
export interface RunPlanCalculationRequestParams {
    planTaskAgro: PlanTaskAgro;
}
export interface RunPlanCalculationAsyncRequestParams {
    planTaskAgro: PlanTaskAgro;
}
export interface RunPlanClipRequestParams {
    clipKey: string;
    planTaskAgro: PlanTaskAgro;
    clipStrategy?: string;
}
export interface RunPlanValidationRequestParams {
    planTaskAgro: PlanTaskAgro;
}
export interface PlanServiceInterface {
    defaultHeaders: HttpHeaders;
    configuration: Configuration;
    /**
     * Cancel calculation
     * Cancel calculation process by the calculation identifier.
* @param requestParameters
     */
    cancelPlanCalculation(requestParameters: CancelPlanCalculationRequestParams, extraHttpRequestParams?: any): Observable<{}>;
    /**
     * Result removal
     * Removal of the planning result by the calculation identifier.
* @param requestParameters
     */
    deletePlanResult(requestParameters: DeletePlanResultRequestParams, extraHttpRequestParams?: any): Observable<{}>;
    /**
     * Getting the result
     * Getting the result based on the calculation identifier.
* @param requestParameters
     */
    readPlanResult(requestParameters: ReadPlanResultRequestParams, extraHttpRequestParams?: any): Observable<PlanResultAgro>;
    /**
     * Calculation state
     * Read calculation state by the calculation identifier.
* @param requestParameters
     */
    readPlanState(requestParameters: ReadPlanStateRequestParams, extraHttpRequestParams?: any): Observable<CalculationStateAgro>;
    /**
     * Planning (SYNC)
     * Production plan calculation.
* @param requestParameters
     */
    runPlanCalculation(requestParameters: RunPlanCalculationRequestParams, extraHttpRequestParams?: any): Observable<PlanResultAgro>;
    /**
     * Planning (ASYNC)
     * The result can be obtained using the [result](#operation/read_plan_result) method, removing - with [delete](#operation/delete_plan_result).
* @param requestParameters
     */
    runPlanCalculationAsync(requestParameters: RunPlanCalculationAsyncRequestParams, extraHttpRequestParams?: any): Observable<CalculationAsyncResultAgro>;
    /**
     * Clipping (SYNC)
     * Data clipping.
* @param requestParameters
     */
    runPlanClip(requestParameters: RunPlanClipRequestParams, extraHttpRequestParams?: any): Observable<PlanTaskAgro>;
    /**
     * Data validation
     * Checking data before planning.
* @param requestParameters
     */
    runPlanValidation(requestParameters: RunPlanValidationRequestParams, extraHttpRequestParams?: any): Observable<ValidateResultAgro>;
}