Skip to content

Commit d3e8346

Browse files
author
Aman Aalam
authored
Merge pull request #63 from trolley/repo-update
Renamed repository link from PaymentRails to Trolley, added more info…
2 parents cd87af1 + b801455 commit d3e8346

16 files changed

+123
-109
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ calls.
1818
const trolley = require('trolleyhq');
1919

2020
const client = trolley.connect({
21-
key: "YOUR-API-KEY",
22-
secret: "YOUR-API-SECRET",
21+
key: "YOUR-ACCESS-KEY",
22+
secret: "YOUR-SECRET-SECRET",
2323
});
2424

2525
// Async/Await version
@@ -46,14 +46,14 @@ client.recipient.find("R-G7SXXpm6cs4aTUd9YhmgWC").then(recipient => {
4646
Methods should all have JSDoc comments to help you understand their usage. As mentioned the [full API documentation](https://docs.trolley.com)
4747
is the best source of information about the API.
4848

49-
For more information please read the [JavaScript API docs](https://github.com/PaymentRails/javascript-sdk/blob/master/docs/) is available. The best starting point is:
49+
For more information please read the [JavaScript API docs](https://github.com/Trolley/javascript-sdk/blob/master/docs/) is available. The best starting point is:
5050

5151
| Data Type | SDK Documentation |
5252
| ----- | ----- |
53-
| Batch | [API Docs for Batch](https://github.com/PaymentRails/javascript-sdk/blob/master/docs/classes/batchgateway.md) |
54-
| Payment | [API Docs for Payment](https://github.com/PaymentRails/javascript-sdk/blob/master/docs/classes/paymentgateway.md) |
55-
| Recipient | [API Docs for Recipient](https://github.com/PaymentRails/javascript-sdk/blob/master/docs/classes/recipientgateway.md) |
56-
| Recipient Account | [API Docs for Recipient Account](https://github.com/PaymentRails/javascript-sdk/blob/master/docs/classes/recipientaccountgateway.md) |
53+
| Batch | [API Docs for Batch](https://github.com/Trolley/javascript-sdk/blob/master/docs/classes/batchgateway.md) |
54+
| Payment | [API Docs for Payment](https://github.com/Trolley/javascript-sdk/blob/master/docs/classes/paymentgateway.md) |
55+
| Recipient | [API Docs for Recipient](https://github.com/Trolley/javascript-sdk/blob/master/docs/classes/recipientgateway.md) |
56+
| Recipient Account | [API Docs for Recipient Account](https://github.com/Trolley/javascript-sdk/blob/master/docs/classes/recipientaccountgateway.md) |
5757

5858
### Running Integration / Unit tests
5959

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939

4040
**connect**(config: *[ConfigurationParams](interfaces/configurationparams.md)*): [Gateway](classes/gateway.md)
4141

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

4444
Create a client for the Trolley (Payment Rails) JavasScript API
4545

docs/classes/balancesgateway.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232

3333
**new BalancesGateway**(gateway: *[Gateway](gateway.md)*): [BalancesGateway](balancesgateway.md)
3434

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

3737
**Parameters:**
3838

@@ -52,7 +52,7 @@ ___
5252

5353
**● config**: *[Configuration](configuration.md)*
5454

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

5757
___
5858
<a id="gateway"></a>
@@ -61,7 +61,7 @@ ___
6161

6262
**● gateway**: *[Gateway](gateway.md)*
6363

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

6666
___
6767

@@ -73,7 +73,7 @@ ___
7373

7474
**all**(): `Promise`<`Balance`[]>
7575

76-
*Defined in [BalancesGateway.ts:32](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BalancesGateway.ts#L32)*
76+
*Defined in [BalancesGateway.ts:32](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/BalancesGateway.ts#L32)*
7777

7878
Fetch the account balance for all enabled bank accounts
7979

@@ -88,7 +88,7 @@ ___
8888

8989
**find**(kind: *"paypal" |"paymentrails"*): `Promise`<`Balance`[]>
9090

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

9393
Fetch the account balance for the given account type
9494

docs/classes/batchgateway.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Gateway class for batcheso
3434

3535
**all**(): `Promise`<`Batch`[]>
3636

37-
*Defined in [BatchGateway.ts:52](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L52)*
37+
*Defined in [BatchGateway.ts:52](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L52)*
3838

3939
Fetch batch all batches with an Iterator
4040

@@ -47,7 +47,7 @@ ___
4747

4848
**create**(batch: *`BatchInput`*, payments?: *`PaymentInput`[]*): `Promise`<`Batch`>
4949

50-
*Defined in [BatchGateway.ts:95](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L95)*
50+
*Defined in [BatchGateway.ts:95](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L95)*
5151

5252
Creates a batch with optional payments. This is the interface that is provide by the [Create Batch](https://docs.trolley.com/api/#create-a-batch) API
5353

@@ -79,7 +79,7 @@ ___
7979

8080
**find**(batchId: *`string`*): `Promise`<`Batch`>
8181

82-
*Defined in [BatchGateway.ts:67](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L67)*
82+
*Defined in [BatchGateway.ts:67](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L67)*
8383

8484
Retrieves a batch based on the batch id
8585

@@ -100,7 +100,7 @@ ___
100100

101101
**generateQuote**(batchId: *`string`*): `Promise`<`Batch`>
102102

103-
*Defined in [BatchGateway.ts:182](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L182)*
103+
*Defined in [BatchGateway.ts:182](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L182)*
104104

105105
Generate a FX quote for this batch
106106

@@ -119,7 +119,7 @@ ___
119119

120120
**paymentList**(batchId: *`string`*, page?: *`number`*, pageSize?: *`number`*): `Promise`<`Payment`[]>
121121

122-
*Defined in [BatchGateway.ts:166](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L166)*
122+
*Defined in [BatchGateway.ts:166](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L166)*
123123

124124
Return a paginated list of payments for this batch
125125

@@ -140,7 +140,7 @@ ___
140140

141141
**remove**(batchId: *`string`*): `Promise`<`boolean`>
142142

143-
*Defined in [BatchGateway.ts:132](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L132)*
143+
*Defined in [BatchGateway.ts:132](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L132)*
144144

145145
Delete the given batch
146146

@@ -161,7 +161,7 @@ ___
161161

162162
**search**(page?: *`number`*, pageSize?: *`number`*, term?: *`string`*): `Promise`<`Batch`[]>
163163

164-
*Defined in [BatchGateway.ts:146](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L146)*
164+
*Defined in [BatchGateway.ts:146](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L146)*
165165

166166
Search for a batch matching the given term
167167

@@ -182,7 +182,7 @@ ___
182182

183183
**startProcessing**(batchId: *`string`*): `Promise`<`Batch`>
184184

185-
*Defined in [BatchGateway.ts:194](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L194)*
185+
*Defined in [BatchGateway.ts:194](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L194)*
186186

187187
Start processing this batch
188188

@@ -201,7 +201,7 @@ ___
201201

202202
**summary**(batchId: *`string`*): `Promise`<`BatchSummary`>
203203

204-
*Defined in [BatchGateway.ts:206](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L206)*
204+
*Defined in [BatchGateway.ts:206](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L206)*
205205

206206
Get a transaction totaled summary for this batch
207207

@@ -220,7 +220,7 @@ ___
220220

221221
**update**(batchId: *`string`*, body: *`BatchInput`*): `Promise`<`boolean`>
222222

223-
*Defined in [BatchGateway.ts:117](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L117)*
223+
*Defined in [BatchGateway.ts:117](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L117)*
224224

225225
Update the batch data, note you can only update the information of a batch not the payments via this API
226226

docs/classes/configuration.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030

3131
**● apiBase**: *`string`*
3232

33-
*Defined in [Configuration.ts:35](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/Configuration.ts#L35)*
33+
*Defined in [Configuration.ts:35](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/Configuration.ts#L35)*
3434

3535
___
3636
<a id="apikey"></a>
@@ -39,7 +39,7 @@ ___
3939

4040
**● apiKey**: *`string`*
4141

42-
*Defined in [Configuration.ts:33](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/Configuration.ts#L33)*
42+
*Defined in [Configuration.ts:33](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/Configuration.ts#L33)*
4343

4444
___
4545
<a id="apisecret"></a>
@@ -48,7 +48,7 @@ ___
4848

4949
**● apiSecret**: *`string`*
5050

51-
*Defined in [Configuration.ts:34](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/Configuration.ts#L34)*
51+
*Defined in [Configuration.ts:34](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/Configuration.ts#L34)*
5252

5353
___
5454

@@ -60,7 +60,7 @@ ___
6060

6161
**setApiKey**(key: *`string`*): `void`
6262

63-
*Defined in [Configuration.ts:55](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/Configuration.ts#L55)*
63+
*Defined in [Configuration.ts:55](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/Configuration.ts#L55)*
6464

6565
Globally set the public API key to connect to Trolley
6666

@@ -79,7 +79,7 @@ ___
7979

8080
**setApiSecret**(secret: *`string`*): `void`
8181

82-
*Defined in [Configuration.ts:63](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/Configuration.ts#L63)*
82+
*Defined in [Configuration.ts:63](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/Configuration.ts#L63)*
8383

8484
Globally set the secret API key to connect to Trolley
8585

@@ -98,7 +98,7 @@ ___
9898

9999
**setEnvironment**(environment: *"production" |"sandbox" |"integration"*): `void`
100100

101-
*Defined in [Configuration.ts:90](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/Configuration.ts#L90)*
101+
*Defined in [Configuration.ts:90](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/Configuration.ts#L90)*
102102

103103
Set the Trolley API environment that your using
104104

docs/classes/gateway.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828

2929
**● balances**: *[BalancesGateway](balancesgateway.md)*
3030

31-
*Defined in [Gateway.ts:15](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/Gateway.ts#L15)*
31+
*Defined in [Gateway.ts:15](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/Gateway.ts#L15)*
3232

3333
___
3434
<a id="batch"></a>
@@ -37,7 +37,7 @@ ___
3737

3838
**● batch**: *[BatchGateway](batchgateway.md)*
3939

40-
*Defined in [Gateway.ts:13](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/Gateway.ts#L13)*
40+
*Defined in [Gateway.ts:13](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/Gateway.ts#L13)*
4141

4242
___
4343
<a id="client"></a>
@@ -46,7 +46,7 @@ ___
4646

4747
**● client**: *`Client`*
4848

49-
*Defined in [Gateway.ts:11](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/Gateway.ts#L11)*
49+
*Defined in [Gateway.ts:11](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/Gateway.ts#L11)*
5050

5151
___
5252
<a id="config"></a>
@@ -55,7 +55,7 @@ ___
5555

5656
**● config**: *[Configuration](configuration.md)*
5757

58-
*Defined in [Gateway.ts:10](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/Gateway.ts#L10)*
58+
*Defined in [Gateway.ts:10](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/Gateway.ts#L10)*
5959

6060
___
6161
<a id="payment"></a>
@@ -64,7 +64,7 @@ ___
6464

6565
**● payment**: *[PaymentGateway](paymentgateway.md)*
6666

67-
*Defined in [Gateway.ts:16](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/Gateway.ts#L16)*
67+
*Defined in [Gateway.ts:16](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/Gateway.ts#L16)*
6868

6969
___
7070
<a id="recipient"></a>
@@ -73,7 +73,7 @@ ___
7373

7474
**● recipient**: *[RecipientGateway](recipientgateway.md)*
7575

76-
*Defined in [Gateway.ts:12](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/Gateway.ts#L12)*
76+
*Defined in [Gateway.ts:12](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/Gateway.ts#L12)*
7777

7878
___
7979
<a id="recipientaccount"></a>
@@ -82,7 +82,7 @@ ___
8282

8383
**● recipientAccount**: *[RecipientAccountGateway](recipientaccountgateway.md)*
8484

85-
*Defined in [Gateway.ts:14](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/Gateway.ts#L14)*
85+
*Defined in [Gateway.ts:14](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/Gateway.ts#L14)*
8686

8787
___
8888

docs/classes/paymentgateway.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626

2727
**create**(batchId: *`string`*, body: *`any`*): `Promise`<`Payment`>
2828

29-
*Defined in [PaymentGateway.ts:55](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/PaymentGateway.ts#L55)*
29+
*Defined in [PaymentGateway.ts:55](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/PaymentGateway.ts#L55)*
3030

3131
Create a new payment in a batch
3232

@@ -53,7 +53,7 @@ ___
5353

5454
**find**(paymentId: *`string`*): `Promise`<`Payment`>
5555

56-
*Defined in [PaymentGateway.ts:34](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/PaymentGateway.ts#L34)*
56+
*Defined in [PaymentGateway.ts:34](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/PaymentGateway.ts#L34)*
5757

5858
Find a specific payment
5959

@@ -74,7 +74,7 @@ ___
7474

7575
**remove**(paymentId: *`string`*, batchId: *`string`*): `Promise`<`boolean`>
7676

77-
*Defined in [PaymentGateway.ts:90](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/PaymentGateway.ts#L90)*
77+
*Defined in [PaymentGateway.ts:90](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/PaymentGateway.ts#L90)*
7878

7979
Delete a given payment -- Note you can only delete non processed payments
8080

@@ -96,7 +96,7 @@ ___
9696

9797
**search**(batchId: *`string`*, page?: *`number`*, pageSize?: *`number`*, term?: *`string`*): `Promise`<`Payment`[]>
9898

99-
*Defined in [PaymentGateway.ts:105](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/PaymentGateway.ts#L105)*
99+
*Defined in [PaymentGateway.ts:105](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/PaymentGateway.ts#L105)*
100100

101101
Search for payments in a given batch
102102

@@ -118,7 +118,7 @@ ___
118118

119119
**update**(paymentId: *`string`*, batchId: *`string`*, body: *`any`*): `Promise`<`boolean`>
120120

121-
*Defined in [PaymentGateway.ts:74](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/PaymentGateway.ts#L74)*
121+
*Defined in [PaymentGateway.ts:74](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/PaymentGateway.ts#L74)*
122122

123123
Update a given payment
124124

0 commit comments

Comments
 (0)