Skip to content

Commit

Permalink
Merge pull request #10 from PaymentRails/analytics-and-rebranding
Browse files Browse the repository at this point in the history
feat:Analytics and rebranding
  • Loading branch information
Aman-Aalam authored Mar 8, 2023
2 parents 6df6b82 + 54d6198 commit 2c5d395
Show file tree
Hide file tree
Showing 43 changed files with 138 additions and 103 deletions.
2 changes: 1 addition & 1 deletion ACKNOWLEDGEMENTS.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Acknowledgements
----------------

The PaymentRails SDK uses code from the following libraries:
The Trolley SDK uses code from the following libraries:

* [Nose](https://github.com/nose-devs/nose)
* [Braintree](https://github.com/braintree/braintree_python), MIT License
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2017 Payment Rails, Inc.
Copyright (c) 2017 Trolley, Inc.

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
Expand Down
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[![Latest Stable Version](https://img.shields.io/pypi/v/paymentrails.svg)](https://pypi.python.org/pypi/paymentrails)


# Payment Rails[^1] Python SDK
# Trolley Python SDK (Previously Payment Rails[^1])

A native Python SDK for the Payment Rails API
A native Python SDK for the Trolley API

[^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

Expand All @@ -20,6 +20,17 @@ A native Python SDK for the Payment Rails API

* Python
* [requests](http://docs.python-requests.org/en/latest/)
* [Mock](https://pypi.org/project/mock/) - For unit tests

## Running Tests

```
// unit tests
$ python -m unittest test/unit/testBalances.py
//integration tests
$ python test/integration/RecipientTest.py
```

## Getting Started

Expand All @@ -37,14 +48,14 @@ print(response.id)

## Documentation for API Endpoints

All URIs are available at http://docs.paymentrails.com/
All URIs are available at https://docs.trolley.com/

All URIs are relative to *https://api.paymentrails.com/v1*
All URIs are relative to *https://api.trolley.com/v1*


### Usage

Methods should all have Python Doc comments to help you understand their usage. As mentioned the [full API documentation](http://docs.paymentrails.com)
Methods should all have Python 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 [Python API docs](https://github.com/PaymentRails/python-sdk/tree/master/docs/) is available. The best starting point is:
Expand Down
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@



# Payment Rails Python SDK
# Trolley Python SDK

## Index

Expand Down Expand Up @@ -33,7 +33,7 @@
---


Create a client for the Payment Rails Python API
Create a client for the Trolley Python API


client = Configuration.gateway("YOUR-PUBLIC-API","YOUR-PRIVATE-API","production")
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/balancesgateway.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[Payment Rails Python SDK](../README.md) > [balances_gateway](../classes/balances_gateway.md)
[Trolley Python SDK](../README.md) > [balances_gateway](../classes/balances_gateway.md)



Expand Down
14 changes: 7 additions & 7 deletions docs/classes/batchgateway.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[Payment Rails Python SDK](../README.md) > [batchgateway](../classes/batchgateway.md)
[Trolley Python SDK](../README.md) > [batchgateway](../classes/batchgateway.md)



Expand Down Expand Up @@ -94,7 +94,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") |



Expand Down Expand Up @@ -127,7 +127,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") |



Expand Down Expand Up @@ -158,8 +158,8 @@ Delete the given batch

| Param | Type | Description |
| ------ | ------ | ------ |
| batchId | `string` | Payment Rails batch (e.g. "B-xx999bb") |
| batch | `Batch` | Payment Rails batch |
| batchId | `string` | Trolley batch (e.g. "B-xx999bb") |
| batch | `Batch` | Trolley batch |



Expand Down Expand Up @@ -226,7 +226,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") |



Expand Down Expand Up @@ -259,7 +259,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") |



Expand Down
4 changes: 2 additions & 2 deletions docs/classes/configuration.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[Payment Rails Python SDK](../README.md) > [Configuration](../classes/configuration.md)
[Trolley Python SDK](../README.md) > [Configuration](../classes/configuration.md)



Expand Down Expand Up @@ -70,7 +70,7 @@ ___



Set the Payment Rails API environment that your using
Set the Trolley API environment that your using


**Parameters:**
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/exceptions.authentication.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[Payment Rails Python SDK](../README.md) > [Exceptions](../packages/exceptions.md) > [Authentication](../classes/exceptions.authentication.md)
[Trolley Python SDK](../README.md) > [Exceptions](../packages/exceptions.md) > [Authentication](../classes/exceptions.authentication.md)



Expand Down
2 changes: 1 addition & 1 deletion docs/classes/exceptions.authorization.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[Payment Rails Python SDK](../README.md) > [Exceptions](../packages/exceptions.md) > [Authorization](../classes/exceptions.authorization.md)
[Trolley Python SDK](../README.md) > [Exceptions](../packages/exceptions.md) > [Authorization](../classes/exceptions.authorization.md)



Expand Down
2 changes: 1 addition & 1 deletion docs/classes/exceptions.baseexception.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[Payment Rails Python SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [BaseException](../classes/exceptions.baseexception.md)
[Trolley Python SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [BaseException](../classes/exceptions.baseexception.md)



Expand Down
2 changes: 1 addition & 1 deletion docs/classes/exceptions.downformaintenance.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[Payment Rails Python SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [DownForMaintenance](../classes/exceptions.downformaintenance.md)
[Trolley Python SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [DownForMaintenance](../classes/exceptions.downformaintenance.md)



Expand Down
2 changes: 1 addition & 1 deletion docs/classes/exceptions.malformed.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[Payment Rails Python SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [Malformed](../classes/exceptions.malformed.md)
[Trolley Python SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [Malformed](../classes/exceptions.malformed.md)



Expand Down
2 changes: 1 addition & 1 deletion docs/classes/exceptions.notfound.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[Payment Rails Python SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [NotFound](../classes/exceptions.notfound.md)
[Trolley Python SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [NotFound](../classes/exceptions.notfound.md)



Expand Down
2 changes: 1 addition & 1 deletion docs/classes/exceptions.servererror.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[Payment Rails Python SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [ServerError](../classes/exceptions.servererror.md)
[Trolley Python SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [ServerError](../classes/exceptions.servererror.md)



Expand Down
2 changes: 1 addition & 1 deletion docs/classes/exceptions.unexpected.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[Payment Rails Python SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [Unexpected](../classes/exceptions.unexpected.md)
[Trolley Python SDK](../README.md) > [Exceptions](../modules/exceptions.md) > [Unexpected](../classes/exceptions.unexpected.md)



Expand Down
2 changes: 1 addition & 1 deletion docs/classes/gateway.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[Payment Rails Python SDK](../README.md) > [Gateway](../classes/gateway.md)
[Trolley Python SDK](../README.md) > [Gateway](../classes/gateway.md)



Expand Down
16 changes: 8 additions & 8 deletions docs/classes/paymentgateway.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[Payment Rails Python SDK](../README.md) > [PaymentGateway](../classes/paymentgateway.md)
[Trolley Python SDK](../README.md) > [PaymentGateway](../classes/paymentgateway.md)



Expand Down Expand Up @@ -40,7 +40,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 | `string` | Payment information |


Expand Down Expand Up @@ -76,7 +76,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") |



Expand Down Expand Up @@ -111,8 +111,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") |



Expand Down Expand Up @@ -145,7 +145,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 |
Expand Down Expand Up @@ -183,8 +183,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 | `string` | Payment update information |


Expand Down
22 changes: 11 additions & 11 deletions docs/classes/recipientaccountgateway.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[Payment Rails Python SDK](../README.md) > [recipient_account_gateway](../classes/recipientaccountgateway.md)
[Trolley Python SDK](../README.md) > [recipient_account_gateway](../classes/recipientaccountgateway.md)



Expand Down Expand Up @@ -32,7 +32,7 @@



Fetch all of the accounts for a given Payment Rails recipient
Fetch all of the accounts for a given Trolley recipient

accounts = client.recipient_account.findAll('R-1234');

Expand All @@ -44,7 +44,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) |



Expand Down Expand Up @@ -83,7 +83,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 |


Expand All @@ -110,7 +110,7 @@ ___



Fetch a specific account for a given Payment Rails recipient
Fetch a specific account for a given Trolley recipient

account = client.recipient_account.find('R-1234', 'A-789');
*__throws__*: {NotFound} if account or recipient don't exist
Expand All @@ -121,8 +121,8 @@ Fetch a specific account for a given Payment Rails recipient

| 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) |



Expand Down Expand Up @@ -157,8 +157,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) |



Expand Down Expand Up @@ -194,8 +194,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 |


Expand Down
8 changes: 4 additions & 4 deletions docs/classes/recipientgateway.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[Payment Rails Python SDK](../README.md) > [recipient_gateway](../classes/recipientgateway.md)
[Trolley Python SDK](../README.md) > [recipient_gateway](../classes/recipientgateway.md)



Expand Down Expand Up @@ -62,7 +62,7 @@ ___



Find a specific recipient by their Payment Rails recipient ID
Find a specific recipient by their Trolley recipient ID

recipient = client.recipient.find("R-fj57vn7emfiwdm8cjmd")

Expand All @@ -71,7 +71,7 @@ Find a specific recipient by their Payment Rails recipient ID

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



Expand Down Expand Up @@ -105,7 +105,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) |



Expand Down
2 changes: 1 addition & 1 deletion docs/packages/exceptions.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[Payment Rails Python SDK](../README.md) > [Exceptions](../packages/exceptions.md)
[Trolley Python SDK](../README.md) > [Exceptions](../packages/exceptions.md)



Expand Down
2 changes: 1 addition & 1 deletion docs/types/batch.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[Payment Rails Python SDK](../README.md) > [Batch](../types/batch.md)
[Trolley Python SDK](../README.md) > [Batch](../types/batch.md)



Expand Down
Loading

0 comments on commit 2c5d395

Please sign in to comment.