Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bryaningl3 committed Nov 19, 2024
1 parent 6758efb commit a60e5f4
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 3 deletions.
14 changes: 14 additions & 0 deletions docs/content/release_notes.md
Original file line number Diff line number Diff line change
@@ -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**

Expand Down
21 changes: 18 additions & 3 deletions docs/content/sdk/lib-gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,14 @@
* [.updatePosition(position)](#PortfolioGatewayupdatePosition)[<code>Promise.&lt;Schema.Position&gt;</code>](/content/sdk/lib-data?id=schemaposition)
* [.deletePosition(portfolio, position)](#PortfolioGatewaydeletePosition)[<code>Promise.&lt;Array.&lt;Schema.Position&gt;&gt;</code>](/content/sdk/lib-data?id=schemaposition)
* [.readPositions([portfolio], [position], [includePreviousPrice])](#PortfolioGatewayreadPositions)[<code>Promise.&lt;Array.&lt;Schema.Position&gt;&gt;</code>](/content/sdk/lib-data?id=schemaposition)
* [.createTransaction(transaction, options)](#PortfolioGatewaycreateTransaction)[<code>Promise.&lt;Schema.TransactionMutateResult&gt;</code>](/content/sdk/lib-data?id=schematransactionmutateresult)
* [.createTransaction(transaction, [options])](#PortfolioGatewaycreateTransaction)[<code>Promise.&lt;Schema.TransactionMutateResult&gt;</code>](/content/sdk/lib-data?id=schematransactionmutateresult)
* [.editTransaction(transaction)](#PortfolioGatewayeditTransaction)[<code>Promise.&lt;Schema.TransactionMutateResult&gt;</code>](/content/sdk/lib-data?id=schematransactionmutateresult)
* [.deleteTransaction(portfolio, position, sequence, [force], [echoStart], [echoEnd])](#PortfolioGatewaydeleteTransaction)[<code>Promise.&lt;Schema.TransactionMutateResult&gt;</code>](/content/sdk/lib-data?id=schematransactionmutateresult)
* [.readTransactions(portfolio, [position], [sequence])](#PortfolioGatewayreadTransactions)[<code>Promise.&lt;Array.&lt;Schema.Transaction&gt;&gt;</code>](/content/sdk/lib-data?id=schematransaction)
* [.readValuations(portfolio, [position])](#PortfolioGatewayreadValuations)[<code>Promise.&lt;Schema.ValuationContainer&gt;</code>](/content/sdk/lib-data?id=schemavaluationcontainer)
* [.checkValuations(portfolio)](#PortfolioGatewaycheckValuations) ⇒ <code>Promise.&lt;Schema.ValuationsAvailabilityResult&gt;</code>
* [.readVersion()](#PortfolioGatewayreadVersion) ⇒ <code>Promise.&lt;Object&gt;</code>
* [.registerAuthorizationObserver(authorizationObserver)](#PortfolioGatewayregisterAuthorizationObserver) ⇒ <code>Disposable</code>
* _static_
* [.forTest(jwtProvider, [product])](#PortfolioGatewayforTest)[<code>Promise.&lt;PortfolioGateway&gt;</code>](#PortfolioGateway)
* [.forDemo(jwtProvider, [product])](#PortfolioGatewayforDemo)[<code>Promise.&lt;PortfolioGateway&gt;</code>](#PortfolioGateway)
Expand Down Expand Up @@ -163,7 +164,7 @@

* * *

### portfolioGateway.createTransaction(transaction, options) :id=portfoliogatewaycreatetransaction
### portfolioGateway.createTransaction(transaction, [options]) :id=portfoliogatewaycreatetransaction
> Creates a new transaction.
**Kind**: instance method of [<code>PortfolioGateway</code>](#PortfolioGateway)
Expand All @@ -173,7 +174,7 @@
| Param | Type |
| --- | --- |
| transaction | [<code>Schema.TransactionCreate</code>](/content/sdk/lib-data?id=schematransactioncreate) |
| options | <code>Object</code> |
| [options] | <code>Object</code> |


* * *
Expand Down Expand Up @@ -264,6 +265,20 @@
**Returns**: <code>Promise.&lt;Object&gt;</code>
**Access**: public

* * *

### portfolioGateway.registerAuthorizationObserver(authorizationObserver) :id=portfoliogatewayregisterauthorizationobserver
> Registers a callback which will be notified when an authorization event occurs.
**Kind**: instance method of [<code>PortfolioGateway</code>](#PortfolioGateway)
**Returns**: <code>Disposable</code>
**Access**: public

| Param | Type |
| --- | --- |
| authorizationObserver | <code>function</code> |


* * *

### PortfolioGateway.forTest(jwtProvider, [product]) :id=portfoliogatewayfortest
Expand Down

0 comments on commit a60e5f4

Please sign in to comment.