@finbourne/lusid-sdk-angular18
Version:
An Angular (18) SDK for secure access to the LUSID® by FINBOURNE web API
795 lines • 113 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
import { Observable } from 'rxjs';
import { AcceptEstimateValuationPointResponse } from '../model/acceptEstimateValuationPointResponse';
import { AllocationGroupDefinition } from '../model/allocationGroupDefinition';
import { CreateValuationPointRequest } from '../model/createValuationPointRequest';
import { DeletedEntityResponse } from '../model/deletedEntityResponse';
import { DiaryEntry } from '../model/diaryEntry';
import { Fee } from '../model/fee';
import { FeeProperties } from '../model/feeProperties';
import { FeeRequest } from '../model/feeRequest';
import { Fund } from '../model/fund';
import { FundCalendarEntry } from '../model/fundCalendarEntry';
import { FundDefinitionRequest } from '../model/fundDefinitionRequest';
import { FundProperties } from '../model/fundProperties';
import { FundRequest } from '../model/fundRequest';
import { FundValuationRequest } from '../model/fundValuationRequest';
import { ListAggregationResponse } from '../model/listAggregationResponse';
import { NavActivityAdjustment } from '../model/navActivityAdjustment';
import { NavActivityAdjustmentResponse } from '../model/navActivityAdjustmentResponse';
import { Operation } from '../model/operation';
import { PagedResourceListOfFee } from '../model/pagedResourceListOfFee';
import { PagedResourceListOfFund } from '../model/pagedResourceListOfFund';
import { PagedResourceListOfFundCalendarEntries } from '../model/pagedResourceListOfFundCalendarEntries';
import { PagedResourceListOfFundCalendarEntry } from '../model/pagedResourceListOfFundCalendarEntry';
import { PagedResourceListOfValuationPointInstrument } from '../model/pagedResourceListOfValuationPointInstrument';
import { PagedResourceListOfValuationPointOverview } from '../model/pagedResourceListOfValuationPointOverview';
import { Property } from '../model/property';
import { QueryFundCashStatementParameters } from '../model/queryFundCashStatementParameters';
import { ResourceListOfNavActivityAdjustmentResponse } from '../model/resourceListOfNavActivityAdjustmentResponse';
import { RevertValuationPointDataRequest } from '../model/revertValuationPointDataRequest';
import { SeriesDefinitionRequest } from '../model/seriesDefinitionRequest';
import { SetShareClassInstrumentsRequest } from '../model/setShareClassInstrumentsRequest';
import { SingleValuationPointQueryParameters } from '../model/singleValuationPointQueryParameters';
import { UpdateValuationPointRequest } from '../model/updateValuationPointRequest';
import { UpsertFundBookmarkRequest } from '../model/upsertFundBookmarkRequest';
import { UpsertValuationPointRequest } from '../model/upsertValuationPointRequest';
import { ValuationPoint } from '../model/valuationPoint';
import { ValuationPointDataQueryParameters } from '../model/valuationPointDataQueryParameters';
import { ValuationPointDataRequest } from '../model/valuationPointDataRequest';
import { ValuationPointDataResponse } from '../model/valuationPointDataResponse';
import { ValuationPointResourceListOfAccountedTransaction } from '../model/valuationPointResourceListOfAccountedTransaction';
import { ValuationPointResourceListOfFundCashStatementRow } from '../model/valuationPointResourceListOfFundCashStatementRow';
import { ValuationPointResourceListOfFundJournalEntryLine } from '../model/valuationPointResourceListOfFundJournalEntryLine';
import { ValuationPointResourceListOfPnlJournalEntryLine } from '../model/valuationPointResourceListOfPnlJournalEntryLine';
import { ValuationPointResourceListOfTrialBalance } from '../model/valuationPointResourceListOfTrialBalance';
import { ValuationPointResourceListOfUnsettledTransaction } from '../model/valuationPointResourceListOfUnsettledTransaction';
import { VersionedResourceListOfFundA2BDataRecord } from '../model/versionedResourceListOfFundA2BDataRecord';
import { VersionedResourceListOfFundA2BMovementRecord } from '../model/versionedResourceListOfFundA2BMovementRecord';
import { VersionedResourceListOfHoldingContributor } from '../model/versionedResourceListOfHoldingContributor';
import { VersionedResourceListOfPortfolioHolding } from '../model/versionedResourceListOfPortfolioHolding';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export interface AcceptEstimateValuationPointRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The valuationPointDataRequest which contains the Diary Entry code for the Estimate Valuation Point to move to Candidate or Final state. */
valuationPointDataRequest: ValuationPointDataRequest;
/** When provided, accepts the Valuation Point of the specified NAV Type, otherwise the Primary NAV Type will be used. */
navTypeCode?: string;
}
export interface AddAllocationGroupsRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The definitions of the Allocation Groups to add to the Fund. */
allocationGroupDefinition: Array<AllocationGroupDefinition>;
}
export interface AddSeriesRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The definitions of the Series to add. */
seriesDefinitionRequest: Array<SeriesDefinitionRequest>;
}
export interface CreateFeeRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The Fee to create. */
feeRequest: FeeRequest;
/** When provided, creates the Fee against the specified NAV Type, otherwise the Primary NAV Type will be used. */
navTypeCode?: string;
}
export interface CreateFundRequestParams {
/** The scope of the Fund. */
scope: string;
/** The definition of the Fund. */
fundRequest: FundRequest;
}
export interface CreateFundV2RequestParams {
/** The scope of the Fund. */
scope: string;
/** The definition of the Fund. */
fundDefinitionRequest: FundDefinitionRequest;
}
export interface CreateValuationPointRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The Valuation Point Estimate definition to create. */
createValuationPointRequest: CreateValuationPointRequest;
/** When provided, creates the Valuation Point against the specified NAV Type, otherwise the Primary NAV Type will be used. */
navTypeCode?: string;
}
export interface DeactivateNavTypesRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The codes of the nav types to be deactivated. */
requestBody: Array<string>;
/** The delete mode to use. Default value: Soft. Available values: Soft, Hard. */
deleteMode?: 'Soft' | 'Hard';
}
export interface DeleteBookmarkRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The bookmark code for the bookmark to be deleted. */
bookmarkCode: string;
/** When provided, deletes the Bookmark against the specified NAV Type, otherwise the Primary NAV Type will be used. */
navTypeCode?: string;
}
export interface DeleteFeeRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The code of the Fee to be deleted. */
feeCode: string;
}
export interface DeleteFundRequestParams {
/** The scope of the Fund to be deleted. */
scope: string;
/** The code of the Fund to be deleted. Together with the scope this uniquely identifies the Fund. */
code: string;
}
export interface DeleteNavActivityAdjustmentsRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope is the unique identifier for the given Fund. */
code: string;
/** The valuation point Code to delete the adjustment from */
valuationPointCode: string;
/** The request describing the Nav activity adjustments to delete from a specific valuation point and nav type */
navActivityAdjustmentResponse: Array<NavActivityAdjustmentResponse>;
/** When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used. */
navTypeCode?: string;
/** The variant of the valuation point used in the request. Together with the valuation point code marks the unique branch for the NavType. */
valuationPointCodeVariant?: string;
}
export interface DeleteValuationPointRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The diary entry code for the valuation Point to be deleted. */
diaryEntryCode: string;
/** The variant of the valuation point used in the request. Together with the valuation point code marks the unique branch for the NavType. This is working only for the Estimates. */
diaryEntryCodeVariant?: string;
/** When provided, deletes the Valuation Point against the specified NAV Type, otherwise the Primary NAV Type will be used. */
navTypeCode?: string;
}
export interface FinaliseCandidateValuationPointRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The details of the Valuation Point to mark as final. */
valuationPointDataRequest: ValuationPointDataRequest;
/** When provided, finalises the Valuation Point of the specified NAV Type, otherwise the Primary NAV Type will be used. */
navTypeCode?: string;
}
export interface GetA2BDataForFundRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The arguments to use for querying the A2B data. This includes start and end dates. */
valuationPointDataQueryParameters: ValuationPointDataQueryParameters;
/** When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used. */
navTypeCode?: string;
/** The asAt datetime at which to resolve the fund and the timeline. Defaults to return the latest version 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 \"Instrument\" domain to decorate onto the A2B data. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\". */
propertyKeys?: Array<string>;
}
export interface GetA2BMovementsForFundRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The arguments to use for querying the A2B movements. This includes start and end dates. */
valuationPointDataQueryParameters: ValuationPointDataQueryParameters;
/** When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used. */
navTypeCode?: string;
/** The asAt datetime at which to resolve the fund and the timeline. Defaults to return the latest version 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 \"Instrument\" domain to decorate onto the A2B movements. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\". */
propertyKeys?: Array<string>;
}
export interface GetFeeRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The code of the Fee. */
feeCode: string;
/** The effective datetime or cut label at which to retrieve the Fee properties. Defaults to the current LUSID system datetime if not specified. */
effectiveAt?: string;
/** The asAt datetime at which to retrieve the Fee. Defaults to returning the latest version of the Fee if not specified. */
asAt?: string;
/** A list of property keys from the \'Fee\' domain to decorate onto the Fee. These must take the format {domain}/{scope}/{code}, for example \'Fee/Account/Id\'. If no properties are specified, then no properties will be returned. */
propertyKeys?: Array<string>;
}
export interface GetFeePropertiesRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The code of the Fee to get the properties for. */
feeCode: string;
/** The effective datetime or cut label at which to list the Fee\'s properties. Defaults to the current LUSID system datetime if not specified. */
effectiveAt?: string;
/** The asAt datetime at which to list the Fee\'s properties. Defaults to return the latest version of each property if not specified. */
asAt?: string;
}
export interface GetFundRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The effective datetime or cut label at which to retrieve the Fund properties. Defaults to the current LUSID system datetime if not specified. */
effectiveAt?: string;
/** The asAt datetime at which to retrieve the Fund definition. Defaults to returning the latest version of the Fund definition if not specified. */
asAt?: string;
/** A list of property keys from the \'Fund\' domain to decorate onto the Fund. These must take the format {domain}/{scope}/{code}, for example \'Fund/Manager/Id\'. If no properties are specified, then no properties will be returned. */
propertyKeys?: Array<string>;
}
export interface GetFundPropertiesRequestParams {
/** The scope of the Fund to list the properties for. */
scope: string;
/** The code of the Fund to list the properties for. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The effective datetime or cut label at which to list the Fund\'s properties. Defaults to the current LUSID system datetime if not specified. */
effectiveAt?: string;
/** The asAt datetime at which to list the Fund\'s properties. Defaults to return the latest version of each property if not specified. */
asAt?: string;
}
export interface GetHoldingContributorsForFundRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The unique holding identifier */
holdingId: number;
/** The arguments to use for querying the holdings.This can be a date, valuationPoint or a bookmark. */
valuationPointDataQueryParameters: ValuationPointDataQueryParameters;
/** When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used. */
navTypeCode?: string;
/** If true, transactions from previously closed holdings are returned. If false, only transactions from last time position is opened. */
includeHistoric?: boolean;
/** Constrains the Holding Contributors to those which contributed to the specified tax lot. */
taxLotId?: string;
/** If true, contributing transaction which have not settled yet will also be returned. False by default */
includeUnsettledMovements?: boolean;
/** When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. */
limit?: number;
/** The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified. */
asAt?: string;
/** The pagination token to use to continue listing transactions from a previous call to GetHoldingContributors. */
page?: string;
}
export interface GetHoldingsForFundRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The arguments to use for querying the holdings. */
singleValuationPointQueryParameters: SingleValuationPointQueryParameters;
/** When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used. */
navTypeCode?: string;
/** The asAt datetime at which to retrieve the holdings of transaction portfolios in the Fund. 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 \"Instrument\", \"Holding\" or \"Portfolio\",\"CustodianAccount\" or \"LegalEntity\" domain to decorate onto domain to decorate onto the holdings. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Holding/system/Cost\". */
propertyKeys?: Array<string>;
/** Whether 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 GetValuationForFundRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used. */
navTypeCode?: string;
/** The request specifying the dates (or DiaryEntry) on which to calculate a set of valuation metrics. */
fundValuationRequest?: FundValuationRequest;
}
export interface GetValuationPointDataRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The arguments to use for querying the Valuation Point data. */
valuationPointDataQueryParameters: ValuationPointDataQueryParameters;
/** The asAt datetime at which to retrieve the Fund definition. Defaults to returning the latest version of the Fund definition if not specified. */
asAt?: string;
/** When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used. */
navTypeCode?: string;
}
export interface GetValuationPointJournalEntryLinesRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The arguments to use for querying the Journal Entry Lines. */
valuationPointDataQueryParameters: ValuationPointDataQueryParameters;
/** The optional code of a General Ledger Profile used to decorate Journal Entry Lines with levels. */
generalLedgerProfileCode?: string;
/** The asAt datetime at which to retrieve Journal Entry Lines. Defaults to returning the latest version if not specified. */
asAt?: string;
/** Expression to filter the result set. */
filter?: 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 Journal Entry Lines from a previous call to GetValuationPointJournalEntryLines. */
page?: string;
/** A list of property keys from the \'Instrument\', \'Transaction\', \'Portfolio\', \'Account\', \'LegalEntity\' or \'CustodianAccount\' domain to decorate onto the Journal Entry Lines. */
propertyKeys?: Array<string>;
/** When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used. */
navTypeCode?: string;
}
export interface GetValuationPointPnlSummaryRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The arguments to use for generating the PnL summary. */
valuationPointDataQueryParameters: ValuationPointDataQueryParameters;
/** The optional code of a General Ledger Profile used to decorate Journal Entry Lines with levels. */
generalLedgerProfileCode?: string;
/** The asAt datetime at which to retrieve PnL summary. Defaults to returning the latest version of each transaction if not specified. */
asAt?: string;
/** \"Expression to filter the result set.\" */
filter?: 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 results from a previous call to GetValuationPointPnlSummary. */
page?: string;
/** When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used. */
navTypeCode?: string;
}
export interface GetValuationPointTransactionsRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The arguments to use for querying the transactions. */
valuationPointDataQueryParameters: ValuationPointDataQueryParameters;
/** The asAt datetime at which to retrieve transactions. Defaults to returning the latest version of each transaction if not specified. */
asAt?: string;
/** Expression to filter the result set. */
filter?: 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 GetValuationPointTransactions. */
page?: string;
/** A list of property keys from the \'Instrument\', \'Transaction\', \'Portfolio\', \'Account\', \'LegalEntity\' or \'CustodianAccount\' domain to decorate onto the transactions. */
propertyKeys?: Array<string>;
/** When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used. */
navTypeCode?: string;
/** The optional scope of a Custom Data Model to use */
dataModelScope?: string;
/** The optional code of a Custom Data Model to use */
dataModelCode?: 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;
/** The membership types of the specified Custom Data Model to return. Default value: Member. Available values: All, Member, Candidate. */
membershipType?: string;
}
export interface GetValuationPointTrialBalanceRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The arguments to use for generating the Trial Balance. */
valuationPointDataQueryParameters: ValuationPointDataQueryParameters;
/** The optional code of a General Ledger Profile used to decorate Journal Entry Lines with levels. */
generalLedgerProfileCode?: string;
/** The asAt datetime at which to retrieve the Trial Balance. Defaults to returning the latest version if not specified. */
asAt?: string;
/** Expression to filter the results by. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. */
filter?: string;
/** When paginating, limit the number of returned results to this number. Defaults to 100 if not specified. */
limit?: number;
/** The pagination token to use to continue listing Trial Balances. This token 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;
/** A list of property keys from the \'Instrument\', \'Transaction\', \'Portfolio\', \'Account\', \'LegalEntity\' or \'CustodianAccount\' domain to decorate onto the TrialBalance. */
propertyKeys?: Array<string>;
/** When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used. */
navTypeCode?: string;
/** If this is set to true, no Cleardown Module will be applied to the Trial Balance. Defaults to false. */
excludeCleardownModule?: boolean;
}
export interface GetValuationPointUnsettledTransactionsRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The arguments to use for querying the unsettled transactions. */
valuationPointDataQueryParameters: ValuationPointDataQueryParameters;
/** The asAt datetime at which to retrieve the report. Defaults to latest. */
asAt?: 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 from a previous call. */
page?: string;
/** A list of property keys from the \'Instrument\', \'Transaction\', \'Portfolio\', or \'Account\' domain to decorate onto the transactions. */
propertyKeys?: Array<string>;
/** When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used. */
navTypeCode?: string;
}
export interface ListFeesRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The effective datetime or cut label at which to list the TimeVariant properties for the Fees. Defaults to the current LUSID system datetime if not specified. */
effectiveAt?: string;
/** The asAt datetime at which to list the Fees. Defaults to returning the latest version of each Fee if not specified. */
asAt?: string;
/** The pagination token to use to continue listing fees; 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 results to this number. Defaults to 100 if not specified. */
limit?: number;
/** Expression to filter the results. For example, to filter on the treatment, specify \"treatment eq \'Monthly\'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. */
filter?: string;
/** A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\" */
sortBy?: Array<string>;
/** A list of property keys from the \'Fee\' domain to decorate onto each Fee. These must take the format {domain}/{scope}/{code}, for example \'Fee/Account/Id\'. */
propertyKeys?: Array<string>;
}
export interface ListFundCalendarRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The asAt datetime at which to list the Calendar. Defaults to returning the latest version of each Calendar Entry if not specified. */
asAt?: string;
/** The pagination token to use to continue listing Calendar Entries; 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 results to this number. Defaults to 100 if not specified. */
limit?: number;
/** Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. */
filter?: string;
/** A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\". */
sortBy?: Array<string>;
/** A list of property keys from the \'ClosedPeriod\' domain to decorate onto each item. */
propertyKeys?: Array<string>;
}
export interface ListFundCalendarEntriesRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The asAt datetime at which to list the Calendar. Defaults to returning the latest version of each Calendar Entry if not specified. */
asAt?: string;
/** The pagination token to use to continue listing Calendar Entries; 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 results to this number. Defaults to 100 if not specified. */
limit?: number;
/** Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. */
filter?: string;
/** A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\". */
sortBy?: Array<string>;
/** A list of property keys from the \'DiaryEntry\' domain to decorate onto each item. */
propertyKeys?: Array<string>;
}
export interface ListFundsRequestParams {
/** The effective datetime or cut label at which to list the TimeVariant properties for the Funds. Defaults to the current LUSID system datetime if not specified. */
effectiveAt?: string;
/** The asAt datetime at which to list the Funds. Defaults to returning the latest version of each Fund if not specified. */
asAt?: string;
/** The pagination token to use to continue listing Funds; 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 results to this number. Defaults to 100 if not specified. */
limit?: number;
/** Expression to filter the results. For example, to filter on the Fund code, specify \"id.Code eq \'Fund1\'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. */
filter?: string;
/** A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\" */
sortBy?: Array<string>;
/** A list of property keys from the \'Fund\' domain to decorate onto each Fund. These must take the format {domain}/{scope}/{code}, for example \'Fund/Manager/Id\'. */
propertyKeys?: Array<string>;
}
export interface ListNavActivityAdjustmentsRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope is the unique identifier for the given Fund. */
code: string;
/** Fetch all NAV adjustment activities for this valuation point. */
valuationPointCode: string;
/** When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used. */
navTypeCode?: string;
/** The asAt datetime at which to list the Nav activity adjustments. Defaults to returning the latest version of each adjustment if not specified. */
asAt?: string;
/** The pagination token to use to continue listing Nav activity adjustments; 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. */
page?: string;
/** When paginating, limit the results to this number. Defaults to 100 if not specified. */
limit?: number;
/** Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. */
filter?: string;
/** The variant of the valuation point used in the request. Together with the valuation point code marks the unique branch for the NavType. */
valuationPointCodeVariant?: string;
}
export interface ListValuationPointInstrumentsRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope is the unique identifier for the given Fund. */
code: string;
/** Fetch all instruments for this valuation point. */
valuationPointCode: string;
/** When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used. */
navTypeCode?: string;
/** The asAt datetime at which to list the instruments. Defaults to returning the latest version of each instrument if not specified. */
asAt?: string;
/** The pagination token to use to continue listing instruments; 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. */
page?: string;
/** When paginating, limit the results to this number. Defaults to 100 if not specified. */
limit?: number;
/** Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. */
filter?: string;
/** A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\". */
sortBy?: Array<string>;
/** A list of property keys from the \'Instrument\' domain to decorate onto instruments, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example \'Instrument/system/Name\'. */
instrumentPropertyKeys?: Array<string>;
/** The variant of the valuation point used in the request. Together with the valuation point code marks the unique branch for the NavType. */
valuationPointCodeVariant?: string;
}
export interface ListValuationPointOverviewRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The effective datetime or cut label at which to list the TimeVariant properties for the Valuation Points. Defaults to the current LUSID system datetime if not specified. */
effectiveAt?: string;
/** The asAt datetime at which to list the Valuation Points. Defaults to returning the latest version of each Valuation Point if not specified. */
asAt?: string;
/** The pagination token to use to continue listing Valuation Points; 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 results to this number. Defaults to 100 if not specified. */
limit?: number;
/** Expression to filter the results by. For example, to filter on the NAV, specify \"NAV gt 300\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. */
filter?: string;
/** A list of property keys from the \'DiaryEntry\' domain to decorate onto each ValuationPoint. These must take the format {domain}/{scope}/{code}, for example \'DiaryEntry/ValuationPoint/Id\'. */
propertyKeys?: Array<string>;
/** When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used. */
navTypeCode?: string;
}
export interface PatchFeeRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The code of the Fee. */
feeCode: string;
/** The json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902. */
operation: Array<Operation>;
}
export interface PatchFundRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902. */
operation: Array<Operation>;
}
export interface QueryCashStatementRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The query parameters specifying the diary entry period and display mode. */
queryFundCashStatementParameters: QueryFundCashStatementParameters;
/** The asAt datetime at which to retrieve the cash statement. Defaults to the latest version if not specified. */
asAt?: string;
/** Expression to filter the result set. */
filter?: 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 get the next page of results. */
page?: string;
/** A list of property keys to decorate onto the cash statement rows. */
propertyKeys?: Array<string>;
/** The code of the NAV type to use. Defaults to the primary NAV type if not specified. */
navTypeCode?: string;
}
export interface RevertValuationPointToEstimateRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The revertValuationPointRequest which contains the Diary Entry code for the Final Valuation Point to move to Estimate status. */
revertValuationPointDataRequest: RevertValuationPointDataRequest;
/** When provided, sets the status of the Valuation Point of the specified NAV Type to be Estimate. Otherwise, the Primary NAV Type will be used. */
navTypeCode?: string;
}
export interface SetShareClassInstrumentsRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The scopes and instrument identifiers for the instruments to be set. */
setShareClassInstrumentsRequest: SetShareClassInstrumentsRequest;
}
export interface UpdateValuationPointRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The Valuation Point Estimate definition to upsert. */
updateValuationPointRequest: UpdateValuationPointRequest;
/** When provided, upserts the Valuation Point against the specified NAV Type, otherwise the Primary NAV Type will be used. */
navTypeCode?: string;
}
export interface UpsertBookmarkRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The bookmark definition to upsert. */
upsertFundBookmarkRequest: UpsertFundBookmarkRequest;
/** When provided, upserts the Valuation Point against the specified NAV Type, otherwise the Primary NAV Type will be used. */
navTypeCode?: string;
}
export interface UpsertDiaryEntryTypeValuationPointRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The Valuation Point Estimate definition to upsert. */
upsertValuationPointRequest: UpsertValuationPointRequest;
/** When provided, upserts the Valuation Point against the specified NAV Type, otherwise the Primary NAV Type will be used. */
navTypeCode?: string;
}
export interface UpsertFeePropertiesRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The code of the Fee to update or insert the properties onto. */
feeCode: string;
/** The properties to be updated or inserted onto the Fee. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. \"Fee/Manager/Id\". */
requestBody?: {
[key: string]: Property;
};
}
export interface UpsertFundPropertiesRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope this uniquely identifies the Fund. */
code: string;
/** The properties to be updated or inserted onto the Fund. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. \"Fund/Manager/Id\". */
requestBody?: {
[key: string]: Property;
};
}
export interface UpsertNavActivityAdjustmentsRequestParams {
/** The scope of the Fund. */
scope: string;
/** The code of the Fund. Together with the scope is the unique identifier for the given Fund. */
code: string;
/** The valuation point Code to apply the adjustment to */
valuationPointCode: string;
/** The request describing the Nav activity adjustments to apply to a specific valuation point and nav type */
navActivityAdjustment: Array<NavActivityAdjustment>;
/** When provided, runs against the specified NAV Type, otherwise the Primary NAV Type will be used. */
navTypeCode?: string;
/** The variant of the valuation point used in the request. Together with the valuation point code marks the unique branch for the NavType. */
valuationPointCodeVariant?: string;
}
export declare class FundsService {
protected httpClient: HttpClient;
protected basePath: string;
defaultHeaders: HttpHeaders;
configuration: Configuration;
encoder: HttpParameterCodec;
constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
private addToHttpParams;
private addToHttpParamsRecursive;
/**
* [EXPERIMENTAL] AcceptEstimateValuationPoint: Accepts an Estimate Valuation Point.
* Accepts the specified estimate Valuation Point. Should the Valuation Point differ since the Valuation Point was last run, both Valuation Points will be returned and status will be marked as \'Candidate\', otherwise it will be marked as \'Final\'.
* @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.
*/
acceptEstimateValuationPoint(requestParameters?: AcceptEstimateValuationPointRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<AcceptEstimateValuationPointResponse>;
acceptEstimateValuationPoint(requestParameters?: AcceptEstimateValuationPointRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<AcceptEstimateValuationPointResponse>>;
acceptEstimateValuationPoint(requestParameters?: AcceptEstimateValuationPointRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<AcceptEstimateValuationPointResponse>>;
/**
* [EXPERIMENTAL] AddAllocationGroups: Add Allocation Groups to a Fund.
* Add the given Allocation Group definitions to the Fund.
* @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.
*/
addAllocationGroups(requestParameters?: AddAllocationGroupsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<Fund>;
addAllocationGroups(requestParameters?: AddAllocationGroupsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<Fund>>;
addAllocationGroups(requestParameters?: AddAllocationGroupsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<Fund>>;
/**
* [EXPERIMENTAL] AddSeries: Add Series to a Fund.
* Add the given Series definitions to the specified Share Classes of the Fund.
* @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.
*/
addSeries(requestParameters?: AddSeriesRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<Fund>;
addSeries(requestParameters?: AddSeriesRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<Fund>>;
addSeries(requestParameters?: AddSeriesRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<Fund>>;
/**
* [EXPERIMENTAL] CreateFee: Create a Fee.
* Create the given Fee.
* @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.
*/
createFee(requestParameters?: CreateFeeRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<Fee>;
createFee(requestParameters?: CreateFeeRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<Fee>>;
createFee(requestParameters?: CreateFeeRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<Fee>>;
/**
* [EXPERIME