artin/OBP-TypeScript
1
0
Fork 0
mirror of https://github.com/OpenBankProject/OBP-TypeScript.git synced 2026-02-06 10:48:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

REFACTOR: docs

Browse Source
This commit is contained in:
Mark Silva 2023-05-03 00:16:31 +08:00
parent bd9b673b42
commit 947b2d112b
9 changed files with 510 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/README.md
View File

@ -2,21 +2,18 @@ obp-typescript / [Modules](modules.md)
# OBP-TypeScript
## Usage
#### Install
#### Symlink
Checkout the obp-typescript library from https://github.com/OpenBankProject/OBP-TypeScript.
Inside the obp-sdk repository folder, execute the **yarn link** command.
##### yarn
```
yarn link
yarn add obp-typescript
```
To link the **obp-typescript** library into your app, run the command inside your app.
##### npm
```
yarn link obp-typescript
npm install obp-typescript
```
#### Example

121
docs/classes/auth.OAuth.md Normal file
View File

@ -0,0 +1,121 @@
[obp-typescript](../README.md) / [Modules](../modules.md) / [auth](../modules/auth.md) / OAuth
# Class: OAuth
[auth](../modules/auth.md).OAuth
Create OAuth.
## Table of contents
### Constructors
- [constructor](auth.OAuth.md#constructor)
### Properties
- [config](auth.OAuth.md#config)
- [instance](auth.OAuth.md#instance)
### Methods
- [authHeader](auth.OAuth.md#authheader)
- [configs](auth.OAuth.md#configs)
- [get](auth.OAuth.md#get)
## Constructors
### constructor
• **new OAuth**(`config`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `config` | [`OAuthConfig`](../modules/auth.md#oauthconfig) |
#### Defined in
[auth/index.ts:62](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/auth/index.ts#L62)
## Properties
### config
• `Private` **config**: [`OAuthConfig`](../modules/auth.md#oauthconfig)
#### Defined in
[auth/index.ts:61](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/auth/index.ts#L61)
___
### instance
• `Private` **instance**: `OAuth`
#### Defined in
[auth/index.ts:60](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/auth/index.ts#L60)
## Methods
### authHeader
▸ **authHeader**(`pathUri`, `method`): `string`
Get the Oauth authentication header.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `pathUri` | `string` | The the relative path of the URL. |
| `method` | `string` | The http method. |
#### Returns
`string`
An OAuthConfig value
#### Defined in
[auth/index.ts:113](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/auth/index.ts#L113)
___
### configs
▸ **configs**(): [`OAuthConfig`](../modules/auth.md#oauthconfig)
Get OAuthConfig object.
#### Returns
[`OAuthConfig`](../modules/auth.md#oauthconfig)
An OAuthConfig value
#### Defined in
[auth/index.ts:100](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/auth/index.ts#L100)
___
### get
▸ **get**(): `OAuth`
Get oauth.OAuth instance.
#### Returns
`OAuth`
An oauth.OAuth value
#### Defined in
[auth/index.ts:89](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/auth/index.ts#L89)

18
docs/enums/api.API.md
View File

@ -28,7 +28,7 @@ Types of OBP API.
#### Defined in
[api/client.ts:45](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/client.ts#L45)
[api/client.ts:46](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/client.ts#L46)
___
@ -38,7 +38,7 @@ ___
#### Defined in
[api/client.ts:52](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/client.ts#L52)
[api/client.ts:53](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/client.ts#L53)
___
@ -48,7 +48,7 @@ ___
#### Defined in
[api/client.ts:44](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/client.ts#L44)
[api/client.ts:45](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/client.ts#L45)
___
@ -58,7 +58,7 @@ ___
#### Defined in
[api/client.ts:49](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/client.ts#L49)
[api/client.ts:50](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/client.ts#L50)
___
@ -68,7 +68,7 @@ ___
#### Defined in
[api/client.ts:50](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/client.ts#L50)
[api/client.ts:51](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/client.ts#L51)
___
@ -78,7 +78,7 @@ ___
#### Defined in
[api/client.ts:51](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/client.ts#L51)
[api/client.ts:52](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/client.ts#L52)
___
@ -88,7 +88,7 @@ ___
#### Defined in
[api/client.ts:46](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/client.ts#L46)
[api/client.ts:47](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/client.ts#L47)
___
@ -98,7 +98,7 @@ ___
#### Defined in
[api/client.ts:47](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/client.ts#L47)
[api/client.ts:48](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/client.ts#L48)
___
@ -108,4 +108,4 @@ ___
#### Defined in
[api/client.ts:48](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/client.ts#L48)
[api/client.ts:49](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/client.ts#L49)

4
docs/enums/api.Version.md
View File

@ -21,7 +21,7 @@ OBP API Versions.
#### Defined in
[api/client.ts:34](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/client.ts#L34)
[api/client.ts:35](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/client.ts#L35)
___
@ -31,4 +31,4 @@ ___
#### Defined in
[api/client.ts:35](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/client.ts#L35)
[api/client.ts:36](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/client.ts#L36)

1
docs/modules.md
View File

@ -7,4 +7,5 @@
### Modules
- [api](modules/api.md)
- [auth](modules/auth.md)
- [index](modules/index.md)

287
docs/modules/api.md
View File

@ -30,8 +30,10 @@
### Functions
- [CreateAny](api.md#createany)
- [CreateTransactionRequestAccount](api.md#createtransactionrequestaccount)
- [Current](api.md#current)
- [DiscardAny](api.md#discardany)
- [GetAccountsByBankId](api.md#getaccountsbybankid)
- [GetAny](api.md#getany)
- [GetBanks](api.md#getbanks)
@ -41,8 +43,11 @@
- [GetKYCStatus](api.md#getkycstatus)
- [GetTagsOnAccount](api.md#gettagsonaccount)
- [GetTransactionsForAccountFull](api.md#gettransactionsforaccountfull)
- [UpdateAny](api.md#updateany)
- [create](api.md#create)
- [discard](api.md#discard)
- [get](api.md#get)
- [update](api.md#update)
## Type Aliases
@ -62,7 +67,7 @@ version
**`Property`**
authentication
[authentication]
**`Property`**
@ -77,14 +82,16 @@ authentication
| Name | Type |
| :------ | :------ |
| `authentication` | [`DirectLoginAuthentication`](api.md#directloginauthentication) |
| `authentication?` | [`DirectLoginAuthentication`](api.md#directloginauthentication) |
| `baseUri` | `string` |
| `oauthConfig?` | [`OAuthConfig`](auth.md#oauthconfig) |
| `token?` | `string` |
| `version` | [`Version`](../enums/api.Version.md) |
| `withFixedVersion?` | `boolean` |
#### Defined in
[api/client.ts:84](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/client.ts#L84)
[api/client.ts:85](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/client.ts#L85)
___
@ -118,11 +125,13 @@ Alias for APIRequest properties.
| Name | Type |
| :------ | :------ |
| `create?` | (`config`: [`APIClientConfig`](api.md#apiclientconfig), `methodCall`: [`MethodCall`](api.md#methodcall)<`T`\>) => `any` |
| `discard?` | (`config`: [`APIClientConfig`](api.md#apiclientconfig), `methodCall`: [`MethodCall`](api.md#methodcall)<`T`\>) => `any` |
| `get?` | (`config`: [`APIClientConfig`](api.md#apiclientconfig), `methodCall`: [`MethodCall`](api.md#methodcall)<`T`\>) => `any` |
| `update?` | (`config`: [`APIClientConfig`](api.md#apiclientconfig), `methodCall`: [`MethodCall`](api.md#methodcall)<`T`\>) => `any` |
#### Defined in
[api/client.ts:123](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/client.ts#L123)
[api/client.ts:126](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/client.ts#L126)
___
@ -154,7 +163,7 @@ consumerKey
#### Defined in
[api/client.ts:64](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/client.ts#L64)
[api/client.ts:65](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/client.ts#L65)
___
@ -204,7 +213,7 @@ APIClientConfig
#### Defined in
[api/client.ts:104](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/client.ts#L104)
[api/client.ts:107](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/client.ts#L107)
___
@ -240,7 +249,7 @@ value
#### Defined in
[api/transaction.ts:43](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/transaction.ts#L43)
[api/transaction.ts:43](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/transaction.ts#L43)
## Variables
@ -265,7 +274,7 @@ A higher order function
#### Defined in
[api/account.ts:67](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/account.ts#L67)
[api/account.ts:67](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/account.ts#L67)
___
@ -290,7 +299,7 @@ A higher order function
#### Defined in
[api/any.ts:66](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/any.ts#L66)
[api/any.ts:138](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/any.ts#L138)
___
@ -315,7 +324,7 @@ A higher order function
#### Defined in
[api/bank.ts:86](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/bank.ts#L86)
[api/bank.ts:86](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/bank.ts#L86)
___
@ -340,7 +349,7 @@ A higher order function
#### Defined in
[api/customer.ts:172](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/customer.ts#L172)
[api/customer.ts:172](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/customer.ts#L172)
___
@ -365,7 +374,7 @@ A higher order function
#### Defined in
[api/kyc.ts:65](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/kyc.ts#L65)
[api/kyc.ts:65](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/kyc.ts#L65)
___
@ -390,7 +399,7 @@ A higher order function
#### Defined in
[api/metadata.ts:68](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/metadata.ts#L68)
[api/metadata.ts:68](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/metadata.ts#L68)
___
@ -415,7 +424,7 @@ A higher order function
#### Defined in
[api/transaction.ts:122](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/transaction.ts#L122)
[api/transaction.ts:122](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/transaction.ts#L122)
___
@ -440,10 +449,64 @@ A higher order function
#### Defined in
[api/user.ts:64](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/user.ts#L64)
[api/user.ts:64](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/user.ts#L64)
## Functions
### CreateAny
▸ **CreateAny**(`config`, `methodCall`): (`path`: `string`) => (`body`: `any`) => `Promise`<[`Any`](../enums/api.API.md#any)\>
Create Any Request.
**`See`**
- [APIClientConfig](api.md#apiclientconfig)
- [TransactionRequestAccountBody](api.md#transactionrequestaccountbody)
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `config` | [`APIClientConfig`](api.md#apiclientconfig) | The APIClientConfig object |
| `methodCall` | (`config`: [`APIClientConfig`](api.md#apiclientconfig), `path`: `string`, `body`: `any`) => `Promise`<`any`\> | A higher order function |
#### Returns
`fn`
A curried function
▸ (`path`): (`body`: `any`) => `Promise`<[`Any`](../enums/api.API.md#any)\>
##### Parameters
| Name | Type |
| :------ | :------ |
| `path` | `string` |
##### Returns
`fn`
▸ (`body`): `Promise`<[`Any`](../enums/api.API.md#any)\>
##### Parameters
| Name | Type |
| :------ | :------ |
| `body` | `any` |
##### Returns
`Promise`<[`Any`](../enums/api.API.md#any)\>
#### Defined in
[api/any.ts:68](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/any.ts#L68)
___
### CreateTransactionRequestAccount
▸ **CreateTransactionRequestAccount**(`config`, `methodCall`): (`bankId`: `string`, `accountId`: `string`, `viewId`: `string`, `account`: `string`) => (`body`: [`TransactionRequestAccountBody`](api.md#transactionrequestaccountbody)) => `Promise`<[`Transaction`](../enums/api.API.md#transaction)\>
@ -497,7 +560,7 @@ A curried function
#### Defined in
[api/transaction.ts:94](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/transaction.ts#L94)
[api/transaction.ts:94](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/transaction.ts#L94)
___
@ -527,7 +590,49 @@ A curried function
#### Defined in
[api/user.ts:45](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/user.ts#L45)
[api/user.ts:45](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/user.ts#L45)
___
### DiscardAny
▸ **DiscardAny**(`config`, `methodCall`): (`path`: `string`) => `Promise`<`any`\>
Delete Any Request.
**`See`**
- [APIClientConfig](api.md#apiclientconfig)
- [TransactionRequestAccountBody](api.md#transactionrequestaccountbody)
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `config` | [`APIClientConfig`](api.md#apiclientconfig) | The APIClientConfig object |
| `methodCall` | (`config`: [`APIClientConfig`](api.md#apiclientconfig), `path`: `string`) => `Promise`<`any`\> | A higher order function |
#### Returns
`fn`
A curried function
▸ (`path`): `Promise`<`any`\>
##### Parameters
| Name | Type |
| :------ | :------ |
| `path` | `string` |
##### Returns
`Promise`<`any`\>
#### Defined in
[api/any.ts:118](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/any.ts#L118)
___
@ -569,7 +674,7 @@ A curried function
#### Defined in
[api/account.ts:46](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/account.ts#L46)
[api/account.ts:46](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/account.ts#L46)
___
@ -611,7 +716,7 @@ A curried function
#### Defined in
[api/any.ts:46](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/any.ts#L46)
[api/any.ts:47](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/any.ts#L47)
___
@ -641,7 +746,7 @@ A curried function
#### Defined in
[api/bank.ts:67](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/bank.ts#L67)
[api/bank.ts:67](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/bank.ts#L67)
___
@ -683,7 +788,7 @@ A curried function
#### Defined in
[api/bank.ts:46](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/bank.ts#L46)
[api/bank.ts:46](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/bank.ts#L46)
___
@ -712,7 +817,7 @@ A curried function
#### Defined in
[api/customer.ts:99](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/customer.ts#L99)
[api/customer.ts:99](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/customer.ts#L99)
___
@ -753,7 +858,7 @@ A curried function
#### Defined in
[api/customer.ts:118](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/customer.ts#L118)
[api/customer.ts:118](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/customer.ts#L118)
___
@ -794,7 +899,7 @@ A curried function
#### Defined in
[api/kyc.ts:45](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/kyc.ts#L45)
[api/kyc.ts:45](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/kyc.ts#L45)
___
@ -837,7 +942,7 @@ A curried function
#### Defined in
[api/metadata.ts:45](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/metadata.ts#L45)
[api/metadata.ts:45](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/metadata.ts#L45)
___
@ -881,7 +986,61 @@ A curried function
#### Defined in
[api/transaction.ts:68](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/transaction.ts#L68)
[api/transaction.ts:68](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/transaction.ts#L68)
___
### UpdateAny
▸ **UpdateAny**(`config`, `methodCall`): (`path`: `string`) => (`body`: `any`) => `Promise`<[`Any`](../enums/api.API.md#any)\>
Update Any Request.
**`See`**
- [APIClientConfig](api.md#apiclientconfig)
- [TransactionRequestAccountBody](api.md#transactionrequestaccountbody)
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `config` | [`APIClientConfig`](api.md#apiclientconfig) | The APIClientConfig object |
| `methodCall` | (`config`: [`APIClientConfig`](api.md#apiclientconfig), `path`: `string`, `body`: `any`) => `Promise`<`any`\> | A higher order function |
#### Returns
`fn`
A curried function
▸ (`path`): (`body`: `any`) => `Promise`<[`Any`](../enums/api.API.md#any)\>
##### Parameters
| Name | Type |
| :------ | :------ |
| `path` | `string` |
##### Returns
`fn`
▸ (`body`): `Promise`<[`Any`](../enums/api.API.md#any)\>
##### Parameters
| Name | Type |
| :------ | :------ |
| `body` | `any` |
##### Returns
`Promise`<[`Any`](../enums/api.API.md#any)\>
#### Defined in
[api/any.ts:93](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/any.ts#L93)
___
@ -917,7 +1076,43 @@ An
#### Defined in
[api/client.ts:329](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/client.ts#L329)
[api/client.ts:431](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/client.ts#L431)
___
### discard
▸ **discard**<`T`\>(`config`, `request`): `any`
A DELETE request function that deletes an API data.
**`See`**
- APIClientConfig
- APIRequest<T>
#### Type parameters
| Name |
| :------ |
| `T` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `config` | [`APIClientConfig`](api.md#apiclientconfig) | The APIClientConfig object |
| `request` | [`APIRequest`](api.md#apirequest)<`T`\> | The APIRequest object |
#### Returns
`any`
An
#### Defined in
[api/client.ts:469](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/client.ts#L469)
___
@ -953,4 +1148,40 @@ An
#### Defined in
[api/client.ts:310](https://github.com/mark-tesobe/OBP-TypeScript/blob/71468c3/src/api/client.ts#L310)
[api/client.ts:412](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/client.ts#L412)
___
### update
▸ **update**<`T`\>(`config`, `request`): `any`
A PUT request function that updates an API data and returns the result.
**`See`**
- APIClientConfig
- APIRequest<T>
#### Type parameters
| Name |
| :------ |
| `T` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `config` | [`APIClientConfig`](api.md#apiclientconfig) | The APIClientConfig object |
| `request` | [`APIRequest`](api.md#apirequest)<`T`\> | The APIRequest object |
#### Returns
`any`
An
#### Defined in
[api/client.ts:450](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/api/client.ts#L450)

61
docs/modules/auth.md Normal file
View File

@ -0,0 +1,61 @@
[obp-typescript](../README.md) / [Modules](../modules.md) / auth
# Module: auth
## Table of contents
### Classes
- [OAuth](../classes/auth.OAuth.md)
### Type Aliases
- [OAuthConfig](auth.md#oauthconfig)
## Type Aliases
### OAuthConfig
Ƭ **OAuthConfig**: `Object`
Alias for OAuthConfig properties.
**`Property`**
baseUri
**`Property`**
consumerKey
**`Property`**
consumerSecret
**`Property`**
redirectUrl
**`Property`**
[token]
**`Property`**
[oauthVerifier]
#### Type declaration
| Name | Type |
| :------ | :------ |
| `accessToken?` | { `key`: `string` ; `secret`: `string` } |
| `accessToken.key` | `string` |
| `accessToken.secret` | `string` |
| `baseUri?` | `string` |
| `consumerKey` | `string` |
| `consumerSecret` | `string` |
| `redirectUrl` | `string` |
#### Defined in
[auth/index.ts:41](https://github.com/mark-tesobe/OBP-TypeScript/blob/bd9b673/src/auth/index.ts#L41)

49
docs/modules/index.md
View File

@ -12,10 +12,12 @@
- [Account](index.md#account)
- [Any](index.md#any)
- [Bank](index.md#bank)
- [CreateAny](index.md#createany)
- [CreateTransactionRequestAccount](index.md#createtransactionrequestaccount)
- [Current](index.md#current)
- [Customer](index.md#customer)
- [DirectLoginAuthentication](index.md#directloginauthentication)
- [DiscardAny](index.md#discardany)
- [GetAccountsByBankId](index.md#getaccountsbybankid)
- [GetAny](index.md#getany)
- [GetBanks](index.md#getbanks)
@ -28,12 +30,17 @@
- [KYC](index.md#kyc)
- [Metadata](index.md#metadata)
- [MethodCall](index.md#methodcall)
- [OAuth](index.md#oauth)
- [OAuthConfig](index.md#oauthconfig)
- [Transaction](index.md#transaction)
- [TransactionRequestAccountBody](index.md#transactionrequestaccountbody)
- [UpdateAny](index.md#updateany)
- [User](index.md#user)
- [Version](index.md#version)
- [create](index.md#create)
- [discard](index.md#discard)
- [get](index.md#get)
- [update](index.md#update)
## References
@ -73,6 +80,12 @@ Re-exports [Bank](api.md#bank)
___
### CreateAny
Re-exports [CreateAny](api.md#createany)
___
### CreateTransactionRequestAccount
Re-exports [CreateTransactionRequestAccount](api.md#createtransactionrequestaccount)
@ -97,6 +110,12 @@ Re-exports [DirectLoginAuthentication](api.md#directloginauthentication)
___
### DiscardAny
Re-exports [DiscardAny](api.md#discardany)
___
### GetAccountsByBankId
Re-exports [GetAccountsByBankId](api.md#getaccountsbybankid)
@ -169,6 +188,18 @@ Re-exports [MethodCall](api.md#methodcall)
___
### OAuth
Re-exports [OAuth](../classes/auth.OAuth.md)
___
### OAuthConfig
Re-exports [OAuthConfig](auth.md#oauthconfig)
___
### Transaction
Re-exports [Transaction](api.md#transaction)
@ -181,6 +212,12 @@ Re-exports [TransactionRequestAccountBody](api.md#transactionrequestaccountbody)
___
### UpdateAny
Re-exports [UpdateAny](api.md#updateany)
___
### User
Re-exports [User](api.md#user)
@ -199,6 +236,18 @@ Re-exports [create](api.md#create)
___
### discard
Re-exports [discard](api.md#discard)
___
### get
Re-exports [get](api.md#get)
___
### update
Re-exports [update](api.md#update)

6
src/auth/index.ts
View File

@ -82,7 +82,7 @@ export class OAuth {
/**
* Get oauth.OAuth instance.
*
* @returns An {oauth.OAuth} value
* @returns An oauth.OAuth value
*
* @public
*/
@ -93,7 +93,7 @@ export class OAuth {
/**
* Get OAuthConfig object.
*
* @returns An {OAuthConfig} value
* @returns An OAuthConfig value
*
* @public
*/
@ -106,7 +106,7 @@ export class OAuth {
*
* @param pathUri - The the relative path of the URL.
* @param method - The http method.
* @returns An {OAuthConfig} value
* @returns An OAuthConfig value
*
* @public
*/