UNPKG

@finbourne/lusid-sdk-angular18

Version:

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

214 lines (213 loc) 14.9 kB
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 interface CreateFundConfigurationRequestParams { /** The scope of the FundConfiguration. */ scope: string; /** The definition of the FundConfiguration. */ fundConfigurationRequest: FundConfigurationRequest; } export interface DeleteFundConfigurationRequestParams { /** The scope of the FundConfiguration to be deleted. */ scope: string; /** The code of the FundConfiguration to be deleted. Together with the scope this uniquely identifies the FundConfiguration. */ code: string; } export interface GetFundConfigurationRequestParams { /** The scope of the FundConfiguration. */ scope: string; /** The code of the FundConfiguration. Together with the scope this uniquely identifies the FundConfiguration. */ code: string; /** The effective datetime or cut label at which to retrieve the FundConfiguration properties. Defaults to the current LUSID system datetime if not specified. */ effectiveAt?: string; /** The asAt datetime at which to retrieve the FundConfiguration definition. Defaults to returning the latest version of the FundConfiguration definition if not specified. */ asAt?: string; /** 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. */ propertyKeys?: Array<string>; } export interface ListFundConfigurationsRequestParams { /** 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. */ effectiveAt?: string; /** The asAt datetime at which to list the FundConfiguration. Defaults to returning the latest version of each FundConfiguration if not specified. */ asAt?: string; /** 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. */ page?: string; /** When paginating, limit the results to this number. Defaults to 100 if not specified. */ limit?: number; /** 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. */ filter?: string; /** A list of field names or properties to sort by, each suffixed by \&quot; ASC\&quot; or \&quot; DESC\&quot;. */ sortBy?: Array<string>; /** 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;. */ propertyKeys?: Array<string>; } export interface PatchFundConfigurationRequestParams { /** The scope of the FundConfiguration. */ scope: string; /** The code of the FundConfiguration. Together with the scope this uniquely identifies the FundConfiguration. */ code: string; /** The json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902. */ operation: Array<Operation>; } export interface UpsertFundConfigurationPropertiesRequestParams { /** The scope of the FundConfiguration to update or insert the properties onto. */ scope: string; /** The code of the FundConfiguration to update or insert the properties onto. Together with the scope this uniquely identifies the FundConfiguration. */ code: string; /** 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;. */ requestBody?: { [key: string]: Property; }; } 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 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. */ createFundConfiguration(requestParameters?: CreateFundConfigurationRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<FundConfiguration>; createFundConfiguration(requestParameters?: CreateFundConfigurationRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<FundConfiguration>>; createFundConfiguration(requestParameters?: CreateFundConfigurationRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<FundConfiguration>>; /** * [EXPERIMENTAL] DeleteFundConfiguration: Delete a FundConfiguration. * Delete the given FundConfiguration. * @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. */ deleteFundConfiguration(requestParameters?: DeleteFundConfigurationRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<DeletedEntityResponse>; deleteFundConfiguration(requestParameters?: DeleteFundConfigurationRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<DeletedEntityResponse>>; deleteFundConfiguration(requestParameters?: DeleteFundConfigurationRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<DeletedEntityResponse>>; /** * [EXPERIMENTAL] GetFundConfiguration: Get FundConfiguration. * Retrieve the definition of a particular FundConfiguration. * @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. */ getFundConfiguration(requestParameters?: GetFundConfigurationRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<FundConfiguration>; getFundConfiguration(requestParameters?: GetFundConfigurationRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<FundConfiguration>>; getFundConfiguration(requestParameters?: GetFundConfigurationRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<FundConfiguration>>; /** * [EXPERIMENTAL] ListFundConfigurations: List FundConfiguration. * List all the FundConfiguration matching particular criteria. * @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. */ listFundConfigurations(requestParameters?: ListFundConfigurationsRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<PagedResourceListOfFundConfiguration>; listFundConfigurations(requestParameters?: ListFundConfigurationsRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<PagedResourceListOfFundConfiguration>>; listFundConfigurations(requestParameters?: ListFundConfigurationsRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): 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, ExternalFeeFilters. * @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. */ patchFundConfiguration(requestParameters?: PatchFundConfigurationRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<FundConfiguration>; patchFundConfiguration(requestParameters?: PatchFundConfigurationRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<FundConfiguration>>; patchFundConfiguration(requestParameters?: PatchFundConfigurationRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): 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 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. */ upsertFundConfigurationProperties(requestParameters?: UpsertFundConfigurationPropertiesRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<FundConfigurationProperties>; upsertFundConfigurationProperties(requestParameters?: UpsertFundConfigurationPropertiesRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<FundConfigurationProperties>>; upsertFundConfigurationProperties(requestParameters?: UpsertFundConfigurationPropertiesRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<FundConfigurationProperties>>; static ɵfac: i0.ɵɵFactoryDeclaration<FundConfigurationService, [null, { optional: true; }, { optional: true; }]>; static ɵprov: i0.ɵɵInjectableDeclaration<FundConfigurationService>; }