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

An Angular (18) SDK for secure access to the LUSID® by FINBOURNE web API

import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } 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 interface DeleteOrderInstructionRequestParams {
    /** The orderInstruction scope. */
    scope: string;
    /** The orderInstruction\'s code. This, together with the scope uniquely identifies the orderInstruction to delete. */
    code: string;
}
export interface GetOrderInstructionRequestParams {
    /** The scope to which the orderInstruction belongs. */
    scope: string;
    /** The orderInstruction\'s unique identifier. */
    code: string;
    /** The asAt datetime at which to retrieve the orderInstruction. Defaults to return the latest version of the orderInstruction if not specified. */
    asAt?: string;
    /** A list of property keys from the \"OrderInstruction\" domain to decorate onto the orderInstruction.              These take the format {domain}/{scope}/{code} e.g. \"OrderInstruction/system/Name\". */
    propertyKeys?: Array<string>;
}
export interface ListOrderInstructionsRequestParams {
    /** The asAt datetime at which to retrieve the orderInstruction. Defaults to return the latest version of the orderInstruction if not specified. */
    asAt?: string;
    /** 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. */
    page?: string;
    /** A list of field names or properties to sort by, each suffixed by \&quot; ASC\&quot; or \&quot; DESC\&quot;. */
    sortBy?: Array<string>;
    /** When paginating, limit the number of returned results to this many. */
    limit?: number;
    /** Expression to filter the result set. Read more about filtering results from LUSID here:              https://support.lusid.com/filtering-results-from-lusid. */
    filter?: string;
    /** 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;.                  All properties, except derived properties, are returned by default, without specifying here. */
    propertyKeys?: Array<string>;
}
export interface UpsertOrderInstructionsRequestParams {
    /** The collection of orderInstruction requests. */
    orderInstructionSetRequest?: OrderInstructionSetRequest;
}
export declare class OrderInstructionsService {
    protected httpClient: HttpClient;
    protected basePath: string;
    defaultHeaders: HttpHeaders;
    configuration: Configuration;
    encoder: HttpParameterCodec;
    constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
    private addToHttpParams;
    private addToHttpParamsRecursive;
    /**
     * DeleteOrderInstruction: Delete orderInstruction
     * Delete an orderInstruction. Deletion will be valid from the orderInstruction\&#39;s creation datetime.  This means that the orderInstruction will no longer exist at any effective datetime from the asAt datetime of deletion.
     * @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.
     */
    deleteOrderInstruction(requestParameters?: DeleteOrderInstructionRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<DeletedEntityResponse>;
    deleteOrderInstruction(requestParameters?: DeleteOrderInstructionRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<DeletedEntityResponse>>;
    deleteOrderInstruction(requestParameters?: DeleteOrderInstructionRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<DeletedEntityResponse>>;
    /**
     * GetOrderInstruction: Get OrderInstruction
     * Fetch a OrderInstruction that matches the specified 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.
     */
    getOrderInstruction(requestParameters?: GetOrderInstructionRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<OrderInstruction>;
    getOrderInstruction(requestParameters?: GetOrderInstructionRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<OrderInstruction>>;
    getOrderInstruction(requestParameters?: GetOrderInstructionRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<OrderInstruction>>;
    /**
     * ListOrderInstructions: List OrderInstructions
     * Fetch the last pre-AsAt date version of each orderInstruction in scope (does not fetch the entire history).
     * @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.
     */
    listOrderInstructions(requestParameters?: ListOrderInstructionsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<PagedResourceListOfOrderInstruction>;
    listOrderInstructions(requestParameters?: ListOrderInstructionsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<PagedResourceListOfOrderInstruction>>;
    listOrderInstructions(requestParameters?: ListOrderInstructionsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<PagedResourceListOfOrderInstruction>>;
    /**
     * UpsertOrderInstructions: Upsert OrderInstruction
     * Upsert; update existing orderInstructions with given ids, or create new orderInstructions otherwise.
     * @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.
     */
    upsertOrderInstructions(requestParameters?: UpsertOrderInstructionsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<ResourceListOfOrderInstruction>;
    upsertOrderInstructions(requestParameters?: UpsertOrderInstructionsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<ResourceListOfOrderInstruction>>;
    upsertOrderInstructions(requestParameters?: UpsertOrderInstructionsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<ResourceListOfOrderInstruction>>;
    static ɵfac: i0.ɵɵFactoryDeclaration<OrderInstructionsService, [null, { optional: true; }, { optional: true; }]>;
    static ɵprov: i0.ɵɵInjectableDeclaration<OrderInstructionsService>;
}