@finbourne/lusid-sdk-angular8

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 { PagedResourceListOfPerson } from '../model/pagedResourceListOfPerson'; import { Person } from '../model/person'; import { ResourceListOfAccessMetadataValueOf } from '../model/resourceListOfAccessMetadataValueOf'; import { ResourceListOfPerson } from '../model/resourceListOfPerson'; import { ResourceListOfPropertyInterval } from '../model/resourceListOfPropertyInterval'; import { ResourceListOfRelation } from '../model/resourceListOfRelation'; import { ResourceListOfRelationship } from '../model/resourceListOfRelationship'; import { SetPersonIdentifiersRequest } from '../model/setPersonIdentifiersRequest'; import { SetPersonPropertiesRequest } from '../model/setPersonPropertiesRequest'; import { UpsertPersonAccessMetadataRequest } from '../model/upsertPersonAccessMetadataRequest'; import { UpsertPersonRequest } from '../model/upsertPersonRequest'; import { Configuration } from '../configuration'; import * as i0 from "@angular/core"; export declare class PersonsService { 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] DeletePerson: Delete person * Delete a person. Deletion will be valid from the person\'s creation datetime. This means that the person will no longer exist at any effective datetime from the asAt datetime of deletion. * @param idTypeScope The scope of the person identifier type. * @param idTypeCode The code of the person identifier type. * @param code Code of the person under specified identifier type scope and code. This together with defined identifier type uniquely identifies the person 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. */ deletePerson(idTypeScope: string, idTypeCode: string, code: string, observe?: 'body', reportProgress?: boolean): Observable<DeletedEntityResponse>; deletePerson(idTypeScope: string, idTypeCode: string, code: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<DeletedEntityResponse>>; deletePerson(idTypeScope: string, idTypeCode: string, code: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<DeletedEntityResponse>>; /** * [EARLY ACCESS] DeletePersonAccessMetadata: Delete a Person Access Metadata entry * Deletes the Person 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 person identifier. * @param idTypeCode Code of the person identifier. * @param code Code of the person 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. */ deletePersonAccessMetadata(idTypeScope: string, idTypeCode: string, code: string, metadataKey: string, effectiveAt?: string, effectiveUntil?: Date, observe?: 'body', reportProgress?: boolean): Observable<DeletedEntityResponse>; deletePersonAccessMetadata(idTypeScope: string, idTypeCode: string, code: string, metadataKey: string, effectiveAt?: string, effectiveUntil?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<DeletedEntityResponse>>; deletePersonAccessMetadata(idTypeScope: string, idTypeCode: string, code: string, metadataKey: string, effectiveAt?: string, effectiveUntil?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<DeletedEntityResponse>>; /** * [EARLY ACCESS] DeletePersonIdentifiers: Delete Person Identifiers * Delete identifiers that belong to the given property keys of the person. * @param idTypeScope Scope of the person identifier type. * @param idTypeCode Code of the person identifier type. * @param code Code of the person under specified identifier type\'s scope and code. This together with stated identifier type uniquely identifies the person. * @param propertyKeys The property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" 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. */ deletePersonIdentifiers(idTypeScope: string, idTypeCode: string, code: string, propertyKeys: Array<string>, effectiveAt?: string, observe?: 'body', reportProgress?: boolean): Observable<DeletedEntityResponse>; deletePersonIdentifiers(idTypeScope: string, idTypeCode: string, code: string, propertyKeys: Array<string>, effectiveAt?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<DeletedEntityResponse>>; deletePersonIdentifiers(idTypeScope: string, idTypeCode: string, code: string, propertyKeys: Array<string>, effectiveAt?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<DeletedEntityResponse>>; /** * [EARLY ACCESS] DeletePersonProperties: Delete Person Properties * Delete all properties that belong to the given property keys of the person. * @param idTypeScope Scope of the person identifier type. * @param idTypeCode Code of the person identifier type. * @param code Code of the person under specified identifier type\'s scope and code. This together with stated identifier type uniquely identifies the person. * @param propertyKeys The property keys of the person\'s properties to delete. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" 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. */ deletePersonProperties(idTypeScope: string, idTypeCode: string, code: string, propertyKeys: Array<string>, effectiveAt?: string, observe?: 'body', reportProgress?: boolean): Observable<DeletedEntityResponse>; deletePersonProperties(idTypeScope: string, idTypeCode: string, code: string, propertyKeys: Array<string>, effectiveAt?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<DeletedEntityResponse>>; deletePersonProperties(idTypeScope: string, idTypeCode: string, code: string, propertyKeys: Array<string>, effectiveAt?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<DeletedEntityResponse>>; /** * [EARLY ACCESS] GetAllPersonAccessMetadata: Get Access Metadata rules for a Person * Pass the Scope and Code of the Person identifier along with the person code parameter to retrieve the associated Access Metadata * @param idTypeScope Scope of the person identifier. * @param idTypeCode Code of the person identifier. * @param code Code of the person 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. */ getAllPersonAccessMetadata(idTypeScope: string, idTypeCode: string, code: string, effectiveAt?: string, asAt?: Date, observe?: 'body', reportProgress?: boolean): Observable<{ [key: string]: Array<AccessMetadataValue>; }>; getAllPersonAccessMetadata(idTypeScope: string, idTypeCode: string, code: string, effectiveAt?: string, asAt?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<{ [key: string]: Array<AccessMetadataValue>; }>>; getAllPersonAccessMetadata(idTypeScope: string, idTypeCode: string, code: string, effectiveAt?: string, asAt?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<{ [key: string]: Array<AccessMetadataValue>; }>>; /** * [EARLY ACCESS] GetPerson: Get Person * Retrieve the definition of a person. * @param idTypeScope Scope of the person identifier type. * @param idTypeCode Code of the person identifier type. * @param code Code of the person under specified scope and code. This together with stated identifier type uniquely identifies the person. * @param propertyKeys A list of property keys from the \"Person\" domain to decorate onto the person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\". * @param effectiveAt The effective datetime or cut label at which to retrieve the person. Defaults to the current LUSID system datetime if not specified. * @param asAt The asAt datetime at which to retrieve the person. Defaults to return the latest version of the person if not specified. * @param relationshipDefinitionIds A list of relationship definitions that are used to decorate related entities onto the person 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. */ getPerson(idTypeScope: string, idTypeCode: string, code: string, propertyKeys?: Array<string>, effectiveAt?: string, asAt?: Date, relationshipDefinitionIds?: Array<string>, observe?: 'body', reportProgress?: boolean): Observable<Person>; getPerson(idTypeScope: string, idTypeCode: string, code: string, propertyKeys?: Array<string>, effectiveAt?: string, asAt?: Date, relationshipDefinitionIds?: Array<string>, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<Person>>; getPerson(idTypeScope: string, idTypeCode: string, code: string, propertyKeys?: Array<string>, effectiveAt?: string, asAt?: Date, relationshipDefinitionIds?: Array<string>, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<Person>>; /** * [EARLY ACCESS] GetPersonAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Person * Get a specific Person Access Metadata by specifying the corresponding identifier parts and Person 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 person identifier. * @param idTypeCode Code of the person identifier. * @param code Code of the person 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. */ getPersonAccessMetadataByKey(idTypeScope: string, idTypeCode: string, code: string, metadataKey: string, effectiveAt?: string, asAt?: Date, observe?: 'body', reportProgress?: boolean): Observable<Array<AccessMetadataValue>>; getPersonAccessMetadataByKey(idTypeScope: string, idTypeCode: string, code: string, metadataKey: string, effectiveAt?: string, asAt?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<Array<AccessMetadataValue>>>; getPersonAccessMetadataByKey(idTypeScope: string, idTypeCode: string, code: string, metadataKey: string, effectiveAt?: string, asAt?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<Array<AccessMetadataValue>>>; /** * [EARLY ACCESS] GetPersonPropertyTimeSeries: Get Person Property Time Series * List the complete time series of a person property. * @param idTypeScope Scope of the person identifier type. * @param idTypeCode Code of the person identifier type. * @param code Code of the person under specified identifier type\'s scope and code. This together with stated identifier type uniquely identifies the person. * @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. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" 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. */ getPersonPropertyTimeSeries(idTypeScope: string, idTypeCode: string, code: string, propertyKey: string, asAt?: Date, filter?: string, page?: string, limit?: number, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfPropertyInterval>; getPersonPropertyTimeSeries(idTypeScope: string, idTypeCode: string, code: string, propertyKey: string, asAt?: Date, filter?: string, page?: string, limit?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfPropertyInterval>>; getPersonPropertyTimeSeries(idTypeScope: string, idTypeCode: string, code: string, propertyKey: string, asAt?: Date, filter?: string, page?: string, limit?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfPropertyInterval>>; /** * [EARLY ACCESS] GetPersonRelations: Get Relations for Person * Get relations for the specified person. * @param idTypeScope Scope of the person identifier type. * @param idTypeCode Code of the person identifier type. * @param code Code of the person under specified identifier type\'s scope and code. This together with stated identifier type uniquely identifies the person. * @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 person\'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. */ getPersonRelations(idTypeScope: string, idTypeCode: string, code: string, effectiveAt?: string, asAt?: Date, filter?: string, identifierTypes?: Array<string>, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfRelation>; getPersonRelations(idTypeScope: string, idTypeCode: string, code: string, effectiveAt?: string, asAt?: Date, filter?: string, identifierTypes?: Array<string>, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfRelation>>; getPersonRelations(idTypeScope: string, idTypeCode: string, code: string, effectiveAt?: string, asAt?: Date, filter?: string, identifierTypes?: Array<string>, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfRelation>>; /** * [EARLY ACCESS] GetPersonRelationships: Get Relationships for Person * Get relationships for the specified person. * @param idTypeScope Scope of the person\'s identifier type. * @param idTypeCode Code of the person\'s identifier type. * @param code Code of the person under specified identifier type\'s scope and code. This together with stated identifier type uniquely identifies the person. * @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. */ getPersonRelationships(idTypeScope: string, idTypeCode: string, code: string, effectiveAt?: string, asAt?: Date, filter?: string, identifierTypes?: Array<string>, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfRelationship>; getPersonRelationships(idTypeScope: string, idTypeCode: string, code: string, effectiveAt?: string, asAt?: Date, filter?: string, identifierTypes?: Array<string>, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfRelationship>>; getPersonRelationships(idTypeScope: string, idTypeCode: string, code: string, effectiveAt?: string, asAt?: Date, filter?: string, identifierTypes?: Array<string>, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfRelationship>>; /** * [EARLY ACCESS] ListAllPersons: List All Persons * List all persons which the user is entitled to see. * @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 persons from a previous call to list persons. 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. Also, if set, a start value cannot be provided. * @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. For example, to filter on the display name, use \"displayName eq \'John\'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. * @param propertyKeys A list of property keys from the \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\". * @param relationshipDefinitionIds A list of relationship definitions that are used to decorate related entities onto the persons 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. */ listAllPersons(effectiveAt?: string, asAt?: Date, page?: string, limit?: number, filter?: string, propertyKeys?: Array<string>, relationshipDefinitionIds?: Array<string>, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfPerson>; listAllPersons(effectiveAt?: string, asAt?: Date, page?: string, limit?: number, filter?: string, propertyKeys?: Array<string>, relationshipDefinitionIds?: Array<string>, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfPerson>>; listAllPersons(effectiveAt?: string, asAt?: Date, page?: string, limit?: number, filter?: string, propertyKeys?: Array<string>, relationshipDefinitionIds?: Array<string>, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfPerson>>; /** * [EARLY ACCESS] ListPersons: List Persons * List persons which have identifiers of a specific identifier type\'s scope and code, and satisfies filter criteria. * @param idTypeScope Scope of the person identifier type. * @param idTypeCode Code of the person 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 persons from a previous call to list persons. 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. Also, if set, a start value cannot be provided. * @param start When paginating, skip this number of results. * @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. For example, to filter on the LUPID, use \"lusidPersonId eq \'string\'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. * @param propertyKeys A list of property keys from the \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\". * @param relationshipDefinitionIds A list of relationship definitions that are used to decorate related entities onto the persons 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. */ listPersons(idTypeScope: string, idTypeCode: string, effectiveAt?: string, asAt?: Date, page?: string, start?: number, limit?: number, filter?: string, propertyKeys?: Array<string>, relationshipDefinitionIds?: Array<string>, observe?: 'body', reportProgress?: boolean): Observable<PagedResourceListOfPerson>; listPersons(idTypeScope: string, idTypeCode: string, effectiveAt?: string, asAt?: Date, page?: string, start?: number, limit?: number, filter?: string, propertyKeys?: Array<string>, relationshipDefinitionIds?: Array<string>, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<PagedResourceListOfPerson>>; listPersons(idTypeScope: string, idTypeCode: string, effectiveAt?: string, asAt?: Date, page?: string, start?: number, limit?: number, filter?: string, propertyKeys?: Array<string>, relationshipDefinitionIds?: Array<string>, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<PagedResourceListOfPerson>>; /** * [EARLY ACCESS] PatchPersonAccessMetadata: Patch Access Metadata rules for a Person. * Patch Person 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 Person 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 person identifier. * @param idTypeCode Code of the person identifier. * @param code Code of the person 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. */ patchPersonAccessMetadata(idTypeScope: string, idTypeCode: string, code: string, accessMetadataOperation: Array<AccessMetadataOperation>, effectiveAt?: string, effectiveUntil?: Date, observe?: 'body', reportProgress?: boolean): Observable<{ [key: string]: Array<AccessMetadataValue>; }>; patchPersonAccessMetadata(idTypeScope: string, idTypeCode: string, code: string, accessMetadataOperation: Array<AccessMetadataOperation>, effectiveAt?: string, effectiveUntil?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<{ [key: string]: Array<AccessMetadataValue>; }>>; patchPersonAccessMetadata(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] SetPersonIdentifiers: Set Person Identifiers * Set identifiers of the person. * @param idTypeScope Scope of the person identifier type. * @param idTypeCode Code of the person identifier type. * @param code Code of the person under specified identifier type\'s scope and code. This together with stated identifier type uniquely identifies the person. * @param setPersonIdentifiersRequest Request containing identifiers to set for the person. 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. */ setPersonIdentifiers(idTypeScope: string, idTypeCode: string, code: string, setPersonIdentifiersRequest: SetPersonIdentifiersRequest, observe?: 'body', reportProgress?: boolean): Observable<Person>; setPersonIdentifiers(idTypeScope: string, idTypeCode: string, code: string, setPersonIdentifiersRequest: SetPersonIdentifiersRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<Person>>; setPersonIdentifiers(idTypeScope: string, idTypeCode: string, code: string, setPersonIdentifiersRequest: SetPersonIdentifiersRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<Person>>; /** * [EARLY ACCESS] SetPersonProperties: Set Person Properties * Set properties of the person. * @param idTypeScope Scope of the person identifier type. * @param idTypeCode Code of the person identifier type. * @param code Code of the person under specified identifier type\'s scope and code. This together with stated identifier type uniquely identifies the person. * @param setPersonPropertiesRequest Request containing properties to set for the person. 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. */ setPersonProperties(idTypeScope: string, idTypeCode: string, code: string, setPersonPropertiesRequest: SetPersonPropertiesRequest, observe?: 'body', reportProgress?: boolean): Observable<Person>; setPersonProperties(idTypeScope: string, idTypeCode: string, code: string, setPersonPropertiesRequest: SetPersonPropertiesRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<Person>>; setPersonProperties(idTypeScope: string, idTypeCode: string, code: string, setPersonPropertiesRequest: SetPersonPropertiesRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<Person>>; /** * [EARLY ACCESS] UpsertPerson: Upsert Person * Create or update a new person under the specified scope. * @param upsertPersonRequest Request to create or update a person. * @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. */ upsertPerson(upsertPersonRequest: UpsertPersonRequest, observe?: 'body', reportProgress?: boolean): Observable<Person>; upsertPerson(upsertPersonRequest: UpsertPersonRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<Person>>; upsertPerson(upsertPersonRequest: UpsertPersonRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<Person>>; /** * [EARLY ACCESS] UpsertPersonAccessMetadata: Upsert a Person Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. * Update or insert one Person 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 Person 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 person identifier. * @param idTypeCode Code of the person identifier. * @param code Code of the person under specified identifier type\'s scope and code. * @param metadataKey Key of the metadata entry to retrieve * @param upsertPersonAccessMetadataRequest The Person 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. */ upsertPersonAccessMetadata(idTypeScope: string, idTypeCode: string, code: string, metadataKey: string, upsertPersonAccessMetadataRequest: UpsertPersonAccessMetadataRequest, effectiveAt?: string, effectiveUntil?: Date, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfAccessMetadataValueOf>; upsertPersonAccessMetadata(idTypeScope: string, idTypeCode: string, code: string, metadataKey: string, upsertPersonAccessMetadataRequest: UpsertPersonAccessMetadataRequest, effectiveAt?: string, effectiveUntil?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfAccessMetadataValueOf>>; upsertPersonAccessMetadata(idTypeScope: string, idTypeCode: string, code: string, metadataKey: string, upsertPersonAccessMetadataRequest: UpsertPersonAccessMetadataRequest, effectiveAt?: string, effectiveUntil?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfAccessMetadataValueOf>>; static ɵfac: i0.ɵɵFactoryDef<PersonsService, [null, { optional: true; }, { optional: true; }]>; static ɵprov: i0.ɵɵInjectableDef<PersonsService>; }