UNPKG

@veeroute/lss-studio-angular

Version:

OpenAPI client for @veeroute/lss-studio-angular

1,779 lines (1,705 loc) 477 kB
import { HttpParameterCodec, HttpHeaders, HttpParams, HttpClient, HttpContext, HttpResponse, HttpEvent } from '@angular/common/http'; import { Observable } from 'rxjs'; import * as i0 from '@angular/core'; import { InjectionToken, ModuleWithProviders, EnvironmentProviders } from '@angular/core'; /** * Standard parameter styles defined by OpenAPI spec */ type StandardParamStyle = 'matrix' | 'label' | 'form' | 'simple' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject'; /** * The OpenAPI standard {@link StandardParamStyle}s may be extended by custom styles by the user. */ type ParamStyle = StandardParamStyle | string; /** * Standard parameter locations defined by OpenAPI spec */ type ParamLocation = 'query' | 'header' | 'path' | 'cookie'; /** * Standard types as defined in <a href="https://swagger.io/specification/#data-types">OpenAPI Specification: Data Types</a> */ type StandardDataType = "integer" | "number" | "boolean" | "string" | "object" | "array"; /** * Standard {@link DataType}s plus your own types/classes. */ type DataType = StandardDataType | string; /** * Standard formats as defined in <a href="https://swagger.io/specification/#data-types">OpenAPI Specification: Data Types</a> */ type StandardDataFormat = "int32" | "int64" | "float" | "double" | "byte" | "binary" | "date" | "date-time" | "password"; type DataFormat = StandardDataFormat | string; /** * The parameter to encode. */ interface Param { name: string; value: unknown; in: ParamLocation; style: ParamStyle; explode: boolean; dataType: DataType; dataFormat: DataFormat | undefined; } interface ConfigurationParameters { /** * @deprecated Since 5.0. Use credentials instead */ apiKeys?: { [key: string]: string; }; username?: string; password?: string; /** * @deprecated Since 5.0. Use credentials instead */ accessToken?: string | (() => string); basePath?: string; withCredentials?: boolean; /** * Takes care of encoding query- and form-parameters. */ encoder?: HttpParameterCodec; /** * Override the default method for encoding path parameters in various * <a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#style-values">styles</a>. * <p> * See {@link README.md} for more details * </p> */ encodeParam?: (param: Param) => string; /** * The keys are the names in the securitySchemes section of the OpenAPI * document. They should map to the value used for authentication * minus any standard prefixes such as 'Basic' or 'Bearer'. */ credentials?: { [key: string]: string | (() => string | undefined); }; } declare class Configuration { /** * @deprecated Since 5.0. Use credentials instead */ apiKeys?: { [key: string]: string; }; username?: string; password?: string; /** * @deprecated Since 5.0. Use credentials instead */ accessToken?: string | (() => string); basePath?: string; withCredentials?: boolean; /** * Takes care of encoding query- and form-parameters. */ encoder?: HttpParameterCodec; /** * Encoding of various path parameter * <a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#style-values">styles</a>. * <p> * See {@link README.md} for more details * </p> */ encodeParam: (param: Param) => string; /** * The keys are the names in the securitySchemes section of the OpenAPI * document. They should map to the value used for authentication * minus any standard prefixes such as 'Basic' or 'Bearer'. */ credentials: { [key: string]: string | (() => string | undefined); }; constructor({ accessToken, apiKeys, basePath, credentials, encodeParam, encoder, password, username, withCredentials }?: ConfigurationParameters); /** * Select the correct content-type to use for a request. * Uses {@link Configuration#isJsonMime} to determine the correct content-type. * If no content type is found return the first found type if the contentTypes is not empty * @param contentTypes - the array of content types that are available for selection * @returns the selected content-type or <code>undefined</code> if no selection could be made. */ selectHeaderContentType(contentTypes: string[]): string | undefined; /** * Select the correct accept content-type to use for a request. * Uses {@link Configuration#isJsonMime} to determine the correct accept content-type. * If no content type is found return the first found type if the contentTypes is not empty * @param accepts - the array of content types that are available for selection. * @returns the selected content-type or <code>undefined</code> if no selection could be made. */ selectHeaderAccept(accepts: string[]): string | undefined; /** * Check if the given MIME is a JSON MIME. * JSON MIME examples: * application/json * application/json; charset=UTF8 * APPLICATION/JSON * application/vnd.company+json * @param mime - MIME (Multipurpose Internet Mail Extensions) * @return True if the given MIME is JSON, false otherwise. */ isJsonMime(mime: string): boolean; lookupCredential(key: string): string | undefined; addCredentialToHeaders(credentialKey: string, headerName: string, headers: HttpHeaders, prefix?: string): HttpHeaders; addCredentialToQuery(credentialKey: string, paramName: string, query: HttpParams): HttpParams; private defaultEncodeParam; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ declare class BaseService { protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; encoder: HttpParameterCodec; constructor(basePath?: string | string[], configuration?: Configuration); protected canConsumeForm(consumes: string[]): boolean; protected addToHttpParams(httpParams: HttpParams, value: any, key?: string, isDeep?: boolean): HttpParams; protected addToHttpParamsRecursive(httpParams: HttpParams, value?: any, key?: string, isDeep?: boolean): HttpParams; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ interface CreateBackupRequestParams { targetFolderKey: string; } interface RestoreBackupRequestParams { targetFolderKey: string; body: string; } interface BackupsServiceInterface { defaultHeaders: HttpHeaders; configuration: Configuration; /** * Folder export * Export folder with experiments. * @param requestParameters */ createBackup(requestParameters: CreateBackupRequestParams, extraHttpRequestParams?: any): Observable<string>; /** * Folder import * Import folder with experiments. The folder should not be of type ROOT and should be empty. * @param requestParameters */ restoreBackup(requestParameters: RestoreBackupRequestParams, extraHttpRequestParams?: any): Observable<{}>; } declare class BackupsService extends BaseService implements BackupsServiceInterface { protected httpClient: HttpClient; constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration); /** * Folder export * Export folder with experiments. * @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. */ createBackup(requestParameters: CreateBackupRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/octet-stream' | 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable<string>; createBackup(requestParameters: CreateBackupRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/octet-stream' | 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<string>>; createBackup(requestParameters: CreateBackupRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/octet-stream' | 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<string>>; /** * Folder import * Import folder with experiments. The folder should not be of type ROOT and should be empty. * @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. */ restoreBackup(requestParameters: RestoreBackupRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable<any>; restoreBackup(requestParameters: RestoreBackupRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<any>>; restoreBackup(requestParameters: RestoreBackupRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<any>>; static ɵfac: i0.ɵɵFactoryDeclaration<BackupsService, [null, { optional: true; }, { optional: true; }]>; static ɵprov: i0.ɵɵInjectableDeclaration<BackupsService>; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Entity type. Defines the source object with attributes and the target table. */ declare enum CustomfieldEntityTypeStudio { LOCATION = "LOCATION", ORDER = "ORDER", DEMAND = "DEMAND", PERFORMER = "PERFORMER", PERFORMER_SHIFT = "PERFORMER_SHIFT", TRANSPORT = "TRANSPORT", TRANSPORT_SHIFT = "TRANSPORT_SHIFT", HARDLINK = "HARDLINK", TRIP = "TRIP", ROUNDTRIP = "ROUNDTRIP", FACT = "FACT", TRIP_STOP = "TRIP_STOP" } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Name in different languages. */ interface TranslationsStudio { [key: string]: any | any; /** * Name, information field. */ ru?: string; /** * Name, information field. */ en?: string; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * The name of the additional column in the table. Used for filters of the `CUSTOMFIELDS` type. */ declare enum TableCustomfieldsColumnTypeStudio { DATETIME_0 = "DATETIME_0", DATETIME_1 = "DATETIME_1", DATETIME_2 = "DATETIME_2", DATETIME_3 = "DATETIME_3", DATETIME_4 = "DATETIME_4", DATETIME_5 = "DATETIME_5", DATETIME_6 = "DATETIME_6", DATETIME_7 = "DATETIME_7", DATETIME_8 = "DATETIME_8", DATETIME_9 = "DATETIME_9", INT_0 = "INT_0", INT_1 = "INT_1", INT_2 = "INT_2", INT_3 = "INT_3", INT_4 = "INT_4", INT_5 = "INT_5", INT_6 = "INT_6", INT_7 = "INT_7", INT_8 = "INT_8", INT_9 = "INT_9", FLOAT_0 = "FLOAT_0", FLOAT_1 = "FLOAT_1", FLOAT_2 = "FLOAT_2", FLOAT_3 = "FLOAT_3", FLOAT_4 = "FLOAT_4", FLOAT_5 = "FLOAT_5", FLOAT_6 = "FLOAT_6", FLOAT_7 = "FLOAT_7", FLOAT_8 = "FLOAT_8", FLOAT_9 = "FLOAT_9", DURATION_0 = "DURATION_0", DURATION_1 = "DURATION_1", DURATION_2 = "DURATION_2", DURATION_3 = "DURATION_3", DURATION_4 = "DURATION_4", DURATION_5 = "DURATION_5", DURATION_6 = "DURATION_6", DURATION_7 = "DURATION_7", DURATION_8 = "DURATION_8", DURATION_9 = "DURATION_9", BOOL_0 = "BOOL_0", BOOL_1 = "BOOL_1", BOOL_2 = "BOOL_2", BOOL_3 = "BOOL_3", BOOL_4 = "BOOL_4", BOOL_5 = "BOOL_5", BOOL_6 = "BOOL_6", BOOL_7 = "BOOL_7", BOOL_8 = "BOOL_8", BOOL_9 = "BOOL_9", STRING_0 = "STRING_0", STRING_1 = "STRING_1", STRING_2 = "STRING_2", STRING_3 = "STRING_3", STRING_4 = "STRING_4", STRING_5 = "STRING_5", STRING_6 = "STRING_6", STRING_7 = "STRING_7", STRING_8 = "STRING_8", STRING_9 = "STRING_9" } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Rule for converting a custom field from an attribute. */ interface CustomfieldConvertRuleStudio { [key: string]: any | any; entity_type: CustomfieldEntityTypeStudio; /** * The attribute key whose value will be written to the specified custom field. */ source_attribute_key: string; target_customfield: TableCustomfieldsColumnTypeStudio | null; translations?: TranslationsStudio; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Custom fields settings. */ interface CustomfieldsSettingsStudio { [key: string]: any | any; /** * List of rules for converting custom fields. */ rules: Array<CustomfieldConvertRuleStudio>; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * List of setting keys with indicating the key of the currently active setting. */ interface SettingsKeyListStudio { [key: string]: any | any; /** * List of setting keys. */ settings_keys: Array<string>; /** * Settings key (nullable), unique identifier. */ active_key?: string | null; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Actualize settings. */ interface ActualizeSettingsStudio { [key: string]: any | any; /** * Current date and time according to the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6). If not specified, the current time when the request was received by the server is taken. */ current_time?: string | null; /** * Acceptable delay. Affects the shift of the right boundaries of hard time windows of orders and time windows of work shifts of performers and transports. */ max_delay_duration?: string; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Time window. */ interface TimeWindowStudio { [key: string]: any | any; /** * Date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6) format. */ from: string; /** * Date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6) format. */ to: string; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Performer\'s shift assigned to the specified time (`shift_time`). */ interface AssignedPerformerStudio { [key: string]: any | any; /** * Performer\'s key, unique identifier. */ performer_key: string; /** * Performer\'s shift key. */ shift_key: string; shift_time: TimeWindowStudio; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Transport\'s shift assigned to the specified time (`shift_time`). */ interface AssignedTransportStudio { [key: string]: any | any; /** * Transport key, unique identifier. */ transport_key: string; /** * Transport\'s shift key. */ shift_key: string; shift_time: TimeWindowStudio; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Attribute. */ interface AttributeStudio { [key: string]: any | any; /** * Attribute\'s key. */ key: string; /** * Attribute\'s value. */ value: string; /** * Attribute processing strategy: * `LASTMILE_REF_TIME` - when sending a task to the scheduler, the value (format [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)) of the attribute is replaced with a relative time; if the value is not in the format, the calculation stops with the `FAILED` status. */ strategy?: string | null; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Process name: * `PLAN` - planning * `REPLAN` - replanning * `ACTUALIZE` - actualization */ declare enum BasicProcessStudio { PLAN = "PLAN", REPLAN = "REPLAN", ACTUALIZE = "ACTUALIZE" } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Entity state that determines its relation to the dataset: * `UNPLANNED` - new entity * `PLANNED` - the entity is planned in a specific trip at a specific time * `ASSIGNED` - the entity is assigned to a specific trip without a specific time * `COMPLETED` - the entity is completed and no longer participates in the calculation * `ERROR` - the entity contains data errors */ declare enum BasicStateStudio { UNPLANNED = "UNPLANNED", PLANNED = "PLANNED", ASSIGNED = "ASSIGNED", COMPLETED = "COMPLETED", ERROR = "ERROR" } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Transport box [compatibilities](#section/Description/Compatibilities). */ interface BoxCompatibilitiesStudio { [key: string]: any | any; /** * Width in meters. */ width?: number; /** * Height in meters. */ height?: number; /** * Length in meters. */ length?: number; /** * A list of tags that define a property or requirement. */ box_features?: Array<string>; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Capacity characteristics. */ interface CapacityStudio { [key: string]: any | any; /** * Weight in kilograms. */ mass?: number; /** * Volume in cubic meters. */ volume?: number; /** * Additional parameter (A) for measuring cargoes and boxes in alternative units. For example, to account for cargo in pieces (this parameter is equal to one for a cargo and the maximum number of cargo to hold for a box). */ capacity_a?: number; /** * Additional parameter (B) for measuring cargoes and boxes in alternative units. */ capacity_b?: number; /** * Additional parameter (C) for measuring cargoes and boxes in alternative units. */ capacity_c?: number; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Box limits. */ interface BoxLimitsStudio { [key: string]: any | any; max_one_cargo_capacity?: CapacityStudio | null; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * A transport box capable to hold a cargo. */ interface BoxStudio { [key: string]: any | any; /** * Unique box key used to identify the cargo placement in boxes. */ key: string; capacity?: CapacityStudio | null; compatibilities?: BoxCompatibilitiesStudio | null; limits?: BoxLimitsStudio | null; /** * Attributes. Used to add service information. */ attributes?: Array<AttributeStudio>; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * The condition for the onset and characteristics of a break. */ interface BreakStudio { [key: string]: any | any; /** * Time duration according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). */ relocating_duration_sum: string; /** * Time duration according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). */ operating_duration_sum?: string | null; /** * Time duration according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). */ duration: string; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Rules for accounting for breaks. */ interface BreakRulesStudio { [key: string]: any | any; /** * The condition for the onset and characteristics of a first break. */ first: BreakStudio; consecutive?: BreakStudio | null; /** * Type of accounting for time spent moving between locations (total or continuous). */ relocating_duration_type?: BreakRulesStudioRelocatingDurationTypeEnum; } declare enum BreakRulesStudioRelocatingDurationTypeEnum { TOTAL = "TOTAL", CONTINUOUS = "CONTINUOUS" } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Statistics on capacity characteristics (ratio). It may be more than one. */ interface CapacityStatisticsRatioStudio { [key: string]: any | any; /** * Loading by mass, in fractions of a unit. */ mass: number; /** * Loading by volume, in fractions of a unit. */ volume: number; /** * Loading by additional parameter (A), in fractions of a unit. */ capacity_a: number; /** * Loading by additional parameter (B), in fractions of a unit. */ capacity_b: number; /** * Loading by additional parameter (C), in fractions of a unit. */ capacity_c: number; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Statistics on capacity characteristics (ratio). Cannot be greater than one. */ interface CapacityStatisticsLoadStudio { [key: string]: any | any; /** * Loading by mass, in fractions of a unit. */ mass: number; /** * Loading by volume, in fractions of a unit. */ volume: number; /** * Loading by additional parameter (A), in fractions of a unit. */ capacity_a: number; /** * Loading by additional parameter (B), in fractions of a unit. */ capacity_b: number; /** * Loading by additional parameter (C), in fractions of a unit. */ capacity_c: number; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Measurements of times and distances for work on location, individual trips and planning in general. */ interface MeasurementsStudio { [key: string]: any | any; time_window: TimeWindowStudio; /** * Time duration according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). */ driving_time: string; /** * Time duration according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). */ waiting_time: string; /** * Time duration according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). */ working_time: string; /** * Time duration according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). */ break_time: string; /** * Time duration according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). */ rest_time: string; /** * Time duration according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). */ arriving_time: string; /** * Time duration according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). */ departure_time: string; /** * Time duration according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). */ total_time: string; /** * Distance in meters. */ distance: number; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Statistics on capacity characteristics. */ interface CapacityStatisticsSumStudio { [key: string]: any | any; /** * Total weight in kilograms. */ mass: number; /** * Total volume in cubic meters. */ volume: number; /** * Amount for additional parameter (A) for measuring loads in alternative units of measurement. */ capacity_a: number; /** * Amount for additional parameter (B) for measuring loads in alternative units of measurement. */ capacity_b: number; /** * Amount for additional parameter (C) for measuring loads in alternative units of measurement. */ capacity_c: number; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Summary statistics for one or a set of trips. */ interface GeneralStatisticsStudio { [key: string]: any | any; /** * Total cost calculated based on the performer\'s and transport tariffs. */ cost: number; /** * The total reward for orders fulfillment. */ reward: number; /** * The total profit is equal to the difference between the total reward (`reward`) and cost (`cost`). */ profit: number; /** * Measurements of times and distances for aggregate and individual trips: * `time_window` - the start time of the first trip and the end time of the last, if there are no trips, the time of the left border of the planning horizon is returned, while the from \\ to fields have the same value * `driving_time` - duration of driving time * `waiting_time` - total waiting time for all locations * `working_time` - total time of work execution at all locations included in the trip * `break_time` - total break time for all locations * `rest_time` - total rest time for all locations * `arriving_time` - total time to drive / park at locations * `departure_time` - total time for departure from locations * `total_time` - total time, composed of `driving_time` + `waiting_time` + `working_time` + `break_time` + `rest_time` + `arriving_time` + `departure_time` * `distance` - the total length of the roundtrip/trip/set of trips, in meters */ measurements: MeasurementsStudio; /** * The total number of planned trips. */ trips_count: number; /** * The total number of performers involved in orders fulfillment. */ performers_count: number; /** * The total number of planned and assigned orders. */ orders_count: number; /** * The total number of planned orders. */ plan_orders_count: number; /** * The total number of assigned orders. */ waitlist_orders_count: number; /** * The total number of stops (non-unique locations). */ stops_count: number; /** * The total number of unique locations within one trip. For general statistics - the sum of unique locations within each trip. */ locations_count: number; /** * Total additive measures of the transported cargo. */ cargo_capacity_sum: CapacityStatisticsSumStudio; /** * The ratio of the total additive measures of the transported cargo to the total capacity of the boxes. In fractions of a unit. It may be more than one. */ cargo_capacity_ratio: CapacityStatisticsRatioStudio; /** * The ratio of the maximum load of boxes to the total capacity of boxes. In fractions of a unit. Cannot be greater than one. */ max_transport_load: CapacityStatisticsLoadStudio; /** * Average speed is the ratio of the total distance to the total time of movement, km/h. */ average_speed: number; /** * Number of [roundtrips](#section/Description/Roundtrips) within a trip. */ round_trips_count: number; /** * Average mileage per roundtrip is the ratio of the total mileage per trip to the number of roundtrips, in meters. */ average_roundtrip_distance: number; /** * Time duration according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). */ average_roundtrip_time: string; /** * Attributes. Used to add service information. */ attributes?: Array<AttributeStudio>; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Experiment calculation history element. */ interface CalculationHistoryElementStudio { [key: string]: any | any; /** * Date and time of receiving statistics in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6) format. */ time: string; total_statistics: GeneralStatisticsStudio; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Calculation status: * `WAITING` - the calculation is waiting to be launched. * `IN_PROGRESS` - calculation in progress. * `FINISHED_IN_TIME` - the calculation completed correctly before the specified maximum time. * `FINISHED_OUT_OF_TIME` - the calculation ended because the specified time for calculation has expired, which can affect the quality of the result for the worse. * `CANCELED` - the calculation was canceled because a cancel command was received. * `CANCELED_BY_TIMEOUT` - the calculation was canceled automatically because the waiting time in the queue was exceeded. * `CANCELED_BY_QUOTA` - the calculation was canceled because the quota for this calculation type was exceeded. * `FAILED` - calculation completed with an error. */ declare enum CalculationStatusStudio { WAITING = "WAITING", IN_PROGRESS = "IN_PROGRESS", FINISHED_IN_TIME = "FINISHED_IN_TIME", FINISHED_OUT_OF_TIME = "FINISHED_OUT_OF_TIME", CANCELED = "CANCELED", CANCELED_BY_TIMEOUT = "CANCELED_BY_TIMEOUT", CANCELED_BY_QUOTA = "CANCELED_BY_QUOTA", FAILED = "FAILED" } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Calculation information. */ interface CalculationInfoStudio { [key: string]: any | any; status: CalculationStatusStudio; /** * Message with additional information about the calculation status. */ message?: string | null; /** * Planning result version. */ result_version: number; /** * Time duration according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). */ preparing_time: string; /** * Time duration according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). */ business_validation_time: string; /** * Time duration according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). */ math_validation_time: string; /** * Time duration according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). */ waiting_time: string; /** * Time duration according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). */ calculation_time: string; /** * Time duration according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). */ postprocessing_time?: string; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Calculation settings. */ interface CalculationSettingsStudio { [key: string]: any | any; /** * Max calculation time. The countdown starts from the time when data is uploaded to the server and calculation starts. */ max_calculation_time?: string; /** * Max calculation time. The countdown starts from the time when data is uploaded to the server. */ max_waiting_time?: string; /** * Calculation result lifetime. The countdown starts from the time when the calculation is completed. */ result_ttl?: string; /** * Timezone. */ result_timezone?: number; /** * Treat warnings as errors and do not run calculations if at least one entity contains invalid data. */ treat_warnings_as_errors?: boolean; /** * Specifies the calculation accuracy in the decimal point sequence number. It equals 3 by default, so the accuracy is 0.001. */ precision?: number; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Service name. */ declare enum ServiceStudio { UNIVERSAL = "UNIVERSAL", ROUTING = "ROUTING", ACCOUNT = "ACCOUNT", ADMIN = "ADMIN", STUDIO = "STUDIO", MONITOR = "MONITOR", PACKER = "PACKER", AGRO = "AGRO", REGISTRY = "REGISTRY", SUPPORT = "SUPPORT" } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Data for request tracing. */ interface TracedataStudio { [key: string]: any | any; /** * Unique process identifier. One is created per process, the same for different requests for the same process. */ process_code: string; /** * Unique identifier of the request. A new one is created for each request. */ request_code: string; /** * Unique username for login. */ username: string; /** * Unique company key. */ company: string; service: ServiceStudio; /** * Operation (request) name. */ operation: string; /** * Environment identifier. */ env: string; /** * Pod identifier. */ pod: string; /** * Date and time service method run in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6) format. */ time: string; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Current calculation state. */ interface CalculationStateStudio { [key: string]: any | any; tracedata: TracedataStudio; /** * Calculation progress as a percentage. The progress displays the current number of completed steps. */ calculation_progress: number; calculation_info: CalculationInfoStudio; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Cost per capacity element. */ interface CapacityCostStudio { [key: string]: any | any; /** * Cost per kilogram, in conventional monetary units. */ mass: number; /** * Cost per cubic meter, in conventional monetary units. */ volume: number; /** * Cost per unit of additional parameter (A), in conventional monetary units. */ capacity_a: number; /** * Cost per unit of additional parameter (B), in conventional monetary units. */ capacity_b: number; /** * Cost per unit of additional parameter (C), in conventional monetary units. */ capacity_c: number; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Capacity limits. */ interface CapacityLimitStudio { [key: string]: any | any; /** * Weight in kilograms. */ mass: number; /** * Volume in cubic meters. */ volume: number; /** * Additional parameter (A) for measuring cargoes and boxes in alternative units. */ capacity_a: number; /** * Additional parameter (B) for measuring cargoes and boxes in alternative units. */ capacity_b: number; /** * Additional parameter (C) for measuring cargoes and boxes in alternative units. */ capacity_c: number; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Capacity change rate for the specified transport type. */ interface CapacityMultiplierStudio { [key: string]: any | any; /** * Mass multiplier. */ mass?: number; /** * Volume multiplier. */ volume?: number; /** * Additional parameter (A) multiplier. */ capacity_a?: number; /** * Additional parameter (B) multiplier. */ capacity_b?: number; /** * Additional parameter (C) multiplier. */ capacity_c?: number; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Types of actions with cargo: * `ADD` - moving cargo into the box * `REMOVE` - moving cargo from the box */ declare enum CargoActionTypeStudio { ADD = "ADD", REMOVE = "REMOVE" } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Action with a cargo. */ interface CargoActionStudio { [key: string]: any | any; /** * Box key. */ box_key: string; /** * Cargo key. */ cargo_key: string; cargo_action_type: CargoActionTypeStudio; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * The ability of the cargo to rotate in 90 degree increments around the axes: * `ALL` - any axes. * `YAW` - around the Z axis. * `PITCH` - around the Y axis. * `ROLL` - around the X axis. */ declare enum CargoRotationTypeStudio { ALL = "ALL", YAW = "YAW", PITCH = "PITCH", ROLL = "ROLL" } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Compatibilities of [the cargo with the transport box and other cargos](#section/Description/Compatibilities). */ interface CargoCompatibilitiesStudio { [key: string]: any | any; /** * Width in meters, used to check the transport box capacity. */ width?: number; /** * Height in meters, used to check the transport box capacity. */ height?: number; /** * Length in meters, used to check the transport box capacity. */ length?: number; /** * List of possibilities of a object rotations (90 degree step): * `ALL` - can rotate by any axis * `YAW` - can yaw * `PITCH` - can pitch * `ROLL` - can roll Empty list means object rotations is prohibited. More about [cargo placement](#section/Description/Cargo-placement). */ rotation?: Array<CargoRotationTypeStudio>; /** * A list of tags that define a property or requirement. */ box_restrictions?: Array<string>; /** * A list of tags that define a property or requirement. */ cargo_features?: Array<string>; /** * A list of tags that define a property or requirement. */ cargo_restrictions?: Array<string>; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Information about the `Honest Sign` marking. */ interface CargoInvoiceHonestSignStudio { [key: string]: any | any; /** * The label of the `Honest Sign` marking. */ label?: string | null; /** * The product requires the `Honest Sign` marking. */ marking_required?: boolean; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Value-added tax (VAT). */ declare enum CargoInvoiceTaxStudio { VAT_NA = "VAT_NA", VAT_00 = "VAT_00", VAT_05 = "VAT_05", VAT_07 = "VAT_07", VAT_10 = "VAT_10", VAT_20 = "VAT_20", VAT_22 = "VAT_22", VAT_05_105 = "VAT_05_105", VAT_07_107 = "VAT_07_107", VAT_10_110 = "VAT_10_110", VAT_20_120 = "VAT_20_120", VAT_22_122 = "VAT_22_122" } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Invoice details for the product. */ interface CargoInvoiceDetailStudio { [key: string]: any | any; /** * Product name. */ full_name: string; /** * Product unit name. */ unit_name?: string | null; /** * Unit price. */ unit_price: number; /** * Product amount. */ unit_amount: number; /** * External product identifier. */ external_id?: string | null; /** * Link to product description. */ external_url?: string | null; tax: CargoInvoiceTaxStudio; honest_sign: CargoInvoiceHonestSignStudio; /** * Barcode or QR-code. */ scan_code?: string | null; /** * Age restrictions apply (18+). */ age_restriction?: boolean; /** * The item being paid. For example, Goods or Services. */ payment_subject_type?: string | null; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Information for printing a receipt. */ interface CargoInvoiceReceiptStudio { [key: string]: any | any; /** * User e-mail address. */ email?: string | null; /** * User phone. */ phone?: string | null; /** * The document used for payment. */ payment_document?: string | null; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Cargo invoice. */ interface CargoInvoiceStudio { [key: string]: any | any; /** * Flag indicating whether payment is required: * `true` - payment required * `false` - payment not required */ payable: boolean; /** * Product data. */ invoice_details: Array<CargoInvoiceDetailStudio>; receipt?: CargoInvoiceReceiptStudio; /** * Prepayment amount. */ prepayment?: number; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Cargo. Regardless of capacity, cargo can only move inside the transport box. */ interface CargoStudio { [key: string]: any | any; /** * Cargo key, unique identifier. */ key: string; capacity?: CapacityStudio | null; compatibilities?: CargoCompatibilitiesStudio | null; /** * The key of the transport box in which the cargo is already located. Applicable only for cargo that is in the order with the type `DROP_FROM_BOX`. For other order types, the key must be empty. */ target_box_key?: string | null; invoice?: CargoInvoiceStudio | null; /** * Attributes. Used to add service information. */ attributes?: Array<AttributeStudio>; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Service availability result. */ interface CheckResultStudio { [key: string]: any | any; /** * The current health indicator of the service. * `0.0` means the service is not ready to perform tasks. * `1.0` means the service is fully ready to perform tasks. */ health: number; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Penalty for violation of compatibility. */ interface CompatibilityPenaltyStudio { [key: string]: any | any; /** * Tag used to determine [compatibility](#section/Description/Compatibilities). */ tag: string; /** * Penalty for violation of compatibility for the specified tag. */ penalty: number; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Additional time for the execution of the application by a certain performer. */ interface DemandExtraDurationStudio { [key: string]: any | any; /** * The key of the ticket whose events need to increase the execution time. */ demand_key: string; /** * Time duration according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). */ additional_duration: string; } /** * VRt.Studio [ST] * * The version of the OpenAPI document: 7.37.3331 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Possible event. Combines the geographical location and the time window, when a demand can be completed. */ interface PossibleEventStudio { [key: string]: any | any; /** * Event key, unique identifier. */ key: string; /** * Location key, where this event is possible. */ location_key: string; /** * Time duration accord