@finbourne/lusid-sdk-angular18

import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http'; import { Observable } from 'rxjs'; import { DeletedEntityResponse } from '../model/deletedEntityResponse'; import { InvestorRecord } from '../model/investorRecord'; import { ResourceListOfInvestorRecord } from '../model/resourceListOfInvestorRecord'; import { UpsertInvestorRecordRequest } from '../model/upsertInvestorRecordRequest'; import { UpsertInvestorRecordsResponse } from '../model/upsertInvestorRecordsResponse'; import { Configuration } from '../configuration'; import * as i0 from "@angular/core"; export interface DeleteInvestorRecordRequestParams { /** The scope of the investor record identifier type. */ idTypeScope: string; /** The code of the investor record identifier type. */ idTypeCode: string; /** Code of the investor record under specified identifier type\'s scope and code. This together with defined identifier type uniquely identifies the investor record to delete. */ code: string; } export interface GetInvestorRecordRequestParams { /** Scope of the investor record identifier type. */ idTypeScope: string; /** Code of the investor record identifier type. */ idTypeCode: string; /** Code of the investor record under specified identifier type\'s scope and code. This together with stated identifier type uniquely identifies the investor record. */ code: string; /** A list of property keys or identifier types (as property keys) from the \"InvestorRecord\" domain to include for found investor record, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"InvestorRecord/ContactDetails/Address\". */ propertyKeys?: Array<string>; /** The effective datetime or cut label at which to retrieve the investor record. Defaults to the current LUSID system datetime if not specified. */ effectiveAt?: string; /** The asAt datetime at which to retrieve the investor record. Defaults to return the latest version of the investor record if not specified. */ asAt?: string; /** A list of relationship definitions that are used to decorate related entities onto the investor record in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. */ relationshipDefinitionIds?: Array<string>; } export interface ListAllInvestorRecordsRequestParams { /** The effective datetime or cut label at which to list the investor records. Defaults to the current LUSID system datetime if not specified. */ effectiveAt?: string; /** The asAt datetime at which to list the investor records. Defaults to return the latest version of each investor records if not specified. */ asAt?: string; /** The pagination token to use to continue listing investor records from a previous call to list investor records. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request. */ page?: string; /** When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified. */ 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 field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\". */ sortBy?: Array<string>; /** A list of property keys or identifier types (as property keys) from the \"InvestorRecord\" domain to include for each investor record, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"InvestorRecord/ContactDetails/Address\". */ propertyKeys?: Array<string>; /** A list of relationship definitions that are used to decorate related entities onto each portfolio in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. */ relationshipDefinitionIds?: Array<string>; } export interface UpsertInvestorRecordsRequestParams { /** Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial */ successMode: string; /** A collection of requests to create or update Investor Records. */ requestBody: { [key: string]: UpsertInvestorRecordRequest; }; } export declare class InvestorRecordsService { protected httpClient: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; encoder: HttpParameterCodec; constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration); private addToHttpParams; private addToHttpParamsRecursive; /** * [EARLY ACCESS] DeleteInvestorRecord: Delete Investor Record * Delete an investor record. Deletion will be valid from the investor record\'s creation datetime. This means that the investor record 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. */ deleteInvestorRecord(requestParameters?: DeleteInvestorRecordRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<DeletedEntityResponse>; deleteInvestorRecord(requestParameters?: DeleteInvestorRecordRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<DeletedEntityResponse>>; deleteInvestorRecord(requestParameters?: DeleteInvestorRecordRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<DeletedEntityResponse>>; /** * [EARLY ACCESS] GetInvestorRecord: Get Investor Record * Retrieve the definition of a investor record. * @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. */ getInvestorRecord(requestParameters?: GetInvestorRecordRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<InvestorRecord>; getInvestorRecord(requestParameters?: GetInvestorRecordRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<InvestorRecord>>; getInvestorRecord(requestParameters?: GetInvestorRecordRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<InvestorRecord>>; /** * [EARLY ACCESS] ListAllInvestorRecords: List Investor Records * List all investor records which the user is entitled to see. * @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. */ listAllInvestorRecords(requestParameters?: ListAllInvestorRecordsRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<ResourceListOfInvestorRecord>; listAllInvestorRecords(requestParameters?: ListAllInvestorRecordsRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<ResourceListOfInvestorRecord>>; listAllInvestorRecords(requestParameters?: ListAllInvestorRecordsRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<ResourceListOfInvestorRecord>>; /** * [EARLY ACCESS] UpsertInvestorRecords: Pluralised upsert of Investor Records * Creates or updates a collection of Investor Records * @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. */ upsertInvestorRecords(requestParameters?: UpsertInvestorRecordsRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<UpsertInvestorRecordsResponse>; upsertInvestorRecords(requestParameters?: UpsertInvestorRecordsRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<UpsertInvestorRecordsResponse>>; upsertInvestorRecords(requestParameters?: UpsertInvestorRecordsRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<UpsertInvestorRecordsResponse>>; static ɵfac: i0.ɵɵFactoryDeclaration<InvestorRecordsService, [null, { optional: true; }, { optional: true; }]>; static ɵprov: i0.ɵɵInjectableDeclaration<InvestorRecordsService>; }