Portfolios

Handles all Portfolio related functionality on the Identity side

Hierarchy

Index

Properties

Methods

Properties

Protected context

context: Context

Inherited from void

Defined in src/api/entities/Namespace.ts:11

create

create: ProcedureMethod‹object, NumberedPortfolio

Defined in src/api/entities/Identity/Portfolios.ts:162

Create a new Portfolio for the Identity

delete

delete: ProcedureMethod‹object, void›

Defined in src/api/entities/Identity/Portfolios.ts:170

Delete a Portfolio by ID

note required role:

  • Portfolio Custodian

Protected parent

parent: Identity

Inherited from void

Defined in src/api/entities/Namespace.ts:9

Methods

getCustodiedPortfolios

getCustodiedPortfolios(paginationOpts?: PaginationOptions): Promise‹ResultSetDefaultPortfolio | NumberedPortfolio››

Defined in src/api/entities/Identity/Portfolios.ts:81

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 getPortfolios

note supports pagination

Parameters:

Returns: Promise‹ResultSetDefaultPortfolio | NumberedPortfolio››

getPortfolio

getPortfolio(): Promise‹DefaultPortfolio

Defined in src/api/entities/Identity/Portfolios.ts:128

Retrieve a numbered Portfolio or the default Portfolio if Portfolio ID is not passed

Returns: Promise‹DefaultPortfolio

getPortfolio(args: object): Promise‹NumberedPortfolio

Defined in src/api/entities/Identity/Portfolios.ts:129

Parameters:

args: object

Returns: Promise‹NumberedPortfolio

getPortfolios

getPortfolios(): Promise‹[DefaultPortfolio, NumberedPortfolio]›

Defined in src/api/entities/Identity/Portfolios.ts:50

Retrieve all the Portfolios owned by this Identity

Returns: Promise‹[DefaultPortfolio, NumberedPortfolio]›

Last updated