diff --git a/docs/content/release_notes.md b/docs/content/release_notes.md index c73160b0..e71a9e57 100644 --- a/docs/content/release_notes.md +++ b/docs/content/release_notes.md @@ -1,5 +1,19 @@ # Release Notes +## 6.0.0 +**Breaking Changes** + +* Updated [`@barchart/portfolio-api-common`]https://github.com/barchart/portfolio-api-common) to the next major version. + +**Technical Enhancements** + +* Updated AWS CodeBuild to use Node.js version 20. + +## 5.11.1 +**Technical Enhancements** + +* Updated the [`@barchart/portfolio-api-common`](https://github.com/barchart/portfolio-api-common) library, taking changes to the `PositionSchema` enumeration. + ## 5.11.0 **New Features** diff --git a/docs/content/sdk/lib-gateway.md b/docs/content/sdk/lib-gateway.md index 3231b81d..0a4f35f1 100644 --- a/docs/content/sdk/lib-gateway.md +++ b/docs/content/sdk/lib-gateway.md @@ -17,13 +17,14 @@ * [.updatePosition(position)](#PortfolioGatewayupdatePosition) ⇒ [Promise.<Schema.Position>](/content/sdk/lib-data?id=schemaposition) * [.deletePosition(portfolio, position)](#PortfolioGatewaydeletePosition) ⇒ [Promise.<Array.<Schema.Position>>](/content/sdk/lib-data?id=schemaposition) * [.readPositions([portfolio], [position], [includePreviousPrice])](#PortfolioGatewayreadPositions) ⇒ [Promise.<Array.<Schema.Position>>](/content/sdk/lib-data?id=schemaposition) - * [.createTransaction(transaction, options)](#PortfolioGatewaycreateTransaction) ⇒ [Promise.<Schema.TransactionMutateResult>](/content/sdk/lib-data?id=schematransactionmutateresult) + * [.createTransaction(transaction, [options])](#PortfolioGatewaycreateTransaction) ⇒ [Promise.<Schema.TransactionMutateResult>](/content/sdk/lib-data?id=schematransactionmutateresult) * [.editTransaction(transaction)](#PortfolioGatewayeditTransaction) ⇒ [Promise.<Schema.TransactionMutateResult>](/content/sdk/lib-data?id=schematransactionmutateresult) * [.deleteTransaction(portfolio, position, sequence, [force], [echoStart], [echoEnd])](#PortfolioGatewaydeleteTransaction) ⇒ [Promise.<Schema.TransactionMutateResult>](/content/sdk/lib-data?id=schematransactionmutateresult) * [.readTransactions(portfolio, [position], [sequence])](#PortfolioGatewayreadTransactions) ⇒ [Promise.<Array.<Schema.Transaction>>](/content/sdk/lib-data?id=schematransaction) * [.readValuations(portfolio, [position])](#PortfolioGatewayreadValuations) ⇒ [Promise.<Schema.ValuationContainer>](/content/sdk/lib-data?id=schemavaluationcontainer) * [.checkValuations(portfolio)](#PortfolioGatewaycheckValuations) ⇒ Promise.<Schema.ValuationsAvailabilityResult> * [.readVersion()](#PortfolioGatewayreadVersion) ⇒ Promise.<Object> + * [.registerAuthorizationObserver(authorizationObserver)](#PortfolioGatewayregisterAuthorizationObserver) ⇒ Disposable * _static_ * [.forTest(jwtProvider, [product])](#PortfolioGatewayforTest) ⇒ [Promise.<PortfolioGateway>](#PortfolioGateway) * [.forDemo(jwtProvider, [product])](#PortfolioGatewayforDemo) ⇒ [Promise.<PortfolioGateway>](#PortfolioGateway) @@ -163,7 +164,7 @@ * * * -### portfolioGateway.createTransaction(transaction, options) :id=portfoliogatewaycreatetransaction +### portfolioGateway.createTransaction(transaction, [options]) :id=portfoliogatewaycreatetransaction > Creates a new transaction. **Kind**: instance method of [PortfolioGateway](#PortfolioGateway) @@ -173,7 +174,7 @@ | Param | Type | | --- | --- | | transaction | [Schema.TransactionCreate](/content/sdk/lib-data?id=schematransactioncreate) | -| options | Object | +| [options] | Object | * * * @@ -264,6 +265,20 @@ **Returns**: Promise.<Object> **Access**: public +* * * + +### portfolioGateway.registerAuthorizationObserver(authorizationObserver) :id=portfoliogatewayregisterauthorizationobserver +> Registers a callback which will be notified when an authorization event occurs. + +**Kind**: instance method of [PortfolioGateway](#PortfolioGateway) +**Returns**: Disposable +**Access**: public + +| Param | Type | +| --- | --- | +| authorizationObserver | function | + + * * * ### PortfolioGateway.forTest(jwtProvider, [product]) :id=portfoliogatewayfortest