UNPKG

@finbourne/lusid-sdk-angular18

Version:

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

717 lines (716 loc) 68.1 kB
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 { CreatePortfolioGroupRequest } from '../model/createPortfolioGroupRequest'; import { DeletedEntityResponse } from '../model/deletedEntityResponse'; import { ExpandedGroup } from '../model/expandedGroup'; import { PagedResourceListOfPortfolioGroup } from '../model/pagedResourceListOfPortfolioGroup'; import { PortfolioGroup } from '../model/portfolioGroup'; import { PortfolioGroupProperties } from '../model/portfolioGroupProperties'; import { Property } from '../model/property'; import { ResourceId } from '../model/resourceId'; import { ResourceListOfAccessMetadataValueOf } from '../model/resourceListOfAccessMetadataValueOf'; import { ResourceListOfProcessedCommand } from '../model/resourceListOfProcessedCommand'; import { ResourceListOfPropertyInterval } from '../model/resourceListOfPropertyInterval'; import { ResourceListOfRelation } from '../model/resourceListOfRelation'; import { ResourceListOfRelationship } from '../model/resourceListOfRelationship'; import { TransactionQueryParameters } from '../model/transactionQueryParameters'; import { UpdatePortfolioGroupRequest } from '../model/updatePortfolioGroupRequest'; import { UpsertPortfolioGroupAccessMetadataRequest } from '../model/upsertPortfolioGroupAccessMetadataRequest'; import { VersionedResourceListOfA2BDataRecord } from '../model/versionedResourceListOfA2BDataRecord'; import { VersionedResourceListOfOutputTransaction } from '../model/versionedResourceListOfOutputTransaction'; import { VersionedResourceListOfPortfolioHolding } from '../model/versionedResourceListOfPortfolioHolding'; import { VersionedResourceListOfTransaction } from '../model/versionedResourceListOfTransaction'; import { Configuration } from '../configuration'; import * as i0 from "@angular/core"; export interface AddPortfolioToGroupRequestParams { /** The scope of the portfolio group to add a portfolio to. */ scope: string; /** The code of the portfolio group to add a portfolio to. Together with the scope this uniquely identifies the portfolio group. */ code: string; /** The effective datetime or cut label from which the portfolio will be added to the group. */ effectiveAt?: string; /** The resource identifier of the portfolio to add to the portfolio group. */ resourceId?: ResourceId; } export interface AddSubGroupToGroupRequestParams { /** The scope of the portfolio group to add a portfolio group to. */ scope: string; /** The code of the portfolio group to add a portfolio group to. Together with the scope this uniquely identifies the portfolio group. */ code: string; /** The effective datetime or cut label from which the sub group will be added to the group. */ effectiveAt?: string; /** The resource identifier of the portfolio group to add to the portfolio group as a sub group. */ resourceId?: ResourceId; } export interface BuildTransactionsForPortfolioGroupRequestParams { /** The scope of the portfolio group. */ scope: string; /** The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. */ code: string; /** The query queryParameters which control how the output transactions are built. */ transactionQueryParameters: TransactionQueryParameters; /** The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified. */ asAt?: string; /** Expression to filter the result set. For example, to filter on the Transaction Type, use \&quot;type eq \&#39;Buy\&#39;\&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. */ filter?: string; /** A list of property keys from the \&quot;Instrument\&quot; or \&quot;Transaction\&quot; domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. \&quot;Instrument/system/Name\&quot; or \&quot;Transaction/strategy/quantsignal\&quot;. */ propertyKeys?: Array<string>; /** When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. */ limit?: number; /** The pagination token to use to continue listing transactions from a previous call to BuildTransactions. */ page?: string; } export interface CreatePortfolioGroupRequestParams { /** The scope that the portfolio group will be created in. */ scope: string; /** The definition and details of the portfolio group. */ createPortfolioGroupRequest?: CreatePortfolioGroupRequest; } export interface DeleteGroupPropertiesRequestParams { /** The scope of the group to delete properties from. */ scope: string; /** The code of the group to delete properties from. Together with the scope this uniquely identifies the group. */ code: string; /** The property keys of the properties to delete. These take the format {domain}/{scope}/{code} e.g. \&quot;PortfolioGroup/Manager/Id\&quot;. Each property must be from the \&quot;PortfolioGroup\&quot; domain. */ requestBody: Array<string>; /** The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified \&#39;effectiveAt\&#39; datetime. If the \&#39;effectiveAt\&#39; 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. */ effectiveAt?: string; } export interface DeleteKeyFromPortfolioGroupAccessMetadataRequestParams { /** The scope of the Portfolio Group */ scope: string; /** The Portfolio Group code */ code: string; /** Key of the Access Metadata entry to delete */ metadataKey: 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 \&#39;effectiveAt\&#39; date of the Access Metadata */ effectiveUntil?: string; } export interface DeletePortfolioFromGroupRequestParams { /** The scope of the portfolio group to remove the portfolio from. */ scope: string; /** The code of the portfolio group to remove the portfolio from. Together with the scope this uniquely identifies the portfolio group. */ code: string; /** The scope of the portfolio being removed from the portfolio group. */ portfolioScope: string; /** The code of the portfolio being removed from the portfolio group. Together with the scope this uniquely identifies the portfolio to remove. */ portfolioCode: string; /** The effective datetime or cut label from which the portfolio will be removed from the portfolio group. */ effectiveAt?: string; } export interface DeletePortfolioGroupRequestParams { /** The scope of the portfolio group to delete. */ scope: string; /** The code of the portfolio group to delete. Together with the scope this uniquely identifies the portfolio group to delete. */ code: string; } export interface DeleteSubGroupFromGroupRequestParams { /** The scope of the portfolio group to remove the sub group from. */ scope: string; /** The code of the portfolio group to remove the sub group from. Together with the scope this uniquely identifies the portfolio group. */ code: string; /** The scope of the sub group to remove from the portfolio group. */ subgroupScope: string; /** The code of the sub group to remove from the portfolio group. Together with the scope this uniquely identifies the sub group. */ subgroupCode: string; /** The effective datetime or cut label from which the sub group will be removed from the portfolio group. */ effectiveAt?: string; } export interface GetA2BDataForPortfolioGroupRequestParams { /** The scope of the group to retrieve the A2B report for. */ scope: string; /** The code of the group to retrieve the A2B report for. Together with the scope this uniquely identifies the portfolio group. */ code: string; /** The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified. */ fromEffectiveAt: string; /** The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified. */ toEffectiveAt: string; /** The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified. */ asAt?: string; /** The scope of the given recipeId */ recipeIdScope?: string; /** The code of the given recipeId */ recipeIdCode?: string; /** A list of property keys from the \&quot;Instrument\&quot; domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. \&quot;Instrument/system/Name\&quot;. */ propertyKeys?: Array<string>; /** Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. */ filter?: string; } export interface GetGroupPropertiesRequestParams { /** The scope of the group to list the properties for. */ scope: string; /** The code of the group to list the properties for. Together with the scope this uniquely identifies the group. */ code: string; /** The effective date time or cut label at which to list the group\&#39;s properties. Defaults to the current LUSID system datetime if not specified. */ effectiveAt?: string; /** The asAt date time at which to list the group\&#39;s properties. Defaults to return the latest version of each property if not specified. */ asAt?: string; } export interface GetHoldingsForPortfolioGroupRequestParams { /** The scope of the portfolio group. */ scope: string; /** The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. */ code: string; /** The effective datetime or cut label at which to retrieve the holdings of transaction portfolios in the portfolio group. Defaults to the current LUSID system datetime if not specified. */ effectiveAt?: string; /** The asAt datetime at which to retrieve the holdings of transaction portfolios in the portfolio group. Defaults to return the latest version of the holdings if not specified. */ asAt?: string; /** 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 property keys from the \&quot;Instrument\&quot;, \&quot;Holding\&quot; or \&quot;Portfolio\&quot; domain to decorate onto the holdings. These take the format {domain}/{scope}/{code} e.g. \&quot;Instrument/system/Name\&quot; or \&quot;Holding/system/Cost\&quot;. */ propertyKeys?: Array<string>; /** Whether or not to expand the holdings to return the underlying tax-lots. Defaults to False. */ byTaxlots?: boolean; /** Number of days ahead to bring back settlements from, in relation to the specified effectiveAt */ includeSettlementEventsAfterDays?: number; } export interface GetPortfolioGroupRequestParams { /** The scope of the portfolio group to retrieve the definition for. */ scope: string; /** The code of the portfolio group to retrieve the definition for. Together with the scope this uniquely identifies the portfolio group. */ code: string; /** The effective datetime or cut label at which to retrieve the portfolio group definition. Defaults to the current LUSID system datetime if not specified. */ effectiveAt?: string; /** The asAt datetime at which to retrieve the portfolio group definition. Defaults to return the latest version of the portfolio group definition if not specified. */ asAt?: string; /** A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example \&#39;Portfolio/Manager/Id\&#39;. */ relatedEntityPropertyKeys?: Array<string>; /** A list of relationship definitions that are used to decorate related entities onto the portfolio group in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. */ relationshipDefinitionIds?: Array<string>; } export interface GetPortfolioGroupAccessMetadataByKeyRequestParams { /** The scope of the Portfolio Group */ scope: string; /** The Portfolio Group code */ code: string; /** Key of the metadata entry to retrieve */ metadataKey: 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 GetPortfolioGroupCommandsRequestParams { /** The scope of the portfolio group to retrieve the commands for. */ scope: string; /** The code of the portfolio group to retrieve the commands for. Together with the scope this uniquely identifies the portfolio group. */ code: string; /** The lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified. */ fromAsAt?: string; /** The upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified. */ toAsAt?: string; /** Expression to filter the result set. For example, to filter on the User ID, use \&quot;userId.id eq \&#39;string\&#39;\&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. */ filter?: string; } export interface GetPortfolioGroupExpansionRequestParams { /** The scope of the portfolio group to expand. */ scope: string; /** The code of the portfolio group to expand. Together with the scope this uniquely identifies the portfolio group to expand. */ code: string; /** The effective datetime or cut label at which to expand the portfolio group. Defaults to the current LUSID system datetime if not specified. */ effectiveAt?: string; /** The asAt datetime at which to expand the portfolio group. Defaults to return the latest version of each portfolio in the group if not specified. */ asAt?: string; /** The restricted list of property keys from the \&quot;Portfolio\&quot; domain which will be decorated onto each portfolio. These take the format {domain}/{scope}/{code} e.g. \&quot;Portfolio/Manager/Id\&quot;. */ propertyFilter?: Array<string>; } export interface GetPortfolioGroupMetadataRequestParams { /** The scope of the Portfolio Group */ scope: string; /** The Portfolio Group code */ code: 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 GetPortfolioGroupPropertyTimeSeriesRequestParams { /** The scope of the group. */ scope: string; /** The code of the group. Together with the scope this uniquely identifies the portfolio group. */ code: string; /** The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. \&quot;PortfolioGroup/Manager/Id\&quot;. Each property must be from the \&quot;PortfolioGroup\&quot; domain. */ propertyKey: string; /** The effective datetime used to resolve the portfolio group. Defaults to the current LUSID system datetime if not specified. */ portfolioGroupEffectiveAt?: string; /** The asAt datetime at which to list the portfolio group\&#39;s property history. Defaults to return the current datetime if not supplied. */ asAt?: string; /** Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. */ filter?: string; /** 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, effectiveAt, and asAt fields must not have changed since the original request. */ page?: string; /** When paginating, limit the number of returned results to this many. */ limit?: number; } export interface GetPortfolioGroupRelationsRequestParams { /** The scope of the portfolio group. */ scope: string; /** The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. */ code: string; /** The effective datetime or cut label at which to retrieve relations. Defaults to the current LUSID system datetime if not specified. */ effectiveAt?: string; /** The asAt datetime at which to retrieve relations. Defaults to return the latest LUSID AsAt time if not specified. */ asAt?: string; /** Expression to filter the relations. Users should provide null or empty string for this field until further notice. */ filter?: string; /** Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. \&quot;Person/CompanyDetails/Role\&quot;. They must be from the \&quot;Person\&quot; or \&quot;LegalEntity\&quot; domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array. */ identifierTypes?: Array<string>; } export interface GetPortfolioGroupRelationshipsRequestParams { /** The scope of the portfolio group. */ scope: string; /** The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. */ code: string; /** The effective datetime or cut label at which to retrieve relationship. 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 \&#39;Person\&#39; or \&#39;LegalEntity\&#39; domains and have the format {domain}/{scope}/{code}, for example \&#39;Person/CompanyDetails/Role\&#39;. An Empty array may be used to return all related Entities. */ identifierTypes?: Array<string>; } export interface GetTransactionsForPortfolioGroupRequestParams { /** The scope of the portfolio group. */ scope: string; /** The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. */ code: string; /** The lower bound effective datetime or cut label (inclusive) from which to retrieve the transactions. There is no lower bound if this is not specified. */ fromTransactionDate?: string; /** The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no upper bound if this is not specified. */ toTransactionDate?: string; /** The asAt datetime at which to retrieve the transactions. Defaults to return the latest version of each transaction if not specified. */ asAt?: string; /** Expression to filter the result set. For example, to filter on the Transaction Type, use \&quot;type eq \&#39;Buy\&#39;\&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. */ filter?: string; /** A list of property keys from the \&quot;Instrument\&quot;, \&quot;Transaction\&quot;, \&quot;LegalEntity\&quot; or \&quot;CustodianAccount\&quot; domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. \&quot;Instrument/system/Name\&quot; or \&quot;Transaction/strategy/quantsignal\&quot;. */ propertyKeys?: Array<string>; /** When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. */ limit?: number; /** The pagination token to use to continue listing transactions from a previous call to GetTransactions. */ page?: string; /** Option to specify whether or not to include cancelled transactions, including previous versions of transactions which have since been amended. Defaults to False if not specified. */ showCancelledTransactions?: boolean; /** A list of field names or properties to sort by, each suffixed by \&quot; ASC\&quot; or \&quot; DESC\&quot;. */ sortBy?: Array<string>; } export interface ListPortfolioGroupsRequestParams { /** The scope to list the portfolio groups in. */ scope: string; /** The effective datetime or cut label at which to list the portfolio groups. Defaults to the current LUSID system datetime if not specified. */ effectiveAt?: string; /** The asAt datetime at which to list the portfolio groups. Defaults to return the latest version of each portfolio group if not specified. */ asAt?: string; /** The pagination token to use to continue listing portfolio groups from a previous call to list portfolio groups. 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 no limit if not specified. */ limit?: number; /** Expression to filter the result set. For example, to filter on the Display Name, use \&quot;displayName eq \&#39;string\&#39;\&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. */ filter?: string; /** A list of field names to sort by, each suffixed by \&quot; ASC\&quot; or \&quot; DESC\&quot; */ sortBy?: Array<string>; /** A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example \&#39;Portfolio/Manager/Id\&#39;. */ relatedEntityPropertyKeys?: Array<string>; /** A list of relationship definitions that are used to decorate related entities onto the portfolio groups in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. */ relationshipDefinitionIds?: Array<string>; } export interface PatchPortfolioGroupAccessMetadataRequestParams { /** The scope of the Portfolio Group */ scope: string; /** The Portfolio Group code */ code: string; /** The Json patch document */ accessMetadataOperation: Array<AccessMetadataOperation>; /** The date this rule will be effective from */ effectiveAt?: string; /** The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next \&#39;effectiveAt\&#39; date of the Access Metadata */ effectiveUntil?: string; } export interface UpdatePortfolioGroupRequestParams { /** The scope of the portfolio group to update the definition for. */ scope: string; /** The code of the portfolio group to update the definition for. Together with the scope this uniquely identifies the portfolio group. */ code: string; /** The effective datetime or cut label at which to update the definition. */ effectiveAt?: string; /** The updated portfolio group definition. */ updatePortfolioGroupRequest?: UpdatePortfolioGroupRequest; } export interface UpsertGroupPropertiesRequestParams { /** The scope of the group to update or insert the properties onto. */ scope: string; /** The code of the group to update or insert the properties onto. Together with the scope this uniquely identifies the group. */ code: string; /** The properties to be updated or inserted onto the group. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. \&quot;PortfolioGroup/Manager/Id\&quot;. */ requestBody?: { [key: string]: Property; }; } export interface UpsertPortfolioGroupAccessMetadataRequestParams { /** The scope of the Portfolio Group */ scope: string; /** The Portfolio Group code */ code: string; /** Key of the access metadata entry to upsert */ metadataKey: string; /** The Portfolio Group Access Metadata rule to upsert */ upsertPortfolioGroupAccessMetadataRequest: UpsertPortfolioGroupAccessMetadataRequest; /** The date this rule will be effective from */ effectiveAt?: string; /** The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next \&#39;effectiveAt\&#39; date of the Access Metadata */ effectiveUntil?: string; } export declare class PortfolioGroupsService { 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] AddPortfolioToGroup: Add portfolio to group * Add a single portfolio to a portfolio group. * @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. */ addPortfolioToGroup(requestParameters?: AddPortfolioToGroupRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<PortfolioGroup>; addPortfolioToGroup(requestParameters?: AddPortfolioToGroupRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<PortfolioGroup>>; addPortfolioToGroup(requestParameters?: AddPortfolioToGroupRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<PortfolioGroup>>; /** * [EARLY ACCESS] AddSubGroupToGroup: Add sub group to group * Add a portfolio group to a portfolio group as a sub group. * @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. */ addSubGroupToGroup(requestParameters?: AddSubGroupToGroupRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<PortfolioGroup>; addSubGroupToGroup(requestParameters?: AddSubGroupToGroupRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<PortfolioGroup>>; addSubGroupToGroup(requestParameters?: AddSubGroupToGroupRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<PortfolioGroup>>; /** * BuildTransactionsForPortfolioGroup: Build transactions for transaction portfolios in a portfolio group * Build transactions for transaction portfolios in a portfolio group over a given interval of effective time. When the specified portfolio in a portfolio group is a derived transaction portfolio, the returned set of transactions is the union set of all transactions of the parent (and any grandparents etc.) and the specified derived transaction portfolio itself. * @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. */ buildTransactionsForPortfolioGroup(requestParameters?: BuildTransactionsForPortfolioGroupRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<VersionedResourceListOfOutputTransaction>; buildTransactionsForPortfolioGroup(requestParameters?: BuildTransactionsForPortfolioGroupRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<VersionedResourceListOfOutputTransaction>>; buildTransactionsForPortfolioGroup(requestParameters?: BuildTransactionsForPortfolioGroupRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<VersionedResourceListOfOutputTransaction>>; /** * CreatePortfolioGroup: Create portfolio group * Create a portfolio group in a specific scope. * @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. */ createPortfolioGroup(requestParameters?: CreatePortfolioGroupRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<PortfolioGroup>; createPortfolioGroup(requestParameters?: CreatePortfolioGroupRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<PortfolioGroup>>; createPortfolioGroup(requestParameters?: CreatePortfolioGroupRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<PortfolioGroup>>; /** * [EARLY ACCESS] DeleteGroupProperties: Delete group properties * Delete one or more properties from a single portfolio group. If the properties are time variant then an effective date time from which the properties will be deleted must be specified. If the properties are perpetual then it is invalid to specify an effective date time for 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. */ deleteGroupProperties(requestParameters?: DeleteGroupPropertiesRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<DeletedEntityResponse>; deleteGroupProperties(requestParameters?: DeleteGroupPropertiesRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<DeletedEntityResponse>>; deleteGroupProperties(requestParameters?: DeleteGroupPropertiesRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<DeletedEntityResponse>>; /** * [EARLY ACCESS] DeleteKeyFromPortfolioGroupAccessMetadata: Delete a Portfolio Group Access Metadata entry * Deletes the Portfolio Group 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. */ deleteKeyFromPortfolioGroupAccessMetadata(requestParameters?: DeleteKeyFromPortfolioGroupAccessMetadataRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<DeletedEntityResponse>; deleteKeyFromPortfolioGroupAccessMetadata(requestParameters?: DeleteKeyFromPortfolioGroupAccessMetadataRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<DeletedEntityResponse>>; deleteKeyFromPortfolioGroupAccessMetadata(requestParameters?: DeleteKeyFromPortfolioGroupAccessMetadataRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<DeletedEntityResponse>>; /** * [EARLY ACCESS] DeletePortfolioFromGroup: Delete portfolio from group * Remove a single portfolio from a portfolio group. * @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. */ deletePortfolioFromGroup(requestParameters?: DeletePortfolioFromGroupRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<PortfolioGroup>; deletePortfolioFromGroup(requestParameters?: DeletePortfolioFromGroupRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<PortfolioGroup>>; deletePortfolioFromGroup(requestParameters?: DeletePortfolioFromGroupRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<PortfolioGroup>>; /** * [EARLY ACCESS] DeletePortfolioGroup: Delete portfolio group * Delete a single portfolio group. A portfolio group can be deleted while it still contains portfolios or sub groups. In this case any portfolios or sub groups contained in this group will not be deleted, however they will no longer be grouped together by this portfolio group. The deletion will be valid from the portfolio group\&#39;s creation datetime, ie. the portfolio group 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. */ deletePortfolioGroup(requestParameters?: DeletePortfolioGroupRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<DeletedEntityResponse>; deletePortfolioGroup(requestParameters?: DeletePortfolioGroupRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<DeletedEntityResponse>>; deletePortfolioGroup(requestParameters?: DeletePortfolioGroupRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<DeletedEntityResponse>>; /** * [EARLY ACCESS] DeleteSubGroupFromGroup: Delete sub group from group * Remove a single portfolio group (sub group) from a portfolio group. * @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. */ deleteSubGroupFromGroup(requestParameters?: DeleteSubGroupFromGroupRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<PortfolioGroup>; deleteSubGroupFromGroup(requestParameters?: DeleteSubGroupFromGroupRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<PortfolioGroup>>; deleteSubGroupFromGroup(requestParameters?: DeleteSubGroupFromGroupRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<PortfolioGroup>>; /** * [EARLY ACCESS] GetA2BDataForPortfolioGroup: Get A2B data for a Portfolio Group * Get an A2B report for all Transaction Portfolios within the given portfolio group. * @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. */ getA2BDataForPortfolioGroup(requestParameters?: GetA2BDataForPortfolioGroupRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<VersionedResourceListOfA2BDataRecord>; getA2BDataForPortfolioGroup(requestParameters?: GetA2BDataForPortfolioGroupRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<VersionedResourceListOfA2BDataRecord>>; getA2BDataForPortfolioGroup(requestParameters?: GetA2BDataForPortfolioGroupRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<VersionedResourceListOfA2BDataRecord>>; /** * [EARLY ACCESS] GetGroupProperties: Get group properties * List all the properties of a single portfolio group. * @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. */ getGroupProperties(requestParameters?: GetGroupPropertiesRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<PortfolioGroupProperties>; getGroupProperties(requestParameters?: GetGroupPropertiesRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<PortfolioGroupProperties>>; getGroupProperties(requestParameters?: GetGroupPropertiesRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<PortfolioGroupProperties>>; /** * GetHoldingsForPortfolioGroup: Get holdings for transaction portfolios in portfolio group * Get the holdings of transaction portfolios in specified portfolio group. * @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. */ getHoldingsForPortfolioGroup(requestParameters?: GetHoldingsForPortfolioGroupRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<VersionedResourceListOfPortfolioHolding>; getHoldingsForPortfolioGroup(requestParameters?: GetHoldingsForPortfolioGroupRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<VersionedResourceListOfPortfolioHolding>>; getHoldingsForPortfolioGroup(requestParameters?: GetHoldingsForPortfolioGroupRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<VersionedResourceListOfPortfolioHolding>>; /** * GetPortfolioGroup: Get portfolio group * Retrieve the definition of a single portfolio group. * @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. */ getPortfolioGroup(requestParameters?: GetPortfolioGroupRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<PortfolioGroup>; getPortfolioGroup(requestParameters?: GetPortfolioGroupRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<PortfolioGroup>>; getPortfolioGroup(requestParameters?: GetPortfolioGroupRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<PortfolioGroup>>; /** * [EARLY ACCESS] GetPortfolioGroupAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Portfolio Group * Get a specific Portfolio Group access metadata by specifying the corresponding identifier parts No matching will be performed through this endpoint. To retrieve a rule, it is necessary to specify, exactly, the identifier of the rule * @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. */ getPortfolioGroupAccessMetadataByKey(requestParameters?: GetPortfolioGroupAccessMetadataByKeyRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<Array<AccessMetadataValue>>; getPortfolioGroupAccessMetadataByKey(requestParameters?: GetPortfolioGroupAccessMetadataByKeyRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<Array<AccessMetadataValue>>>; getPortfolioGroupAccessMetadataByKey(requestParameters?: GetPortfolioGroupAccessMetadataByKeyRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<Array<AccessMetadataValue>>>; /** * GetPortfolioGroupCommands: Get portfolio group commands * Gets all the commands that modified a single portfolio group. * @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. */ getPortfolioGroupCommands(requestParameters?: GetPortfolioGroupCommandsRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<ResourceListOfProcessedCommand>; getPortfolioGroupCommands(requestParameters?: GetPortfolioGroupCommandsRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<ResourceListOfProcessedCommand>>; getPortfolioGroupCommands(requestParameters?: GetPortfolioGroupCommandsRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<ResourceListOfProcessedCommand>>; /** * [EARLY ACCESS] GetPortfolioGroupExpansion: Get portfolio group expansion * List all the portfolios in a group, including all portfolios within sub groups in the group. Each portfolio will be decorated with all of its properties unless a property filter is specified. * @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. */ getPortfolioGroupExpansion(requestParameters?: GetPortfolioGroupExpansionRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean;