@finbourne/lusid-sdk-angular16/lib/.generated/api/fundConfiguration.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 { DeletedEntityResponse } from '../model/deletedEntityResponse';
import { FundConfiguration } from '../model/fundConfiguration';
import { FundConfigurationProperties } from '../model/fundConfigurationProperties';
import { FundConfigurationRequest } from '../model/fundConfigurationRequest';
import { Operation } from '../model/operation';
import { PagedResourceListOfFundConfiguration } from '../model/pagedResourceListOfFundConfiguration';
import { Property } from '../model/property';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export declare class FundConfigurationService {
    protected httpClient: HttpClient;
    protected basePath: string;
    defaultHeaders: HttpHeaders;
    configuration: Configuration;
    encoder: HttpParameterCodec;
    constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
    private addToHttpParams;
    private addToHttpParamsRecursive;
    /**
     * [EXPERIMENTAL] CreateFundConfiguration: Create a FundConfiguration.
     * Create the given FundConfiguration.
     * @param scope The scope of the FundConfiguration.
     * @param fundConfigurationRequest The definition of the FundConfiguration.
     * @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.
     */
    createFundConfiguration(scope: string, fundConfigurationRequest: FundConfigurationRequest, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<FundConfiguration>;
    createFundConfiguration(scope: string, fundConfigurationRequest: FundConfigurationRequest, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<FundConfiguration>>;
    createFundConfiguration(scope: string, fundConfigurationRequest: FundConfigurationRequest, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpEvent<FundConfiguration>>;
    /**
     * [EXPERIMENTAL] DeleteFundConfiguration: Delete a FundConfiguration.
     * Delete the given FundConfiguration.
     * @param scope The scope of the FundConfiguration to be deleted.
     * @param code The code of the FundConfiguration to be deleted.               Together with the scope this uniquely identifies the FundConfiguration.
     * @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.
     */
    deleteFundConfiguration(scope: string, code: string, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<DeletedEntityResponse>;
    deleteFundConfiguration(scope: string, code: string, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<DeletedEntityResponse>>;
    deleteFundConfiguration(scope: string, code: string, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpEvent<DeletedEntityResponse>>;
    /**
     * [EXPERIMENTAL] GetFundConfiguration: Get FundConfiguration.
     * Retrieve the definition of a particular FundConfiguration.
     * @param scope The scope of the FundConfiguration.
     * @param code The code of the FundConfiguration. Together with the scope this uniquely identifies the FundConfiguration.
     * @param effectiveAt The effective datetime or cut label at which to retrieve the FundConfiguration properties. Defaults to the current LUSID system datetime if not specified.
     * @param asAt The asAt datetime at which to retrieve the FundConfiguration definition. Defaults to returning the latest version of the FundConfiguration definition if not specified.
     * @param propertyKeys A list of property keys from the \&#39;FundConfiguration\&#39; domain to decorate onto the FundConfiguration.              These must take the format {domain}/{scope}/{code}, for example \&#39;FundConfiguration/Manager/Id\&#39;. If no properties are specified, then no properties will be returned.
     * @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.
     */
    getFundConfiguration(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<FundConfiguration>;
    getFundConfiguration(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<FundConfiguration>>;
    getFundConfiguration(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<FundConfiguration>>;
    /**
     * [EXPERIMENTAL] ListFundConfigurations: List FundConfiguration.
     * List all the FundConfiguration matching particular criteria.
     * @param effectiveAt The effective datetime or cut label at which to list the TimeVariant properties for the FundConfiguration.              Defaults to the current LUSID system datetime if not specified.
     * @param asAt The asAt datetime at which to list the FundConfiguration. Defaults to returning the latest version of each FundConfiguration if not specified.
     * @param page The pagination token to use to continue listing FundConfiguration; this              value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt              and asAt fields must not have changed since the original request.
     * @param limit When paginating, limit the results to this number. Defaults to 100 if not specified.
     * @param filter Expression to filter the results.              For example, to filter on the FundConfiguration type, specify \&quot;id.Code eq \&#39;FundConfiguration1\&#39;\&quot;. For more information about filtering              results, see https://support.lusid.com/knowledgebase/article/KA-01914.
     * @param sortBy A list of field names or properties to sort by, each suffixed by \&quot; ASC\&quot; or \&quot; DESC\&quot;.
     * @param propertyKeys A list of property keys from the \&#39;FundConfiguration\&#39; domain to decorate onto each FundConfiguration.              These must take the format {domain}/{scope}/{code}, for example \&#39;FundConfiguration/Manager/Id\&#39;.
     * @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.
     */
    listFundConfigurations(effectiveAt?: string, asAt?: string, page?: string, limit?: number, filter?: string, sortBy?: Array<string>, propertyKeys?: Array<string>, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<PagedResourceListOfFundConfiguration>;
    listFundConfigurations(effectiveAt?: string, asAt?: string, page?: string, limit?: number, filter?: string, sortBy?: Array<string>, propertyKeys?: Array<string>, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<PagedResourceListOfFundConfiguration>>;
    listFundConfigurations(effectiveAt?: string, asAt?: string, page?: string, limit?: number, filter?: string, sortBy?: Array<string>, propertyKeys?: Array<string>, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpEvent<PagedResourceListOfFundConfiguration>>;
    /**
     * [EXPERIMENTAL] PatchFundConfiguration: Patch Fund Configuration.
     * Create or update certain fields for a particular FundConfiguration.  The behaviour is defined by the JSON Patch specification.                Currently supported fields are: displayName, description, dealingFilters, pnlFilters, backOutFilters.
     * @param scope The scope of the FundConfiguration.
     * @param code The code of the FundConfiguration. Together with the               scope this uniquely identifies the FundConfiguration.
     * @param operation The json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902.
     * @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.
     */
    patchFundConfiguration(scope: string, code: string, operation: Array<Operation>, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<FundConfiguration>;
    patchFundConfiguration(scope: string, code: string, operation: Array<Operation>, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<FundConfiguration>>;
    patchFundConfiguration(scope: string, code: string, operation: Array<Operation>, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpEvent<FundConfiguration>>;
    /**
     * [EXPERIMENTAL] UpsertFundConfigurationProperties: Upsert FundConfiguration properties
     * Update or insert one or more properties onto a single FundConfiguration. A property will be updated if it  already exists and inserted if it does not. All properties must be of the domain \&#39;FundConfiguration\&#39;.                Upserting a property that exists for an FundConfiguration, with a null value, will delete the instance of the property for that group.                Properties have an &lt;i&gt;effectiveFrom&lt;/i&gt; datetime for which the property is valid, and an &lt;i&gt;effectiveUntil&lt;/i&gt;  datetime until which the property is valid. Not supplying an &lt;i&gt;effectiveUntil&lt;/i&gt; datetime results in the property being  valid indefinitely, or until the next &lt;i&gt;effectiveFrom&lt;/i&gt; datetime of the property.
     * @param scope The scope of the FundConfiguration to update or insert the properties onto.
     * @param code The code of the FundConfiguration to update or insert the properties onto. Together with the scope this uniquely identifies the FundConfiguration.
     * @param requestBody The properties to be updated or inserted onto the Fund Configuration. Each property in               the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. \&quot;FundConfiguration/Manager/Id\&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.
     */
    upsertFundConfigurationProperties(scope: string, code: string, requestBody?: {
        [key: string]: Property;
    }, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<FundConfigurationProperties>;
    upsertFundConfigurationProperties(scope: string, code: string, requestBody?: {
        [key: string]: Property;
    }, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<FundConfigurationProperties>>;
    upsertFundConfigurationProperties(scope: string, code: string, requestBody?: {
        [key: string]: Property;
    }, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpEvent<FundConfigurationProperties>>;
    static ɵfac: i0.ɵɵFactoryDeclaration<FundConfigurationService, [null, { optional: true; }, { optional: true; }]>;
    static ɵprov: i0.ɵɵInjectableDeclaration<FundConfigurationService>;
}