Merge pull request #17 from PaymentRails/analytics-and-rebranding

feat:Analytics and rebranding

README.md

@@ -1,8 +1,8 @@
-# Payment Rails[^1] JAVA SDK
+# Trolley Java SDK (Previously Payment Rails[^1])
 
-A native JAVA SDK for the Payment Rails API
+A native Java SDK for Trolley
 
-[^1]: [Payment Rails is now Trolley](https://www.trolley.com/payment-rails-is-now-trolley-series-a), we'll be updating our SDKs to support the new domain during the first half of 2022.
+[^1]: [Payment Rails is now Trolley](https://www.trolley.com/payment-rails-is-now-trolley-series-a). We're in the process of updating our SDKs to support the new domain. In this transition phase, you might still see "PaymentRails" at some places.
 
 ## Installation
 
@@ -22,11 +22,11 @@ Add this dependency to your project's POM:
 <dependency>
     <groupId>ca.paymentrails</groupId>
     <artifactId>paymentrails</artifactId>
-    <version>1.0.1</version>
+    <version>1.0.2</version>
 </dependency>
 ```
 
-The library is hosted at [insert github link]
+The library is hosted at [https://github.com/paymentRails/java-sdk](https://github.com/paymentRails/java-sdk)
 
 ## Getting Started
 
@@ -51,10 +51,10 @@ public class PaymentRailsExample {
 
 ### Usage
 
-Methods should all have Java Doc comments to help you understand their usage. As mentioned the [full API documentation](http://docs.paymentrails.com)
+Methods should all have Java Doc 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 [Java API docs](https://github.com/PaymentRails/paymentrails_dotnet/tree/master/docs/) is available. The best starting point is:
+For more information please read the [Java API docs](https://github.com/PaymentRails/java-sdk/tree/master/docs) is available. The best starting point is:
 
 | Data Type         | SDK Documentation                                                                                                              |
 | ----------------- | ------------------------------------------------------------------------------------------------------------------------------ |

docs/README.md

@@ -1,5 +1,5 @@
 
-# Payment Rails Java SDK
+# Trolley Java SDK
 
 ## Index
 

docs/classes/batchgateway.md

@@ -1,4 +1,4 @@
-[Payment Rails Java SDK](../README.md) > [BatchGateway](../classes/BatchGateway.md)
+[Trolley Java SDK](../README.md) > [BatchGateway](../classes/BatchGateway.md)
 
 # Class: BatchGateway
 
@@ -31,7 +31,7 @@ Gateway class for batches
 
 *Defined in [BatchGateway.java:95](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/ca/paymentrails/paymentrails/BatchGateway.java#L95)*
 
-Creates a batch with optional payments. This is the interface that is provide by the [Create Batch](http://docs.paymentrails.com/api/#create-a-batch) API
+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
 
     Batch batch = client.batch.create("{\"sourceCurrency\": \"USD\", \"description\":\"Docs Create\"}");
 
@@ -61,7 +61,7 @@ Retrieves a batch based on the batch id
 
 | Param | Type | Description |
 | ------ | ------ | ------ |
-| batchId | `string`   |  Payment Rails batch id (e.g. "B-xx999bb") |
+| batchId | `string`   |  Trolley batch id (e.g. "B-xx999bb") |
 
 **Returns:** `Batch`
 
@@ -81,7 +81,7 @@ Generate a FX quote for this batch
 
 | Param | Type | Description |
 | ------ | ------ | ------ |
-| batchId | `string`   |  Payment Rails payment id (e.g. "B-xx999bb") |
+| batchId | `string`   |  Trolley payment id (e.g. "B-xx999bb") |
 
 **Returns:** `Batch`
 
@@ -101,7 +101,7 @@ Return a paginated list of payments for this batch
 
 | Param | Type | Default value | Description |
 | ------ | ------ | ------ | ------ |
-| batchId | `string`  | - |   Payment Rails payment id (e.g. "B-xx999bb") |
+| batchId | `string`  | - |   Trolley payment id (e.g. "B-xx999bb") |
 | page | `number`  | 1 |   starting a 1 |
 | pageSize | `number`  | 10 |   in the range 0...1000 |
 
@@ -125,7 +125,7 @@ Delete the given batch
 
 | Param | Type | Description |
 | ------ | ------ | ------ |
-| batchId | `string`   |  Payment Rails batch (e.g. "B-xx999bb") |
+| batchId | `string`   |  Trolley batch (e.g. "B-xx999bb") |
 
 **Returns:** `Boolean`
 
@@ -167,7 +167,7 @@ Start processing this batch
 
 | Param | Type | Description |
 | ------ | ------ | ------ |
-| batchId | `string`   |  Payment Rails batch id (e.g. "B-xx999bb") |
+| batchId | `string`   |  Trolley batch id (e.g. "B-xx999bb") |
 
 **Returns:** `Batch`
 
@@ -189,7 +189,7 @@ Get a transaction totaled summary for this batch
 
 | Param | Type | Description |
 | ------ | ------ | ------ |
-| batchId | `string`   |  Payment Rails payment id (e.g. "B-xx999bb") |
+| batchId | `string`   |  Trolley payment id (e.g. "B-xx999bb") |
 
 **Returns:** `String`
 

docs/classes/configuration.md

@@ -1,4 +1,4 @@
-[Payment Rails Java SDK](../README.md) > [Configuration](../classes/Configuration.md)
+[Trolley Java SDK](../README.md) > [Configuration](../classes/Configuration.md)
 
 # Class: Configuration
 
@@ -14,11 +14,11 @@
 
 ## Properties
 
-<a id="enviroment"></a>
+<a id="environment"></a>
 
-### enviroment
+### environment
 
-**●  enviroment**:  *`string`*
+**●  environment**:  *`string`*
 
 *Defined in [Configuration.java:35](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/ca/paymentrails/paymentrails/Configuration.java#L35)*
 
@@ -52,7 +52,7 @@
 
 *Defined in [Configuration.java:90](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/ca/paymentrails/paymentrails/Configuration.java#L90)*
 
-Set the Payment Rails API environment that your using
+Set the Trolley API environment that you're using
 
 **Parameters:**
 
@@ -62,4 +62,4 @@ Set the Payment Rails API environment that your using
 
 **Returns:** `void`
 
----
+---

docs/classes/exceptions.authentication.md

@@ -1,4 +1,4 @@
-[Payment Rails Python SDK](../README.md) > [Exceptions](../packages/exceptions.md) > [Authentication](../classes/exceptions.authentication.md)
+[Trolley Java SDK](../README.md) > [Exceptions](../packages/exceptions.md) > [Authentication](../classes/exceptions.authentication.md)
 
 # Class: Authentication
 

docs/classes/exceptions.authorization.md

@@ -1,4 +1,4 @@
-[Payment Rails Python SDK](../README.md) > [Exceptions](../packages/exceptions.md) > [Authorization](../classes/exceptions.authorization.md)
+[Trolley Java SDK](../README.md) > [Exceptions](../packages/exceptions.md) > [Authorization](../classes/exceptions.authorization.md)
 
 # Class: Authorization
 

docs/classes/exceptions.baseexception.md

@@ -1,4 +1,4 @@
-[Payment Rails Python SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [BaseException](../classes/exceptions.baseexception.md)
+[Trolley Java SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [BaseException](../classes/exceptions.baseexception.md)
 
 # Class: BaseException
 

docs/classes/exceptions.downformaintenance.md

@@ -1,4 +1,4 @@
-[Payment Rails Python SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [DownForMaintenance](../classes/exceptions.downformaintenance.md)
+[Trolley Java SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [DownForMaintenance](../classes/exceptions.downformaintenance.md)
 
 # Class: DownForMaintenance
 

docs/classes/exceptions.malformed.md

@@ -1,4 +1,4 @@
-[Payment Rails Python SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [Malformed](../classes/exceptions.malformed.md)
+[Trolley Java SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [Malformed](../classes/exceptions.malformed.md)
 
 # Class: Malformed
 

docs/classes/exceptions.notfound.md

@@ -1,4 +1,4 @@
-[Payment Rails Python SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [NotFound](../classes/exceptions.notfound.md)
+[Trolley Java SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [NotFound](../classes/exceptions.notfound.md)
 
 # Class: NotFound
 

docs/classes/exceptions.servererror.md

@@ -1,4 +1,4 @@
-[Payment Rails Python SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [ServerError](../classes/exceptions.servererror.md)
+[Trolley Java SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [ServerError](../classes/exceptions.servererror.md)
 
 # Class: ServerError
 

docs/classes/exceptions.unexpected.md

@@ -1,4 +1,4 @@
-[Payment Rails Python SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [Unexpected](../classes/exceptions.unexpected.md)
+[Trolley Java SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [Unexpected](../classes/exceptions.unexpected.md)
 
 # Class: Unexpected
 

docs/classes/gateway.md

@@ -1,4 +1,4 @@
-[Payment Rails Java SDK](../README.md) > [Gateway](../classes/gateway.md)
+[Trolley Java SDK](../README.md) > [Gateway](../classes/gateway.md)
 
 # Class: Gateway
 

docs/classes/paymentgateway.md

@@ -1,4 +1,4 @@
-[Payment Rails Java SDK](../README.md) > [PaymentGateway](../classes/paymentgateway.md)
+[Trolley Java SDK](../README.md) > [PaymentGateway](../classes/paymentgateway.md)
 
 # Class: PaymentGateway
 
@@ -32,7 +32,7 @@ Create a new payment in a batch
 
 | Param | Type | Description |
 | ------ | ------ | ------ |
-| batchId | `string`   |  Payment Rails payment id (e.g. "B-xx999bb") |
+| batchId | `string`   |  Trolley payment id (e.g. "B-xx999bb") |
 | body | `any`   |  Payment information |
 
 **Returns:** `Payment`
@@ -55,7 +55,7 @@ Find a specific payment
 
 | Param | Type | Description |
 | ------ | ------ | ------ |
-| paymentId | `string`   |  Payment Rails payment id (e.g. "P-aabccc") |
+| paymentId | `string`   |  Trolley payment id (e.g. "P-aabccc") |
 
 **Returns:** `Payment`
 
@@ -77,8 +77,8 @@ Delete a given payment -- Note you can only delete non processed payments
 
 | Param | Type | Description |
 | ------ | ------ | ------ |
-| paymentId | `string`   |  Payment Rails payment id (e.g. "P-aabccc") |
-| batchId | `string`   |  Payment Rails payment id (e.g. "B-xx999bb") |
+| paymentId | `string`   |  Trolley payment id (e.g. "P-aabccc") |
+| batchId | `string`   |  Trolley payment id (e.g. "B-xx999bb") |
 
 **Returns:** `boolean`
 
@@ -98,7 +98,7 @@ Search for payments in a given batch
 
 | Param | Type | Default value | Description |
 | ------ | ------ | ------ | ------ |
-| batchId | `string`  | - |   Payment Rails payment id (e.g. "B-xx999bb") |
+| batchId | `string`  | - |   Trolley payment id (e.g. "B-xx999bb") |
 | page | `number`  | 1 |   Page number (1 based) |
 | pageSize | `number`  | 10 |   Page size (0...1000) |
 | term | `string`  | "" |   Any search terms to look for |
@@ -123,8 +123,8 @@ Update a given payment
 
 | Param | Type | Description |
 | ------ | ------ | ------ |
-| paymentId | `string`   |  Payment Rails payment id (e.g. "P-aabccc") |
-| batchId | `string`   |  Payment Rails payment id (e.g. "B-xx999bb") |
+| paymentId | `string`   |  Trolley payment id (e.g. "P-aabccc") |
+| batchId | `string`   |  Trolley payment id (e.g. "B-xx999bb") |
 | body | `any`   |  Payment update information |
 
 **Returns:** `boolean`

docs/classes/recipientaccountgateway.md

@@ -1,4 +1,4 @@
-[Payment Rails Java SDK](../README.md) > [RecipientAccountGateway](../classes/recipientaccountgateway.md)
+[Trolley Java SDK](../README.md) > [RecipientAccountGateway](../classes/recipientaccountgateway.md)
 
 # Class: RecipientAccountGateway
 
@@ -24,7 +24,7 @@
 
 *Defined in [RecipientAccountGateway.java:33](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/ca/paymentrails/paymentrails/RecipientAccountGateway.java#L33)*
 
-Fetch all of the accounts for a given Payment Rails recipient
+Fetch all of the accounts for a given Trolley recipient
 
     $response = PaymentRails\RecipientAccount::all($recipient_id);
     List<RecipientAccount> recipientAccounts = client.recipientAccount.findAll("R-123r4cs");
@@ -33,7 +33,7 @@ Fetch all of the accounts for a given Payment Rails recipient
 
 | Param | Type | Description |
 | ------ | ------ | ------ |
-| recipientId | `string`   |  The Payment Rails recipient ID (e.g. R-xyzzy) |
+| recipientId | `string`   |  The Trolley recipient ID (e.g. R-xyzzy) |
 
 **Returns:** `List<RecipientAccount>(recipientaccount.md)[]>
 
@@ -54,7 +54,7 @@ Create a new recipient account
 
 | Param | Type | Description |
 | ------ | ------ | ------ |
-| recipientId | `string`   |  The Payment Rails recipient ID (e.g. R-xyzzy) |
+| recipientId | `string`   |  The Trolley recipient ID (e.g. R-xyzzy) |
 | body | `string`   |  Account information |
 
 **Returns:** `RecipientAccount`(recipientaccount.md)>
@@ -69,16 +69,16 @@ Create a new recipient account
 
 *Defined in [RecipientAccountGateway.java:52](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/ca/paymentrails/paymentrails/RecipientAccountGateway.java#L52)*
 
-Fetch a specific account for a given Payment Rails recipient
+Fetch a specific account for a given Trolley recipient
 
 RecipientAccount recipientAccount = client.recipientAccount.find("R-ad322121", "A-2134fd");
 
 **Parameters:**
 
 | Param | Type | Description |
 | ------ | ------ | ------ |
-| recipientId | `string`   |  The Payment Rails recipient ID (e.g. R-xyzzy) |
-| accountId | `string`   |  The Payment Rails account ID (e.g. A-xyzzy) |
+| recipientId | `string`   |  The Trolley recipient ID (e.g. R-xyzzy) |
+| accountId | `string`   |  The Trolley account ID (e.g. A-xyzzy) |
 
 **Returns:** `RecipientAccount`(recipientaccount.md)>
 
@@ -100,8 +100,8 @@ Delete the given recipient account. This will only return success, otherwise it
 
 | Param | Type | Description |
 | ------ | ------ | ------ |
-| recipientId | `string`   |  The Payment Rails recipient ID (e.g. R-xyzzy) |
-| accountId | `string`   |  The Payment Rails account ID (e.g. A-xyzzy) |
+| recipientId | `string`   |  The Trolley recipient ID (e.g. R-xyzzy) |
+| accountId | `string`   |  The Trolley account ID (e.g. A-xyzzy) |
 
 **Returns:** `boolean`
 
@@ -123,8 +123,8 @@ Update a recipient account. Note: Updating an account will create a new account
 
 | Param | Type | Description |
 | ------ | ------ | ------ |
-| recipientId | `string`   |  The Payment Rails recipient ID (e.g. R-xyzzy) |
-| accountId | `string`   |  The Payment Rails account ID (e.g. A-xyzzy) |
+| recipientId | `string`   |  The Trolley recipient ID (e.g. R-xyzzy) |
+| accountId | `string`   |  The Trolley account ID (e.g. A-xyzzy) |
 | body | `any`   |  Account information |
 
 **Returns:** `RecipientAccount`(recipientaccount.md)>

docs/classes/recipientgateway.md

@@ -1,4 +1,4 @@
-[Payment Rails Java SDK](../README.md) > [RecipientGateway](../classes/RecipientGateway.md)
+[Trolley Java SDK](../README.md) > [RecipientGateway](../classes/RecipientGateway.md)
 
 # Class: RecipientGateway
 
@@ -48,15 +48,15 @@ Create a given recipient
 
 *Defined in [RecipientGateway.java:58](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/ca/paymentrails/paymentrails/RecipientGateway.java#L58)*
 
-Find a specific recipient by their Payment Rails recipient ID
+Find a specific recipient by their Trolley recipient ID
 
 Recipient recipient = client.recipient.find(R-efr313md8cj);
 
 **Parameters:**
 
 | Param | Type | Description |
 | ------ | ------ | ------ |
-| recipientId | `string`   |  The Payment Rails recipient ID (e.g. R-xyzzy) |
+| recipientId | `string`   |  The Trolley recipient ID (e.g. R-xyzzy) |
 
 **Returns:** `Recipient`
 
@@ -78,7 +78,7 @@ Delete the given recipient.
 
 | Param | Type | Description |
 | ------ | ------ | ------ |
-| recipientId | `string`   |  The Payment Rails recipient ID (e.g. R-xyzzy) |
+| recipientId | `string`   |  The Trolley recipient ID (e.g. R-xyzzy) |
 
 **Returns:** `boolean`
 

docs/packages/exceptions.md

@@ -1,4 +1,4 @@
-[Payment Rails Java SDK](../README.md) > [Exceptions](../packages/exceptions.md)
+[Trolley Java SDK](../README.md) > [Exceptions](../packages/exceptions.md)
 
 # Package: Exceptions
 

docs/types/batch.md

@@ -1,4 +1,4 @@
-[Payment Rails Java SDK](../README.md) > [BatchInput](../types/batch.md)
+[Trolley Java SDK](../README.md) > [BatchInput](../types/batch.md)
 
 # Types: Batch