@finbourne/lusid-sdk-angular8
Version:
An angular (8+) SDK for secure access to the LUSID® by FINBOURNE web API
295 lines (294 loc) • 37.4 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } from '@angular/common/http';
import { Observable } from 'rxjs';
import { AccessMetadataOperation } from '../model/accessMetadataOperation';
import { AccessMetadataValue } from '../model/accessMetadataValue';
import { DeletedEntityResponse } from '../model/deletedEntityResponse';
import { LegalEntity } from '../model/legalEntity';
import { PagedResourceListOfLegalEntity } from '../model/pagedResourceListOfLegalEntity';
import { ResourceListOfAccessMetadataValueOf } from '../model/resourceListOfAccessMetadataValueOf';
import { ResourceListOfLegalEntity } from '../model/resourceListOfLegalEntity';
import { ResourceListOfPropertyInterval } from '../model/resourceListOfPropertyInterval';
import { ResourceListOfRelation } from '../model/resourceListOfRelation';
import { ResourceListOfRelationship } from '../model/resourceListOfRelationship';
import { SetLegalEntityIdentifiersRequest } from '../model/setLegalEntityIdentifiersRequest';
import { SetLegalEntityPropertiesRequest } from '../model/setLegalEntityPropertiesRequest';
import { UpsertLegalEntityAccessMetadataRequest } from '../model/upsertLegalEntityAccessMetadataRequest';
import { UpsertLegalEntityRequest } from '../model/upsertLegalEntityRequest';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export declare class LegalEntitiesService {
protected httpClient: HttpClient;
protected basePath: string;
defaultHeaders: HttpHeaders;
configuration: Configuration;
constructor(httpClient: HttpClient, basePath: string, configuration: Configuration);
/**
* @param consumes string[] mime-types
* @return true: consumes contains 'multipart/form-data', false: otherwise
*/
private canConsumeForm;
/**
* [EARLY ACCESS] DeleteLegalEntity: Delete Legal Entity
* Delete a legal entity. Deletion will be valid from the legal entity\'s creation datetime. This means that the legal entity will no longer exist at any effective datetime from the asAt datetime of deletion.
* @param idTypeScope The scope of the legal entity identifier type.
* @param idTypeCode The code of the legal entity identifier type.
* @param code Code of the legal entity under specified identifier type\'s scope and code. This together with defined identifier type uniquely identifies the legal entity to delete.
* @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.
*/
deleteLegalEntity(idTypeScope: string, idTypeCode: string, code: string, observe?: 'body', reportProgress?: boolean): Observable<DeletedEntityResponse>;
deleteLegalEntity(idTypeScope: string, idTypeCode: string, code: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<DeletedEntityResponse>>;
deleteLegalEntity(idTypeScope: string, idTypeCode: string, code: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<DeletedEntityResponse>>;
/**
* [EARLY ACCESS] DeleteLegalEntityAccessMetadata: Delete a Legal Entity Access Metadata entry
* Deletes the Legal Entity Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure).
* @param idTypeScope Scope of the Legal Entity identifier.
* @param idTypeCode Code of the Legal Entity identifier.
* @param code Code of the Legal Entity under specified identifier type\'s scope and code.
* @param metadataKey Key of the metadata entry to retrieve
* @param effectiveAt The effective date to delete at, if this is not supplied, it will delete all data found
* @param effectiveUntil 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
* @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.
*/
deleteLegalEntityAccessMetadata(idTypeScope: string, idTypeCode: string, code: string, metadataKey: string, effectiveAt?: string, effectiveUntil?: Date, observe?: 'body', reportProgress?: boolean): Observable<DeletedEntityResponse>;
deleteLegalEntityAccessMetadata(idTypeScope: string, idTypeCode: string, code: string, metadataKey: string, effectiveAt?: string, effectiveUntil?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<DeletedEntityResponse>>;
deleteLegalEntityAccessMetadata(idTypeScope: string, idTypeCode: string, code: string, metadataKey: string, effectiveAt?: string, effectiveUntil?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<DeletedEntityResponse>>;
/**
* [EARLY ACCESS] DeleteLegalEntityIdentifiers: Delete Legal Entity Identifiers
* Delete identifiers that belong to the given property keys of the legal entity.
* @param idTypeScope Scope of the legal entity identifier type.
* @param idTypeCode Code of the legal entity identifier type.
* @param code Code of the legal entity under specified identifier type\'s scope and code. This together with stated identifier type uniquely identifies the legal entity.
* @param propertyKeys The property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. \"LegalEntity/CreditAgency/Identifier\". Each property must be from the \"LegalEntity\" domain. Identifiers or identifiers not specified in request will not be changed.
* @param effectiveAt The effective datetime or cut label at which to delete the identifiers. Defaults to the current LUSID system datetime if not specified. Must not include an effective datetime if identifiers are perpetual.
* @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.
*/
deleteLegalEntityIdentifiers(idTypeScope: string, idTypeCode: string, code: string, propertyKeys: Array<string>, effectiveAt?: string, observe?: 'body', reportProgress?: boolean): Observable<DeletedEntityResponse>;
deleteLegalEntityIdentifiers(idTypeScope: string, idTypeCode: string, code: string, propertyKeys: Array<string>, effectiveAt?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<DeletedEntityResponse>>;
deleteLegalEntityIdentifiers(idTypeScope: string, idTypeCode: string, code: string, propertyKeys: Array<string>, effectiveAt?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<DeletedEntityResponse>>;
/**
* [EARLY ACCESS] DeleteLegalEntityProperties: Delete Legal Entity Properties
* Delete all properties that belong to the given property keys of the legal entity.
* @param idTypeScope Scope of the legal entity identifier type.
* @param idTypeCode Code of the legal entity identifier type.
* @param code Code of the legal entity under specified identifier type\'s scope and code. This together with stated identifier type uniquely identifies the legal entity.
* @param propertyKeys The property keys of the legal entities properties to delete. These take the format {domain}/{scope}/{code} e.g. \"LegalEntity/CompanyDetails/Role\". Each property must be from the \"LegalEntity\" domain. Properties or identifiers not specified in request will not be changed.
* @param effectiveAt The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified \'effectiveAt\' datetime. If the \'effectiveAt\' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.
* @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.
*/
deleteLegalEntityProperties(idTypeScope: string, idTypeCode: string, code: string, propertyKeys: Array<string>, effectiveAt?: string, observe?: 'body', reportProgress?: boolean): Observable<DeletedEntityResponse>;
deleteLegalEntityProperties(idTypeScope: string, idTypeCode: string, code: string, propertyKeys: Array<string>, effectiveAt?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<DeletedEntityResponse>>;
deleteLegalEntityProperties(idTypeScope: string, idTypeCode: string, code: string, propertyKeys: Array<string>, effectiveAt?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<DeletedEntityResponse>>;
/**
* [EARLY ACCESS] GetAllLegalEntityAccessMetadata: Get Access Metadata rules for a Legal Entity
* Pass the Scope and Code of the Legal Entity identifier along with the Legal Entity code parameter to retrieve the associated Access Metadata
* @param idTypeScope Scope of the Legal Entity identifier.
* @param idTypeCode Code of the Legal Entity identifier.
* @param code Code of the Legal Entity under specified identifier type\'s scope and code.
* @param effectiveAt The effectiveAt datetime at which to retrieve the Access Metadata
* @param asAt The asAt datetime at which to retrieve the Access Metadata
* @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.
*/
getAllLegalEntityAccessMetadata(idTypeScope: string, idTypeCode: string, code: string, effectiveAt?: string, asAt?: Date, observe?: 'body', reportProgress?: boolean): Observable<{
[key: string]: Array<AccessMetadataValue>;
}>;
getAllLegalEntityAccessMetadata(idTypeScope: string, idTypeCode: string, code: string, effectiveAt?: string, asAt?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<{
[key: string]: Array<AccessMetadataValue>;
}>>;
getAllLegalEntityAccessMetadata(idTypeScope: string, idTypeCode: string, code: string, effectiveAt?: string, asAt?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<{
[key: string]: Array<AccessMetadataValue>;
}>>;
/**
* [EARLY ACCESS] GetLegalEntity: Get Legal Entity
* Retrieve the definition of a legal entity.
* @param idTypeScope Scope of the legal entity identifier type.
* @param idTypeCode Code of the legal entity identifier type.
* @param code Code of the legal entity under specified identifier type\'s scope and code. This together with stated identifier type uniquely identifies the legal entity.
* @param propertyKeys A list of property keys or identifier types (as property keys) from the \"LegalEntity\" domain to include for found legal entity, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"LegalEntity/ContactDetails/Address\".
* @param effectiveAt The effective datetime or cut label at which to retrieve the legal entity. Defaults to the current LUSID system datetime if not specified.
* @param asAt The asAt datetime at which to retrieve the legal entity. Defaults to return the latest version of the legal entity if not specified.
* @param relationshipDefinitionIds A list of relationship definitions that are used to decorate related entities onto the legal entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
* @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.
*/
getLegalEntity(idTypeScope: string, idTypeCode: string, code: string, propertyKeys?: Array<string>, effectiveAt?: string, asAt?: Date, relationshipDefinitionIds?: Array<string>, observe?: 'body', reportProgress?: boolean): Observable<LegalEntity>;
getLegalEntity(idTypeScope: string, idTypeCode: string, code: string, propertyKeys?: Array<string>, effectiveAt?: string, asAt?: Date, relationshipDefinitionIds?: Array<string>, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<LegalEntity>>;
getLegalEntity(idTypeScope: string, idTypeCode: string, code: string, propertyKeys?: Array<string>, effectiveAt?: string, asAt?: Date, relationshipDefinitionIds?: Array<string>, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<LegalEntity>>;
/**
* [EARLY ACCESS] GetLegalEntityAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Legal Entity
* Get a specific Legal Entity Access Metadata by specifying the corresponding identifier parts and Legal Entity code No matching will be performed through this endpoint. To retrieve an entry, it is necessary to specify, exactly, the identifier of the entry
* @param idTypeScope Scope of the Legal Entity identifier.
* @param idTypeCode Code of the Legal Entity identifier.
* @param code Code of the Legal Entity under specified identifier type\'s scope and code.
* @param metadataKey Key of the metadata entry to retrieve
* @param effectiveAt The effectiveAt datetime at which to retrieve the Access Metadata
* @param asAt The asAt datetime at which to retrieve the Access Metadata
* @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.
*/
getLegalEntityAccessMetadataByKey(idTypeScope: string, idTypeCode: string, code: string, metadataKey: string, effectiveAt?: string, asAt?: Date, observe?: 'body', reportProgress?: boolean): Observable<Array<AccessMetadataValue>>;
getLegalEntityAccessMetadataByKey(idTypeScope: string, idTypeCode: string, code: string, metadataKey: string, effectiveAt?: string, asAt?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<Array<AccessMetadataValue>>>;
getLegalEntityAccessMetadataByKey(idTypeScope: string, idTypeCode: string, code: string, metadataKey: string, effectiveAt?: string, asAt?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<Array<AccessMetadataValue>>>;
/**
* [EARLY ACCESS] GetLegalEntityPropertyTimeSeries: Get Legal Entity Property Time Series
* List the complete time series of a legal entity property.
* @param idTypeScope Scope of the legal entity identifier type.
* @param idTypeCode Code of the legal entity identifier type.
* @param code Code of the legal entity under specified identifier type\'s scope and code. This together with stated identifier type uniquely identifies the legal entity.
* @param propertyKey The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. \"LegalEntity/ContactDetails/Address\". Each property must be from the \"LegalEntity\" domain.
* @param asAt The asAt datetime at which to list the person\'s property history. Defaults to return the current datetime if not supplied.
* @param filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
* @param page The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request.
* @param limit When paginating, limit the number of returned results to this many.
* @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.
*/
getLegalEntityPropertyTimeSeries(idTypeScope: string, idTypeCode: string, code: string, propertyKey: string, asAt?: Date, filter?: string, page?: string, limit?: number, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfPropertyInterval>;
getLegalEntityPropertyTimeSeries(idTypeScope: string, idTypeCode: string, code: string, propertyKey: string, asAt?: Date, filter?: string, page?: string, limit?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfPropertyInterval>>;
getLegalEntityPropertyTimeSeries(idTypeScope: string, idTypeCode: string, code: string, propertyKey: string, asAt?: Date, filter?: string, page?: string, limit?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfPropertyInterval>>;
/**
* [EXPERIMENTAL] GetLegalEntityRelations: Get Relations for Legal Entity
* Get relations for the specified Legal Entity
* @param idTypeScope Scope of the legal entity identifier type.
* @param idTypeCode Code of the legal entity identifier type.
* @param code Code of the legal entity under specified identifier type\'s scope and code. This together with stated identifier type uniquely identifies the legal entity.
* @param effectiveAt The effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified.
* @param asAt The asAt datetime at which to retrieve the legal entity\'s relations. Defaults to return the latest LUSID AsAt time if not specified.
* @param filter Expression to filter the relations. Users should provide null or empty string for this field until further notice.
* @param identifierTypes Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". They must be from the \"Person\" or \"LegalEntity\" domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array.
* @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.
*/
getLegalEntityRelations(idTypeScope: string, idTypeCode: string, code: string, effectiveAt?: string, asAt?: Date, filter?: string, identifierTypes?: Array<string>, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfRelation>;
getLegalEntityRelations(idTypeScope: string, idTypeCode: string, code: string, effectiveAt?: string, asAt?: Date, filter?: string, identifierTypes?: Array<string>, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfRelation>>;
getLegalEntityRelations(idTypeScope: string, idTypeCode: string, code: string, effectiveAt?: string, asAt?: Date, filter?: string, identifierTypes?: Array<string>, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfRelation>>;
/**
* [EARLY ACCESS] GetLegalEntityRelationships: Get Relationships for Legal Entity
* Get Relationships for the specified Legal Entity
* @param idTypeScope Scope of the legal entity\'s identifier type.
* @param idTypeCode Code of the legal entity\'s identifier type.
* @param code Code of the legal entity under specified identifier type\'s scope and code. This together with stated identifier type uniquely identifies the legal entity.
* @param effectiveAt The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified.
* @param asAt The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified.
* @param filter Expression to filter relationships. Users should provide null or empty string for this field until further notice.
* @param identifierTypes 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.
* @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.
*/
getLegalEntityRelationships(idTypeScope: string, idTypeCode: string, code: string, effectiveAt?: string, asAt?: Date, filter?: string, identifierTypes?: Array<string>, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfRelationship>;
getLegalEntityRelationships(idTypeScope: string, idTypeCode: string, code: string, effectiveAt?: string, asAt?: Date, filter?: string, identifierTypes?: Array<string>, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfRelationship>>;
getLegalEntityRelationships(idTypeScope: string, idTypeCode: string, code: string, effectiveAt?: string, asAt?: Date, filter?: string, identifierTypes?: Array<string>, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfRelationship>>;
/**
* [EARLY ACCESS] ListAllLegalEntities: List Legal Entities
* List all legal entities which the user is entitled to see.
* @param effectiveAt The effective datetime or cut label at which to list the legal entities. Defaults to the current LUSID system datetime if not specified.
* @param asAt The asAt datetime at which to list the legal entities. Defaults to return the latest version of each legal entities if not specified.
* @param page The pagination token to use to continue listing legal entities from a previous call to list legal entities. 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 number of returned results to this many. Defaults to 5000 if not specified.
* @param filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
* @param propertyKeys A list of property keys or identifier types (as property keys) from the \"LegalEntity\" domain to include for each legal entity, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"LegalEntity/ContactDetails/Address\".
* @param relationshipDefinitionIds 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}.
* @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.
*/
listAllLegalEntities(effectiveAt?: string, asAt?: Date, page?: string, limit?: number, filter?: string, propertyKeys?: Array<string>, relationshipDefinitionIds?: Array<string>, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfLegalEntity>;
listAllLegalEntities(effectiveAt?: string, asAt?: Date, page?: string, limit?: number, filter?: string, propertyKeys?: Array<string>, relationshipDefinitionIds?: Array<string>, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfLegalEntity>>;
listAllLegalEntities(effectiveAt?: string, asAt?: Date, page?: string, limit?: number, filter?: string, propertyKeys?: Array<string>, relationshipDefinitionIds?: Array<string>, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfLegalEntity>>;
/**
* [EARLY ACCESS] ListLegalEntities: List Legal Entities
* List legal entities which has identifier of specific identifier type\'s scope and code, and satisfies filter criteria.
* @param idTypeScope Scope of the legal entity identifier type.
* @param idTypeCode Code of the legal entity identifier type.
* @param effectiveAt The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified.
* @param asAt The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified.
* @param page The pagination token to use to continue listing legal entities from a previous call to list legal entities. 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 number of returned results to this many. Defaults to 100 if not specified.
* @param filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
* @param propertyKeys A list of property keys or identifier types (as property keys) from the \"LegalEntity\" domain to include for each legal entity, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"LegalEntity/ContactDetails/Address\".
* @param relationshipDefinitionIds 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}.
* @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.
*/
listLegalEntities(idTypeScope: string, idTypeCode: string, effectiveAt?: string, asAt?: Date, page?: string, limit?: number, filter?: string, propertyKeys?: Array<string>, relationshipDefinitionIds?: Array<string>, observe?: 'body', reportProgress?: boolean): Observable<PagedResourceListOfLegalEntity>;
listLegalEntities(idTypeScope: string, idTypeCode: string, effectiveAt?: string, asAt?: Date, page?: string, limit?: number, filter?: string, propertyKeys?: Array<string>, relationshipDefinitionIds?: Array<string>, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<PagedResourceListOfLegalEntity>>;
listLegalEntities(idTypeScope: string, idTypeCode: string, effectiveAt?: string, asAt?: Date, page?: string, limit?: number, filter?: string, propertyKeys?: Array<string>, relationshipDefinitionIds?: Array<string>, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<PagedResourceListOfLegalEntity>>;
/**
* [EARLY ACCESS] PatchLegalEntityAccessMetadata: Patch Access Metadata rules for a Legal Entity.
* Patch Legal Entity 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 Legal Entity 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 idTypeScope Scope of the Legal Entity identifier.
* @param idTypeCode Code of the Legal Entity identifier.
* @param code Code of the Legal Entity under specified identifier type\'s scope and code.
* @param accessMetadataOperation The Json Patch document
* @param effectiveAt The effectiveAt datetime at which to upsert the Access Metadata
* @param effectiveUntil 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
* @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.
*/
patchLegalEntityAccessMetadata(idTypeScope: string, idTypeCode: string, code: string, accessMetadataOperation: Array<AccessMetadataOperation>, effectiveAt?: string, effectiveUntil?: Date, observe?: 'body', reportProgress?: boolean): Observable<{
[key: string]: Array<AccessMetadataValue>;
}>;
patchLegalEntityAccessMetadata(idTypeScope: string, idTypeCode: string, code: string, accessMetadataOperation: Array<AccessMetadataOperation>, effectiveAt?: string, effectiveUntil?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<{
[key: string]: Array<AccessMetadataValue>;
}>>;
patchLegalEntityAccessMetadata(idTypeScope: string, idTypeCode: string, code: string, accessMetadataOperation: Array<AccessMetadataOperation>, effectiveAt?: string, effectiveUntil?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<{
[key: string]: Array<AccessMetadataValue>;
}>>;
/**
* [EARLY ACCESS] SetLegalEntityIdentifiers: Set Legal Entity Identifiers
* Set identifiers of the Legal Entity.
* @param idTypeScope Scope of the legal entity identifier type.
* @param idTypeCode Code of the legal entity identifier type.
* @param code Code of the legal entity under specified identifier type\'s scope and code. This together with stated identifier type uniquely identifies the legal entity.
* @param setLegalEntityIdentifiersRequest Request containing identifiers to set for the legal entity. Identifiers not specified in request will not be changed.
* @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.
*/
setLegalEntityIdentifiers(idTypeScope: string, idTypeCode: string, code: string, setLegalEntityIdentifiersRequest: SetLegalEntityIdentifiersRequest, observe?: 'body', reportProgress?: boolean): Observable<LegalEntity>;
setLegalEntityIdentifiers(idTypeScope: string, idTypeCode: string, code: string, setLegalEntityIdentifiersRequest: SetLegalEntityIdentifiersRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<LegalEntity>>;
setLegalEntityIdentifiers(idTypeScope: string, idTypeCode: string, code: string, setLegalEntityIdentifiersRequest: SetLegalEntityIdentifiersRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<LegalEntity>>;
/**
* [EARLY ACCESS] SetLegalEntityProperties: Set Legal Entity Properties
* Set properties of the legal entity.
* @param idTypeScope Scope of the legal entity identifier type.
* @param idTypeCode Code of the legal entity identifier type.
* @param code Code of the legal entity under specified identifier type\'s scope and code. This together with stated identifier type uniquely identifies the legal entity.
* @param setLegalEntityPropertiesRequest Request containing properties to set for the legal entity. Properties not specified in request will not be changed.
* @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.
*/
setLegalEntityProperties(idTypeScope: string, idTypeCode: string, code: string, setLegalEntityPropertiesRequest: SetLegalEntityPropertiesRequest, observe?: 'body', reportProgress?: boolean): Observable<LegalEntity>;
setLegalEntityProperties(idTypeScope: string, idTypeCode: string, code: string, setLegalEntityPropertiesRequest: SetLegalEntityPropertiesRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<LegalEntity>>;
setLegalEntityProperties(idTypeScope: string, idTypeCode: string, code: string, setLegalEntityPropertiesRequest: SetLegalEntityPropertiesRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<LegalEntity>>;
/**
* [EARLY ACCESS] UpsertLegalEntity: Upsert Legal Entity
* Create or update a legal entity
* @param upsertLegalEntityRequest Request to create or update a legal entity.
* @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.
*/
upsertLegalEntity(upsertLegalEntityRequest: UpsertLegalEntityRequest, observe?: 'body', reportProgress?: boolean): Observable<LegalEntity>;
upsertLegalEntity(upsertLegalEntityRequest: UpsertLegalEntityRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<LegalEntity>>;
upsertLegalEntity(upsertLegalEntityRequest: UpsertLegalEntityRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<LegalEntity>>;
/**
* [EARLY ACCESS] UpsertLegalEntityAccessMetadata: Upsert a Legal Entity Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID.
* Update or insert one Legal Entity Access Metadata entry in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Legal Entity Access Metadata rule or 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 idTypeScope Scope of the Legal Entity identifier.
* @param idTypeCode Code of the Legal Entity identifier.
* @param code Code of the Legal Entity under specified identifier type\'s scope and code.
* @param metadataKey Key of the metadata entry to retrieve
* @param upsertLegalEntityAccessMetadataRequest The Legal Entity Access Metadata entry to upsert
* @param effectiveAt The effectiveAt datetime at which to upsert the Access Metadata
* @param effectiveUntil 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
* @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.
*/
upsertLegalEntityAccessMetadata(idTypeScope: string, idTypeCode: string, code: string, metadataKey: string, upsertLegalEntityAccessMetadataRequest: UpsertLegalEntityAccessMetadataRequest, effectiveAt?: string, effectiveUntil?: Date, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfAccessMetadataValueOf>;
upsertLegalEntityAccessMetadata(idTypeScope: string, idTypeCode: string, code: string, metadataKey: string, upsertLegalEntityAccessMetadataRequest: UpsertLegalEntityAccessMetadataRequest, effectiveAt?: string, effectiveUntil?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfAccessMetadataValueOf>>;
upsertLegalEntityAccessMetadata(idTypeScope: string, idTypeCode: string, code: string, metadataKey: string, upsertLegalEntityAccessMetadataRequest: UpsertLegalEntityAccessMetadataRequest, effectiveAt?: string, effectiveUntil?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfAccessMetadataValueOf>>;
static ɵfac: i0.ɵɵFactoryDef<LegalEntitiesService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDef<LegalEntitiesService>;
}