Skip to content

Commit

Permalink
Merge pull request #23 from trolley/dev
Browse files Browse the repository at this point in the history
RC v1.1.0
  • Loading branch information
Aman-Aalam authored Jun 14, 2023
2 parents a4b3671 + be1a63e commit 72566dc
Show file tree
Hide file tree
Showing 94 changed files with 5,029 additions and 3,141 deletions.
2 changes: 2 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
ACCESS_KEY=
SECRET_KEY=
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,6 @@ nbproject
.project
.vscode
.vscode/*
src/main/java/ca/paymentrails/paymentrails/index.java
src/main/java/com/trolley/trolley/index.java
/.metadata/
.env
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,21 @@ Add this dependency to your project's POM:

```xml
<dependency>
<groupId>ca.paymentrails</groupId>
<artifactId>paymentrails</artifactId>
<version>1.0.2</version>
<groupId>com.trolley</groupId>
<artifactId>java-sdk</artifactId>
<version>1.0.1</version>
</dependency>
```

The library is hosted at [https://github.com/paymentRails/java-sdk](https://github.com/paymentRails/java-sdk)
The library's source is hosted at [https://github.com/paymentRails/java-sdk](https://github.com/paymentRails/java-sdk)

The library can be found at: [https://central.sonatype.com/artifact/com.trolley/java-sdk/1.0](https://central.sonatype.com/artifact/com.trolley/java-sdk/1.0)

## Getting Started

```java
import ca.paymentrails.paymentrails.*;
import ca.paymentrails.Exceptions.*;
import com.trolley.java-sdk.*;
import com.trolley.Exceptions.*;

public class PaymentRailsExample {
public static void main(String[] args) {
Expand All @@ -51,7 +53,7 @@ public class PaymentRailsExample {

### Usage

Methods should all have Java Doc comments to help you understand their usage. As mentioned the [full API documentation](https://docs.trolley.com)
Methods should all have Java Doc comments to help you understand their usage. As mentioned the [full API documentation](http://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/java-sdk/tree/master/docs) is available. The best starting point is:
Expand Down
72 changes: 36 additions & 36 deletions docs/classes/batchgateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,21 @@
# Class: BatchGateway

Gateway class for batches
*__class__*: BatchGateway
_**class**_: BatchGateway

## Index

### Methods

* [create](BatchGateway.md#create)
* [find](BatchGateway.md#find)
* [generateQuote](BatchGateway.md#generatequote)
* [paymentList](BatchGateway.md#paymentlist)
* [delete](BatchGateway.md#delete)
* [search](BatchGateway.md#search)
* [processBatch](BatchGateway.md#processBatch)
* [summary](BatchGateway.md#summary)
* [update](BatchGateway.md#update)
- [create](BatchGateway.md#create)
- [find](BatchGateway.md#find)
- [generateQuote](BatchGateway.md#generatequote)
- [paymentList](BatchGateway.md#paymentlist)
- [delete](BatchGateway.md#delete)
- [search](BatchGateway.md#search)
- [processBatch](BatchGateway.md#processBatch)
- [summary](BatchGateway.md#summary)
- [update](BatchGateway.md#update)

---

Expand All @@ -27,19 +27,19 @@ Gateway class for batches

### create

**create**(batch: *`Batch`*): `Batch`
**create**(batch: _`Batch`_): `Batch`

*Defined in [BatchGateway.java:95](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/ca/paymentrails/paymentrails/BatchGateway.java#L95)*
_Defined in [BatchGateway.java:95](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/com/trolley/trolley/BatchGateway.java#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
Creates a batch with optional payments. This is the interface that is provide by the [Create Batch](http://docs.trolley.com/api/#create-a-batch) API

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

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| batch | `Batch` | - |
| Param | Type | Description |
| ----- | ------- | ----------- |
| batch | `Batch` | - |

**Returns:** `Batch`

Expand All @@ -49,9 +49,9 @@ Creates a batch with optional payments. This is the interface that is provide by

### find

**find**(batchId: *`string`*): `Batch`
**find**(batchId: _`string`_): `Batch`

*Defined in [BatchGateway.java:67](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/ca/paymentrails/paymentrails/BatchGateway.java#L67)*
_Defined in [BatchGateway.java:67](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/com/trolley/trolley/BatchGateway.java#L67)_

Retrieves a batch based on the batch id

Expand All @@ -71,9 +71,9 @@ Retrieves a batch based on the batch id

### generateQuote

**generateQuote**(batchId: *`string`*): `Batch`
**generateQuote**(batchId: _`string`_): `Batch`

*Defined in [BatchGateway.java:182](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/ca/paymentrails/paymentrails/BatchGateway.java#L182)*
_Defined in [BatchGateway.java:182](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/com/trolley/trolley/BatchGateway.java#L182)_

Generate a FX quote for this batch

Expand All @@ -91,9 +91,9 @@ Generate a FX quote for this batch

### paymentList

**paymentList**(batchId: *`string`*, page?: *`number`*, pageSize?: *`number`*): `Payment`[]
**paymentList**(batchId: _`string`_, page?: _`number`_, pageSize?: _`number`_): `Payment`[]

*Defined in [BatchGateway.java:166](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/ca/paymentrails/paymentrails/BatchGateway.java#L166)*
_Defined in [BatchGateway.java:166](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/com/trolley/trolley/BatchGateway.java#L166)_

Return a paginated list of payments for this batch

Expand All @@ -113,9 +113,9 @@ Return a paginated list of payments for this batch

### delete

**delete**(batchId: *`string`*): `Boolean`
**delete**(batchId: _`string`_): `Boolean`

*Defined in [BatchGateway.java:132](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/ca/paymentrails/paymentrails/BatchGateway.java#L132)*
_Defined in [BatchGateway.java:132](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/com/trolley/trolley/BatchGateway.java#L132)_

Delete the given batch

Expand All @@ -135,19 +135,19 @@ Delete the given batch

### search

**search**(page?: *`number`*, pageSize?: *`number`*, term?: *`string`*): `Batch`[]
**search**(page?: _`number`_, pageSize?: _`number`_, term?: _`string`_): `Batch`[]

*Defined in [BatchGateway.java:146](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/ca/paymentrails/paymentrails/BatchGateway.java#L146)*
_Defined in [BatchGateway.java:146](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/com/trolley/trolley/BatchGateway.java#L146)_

Search for a batch matching the given term

**Parameters:**

| Param | Type | Default value | Description |
| ------ | ------ | ------ | ------ |
| page | `number` | 1 | - |
| pageSize | `number` | 10 | - |
| term | `string` | &quot;&quot; | string search term |
| Param | Type | Default value | Description |
| -------- | -------- | ------------- | ------------------ |
| page | `number` | 1 | - |
| pageSize | `number` | 10 | - |
| term | `string` | &quot;&quot; | string search term |

**Returns:** `Batch`[]

Expand All @@ -157,9 +157,9 @@ Search for a batch matching the given term

### processBatch

**processBatch**(batchId: *`string`*): `Batch`
**processBatch**(batchId: _`string`_): `Batch`

*Defined in [BatchGateway.java:194](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/ca/paymentrails/paymentrails/BatchGateway.java#L194)*
_Defined in [BatchGateway.java:194](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/com/trolley/trolley/BatchGateway.java#L194)_

Start processing this batch

Expand All @@ -177,9 +177,9 @@ Start processing this batch

### summary

**summary**(batchId: *`string`*): `String`
**summary**(batchId: _`string`_): `String`

*Defined in [BatchGateway.java:206](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/ca/paymentrails/paymentrails/BatchGateway.java#L206)*
_Defined in [BatchGateway.java:206](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/com/trolley/trolley/BatchGateway.java#L206)_

Get a transaction totaled summary for this batch

Expand All @@ -193,4 +193,4 @@ Get a transaction totaled summary for this batch

**Returns:** `String`

---
---
28 changes: 14 additions & 14 deletions docs/classes/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@

### Properties

* [apiBase](Configuration.md#apibase)
* [apiKey](Configuration.md#apikey)
* [apiSecret](Configuration.md#apisecret)
- [apiBase](Configuration.md#apibase)
- [apiKey](Configuration.md#apikey)
- [apiSecret](Configuration.md#apisecret)

---

Expand All @@ -18,47 +18,47 @@

### environment

** environment**: *`string`*
**enviroment**: _`string`_

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

---

<a id="publicKey"></a>

### publicKey

** publicKey**: *`string`*
**● publicKey**: _`string`_

*Defined in [Configuration.java:33](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/ca/paymentrails/paymentrails/Configuration.java#L33)*
_Defined in [Configuration.java:33](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/com/trolley/trolley/Configuration.java#L33)_

---

<a id="privateKey"></a>

### privateKey

** privateKey**: *`string`*
**● privateKey**: _`string`_

*Defined in [Configuration.java:34](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/ca/paymentrails/paymentrails/Configuration.java#L34)*
_Defined in [Configuration.java:34](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/com/trolley/trolley/Configuration.java#L34)_

---

<a id="environment"></a>

### «Static» environment

**environment**(environment: *"production"⎮"sandbox"⎮"integration"*): `void`
**environment**(environment: _"production"⎮"sandbox"⎮"integration"_): `void`

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

Set the Trolley API environment that you're using

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| environment | "production"⎮"sandbox"⎮"integration" | one of "production" or "sandbox" |
| Param | Type | Description |
| ----------- | ------------------------------------ | -------------------------------- |
| environment | "production"⎮"sandbox"⎮"integration" | one of "production" or "sandbox" |

**Returns:** `void`

Expand Down
38 changes: 19 additions & 19 deletions docs/classes/gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@

### Properties

* [balances](gateway.md#balances)
* [batch](gateway.md#batch)
* [config](gateway.md#config)
* [payment](gateway.md#payment)
* [recipient](gateway.md#recipient)
* [recipientAccount](gateway.md#recipientaccount)
- [balances](gateway.md#balances)
- [batch](gateway.md#batch)
- [config](gateway.md#config)
- [payment](gateway.md#payment)
- [recipient](gateway.md#recipient)
- [recipientAccount](gateway.md#recipientaccount)

---

Expand All @@ -21,58 +21,58 @@

### balances

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

*Defined in [Gateway.md:15]*
_Defined in [Gateway.md:15]_

---

<a id="batch"></a>

### batch

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

*Defined in [Gateway.java:13](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/ca/paymentrails/paymentrails/Gateway.java#L13)*
_Defined in [Gateway.java:13](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/com/trolley/trolley/Gateway.java#L13)_

---

<a id="config"></a>

### config

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

*Defined in [Gateway.java:10](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/ca/paymentrails/paymentrails/Gateway.java#L10)*
_Defined in [Gateway.java:10](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/com/trolley/trolley/Gateway.java#L10)_

---

<a id="payment"></a>

### payment

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

*Defined in [Gateway.java:16](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/ca/paymentrails/paymentrails/Gateway.java#L16)*
_Defined in [Gateway.java:16](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/com/trolley/trolley/Gateway.java#L16)_

---

<a id="recipient"></a>

### recipient

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

*Defined in [Gateway.java:12](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/ca/paymentrails/paymentrails/Gateway.java#L12)*
_Defined in [Gateway.java:12](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/com/trolley/trolley/Gateway.java#L12)_

---

<a id="recipientaccount"></a>

### recipientAccount

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

*Defined in [Gateway.java:14](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/ca/paymentrails/paymentrails/Gateway.java#L14)*
_Defined in [Gateway.java:14](https://github.com/PaymentRails/java-sdk/tree/master/src/main/java/com/trolley/trolley/Gateway.java#L14)_

---
---
Loading

0 comments on commit 72566dc

Please sign in to comment.