@veeroute/lss-packer-angular/api/packService.d.ts

OpenAPI client for @veeroute/lss-packer-angular

import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
import { Observable } from 'rxjs';
import { CalculationAsyncResultPacker } from '../model/calculationAsyncResult';
import { CalculationStatePacker } from '../model/calculationState';
import { PackResultPacker } from '../model/packResult';
import { ValidateResultPacker } from '../model/validateResult';
import { Configuration } from '../configuration';
import { PackServiceInterface, CancelPackCalculationRequestParams, DeletePackResultRequestParams, ReadPackResultRequestParams, ReadPackStateRequestParams, RunPackCalculationRequestParams, RunPackCalculationAsyncRequestParams, RunPackValidationRequestParams } from './packServiceInterface';
import * as i0 from "@angular/core";
export declare class PackService implements PackServiceInterface {
    protected httpClient: HttpClient;
    protected basePath: string;
    defaultHeaders: HttpHeaders;
    configuration: Configuration;
    encoder: HttpParameterCodec;
    constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
    private addToHttpParams;
    private addToHttpParamsRecursive;
    /**
     * 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.
     */
    cancelPackCalculation(requestParameters: CancelPackCalculationRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<any>;
    cancelPackCalculation(requestParameters: CancelPackCalculationRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<any>>;
    cancelPackCalculation(requestParameters: CancelPackCalculationRequestParams, 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.
     */
    deletePackResult(requestParameters: DeletePackResultRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<any>;
    deletePackResult(requestParameters: DeletePackResultRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<any>>;
    deletePackResult(requestParameters: DeletePackResultRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<any>>;
    /**
     * 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.
     */
    readPackResult(requestParameters: ReadPackResultRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<PackResultPacker>;
    readPackResult(requestParameters: ReadPackResultRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<PackResultPacker>>;
    readPackResult(requestParameters: ReadPackResultRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<PackResultPacker>>;
    /**
     * 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.
     */
    readPackState(requestParameters: ReadPackStateRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<CalculationStatePacker>;
    readPackState(requestParameters: ReadPackStateRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<CalculationStatePacker>>;
    readPackState(requestParameters: ReadPackStateRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<CalculationStatePacker>>;
    /**
     * Packing (SYNC)
     * Planning the optimal package.
     * @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.
     */
    runPackCalculation(requestParameters: RunPackCalculationRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<PackResultPacker>;
    runPackCalculation(requestParameters: RunPackCalculationRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<PackResultPacker>>;
    runPackCalculation(requestParameters: RunPackCalculationRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<PackResultPacker>>;
    /**
     * Packing (ASYNC)
     * The result can be obtained using the [result](#operation/read_pack_result) method, removing - with [delete](#operation/delete_pack_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.
     */
    runPackCalculationAsync(requestParameters: RunPackCalculationAsyncRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<CalculationAsyncResultPacker>;
    runPackCalculationAsync(requestParameters: RunPackCalculationAsyncRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<CalculationAsyncResultPacker>>;
    runPackCalculationAsync(requestParameters: RunPackCalculationAsyncRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<CalculationAsyncResultPacker>>;
    /**
     * 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.
     */
    runPackValidation(requestParameters: RunPackValidationRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<ValidateResultPacker>;
    runPackValidation(requestParameters: RunPackValidationRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<ValidateResultPacker>>;
    runPackValidation(requestParameters: RunPackValidationRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<ValidateResultPacker>>;
    static ɵfac: i0.ɵɵFactoryDeclaration<PackService, [null, { optional: true; }, { optional: true; }]>;
    static ɵprov: i0.ɵɵInjectableDeclaration<PackService>;
}