@finbourne/lusid-sdk-angular8/lib/generated/api/orderInstructions.service.d.ts

An angular (8+) SDK for secure access to the LUSID® by FINBOURNE web API

import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } from '@angular/common/http';
import { Observable } from 'rxjs';
import { DeletedEntityResponse } from '../model/deletedEntityResponse';
import { OrderInstruction } from '../model/orderInstruction';
import { OrderInstructionSetRequest } from '../model/orderInstructionSetRequest';
import { PagedResourceListOfOrderInstruction } from '../model/pagedResourceListOfOrderInstruction';
import { ResourceListOfOrderInstruction } from '../model/resourceListOfOrderInstruction';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export declare class OrderInstructionsService {
    protected httpClient: HttpClient;
    protected basePath: string;
    defaultHeaders: HttpHeaders;
    configuration: Configuration;
    constructor(httpClient: HttpClient, basePath: string, configuration: Configuration);
    /**
     * @param consumes string[] mime-types
     * @return true: consumes contains 'multipart/form-data', false: otherwise
     */
    private canConsumeForm;
    /**
     * [EXPERIMENTAL] DeleteOrderInstruction: Delete orderInstruction
     * Delete an orderInstruction. Deletion will be valid from the orderInstruction\'s creation datetime.  This means that the orderInstruction will no longer exist at any effective datetime from the asAt datetime of deletion.
     * @param scope The orderInstruction scope.
     * @param code The orderInstruction\'s code. This, together with the scope uniquely identifies the orderInstruction to delete.
     * @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.
     */
    deleteOrderInstruction(scope: string, code: string, observe?: 'body', reportProgress?: boolean): Observable<DeletedEntityResponse>;
    deleteOrderInstruction(scope: string, code: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<DeletedEntityResponse>>;
    deleteOrderInstruction(scope: string, code: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<DeletedEntityResponse>>;
    /**
     * [EXPERIMENTAL] GetOrderInstruction: Get OrderInstruction
     * Fetch a OrderInstruction that matches the specified identifier
     * @param scope The scope to which the orderInstruction belongs.
     * @param code The orderInstruction\&#39;s unique identifier.
     * @param asAt The asAt datetime at which to retrieve the orderInstruction. Defaults to return the latest version of the orderInstruction if not specified.
     * @param propertyKeys A list of property keys from the \&quot;OrderInstruction\&quot; domain to decorate onto the orderInstruction.              These take the format {domain}/{scope}/{code} e.g. \&quot;OrderInstruction/system/Name\&quot;.
     * @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.
     */
    getOrderInstruction(scope: string, code: string, asAt?: Date, propertyKeys?: Array<string>, observe?: 'body', reportProgress?: boolean): Observable<OrderInstruction>;
    getOrderInstruction(scope: string, code: string, asAt?: Date, propertyKeys?: Array<string>, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<OrderInstruction>>;
    getOrderInstruction(scope: string, code: string, asAt?: Date, propertyKeys?: Array<string>, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<OrderInstruction>>;
    /**
     * [EXPERIMENTAL] ListOrderInstructions: List OrderInstructions
     * Fetch the last pre-AsAt date version of each orderInstruction in scope (does not fetch the entire history).
     * @param asAt The asAt datetime at which to retrieve the orderInstruction. Defaults to return the latest version of the orderInstruction if not specified.
     * @param page The pagination token to use to continue listing orderInstructions from a previous call to list orderInstructions.              This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields              must not have changed since the original request.
     * @param sortBy Order the results by these fields. Use use the \&#39;-\&#39; sign to denote descending order e.g. -MyFieldName.
     * @param limit When paginating, limit the number of returned results to this many.
     * @param filter Expression to filter the result set. Read more about filtering results from LUSID here:              https://support.lusid.com/filtering-results-from-lusid.
     * @param propertyKeys A list of property keys from the \&quot;OrderInstruction\&quot; domain to decorate onto each orderInstruction.                  These take the format {domain}/{scope}/{code} e.g. \&quot;OrderInstruction/system/Name\&quot;.
     * @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.
     */
    listOrderInstructions(asAt?: Date, page?: string, sortBy?: Array<string>, limit?: number, filter?: string, propertyKeys?: Array<string>, observe?: 'body', reportProgress?: boolean): Observable<PagedResourceListOfOrderInstruction>;
    listOrderInstructions(asAt?: Date, page?: string, sortBy?: Array<string>, limit?: number, filter?: string, propertyKeys?: Array<string>, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<PagedResourceListOfOrderInstruction>>;
    listOrderInstructions(asAt?: Date, page?: string, sortBy?: Array<string>, limit?: number, filter?: string, propertyKeys?: Array<string>, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<PagedResourceListOfOrderInstruction>>;
    /**
     * [EXPERIMENTAL] UpsertOrderInstructions: Upsert OrderInstruction
     * Upsert; update existing orderInstructions with given ids, or create new orderInstructions otherwise.
     * @param orderInstructionSetRequest The collection of orderInstruction requests.
     * @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.
     */
    upsertOrderInstructions(orderInstructionSetRequest?: OrderInstructionSetRequest, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfOrderInstruction>;
    upsertOrderInstructions(orderInstructionSetRequest?: OrderInstructionSetRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfOrderInstruction>>;
    upsertOrderInstructions(orderInstructionSetRequest?: OrderInstructionSetRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfOrderInstruction>>;
    static ɵfac: i0.ɵɵFactoryDef<OrderInstructionsService, [null, { optional: true; }, { optional: true; }]>;
    static ɵprov: i0.ɵɵInjectableDef<OrderInstructionsService>;
}