@finbourne/lusid-sdk-angular16/lib/.generated/api/referencePortfolio.service.d.ts

An angular (16) 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 { CreateReferencePortfolioRequest } from '../model/createReferencePortfolioRequest';
import { GetReferencePortfolioConstituentsResponse } from '../model/getReferencePortfolioConstituentsResponse';
import { Portfolio } from '../model/portfolio';
import { ResourceListOfConstituentsAdjustmentHeader } from '../model/resourceListOfConstituentsAdjustmentHeader';
import { UpsertReferencePortfolioConstituentPropertiesRequest } from '../model/upsertReferencePortfolioConstituentPropertiesRequest';
import { UpsertReferencePortfolioConstituentPropertiesResponse } from '../model/upsertReferencePortfolioConstituentPropertiesResponse';
import { UpsertReferencePortfolioConstituentsRequest } from '../model/upsertReferencePortfolioConstituentsRequest';
import { UpsertReferencePortfolioConstituentsResponse } from '../model/upsertReferencePortfolioConstituentsResponse';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export declare class ReferencePortfolioService {
    protected httpClient: HttpClient;
    protected basePath: string;
    defaultHeaders: HttpHeaders;
    configuration: Configuration;
    encoder: HttpParameterCodec;
    constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
    private addToHttpParams;
    private addToHttpParamsRecursive;
    /**
     * CreateReferencePortfolio: Create reference portfolio
     * Create a reference portfolio in a particular scope.
     * @param scope The scope in which to create the reference portfolio.
     * @param createReferencePortfolioRequest The definition of the reference portfolio.
     * @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.
     */
    createReferencePortfolio(scope: string, createReferencePortfolioRequest: CreateReferencePortfolioRequest, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<Portfolio>;
    createReferencePortfolio(scope: string, createReferencePortfolioRequest: CreateReferencePortfolioRequest, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<Portfolio>>;
    createReferencePortfolio(scope: string, createReferencePortfolioRequest: CreateReferencePortfolioRequest, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpEvent<Portfolio>>;
    /**
     * GetReferencePortfolioConstituents: Get reference portfolio constituents
     * Get constituents from a reference portfolio at a particular effective time.
     * @param scope The scope of the reference portfolio.
     * @param code The code of the reference portfolio. Together with the scope this uniquely identifies              the reference portfolio.
     * @param effectiveAt The effective date of the constituents to retrieve. Defaults to the current LUSID system datetime if not specified.
     * @param asAt The asAt datetime at which to retrieve constituents. Defaults to return the latest version              of each constituent if not specified.
     * @param propertyKeys A list of property keys from the \&#39;Instrument\&#39; or \&#39;ReferenceHolding\&#39; domain to decorate onto              constituents. These take the format {domain}/{scope}/{code} e.g. \&#39;Instrument/system/Name\&#39; or              \&#39;ReferenceHolding/strategy/quantsignal\&#39;. Defaults to return all available instrument and reference holding properties if not specified.
     * @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.
     */
    getReferencePortfolioConstituents(scope: string, code: string, effectiveAt?: string, asAt?: string, propertyKeys?: Array<string>, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<GetReferencePortfolioConstituentsResponse>;
    getReferencePortfolioConstituents(scope: string, code: string, effectiveAt?: string, asAt?: string, propertyKeys?: Array<string>, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<GetReferencePortfolioConstituentsResponse>>;
    getReferencePortfolioConstituents(scope: string, code: string, effectiveAt?: string, asAt?: string, propertyKeys?: Array<string>, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpEvent<GetReferencePortfolioConstituentsResponse>>;
    /**
     * ListConstituentsAdjustments: List constituents adjustments
     * List adjustments made to constituents in a reference portfolio.
     * @param scope The scope of the reference portfolio.
     * @param code The code of the reference portfolio. Together with the scope this uniquely identifies              the reference portfolio.
     * @param fromEffectiveAt Events between this time (inclusive) and the toEffectiveAt are returned.
     * @param toEffectiveAt Events between this time (inclusive) and the fromEffectiveAt are returned.
     * @param asAtTime The asAt time for which the result is valid.
     * @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.
     */
    listConstituentsAdjustments(scope: string, code: string, fromEffectiveAt: string, toEffectiveAt: string, asAtTime?: string, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<ResourceListOfConstituentsAdjustmentHeader>;
    listConstituentsAdjustments(scope: string, code: string, fromEffectiveAt: string, toEffectiveAt: string, asAtTime?: string, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<ResourceListOfConstituentsAdjustmentHeader>>;
    listConstituentsAdjustments(scope: string, code: string, fromEffectiveAt: string, toEffectiveAt: string, asAtTime?: string, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpEvent<ResourceListOfConstituentsAdjustmentHeader>>;
    /**
     * [EARLY ACCESS] UpsertReferencePortfolioConstituentProperties: Upsert constituent properties
     * Create or update one or more constituent properties for a single constituent in the reference portfolio.  Each property will be updated if it already exists, created if it does not and deleted if value is null.  Both constituent and portfolio must exist at the time when properties are created or updated.
     * @param scope The scope of the reference portfolio.
     * @param code The code of the reference portfolio. Together with the scope this uniquely identifies              the reference portfolio.
     * @param upsertReferencePortfolioConstituentPropertiesRequest The request to modify properties for the constituent.
     * @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.
     */
    upsertReferencePortfolioConstituentProperties(scope: string, code: string, upsertReferencePortfolioConstituentPropertiesRequest: UpsertReferencePortfolioConstituentPropertiesRequest, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<UpsertReferencePortfolioConstituentPropertiesResponse>;
    upsertReferencePortfolioConstituentProperties(scope: string, code: string, upsertReferencePortfolioConstituentPropertiesRequest: UpsertReferencePortfolioConstituentPropertiesRequest, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<UpsertReferencePortfolioConstituentPropertiesResponse>>;
    upsertReferencePortfolioConstituentProperties(scope: string, code: string, upsertReferencePortfolioConstituentPropertiesRequest: UpsertReferencePortfolioConstituentPropertiesRequest, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpEvent<UpsertReferencePortfolioConstituentPropertiesResponse>>;
    /**
     * UpsertReferencePortfolioConstituents: Upsert reference portfolio constituents
     * Add constituents to a reference portfolio.
     * @param scope The scope of the reference portfolio.
     * @param code The code of the reference portfolio. Together with the scope this uniquely identifies              the reference portfolio.
     * @param upsertReferencePortfolioConstituentsRequest The constituents to upload to the reference portfolio.
     * @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.
     */
    upsertReferencePortfolioConstituents(scope: string, code: string, upsertReferencePortfolioConstituentsRequest: UpsertReferencePortfolioConstituentsRequest, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<UpsertReferencePortfolioConstituentsResponse>;
    upsertReferencePortfolioConstituents(scope: string, code: string, upsertReferencePortfolioConstituentsRequest: UpsertReferencePortfolioConstituentsRequest, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<UpsertReferencePortfolioConstituentsResponse>>;
    upsertReferencePortfolioConstituents(scope: string, code: string, upsertReferencePortfolioConstituentsRequest: UpsertReferencePortfolioConstituentsRequest, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpEvent<UpsertReferencePortfolioConstituentsResponse>>;
    static ɵfac: i0.ɵɵFactoryDeclaration<ReferencePortfolioService, [null, { optional: true; }, { optional: true; }]>;
    static ɵprov: i0.ɵɵInjectableDeclaration<ReferencePortfolioService>;
}