Merge pull request #63 from trolley/repo-update

Renamed repository link from PaymentRails to Trolley, added more info…

Author: Aman Aalam

README.md

@@ -18,8 +18,8 @@ calls.
 const trolley = require('trolleyhq');
 
 const client = trolley.connect({
-  key: "YOUR-API-KEY",
-  secret: "YOUR-API-SECRET",
+  key: "YOUR-ACCESS-KEY",
+  secret: "YOUR-SECRET-SECRET",
 });
 
 // Async/Await version
@@ -46,14 +46,14 @@ client.recipient.find("R-G7SXXpm6cs4aTUd9YhmgWC").then(recipient => {
 Methods should all have JSDoc comments to help you understand their usage. As mentioned the [full API documentation](https://docs.trolley.com)
 is the best source of information about the API.
 
-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:
+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:
 
 | Data Type | SDK Documentation |
 | ----- | ----- |
-| Batch | [API Docs for Batch](https://github.com/PaymentRails/javascript-sdk/blob/master/docs/classes/batchgateway.md) |
-| Payment | [API Docs for Payment](https://github.com/PaymentRails/javascript-sdk/blob/master/docs/classes/paymentgateway.md) |
-| Recipient | [API Docs for Recipient](https://github.com/PaymentRails/javascript-sdk/blob/master/docs/classes/recipientgateway.md) |
-| Recipient Account | [API Docs for Recipient Account](https://github.com/PaymentRails/javascript-sdk/blob/master/docs/classes/recipientaccountgateway.md) |
+| Batch | [API Docs for Batch](https://github.com/Trolley/javascript-sdk/blob/master/docs/classes/batchgateway.md) |
+| Payment | [API Docs for Payment](https://github.com/Trolley/javascript-sdk/blob/master/docs/classes/paymentgateway.md) |
+| Recipient | [API Docs for Recipient](https://github.com/Trolley/javascript-sdk/blob/master/docs/classes/recipientgateway.md) |
+| Recipient Account | [API Docs for Recipient Account](https://github.com/Trolley/javascript-sdk/blob/master/docs/classes/recipientaccountgateway.md) |
 
 ### Running Integration / Unit tests
 

docs/README.md

@@ -39,7 +39,7 @@
 
 ▸ **connect**(config: *[ConfigurationParams](interfaces/configurationparams.md)*): [Gateway](classes/gateway.md)
 
-*Defined in [index.ts:21](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/index.ts#L21)*
+*Defined in [index.ts:21](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/index.ts#L21)*
 
 Create a client for the Trolley (Payment Rails) JavasScript API
 

docs/classes/balancesgateway.md

@@ -32,7 +32,7 @@
 
 ⊕ **new BalancesGateway**(gateway: *[Gateway](gateway.md)*): [BalancesGateway](balancesgateway.md)
 
-*Defined in [BalancesGateway.ts:15](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BalancesGateway.ts#L15)*
+*Defined in [BalancesGateway.ts:15](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/BalancesGateway.ts#L15)*
 
 **Parameters:**
 
@@ -52,7 +52,7 @@ ___
 
 **● config**: *[Configuration](configuration.md)*
 
-*Defined in [BalancesGateway.ts:15](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BalancesGateway.ts#L15)*
+*Defined in [BalancesGateway.ts:15](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/BalancesGateway.ts#L15)*
 
 ___
 <a id="gateway"></a>
@@ -61,7 +61,7 @@ ___
 
 **● gateway**: *[Gateway](gateway.md)*
 
-*Defined in [BalancesGateway.ts:11](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BalancesGateway.ts#L11)*
+*Defined in [BalancesGateway.ts:11](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/BalancesGateway.ts#L11)*
 
 ___
 
@@ -73,7 +73,7 @@ ___
 
 ▸ **all**(): `Promise`<`Balance`[]>
 
-*Defined in [BalancesGateway.ts:32](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BalancesGateway.ts#L32)*
+*Defined in [BalancesGateway.ts:32](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/BalancesGateway.ts#L32)*
 
 Fetch the account balance for all enabled bank accounts
 
@@ -88,7 +88,7 @@ ___
 
 ▸ **find**(kind: *"paypal" |"paymentrails"*): `Promise`<`Balance`[]>
 
-*Defined in [BalancesGateway.ts:49](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BalancesGateway.ts#L49)*
+*Defined in [BalancesGateway.ts:49](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/BalancesGateway.ts#L49)*
 
 Fetch the account balance for the given account type
 

docs/classes/batchgateway.md

@@ -34,7 +34,7 @@ Gateway class for batcheso
 
 ▸ **all**(): `Promise`<`Batch`[]>
 
-*Defined in [BatchGateway.ts:52](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L52)*
+*Defined in [BatchGateway.ts:52](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L52)*
 
 Fetch batch all batches with an Iterator
 
@@ -47,7 +47,7 @@ ___
 
 ▸ **create**(batch: *`BatchInput`*, payments?: *`PaymentInput`[]*): `Promise`<`Batch`>
 
-*Defined in [BatchGateway.ts:95](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L95)*
+*Defined in [BatchGateway.ts:95](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L95)*
 
 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
 
@@ -79,7 +79,7 @@ ___
 
 ▸ **find**(batchId: *`string`*): `Promise`<`Batch`>
 
-*Defined in [BatchGateway.ts:67](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L67)*
+*Defined in [BatchGateway.ts:67](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L67)*
 
 Retrieves a batch based on the batch id
 
@@ -100,7 +100,7 @@ ___
 
 ▸ **generateQuote**(batchId: *`string`*): `Promise`<`Batch`>
 
-*Defined in [BatchGateway.ts:182](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L182)*
+*Defined in [BatchGateway.ts:182](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L182)*
 
 Generate a FX quote for this batch
 
@@ -119,7 +119,7 @@ ___
 
 ▸ **paymentList**(batchId: *`string`*, page?: *`number`*, pageSize?: *`number`*): `Promise`<`Payment`[]>
 
-*Defined in [BatchGateway.ts:166](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L166)*
+*Defined in [BatchGateway.ts:166](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L166)*
 
 Return a paginated list of payments for this batch
 
@@ -140,7 +140,7 @@ ___
 
 ▸ **remove**(batchId: *`string`*): `Promise`<`boolean`>
 
-*Defined in [BatchGateway.ts:132](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L132)*
+*Defined in [BatchGateway.ts:132](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L132)*
 
 Delete the given batch
 
@@ -161,7 +161,7 @@ ___
 
 ▸ **search**(page?: *`number`*, pageSize?: *`number`*, term?: *`string`*): `Promise`<`Batch`[]>
 
-*Defined in [BatchGateway.ts:146](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L146)*
+*Defined in [BatchGateway.ts:146](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L146)*
 
 Search for a batch matching the given term
 
@@ -182,7 +182,7 @@ ___
 
 ▸ **startProcessing**(batchId: *`string`*): `Promise`<`Batch`>
 
-*Defined in [BatchGateway.ts:194](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L194)*
+*Defined in [BatchGateway.ts:194](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L194)*
 
 Start processing this batch
 
@@ -201,7 +201,7 @@ ___
 
 ▸ **summary**(batchId: *`string`*): `Promise`<`BatchSummary`>
 
-*Defined in [BatchGateway.ts:206](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L206)*
+*Defined in [BatchGateway.ts:206](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L206)*
 
 Get a transaction totaled summary for this batch
 
@@ -220,7 +220,7 @@ ___
 
 ▸ **update**(batchId: *`string`*, body: *`BatchInput`*): `Promise`<`boolean`>
 
-*Defined in [BatchGateway.ts:117](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L117)*
+*Defined in [BatchGateway.ts:117](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/BatchGateway.ts#L117)*
 
 Update the batch data, note you can only update the information of a batch not the payments via this API
 

docs/classes/configuration.md

@@ -30,7 +30,7 @@
 
 **● apiBase**: *`string`*
 
-*Defined in [Configuration.ts:35](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/Configuration.ts#L35)*
+*Defined in [Configuration.ts:35](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/Configuration.ts#L35)*
 
 ___
 <a id="apikey"></a>
@@ -39,7 +39,7 @@ ___
 
 **● apiKey**: *`string`*
 
-*Defined in [Configuration.ts:33](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/Configuration.ts#L33)*
+*Defined in [Configuration.ts:33](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/Configuration.ts#L33)*
 
 ___
 <a id="apisecret"></a>
@@ -48,7 +48,7 @@ ___
 
 **● apiSecret**: *`string`*
 
-*Defined in [Configuration.ts:34](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/Configuration.ts#L34)*
+*Defined in [Configuration.ts:34](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/Configuration.ts#L34)*
 
 ___
 
@@ -60,7 +60,7 @@ ___
 
 ▸ **setApiKey**(key: *`string`*): `void`
 
-*Defined in [Configuration.ts:55](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/Configuration.ts#L55)*
+*Defined in [Configuration.ts:55](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/Configuration.ts#L55)*
 
 Globally set the public API key to connect to Trolley
 
@@ -79,7 +79,7 @@ ___
 
 ▸ **setApiSecret**(secret: *`string`*): `void`
 
-*Defined in [Configuration.ts:63](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/Configuration.ts#L63)*
+*Defined in [Configuration.ts:63](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/Configuration.ts#L63)*
 
 Globally set the secret API key to connect to Trolley
 
@@ -98,7 +98,7 @@ ___
 
 ▸ **setEnvironment**(environment: *"production" |"sandbox" |"integration"*): `void`
 
-*Defined in [Configuration.ts:90](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/Configuration.ts#L90)*
+*Defined in [Configuration.ts:90](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/Configuration.ts#L90)*
 
 Set the Trolley API environment that your using
 

docs/classes/gateway.md

@@ -28,7 +28,7 @@
 
 **● balances**: *[BalancesGateway](balancesgateway.md)*
 
-*Defined in [Gateway.ts:15](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/Gateway.ts#L15)*
+*Defined in [Gateway.ts:15](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/Gateway.ts#L15)*
 
 ___
 <a id="batch"></a>
@@ -37,7 +37,7 @@ ___
 
 **● batch**: *[BatchGateway](batchgateway.md)*
 
-*Defined in [Gateway.ts:13](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/Gateway.ts#L13)*
+*Defined in [Gateway.ts:13](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/Gateway.ts#L13)*
 
 ___
 <a id="client"></a>
@@ -46,7 +46,7 @@ ___
 
 **● client**: *`Client`*
 
-*Defined in [Gateway.ts:11](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/Gateway.ts#L11)*
+*Defined in [Gateway.ts:11](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/Gateway.ts#L11)*
 
 ___
 <a id="config"></a>
@@ -55,7 +55,7 @@ ___
 
 **● config**: *[Configuration](configuration.md)*
 
-*Defined in [Gateway.ts:10](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/Gateway.ts#L10)*
+*Defined in [Gateway.ts:10](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/Gateway.ts#L10)*
 
 ___
 <a id="payment"></a>
@@ -64,7 +64,7 @@ ___
 
 **● payment**: *[PaymentGateway](paymentgateway.md)*
 
-*Defined in [Gateway.ts:16](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/Gateway.ts#L16)*
+*Defined in [Gateway.ts:16](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/Gateway.ts#L16)*
 
 ___
 <a id="recipient"></a>
@@ -73,7 +73,7 @@ ___
 
 **● recipient**: *[RecipientGateway](recipientgateway.md)*
 
-*Defined in [Gateway.ts:12](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/Gateway.ts#L12)*
+*Defined in [Gateway.ts:12](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/Gateway.ts#L12)*
 
 ___
 <a id="recipientaccount"></a>
@@ -82,7 +82,7 @@ ___
 
 **● recipientAccount**: *[RecipientAccountGateway](recipientaccountgateway.md)*
 
-*Defined in [Gateway.ts:14](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/Gateway.ts#L14)*
+*Defined in [Gateway.ts:14](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/Gateway.ts#L14)*
 
 ___
 

docs/classes/paymentgateway.md

@@ -26,7 +26,7 @@
 
 ▸ **create**(batchId: *`string`*, body: *`any`*): `Promise`<`Payment`>
 
-*Defined in [PaymentGateway.ts:55](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/PaymentGateway.ts#L55)*
+*Defined in [PaymentGateway.ts:55](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/PaymentGateway.ts#L55)*
 
 Create a new payment in a batch
 
@@ -53,7 +53,7 @@ ___
 
 ▸ **find**(paymentId: *`string`*): `Promise`<`Payment`>
 
-*Defined in [PaymentGateway.ts:34](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/PaymentGateway.ts#L34)*
+*Defined in [PaymentGateway.ts:34](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/PaymentGateway.ts#L34)*
 
 Find a specific payment
 
@@ -74,7 +74,7 @@ ___
 
 ▸ **remove**(paymentId: *`string`*, batchId: *`string`*): `Promise`<`boolean`>
 
-*Defined in [PaymentGateway.ts:90](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/PaymentGateway.ts#L90)*
+*Defined in [PaymentGateway.ts:90](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/PaymentGateway.ts#L90)*
 
 Delete a given payment -- Note you can only delete non processed payments
 
@@ -96,7 +96,7 @@ ___
 
 ▸ **search**(batchId: *`string`*, page?: *`number`*, pageSize?: *`number`*, term?: *`string`*): `Promise`<`Payment`[]>
 
-*Defined in [PaymentGateway.ts:105](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/PaymentGateway.ts#L105)*
+*Defined in [PaymentGateway.ts:105](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/PaymentGateway.ts#L105)*
 
 Search for payments in a given batch
 
@@ -118,7 +118,7 @@ ___
 
 ▸ **update**(paymentId: *`string`*, batchId: *`string`*, body: *`any`*): `Promise`<`boolean`>
 
-*Defined in [PaymentGateway.ts:74](https://github.com/PaymentRails/javascript-sdk/blob/c3121c6/lib/PaymentGateway.ts#L74)*
+*Defined in [PaymentGateway.ts:74](https://github.com/Trolley/javascript-sdk/blob/c3121c6/lib/PaymentGateway.ts#L74)*
 
 Update a given payment