api_entities_Identity_Portfolios.Portfolios
Previousapi_entities_Identity_IdentityAuthorizations.IdentityAuthorizationsNextapi_entities_Instruction.Instruction
Last updated
Was this helpful?
Last updated
Was this helpful?
/ / / Portfolios
.Portfolios
Handles all Portfolio related functionality on the Identity side
Namespace<>
↳ Portfolios
▸ delete(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Delete a Portfolio by ID
note required role:
Portfolio Custodian
Parameters
args
Object
args.portfolio
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
note supports pagination
Parameters
paginationOpts?
Returns
Defined in
Retrieve a Numbered Portfolio or the Default Portfolio if Portfolio ID is not passed
Returns
Defined in
Parameters
args
Object
args.portfolioId
BigNumber
Returns
Defined in
Retrieve all the Portfolios owned by this Identity
Returns
Defined in
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
BigNumber |
▸ getCustodiedPortfolios(paginationOpts?): Promise<< | >>
Retrieve all Portfolios custodied by this Identity. This only includes portfolios owned by a different Identity but custodied by this one. To fetch Portfolios owned by this Identity, use
Promise<< | >>
▸ getPortfolio(): Promise<>
Promise<>
▸ getPortfolio(args): Promise<>
Promise<>
▸ getPortfolios(): Promise<[, ...NumberedPortfolio[]]>
Promise<[, ...NumberedPortfolio[]]>