Skip to content

Commit a0edc3c

Browse files
authored
Update packages to avoid security warning
* Update packages to avoid security warning * bump version * fix dependancy locations * fix comma * Fixed tests for TS2.8 * Updated build to work
1 parent 82f88e6 commit a0edc3c

28 files changed

+1142
-1819
lines changed

docs/README.md

Lines changed: 5 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11

2-
3-
42
# Payment Rails JavaScript SDK
53

64
## Index
@@ -9,7 +7,6 @@
97

108
* [Exceptions](modules/exceptions.md)
119

12-
1310
### Classes
1411

1512
* [BalancesGateway](classes/balancesgateway.md)
@@ -21,34 +18,28 @@
2118
* [RecipientAccountGateway](classes/recipientaccountgateway.md)
2219
* [RecipientGateway](classes/recipientgateway.md)
2320

24-
2521
### Interfaces
2622

2723
* [BatchInput](interfaces/batchinput.md)
2824
* [ConfigurationParams](interfaces/configurationparams.md)
2925
* [PaymentInput](interfaces/paymentinput.md)
3026
* [RecipientInput](interfaces/recipientinput.md)
3127

32-
3328
### Functions
3429

3530
* [connect](#connect)
3631

32+
---
3733

34+
## Functions
3835

39-
---
40-
# Functions
4136
<a id="connect"></a>
4237

4338
### connect
4439

45-
**connect**(config: *[ConfigurationParams](interfaces/configurationparams.md)*): [Gateway](classes/gateway.md)
46-
47-
48-
49-
*Defined in [index.ts:21](https://github.com/PaymentRails/javascript-sdk/blob/0e7d5e5/lib/index.ts#L21)*
50-
40+
**connect**(config: *[ConfigurationParams](interfaces/configurationparams.md)*): [Gateway](classes/gateway.md)
5141

42+
*Defined in [index.ts:21](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/index.ts#L21)*
5243

5344
Create a client for the Payment Rails JavasScript API
5445

@@ -57,23 +48,13 @@ Create a client for the Payment Rails JavasScript API
5748
secret: "MY_PRIVATE_KEY",
5849
});
5950

60-
6151
**Parameters:**
6252

6353
| Param | Type | Description |
6454
| ------ | ------ | ------ |
65-
| config | [ConfigurationParams](interfaces/configurationparams.md) | The configuration parameters |
66-
67-
68-
69-
55+
| config | [ConfigurationParams](interfaces/configurationparams.md) | The configuration parameters |
7056

7157
**Returns:** [Gateway](classes/gateway.md)
7258

73-
74-
75-
76-
7759
___
7860

79-

docs/classes/balancesgateway.md

Lines changed: 53 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,82 +1,108 @@
11
[Payment Rails JavaScript SDK](../README.md) > [BalancesGateway](../classes/balancesgateway.md)
22

3+
# Class: BalancesGateway
34

5+
## Hierarchy
46

5-
# Class: BalancesGateway
7+
**BalancesGateway**
68

79
## Index
810

11+
### Constructors
12+
13+
* [constructor](balancesgateway.md#constructor)
14+
15+
### Properties
16+
17+
* [config](balancesgateway.md#config)
18+
* [gateway](balancesgateway.md#gateway)
19+
920
### Methods
1021

1122
* [all](balancesgateway.md#all)
1223
* [find](balancesgateway.md#find)
1324

25+
---
1426

27+
## Constructors
1528

16-
---
29+
<a id="constructor"></a>
1730

31+
### `<Private>` constructor
1832

19-
## Methods
20-
<a id="all"></a>
33+
**new BalancesGateway**(gateway: *[Gateway](gateway.md)*): [BalancesGateway](balancesgateway.md)
2134

22-
### all
35+
*Defined in [BalancesGateway.ts:15](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BalancesGateway.ts#L15)*
2336

24-
**all**(): `Promise`.<`Balance`[]>
37+
**Parameters:**
2538

39+
| Param | Type | Description |
40+
| ------ | ------ | ------ |
41+
| gateway | [Gateway](gateway.md) | gateway object |
2642

43+
**Returns:** [BalancesGateway](balancesgateway.md)
2744

28-
*Defined in [BalancesGateway.ts:32](https://github.com/PaymentRails/javascript-sdk/blob/0e7d5e5/lib/BalancesGateway.ts#L32)*
45+
___
2946

47+
## Properties
3048

49+
<a id="config"></a>
3150

32-
Fetch the account balance for all enabled bank accounts
51+
### `<Private>` config
3352

34-
const balances = await client.balances.all();
53+
**● config**: *[Configuration](configuration.md)*
3554

55+
*Defined in [BalancesGateway.ts:15](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BalancesGateway.ts#L15)*
3656

57+
___
58+
<a id="gateway"></a>
3759

60+
### `<Private>` gateway
3861

39-
**Returns:** `Promise`.<`Balance`[]>
62+
**● gateway**: *[Gateway](gateway.md)*
4063

64+
*Defined in [BalancesGateway.ts:11](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BalancesGateway.ts#L11)*
4165

66+
___
4267

68+
## Methods
4369

70+
<a id="all"></a>
4471

45-
___
72+
### all
4673

47-
<a id="find"></a>
74+
**all**(): `Promise`<`Balance`[]>
4875

49-
### find
76+
*Defined in [BalancesGateway.ts:32](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BalancesGateway.ts#L32)*
77+
78+
Fetch the account balance for all enabled bank accounts
5079

51-
**find**(kind: *"paypal"⎮"paymentrails"*): `Promise`.<`Balance`[]>
80+
const balances = await client.balances.all();
5281

82+
**Returns:** `Promise`<`Balance`[]>
5383

84+
___
85+
<a id="find"></a>
5486

55-
*Defined in [BalancesGateway.ts:49](https://github.com/PaymentRails/javascript-sdk/blob/0e7d5e5/lib/BalancesGateway.ts#L49)*
87+
### find
5688

89+
**find**(kind: *"paypal" |"paymentrails"*): `Promise`<`Balance`[]>
5790

91+
*Defined in [BalancesGateway.ts:49](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BalancesGateway.ts#L49)*
5892

5993
Fetch the account balance for the given account type
6094

6195
const balances = await client.balances.find("paymentrails");
6296

63-
6497
**Parameters:**
6598

6699
| Param | Type | Description |
67100
| ------ | ------ | ------ |
68-
| kind | "paypal"⎮"paymentrails" | The account type to get the balances for |
69-
70-
71-
72-
73-
74-
**Returns:** `Promise`.<`Balance`[]>
75-
76-
77-
101+
| kind | "paypal" |
102+
"paymentrails"
103+
| The account type to get the balances for |
78104

105+
**Returns:** `Promise`<`Balance`[]>
79106

80107
___
81108

82-

0 commit comments

Comments
 (0)