@finbourne/lusid-sdk-angular18

import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http'; import { Observable } from 'rxjs'; import { AccessMetadataOperation } from '../model/accessMetadataOperation'; import { AccessMetadataValue } from '../model/accessMetadataValue'; import { DeletedEntityResponse } from '../model/deletedEntityResponse'; import { InvestorRecord } from '../model/investorRecord'; import { ResourceListOfInvestorRecord } from '../model/resourceListOfInvestorRecord'; import { ResourceListOfRelationship } from '../model/resourceListOfRelationship'; import { UpsertInvestorRecordRequest } from '../model/upsertInvestorRecordRequest'; import { UpsertInvestorRecordsResponse } from '../model/upsertInvestorRecordsResponse'; import { Configuration } from '../configuration'; import * as i0 from "@angular/core"; export interface DeleteInvestorRecordRequestParams { /** Code of the investor record identifier type. */ identifierType: string; /** Code of the investor record under specified identifier type\'s scope and code. */ identifierValue: string; /** The scope of the investor record entity. */ scope: string; /** Scope of the investor record identifier type. */ identifierScope: string; } export interface DeleteInvestorRecordAccessMetadataRequestParams { /** Code of the investor record identifier type. */ identifierType: string; /** Code of the investor record under specified identifier type\'s scope and code. */ identifierValue: string; /** Key of the metadata entry to delete */ metadataKey: string; /** The scope of the investor record entity. */ scope: string; /** Scope of the investor record identifier type. */ identifierScope: string; /** The effective date to delete at, if this is not supplied, it will delete all data found */ effectiveAt?: string; /** The effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next \'effectiveAt\' date of the Access Metadata */ effectiveUntil?: string; } export interface GetAllInvestorRecordAccessMetadataRequestParams { /** Code of the investor record identifier type. */ identifierType: string; /** Code of the investor record under specified identifier type\'s scope and code. */ identifierValue: string; /** The scope of the investor record entity. */ scope: string; /** Scope of the investor record identifier type. */ identifierScope: string; /** The effectiveAt datetime at which to retrieve the Access Metadata */ effectiveAt?: string; /** The asAt datetime at which to retrieve the Access Metadata */ asAt?: string; } export interface GetInvestorRecordRequestParams { /** Code of the investor record identifier type. */ identifierType: string; /** Code of the investor record under specified identifier type\'s scope and code. */ identifierValue: string; /** The scope of the investor record entity. */ scope: string; /** Scope of the investor record identifier type. */ identifierScope: 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 GetInvestorRecordRelationshipsRequestParams { /** Code of the investor record identifier type. */ identifierType: string; /** Code of the investor record under specified identifier type\'s scope and code. */ identifierValue: string; /** The scope of the investor record entity. */ scope: string; /** Scope of the investor record identifier type. */ identifierScope: string; /** The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. */ effectiveAt?: string; /** The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. */ asAt?: string; /** Expression to filter relationships. Users should provide null or empty string for this field until further notice. */ filter?: string; /** Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the \'Person\' or \'LegalEntity\' domains and have the format {domain}/{scope}/{code}, for example \'Person/CompanyDetails/Role\'. An Empty array may be used to return all related Entities. */ identifierTypes?: 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 PatchInvestorRecordAccessMetadataRequestParams { /** Code of the investor record identifier type. */ identifierType: string; /** Code of the investor record under specified identifier type\'s scope and code. */ identifierValue: string; /** The scope of the investor record entity. */ scope: string; /** Scope of the investor record identifier type. */ identifierScope: string; /** The Json Patch document */ accessMetadataOperation: Array<AccessMetadataOperation>; /** The effectiveAt datetime at which to upsert the Access Metadata */ effectiveAt?: string; /** The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next \'effectiveAt\' datetime of the Access Metadata */ effectiveUntil?: 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] DeleteInvestorRecordAccessMetadata: Delete an Investor Record Access Metadata entry. * Deletes the Investor Record Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure). * @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. */ deleteInvestorRecordAccessMetadata(requestParameters?: DeleteInvestorRecordAccessMetadataRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<DeletedEntityResponse>; deleteInvestorRecordAccessMetadata(requestParameters?: DeleteInvestorRecordAccessMetadataRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<DeletedEntityResponse>>; deleteInvestorRecordAccessMetadata(requestParameters?: DeleteInvestorRecordAccessMetadataRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<DeletedEntityResponse>>; /** * [EARLY ACCESS] GetAllInvestorRecordAccessMetadata: Get Access Metadata rules for an Investor Record. * Pass the Scope and Code of the Investor Record identifier along with the identifier value parameter to retrieve the associated Access Metadata. * @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. */ getAllInvestorRecordAccessMetadata(requestParameters?: GetAllInvestorRecordAccessMetadataRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<{ [key: string]: Array<AccessMetadataValue>; }>; getAllInvestorRecordAccessMetadata(requestParameters?: GetAllInvestorRecordAccessMetadataRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<{ [key: string]: Array<AccessMetadataValue>; }>>; getAllInvestorRecordAccessMetadata(requestParameters?: GetAllInvestorRecordAccessMetadataRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<{ [key: string]: Array<AccessMetadataValue>; }>>; /** * [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] GetInvestorRecordRelationships: Get Investor Record relationships * Get relationships for a particular 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. */ getInvestorRecordRelationships(requestParameters?: GetInvestorRecordRelationshipsRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<ResourceListOfRelationship>; getInvestorRecordRelationships(requestParameters?: GetInvestorRecordRelationshipsRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<ResourceListOfRelationship>>; getInvestorRecordRelationships(requestParameters?: GetInvestorRecordRelationshipsRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<ResourceListOfRelationship>>; /** * [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] PatchInvestorRecordAccessMetadata: Patch Access Metadata rules for an Investor Record. * Patch Investor Record Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only \'add\' is a supported operation on the patch document Currently only valid metadata keys are supported paths on the patch document The response will return any affected Investor Record Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. * @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. */ patchInvestorRecordAccessMetadata(requestParameters?: PatchInvestorRecordAccessMetadataRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<{ [key: string]: Array<AccessMetadataValue>; }>; patchInvestorRecordAccessMetadata(requestParameters?: PatchInvestorRecordAccessMetadataRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<{ [key: string]: Array<AccessMetadataValue>; }>>; patchInvestorRecordAccessMetadata(requestParameters?: PatchInvestorRecordAccessMetadataRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<{ [key: string]: Array<AccessMetadataValue>; }>>; /** * [EARLY ACCESS] UpsertInvestorRecords: Upsert 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>; }