Skip to content

Commit a4b3671

Browse files
author
Aman Aalam
authored
Merge pull request #17 from PaymentRails/analytics-and-rebranding
feat:Analytics and rebranding
2 parents 6b799a2 + 75c30e3 commit a4b3671

28 files changed

+132
-85
lines changed

‎README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Payment Rails[^1] JAVA SDK
1+
# Trolley Java SDK (Previously Payment Rails[^1])
22

3-
A native JAVA SDK for the Payment Rails API
3+
A native Java SDK for Trolley
44

5-
[^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.
5+
[^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.
66

77
## Installation
88

@@ -22,11 +22,11 @@ Add this dependency to your project's POM:
2222
<dependency>
2323
<groupId>ca.paymentrails</groupId>
2424
<artifactId>paymentrails</artifactId>
25-
<version>1.0.1</version>
25+
<version>1.0.2</version>
2626
</dependency>
2727
```
2828

29-
The library is hosted at [insert github link]
29+
The library is hosted at [https://github.com/paymentRails/java-sdk](https://github.com/paymentRails/java-sdk)
3030

3131
## Getting Started
3232

@@ -51,10 +51,10 @@ public class PaymentRailsExample {
5151

5252
### Usage
5353

54-
Methods should all have Java Doc comments to help you understand their usage. As mentioned the [full API documentation](http://docs.paymentrails.com)
54+
Methods should all have Java Doc comments to help you understand their usage. As mentioned the [full API documentation](https://docs.trolley.com)
5555
is the best source of information about the API.
5656

57-
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:
57+
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:
5858

5959
| Data Type | SDK Documentation |
6060
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------ |

‎docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
# Payment Rails Java SDK
2+
# Trolley Java SDK
33

44
## Index
55

‎docs/classes/batchgateway.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[Payment Rails Java SDK](../README.md) > [BatchGateway](../classes/BatchGateway.md)
1+
[Trolley Java SDK](../README.md) > [BatchGateway](../classes/BatchGateway.md)
22

33
# Class: BatchGateway
44

@@ -31,7 +31,7 @@ Gateway class for batches
3131

3232
*Defined in [BatchGateway.java:95](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/ca/paymentrails/paymentrails/BatchGateway.java#L95)*
3333

34-
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
34+
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
3535

3636
Batch batch = client.batch.create("{\"sourceCurrency\": \"USD\", \"description\":\"Docs Create\"}");
3737

@@ -61,7 +61,7 @@ Retrieves a batch based on the batch id
6161

6262
| Param | Type | Description |
6363
| ------ | ------ | ------ |
64-
| batchId | `string` | Payment Rails batch id (e.g. "B-xx999bb") |
64+
| batchId | `string` | Trolley batch id (e.g. "B-xx999bb") |
6565

6666
**Returns:** `Batch`
6767

@@ -81,7 +81,7 @@ Generate a FX quote for this batch
8181

8282
| Param | Type | Description |
8383
| ------ | ------ | ------ |
84-
| batchId | `string` | Payment Rails payment id (e.g. "B-xx999bb") |
84+
| batchId | `string` | Trolley payment id (e.g. "B-xx999bb") |
8585

8686
**Returns:** `Batch`
8787

@@ -101,7 +101,7 @@ Return a paginated list of payments for this batch
101101

102102
| Param | Type | Default value | Description |
103103
| ------ | ------ | ------ | ------ |
104-
| batchId | `string` | - | Payment Rails payment id (e.g. "B-xx999bb") |
104+
| batchId | `string` | - | Trolley payment id (e.g. "B-xx999bb") |
105105
| page | `number` | 1 | starting a 1 |
106106
| pageSize | `number` | 10 | in the range 0...1000 |
107107

@@ -125,7 +125,7 @@ Delete the given batch
125125

126126
| Param | Type | Description |
127127
| ------ | ------ | ------ |
128-
| batchId | `string` | Payment Rails batch (e.g. "B-xx999bb") |
128+
| batchId | `string` | Trolley batch (e.g. "B-xx999bb") |
129129

130130
**Returns:** `Boolean`
131131

@@ -167,7 +167,7 @@ Start processing this batch
167167

168168
| Param | Type | Description |
169169
| ------ | ------ | ------ |
170-
| batchId | `string` | Payment Rails batch id (e.g. "B-xx999bb") |
170+
| batchId | `string` | Trolley batch id (e.g. "B-xx999bb") |
171171

172172
**Returns:** `Batch`
173173

@@ -189,7 +189,7 @@ Get a transaction totaled summary for this batch
189189

190190
| Param | Type | Description |
191191
| ------ | ------ | ------ |
192-
| batchId | `string` | Payment Rails payment id (e.g. "B-xx999bb") |
192+
| batchId | `string` | Trolley payment id (e.g. "B-xx999bb") |
193193

194194
**Returns:** `String`
195195

‎docs/classes/configuration.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[Payment Rails Java SDK](../README.md) > [Configuration](../classes/Configuration.md)
1+
[Trolley Java SDK](../README.md) > [Configuration](../classes/Configuration.md)
22

33
# Class: Configuration
44

@@ -14,11 +14,11 @@
1414

1515
## Properties
1616

17-
<a id="enviroment"></a>
17+
<a id="environment"></a>
1818

19-
### enviroment
19+
### environment
2020

21-
**● enviroment**: *`string`*
21+
**● environment**: *`string`*
2222

2323
*Defined in [Configuration.java:35](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/ca/paymentrails/paymentrails/Configuration.java#L35)*
2424

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

5353
*Defined in [Configuration.java:90](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/ca/paymentrails/paymentrails/Configuration.java#L90)*
5454

55-
Set the Payment Rails API environment that your using
55+
Set the Trolley API environment that you're using
5656

5757
**Parameters:**
5858

@@ -62,4 +62,4 @@ Set the Payment Rails API environment that your using
6262

6363
**Returns:** `void`
6464

65-
---
65+
---

‎docs/classes/exceptions.authentication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[Payment Rails Python SDK](../README.md) > [Exceptions](../packages/exceptions.md) > [Authentication](../classes/exceptions.authentication.md)
1+
[Trolley Java SDK](../README.md) > [Exceptions](../packages/exceptions.md) > [Authentication](../classes/exceptions.authentication.md)
22

33
# Class: Authentication
44

‎docs/classes/exceptions.authorization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[Payment Rails Python SDK](../README.md) > [Exceptions](../packages/exceptions.md) > [Authorization](../classes/exceptions.authorization.md)
1+
[Trolley Java SDK](../README.md) > [Exceptions](../packages/exceptions.md) > [Authorization](../classes/exceptions.authorization.md)
22

33
# Class: Authorization
44

‎docs/classes/exceptions.baseexception.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[Payment Rails Python SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [BaseException](../classes/exceptions.baseexception.md)
1+
[Trolley Java SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [BaseException](../classes/exceptions.baseexception.md)
22

33
# Class: BaseException
44

‎docs/classes/exceptions.downformaintenance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[Payment Rails Python SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [DownForMaintenance](../classes/exceptions.downformaintenance.md)
1+
[Trolley Java SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [DownForMaintenance](../classes/exceptions.downformaintenance.md)
22

33
# Class: DownForMaintenance
44

‎docs/classes/exceptions.malformed.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[Payment Rails Python SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [Malformed](../classes/exceptions.malformed.md)
1+
[Trolley Java SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [Malformed](../classes/exceptions.malformed.md)
22

33
# Class: Malformed
44

‎docs/classes/exceptions.notfound.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[Payment Rails Python SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [NotFound](../classes/exceptions.notfound.md)
1+
[Trolley Java SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [NotFound](../classes/exceptions.notfound.md)
22

33
# Class: NotFound
44

‎docs/classes/exceptions.servererror.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[Payment Rails Python SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [ServerError](../classes/exceptions.servererror.md)
1+
[Trolley Java SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [ServerError](../classes/exceptions.servererror.md)
22

33
# Class: ServerError
44

‎docs/classes/exceptions.unexpected.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[Payment Rails Python SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [Unexpected](../classes/exceptions.unexpected.md)
1+
[Trolley Java SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [Unexpected](../classes/exceptions.unexpected.md)
22

33
# Class: Unexpected
44

‎docs/classes/gateway.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[Payment Rails Java SDK](../README.md) > [Gateway](../classes/gateway.md)
1+
[Trolley Java SDK](../README.md) > [Gateway](../classes/gateway.md)
22

33
# Class: Gateway
44

‎docs/classes/paymentgateway.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[Payment Rails Java SDK](../README.md) > [PaymentGateway](../classes/paymentgateway.md)
1+
[Trolley Java SDK](../README.md) > [PaymentGateway](../classes/paymentgateway.md)
22

33
# Class: PaymentGateway
44

@@ -32,7 +32,7 @@ Create a new payment in a batch
3232

3333
| Param | Type | Description |
3434
| ------ | ------ | ------ |
35-
| batchId | `string` | Payment Rails payment id (e.g. "B-xx999bb") |
35+
| batchId | `string` | Trolley payment id (e.g. "B-xx999bb") |
3636
| body | `any` | Payment information |
3737

3838
**Returns:** `Payment`
@@ -55,7 +55,7 @@ Find a specific payment
5555

5656
| Param | Type | Description |
5757
| ------ | ------ | ------ |
58-
| paymentId | `string` | Payment Rails payment id (e.g. "P-aabccc") |
58+
| paymentId | `string` | Trolley payment id (e.g. "P-aabccc") |
5959

6060
**Returns:** `Payment`
6161

@@ -77,8 +77,8 @@ Delete a given payment -- Note you can only delete non processed payments
7777

7878
| Param | Type | Description |
7979
| ------ | ------ | ------ |
80-
| paymentId | `string` | Payment Rails payment id (e.g. "P-aabccc") |
81-
| batchId | `string` | Payment Rails payment id (e.g. "B-xx999bb") |
80+
| paymentId | `string` | Trolley payment id (e.g. "P-aabccc") |
81+
| batchId | `string` | Trolley payment id (e.g. "B-xx999bb") |
8282

8383
**Returns:** `boolean`
8484

@@ -98,7 +98,7 @@ Search for payments in a given batch
9898

9999
| Param | Type | Default value | Description |
100100
| ------ | ------ | ------ | ------ |
101-
| batchId | `string` | - | Payment Rails payment id (e.g. "B-xx999bb") |
101+
| batchId | `string` | - | Trolley payment id (e.g. "B-xx999bb") |
102102
| page | `number` | 1 | Page number (1 based) |
103103
| pageSize | `number` | 10 | Page size (0...1000) |
104104
| term | `string` | &quot;&quot; | Any search terms to look for |
@@ -123,8 +123,8 @@ Update a given payment
123123

124124
| Param | Type | Description |
125125
| ------ | ------ | ------ |
126-
| paymentId | `string` | Payment Rails payment id (e.g. "P-aabccc") |
127-
| batchId | `string` | Payment Rails payment id (e.g. "B-xx999bb") |
126+
| paymentId | `string` | Trolley payment id (e.g. "P-aabccc") |
127+
| batchId | `string` | Trolley payment id (e.g. "B-xx999bb") |
128128
| body | `any` | Payment update information |
129129

130130
**Returns:** `boolean`

‎docs/classes/recipientaccountgateway.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[Payment Rails Java SDK](../README.md) > [RecipientAccountGateway](../classes/recipientaccountgateway.md)
1+
[Trolley Java SDK](../README.md) > [RecipientAccountGateway](../classes/recipientaccountgateway.md)
22

33
# Class: RecipientAccountGateway
44

@@ -24,7 +24,7 @@
2424

2525
*Defined in [RecipientAccountGateway.java:33](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/ca/paymentrails/paymentrails/RecipientAccountGateway.java#L33)*
2626

27-
Fetch all of the accounts for a given Payment Rails recipient
27+
Fetch all of the accounts for a given Trolley recipient
2828

2929
$response = PaymentRails\RecipientAccount::all($recipient_id);
3030
List<RecipientAccount> recipientAccounts = client.recipientAccount.findAll("R-123r4cs");
@@ -33,7 +33,7 @@ Fetch all of the accounts for a given Payment Rails recipient
3333

3434
| Param | Type | Description |
3535
| ------ | ------ | ------ |
36-
| recipientId | `string` | The Payment Rails recipient ID (e.g. R-xyzzy) |
36+
| recipientId | `string` | The Trolley recipient ID (e.g. R-xyzzy) |
3737

3838
**Returns:** `List<RecipientAccount>(recipientaccount.md)[]>
3939

@@ -54,7 +54,7 @@ Create a new recipient account
5454

5555
| Param | Type | Description |
5656
| ------ | ------ | ------ |
57-
| recipientId | `string` | The Payment Rails recipient ID (e.g. R-xyzzy) |
57+
| recipientId | `string` | The Trolley recipient ID (e.g. R-xyzzy) |
5858
| body | `string` | Account information |
5959

6060
**Returns:** `RecipientAccount`(recipientaccount.md)>
@@ -69,16 +69,16 @@ Create a new recipient account
6969

7070
*Defined in [RecipientAccountGateway.java:52](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/ca/paymentrails/paymentrails/RecipientAccountGateway.java#L52)*
7171

72-
Fetch a specific account for a given Payment Rails recipient
72+
Fetch a specific account for a given Trolley recipient
7373

7474
RecipientAccount recipientAccount = client.recipientAccount.find("R-ad322121", "A-2134fd");
7575

7676
**Parameters:**
7777

7878
| Param | Type | Description |
7979
| ------ | ------ | ------ |
80-
| recipientId | `string` | The Payment Rails recipient ID (e.g. R-xyzzy) |
81-
| accountId | `string` | The Payment Rails account ID (e.g. A-xyzzy) |
80+
| recipientId | `string` | The Trolley recipient ID (e.g. R-xyzzy) |
81+
| accountId | `string` | The Trolley account ID (e.g. A-xyzzy) |
8282

8383
**Returns:** `RecipientAccount`(recipientaccount.md)>
8484

@@ -100,8 +100,8 @@ Delete the given recipient account. This will only return success, otherwise it
100100

101101
| Param | Type | Description |
102102
| ------ | ------ | ------ |
103-
| recipientId | `string` | The Payment Rails recipient ID (e.g. R-xyzzy) |
104-
| accountId | `string` | The Payment Rails account ID (e.g. A-xyzzy) |
103+
| recipientId | `string` | The Trolley recipient ID (e.g. R-xyzzy) |
104+
| accountId | `string` | The Trolley account ID (e.g. A-xyzzy) |
105105

106106
**Returns:** `boolean`
107107

@@ -123,8 +123,8 @@ Update a recipient account. Note: Updating an account will create a new account
123123

124124
| Param | Type | Description |
125125
| ------ | ------ | ------ |
126-
| recipientId | `string` | The Payment Rails recipient ID (e.g. R-xyzzy) |
127-
| accountId | `string` | The Payment Rails account ID (e.g. A-xyzzy) |
126+
| recipientId | `string` | The Trolley recipient ID (e.g. R-xyzzy) |
127+
| accountId | `string` | The Trolley account ID (e.g. A-xyzzy) |
128128
| body | `any` | Account information |
129129

130130
**Returns:** `RecipientAccount`(recipientaccount.md)>

‎docs/classes/recipientgateway.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[Payment Rails Java SDK](../README.md) > [RecipientGateway](../classes/RecipientGateway.md)
1+
[Trolley Java SDK](../README.md) > [RecipientGateway](../classes/RecipientGateway.md)
22

33
# Class: RecipientGateway
44

@@ -48,15 +48,15 @@ Create a given recipient
4848

4949
*Defined in [RecipientGateway.java:58](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/ca/paymentrails/paymentrails/RecipientGateway.java#L58)*
5050

51-
Find a specific recipient by their Payment Rails recipient ID
51+
Find a specific recipient by their Trolley recipient ID
5252

5353
Recipient recipient = client.recipient.find(R-efr313md8cj);
5454

5555
**Parameters:**
5656

5757
| Param | Type | Description |
5858
| ------ | ------ | ------ |
59-
| recipientId | `string` | The Payment Rails recipient ID (e.g. R-xyzzy) |
59+
| recipientId | `string` | The Trolley recipient ID (e.g. R-xyzzy) |
6060

6161
**Returns:** `Recipient`
6262

@@ -78,7 +78,7 @@ Delete the given recipient.
7878

7979
| Param | Type | Description |
8080
| ------ | ------ | ------ |
81-
| recipientId | `string` | The Payment Rails recipient ID (e.g. R-xyzzy) |
81+
| recipientId | `string` | The Trolley recipient ID (e.g. R-xyzzy) |
8282

8383
**Returns:** `boolean`
8484

‎docs/packages/exceptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[Payment Rails Java SDK](../README.md) > [Exceptions](../packages/exceptions.md)
1+
[Trolley Java SDK](../README.md) > [Exceptions](../packages/exceptions.md)
22

33
# Package: Exceptions
44

‎docs/types/batch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[Payment Rails Java SDK](../README.md) > [BatchInput](../types/batch.md)
1+
[Trolley Java SDK](../README.md) > [BatchInput](../types/batch.md)
22

33
# Types: Batch
44

0 commit comments

Comments
 (0)