Skip to content

Commit

Permalink
Merge pull request #66 from ThePay/4976-updated-url
Browse files Browse the repository at this point in the history
4976 updated url
  • Loading branch information
AlexKratky authored Jan 24, 2024
2 parents 8e94f74 + 93a28c7 commit 4a52764
Show file tree
Hide file tree
Showing 8 changed files with 33 additions and 33 deletions.
2 changes: 1 addition & 1 deletion doc/get-transactions-history.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ $filter = new \ThePay\ApiClient\Filter\TransactionFilter('TP32111146804895511653
$transactionPaginatedCollection = $client->getAccountTransactionHistory($filter);
```

The first parameter of method **getAccountTransactionHistory** is filter object `\ThePay\ApiClient\Filter\TransactionFilter()`. All filter parameters are described in [Apiary](https://dataapi21.docs.apiary.io/#reference/0/merchant-level-resources/get-account-transaction-history).
The first parameter of method **getAccountTransactionHistory** is filter object `\ThePay\ApiClient\Filter\TransactionFilter()`. All filter parameters are described in [Apiary](https://thepay.docs.apiary.io/#reference/0/merchant-level-resources/get-account-transaction-history).

Second and third parameter are used for pagination, where second is page number and third is number of records per page. Parameters are not required.

Expand Down
32 changes: 16 additions & 16 deletions doc/index.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
# Available methods and usage

[![API documentation](https://img.shields.io/static/v1?label=API&message=documentation)](https://dataapi21.docs.apiary.io/#)
[![API documentation](https://img.shields.io/static/v1?label=API&message=documentation)](https://thepay.docs.apiary.io/#)


| SDK method | API/GATE call | Description |
| --- | --- | --- |
| getProjects | https://dataapi21.docs.apiary.io/#reference/0/merchant-level-resources/get-projects | |
| getActivePaymentMethods | https://dataapi21.docs.apiary.io/#reference/0/project-level-resources/get-payment-methods |
| getPayment | https://dataapi21.docs.apiary.io/#reference/0/project-level-resources/get-payment-detail |
| getPayments | https://dataapi21.docs.apiary.io/#reference/0/project-level-resources/get-payments |
| getProjects | https://thepay.docs.apiary.io/#reference/0/merchant-level-resources/get-projects | |
| getActivePaymentMethods | https://thepay.docs.apiary.io/#reference/0/project-level-resources/get-payment-methods |
| getPayment | https://thepay.docs.apiary.io/#reference/0/project-level-resources/get-payment-detail |
| getPayments | https://thepay.docs.apiary.io/#reference/0/project-level-resources/get-payments |
| getPaymentButtons | |
| getPaymentButton | |
| getPaymentButtonsForPayment | |
| createPayment | https://dataapi21.docs.apiary.io/#reference/0/project-level-resources/create-new-payment |
| realizePreauthorizedPayment | https://dataapi21.docs.apiary.io/#reference/0/project-level-resources/realize-preauthorized-payment |
| cancelPreauthorizedPayment | https://dataapi21.docs.apiary.io/#reference/0/project-level-resources/cancel-preauthorized-payment |
| getPaymentRefund | https://dataapi21.docs.apiary.io/#reference/0/project-level-resources/payment-refund-info |
| createPaymentRefund | https://dataapi21.docs.apiary.io/#reference/0/project-level-resources/payment-refund-request |
| getAccountTransactionHistory | https://dataapi21.docs.apiary.io/#reference/0/merchant-level-resources/get-account-transaction-history |
| realizeRegularSubscriptionPayment | https://dataapi21.docs.apiary.io/#reference/0/project-level-resources/realize-regular-subscription-payment |
| realizeIrregularSubscriptionPayment | https://dataapi21.docs.apiary.io/#reference/0/project-level-resources/realize-irregular-subscription-payment |
| realizeUsageBasedSubscriptionPayment | https://dataapi21.docs.apiary.io/#reference/0/project-level-resources/realize-usage-based-subscription-payment |
| realizePaymentBySavedAuthorization | https://dataapi21.docs.apiary.io/#reference/0/project-level-resources/realize-payment-by-saved-authorization |
| getPaymentUrlsForPayment | https://dataapi21.docs.apiary.io/#reference/payment-management/general-payment-management/get-available-payment-methods |
| createPayment | https://thepay.docs.apiary.io/#reference/0/project-level-resources/create-new-payment |
| realizePreauthorizedPayment | https://thepay.docs.apiary.io/#reference/0/project-level-resources/realize-preauthorized-payment |
| cancelPreauthorizedPayment | https://thepay.docs.apiary.io/#reference/0/project-level-resources/cancel-preauthorized-payment |
| getPaymentRefund | https://thepay.docs.apiary.io/#reference/0/project-level-resources/payment-refund-info |
| createPaymentRefund | https://thepay.docs.apiary.io/#reference/0/project-level-resources/payment-refund-request |
| getAccountTransactionHistory | https://thepay.docs.apiary.io/#reference/0/merchant-level-resources/get-account-transaction-history |
| realizeRegularSubscriptionPayment | https://thepay.docs.apiary.io/#reference/0/project-level-resources/realize-regular-subscription-payment |
| realizeIrregularSubscriptionPayment | https://thepay.docs.apiary.io/#reference/0/project-level-resources/realize-irregular-subscription-payment |
| realizeUsageBasedSubscriptionPayment | https://thepay.docs.apiary.io/#reference/0/project-level-resources/realize-usage-based-subscription-payment |
| realizePaymentBySavedAuthorization | https://thepay.docs.apiary.io/#reference/0/project-level-resources/realize-payment-by-saved-authorization |
| getPaymentUrlsForPayment | https://thepay.docs.apiary.io/#reference/payment-management/general-payment-management/get-available-payment-methods |

## Usage examples

Expand Down
2 changes: 1 addition & 1 deletion doc/notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ There are three query parameters added to notifications url:

* payment_uid
* project_id
* type (which determines notification type - see [Notification types enum](https://dataapi21.docs.apiary.io/#introduction/enums/notification-types))
* type (which determines notification type - see [Notification types enum](https://thepay.docs.apiary.io/#introduction/enums/notification-types))

In most cases you want to check the state of payment after getting notification:

Expand Down
16 changes: 8 additions & 8 deletions src/Service/ApiService.php
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ public function __construct(TheConfig $config, HttpServiceInterface $httpService
/**
* Fetch all projects for merchant set in TheConfig
*
* @see https://dataapi21.docs.apiary.io/#reference/0/merchant-level-resources/get-projects
* @see https://thepay.docs.apiary.io/#reference/0/merchant-level-resources/get-projects
*
* @return Project[]
*/
Expand Down Expand Up @@ -85,7 +85,7 @@ public function getProjects()
/**
* Fetch all active payment methods.
*
* @see https://dataapi21.docs.apiary.io/#reference/projects/payment-methods/list-payment-methods
* @see https://thepay.docs.apiary.io/#reference/projects/payment-methods/list-payment-methods
* @param LanguageCode|null $languageCode language for payment method titles, null value language from TheConfig used
* @return PaymentMethodCollection
* @throws ApiException
Expand All @@ -110,7 +110,7 @@ public function getActivePaymentMethods(LanguageCode $languageCode = null)
}

/**
* @see https://dataapi21.docs.apiary.io/#reference/data-retrieval/transactions/get-balance-history
* @see https://thepay.docs.apiary.io/#reference/data-retrieval/transactions/get-balance-history
*
* @param int|null $projectId
*
Expand Down Expand Up @@ -151,7 +151,7 @@ static function (array $accountBalance) {
}

/**
* @see https://dataapi21.docs.apiary.io/#reference/0/merchant-level-resources/get-account-transaction-history
* @see https://thepay.docs.apiary.io/#reference/0/merchant-level-resources/get-account-transaction-history
*
* @param TransactionFilter $filter
* @param int $page
Expand All @@ -178,7 +178,7 @@ public function getAccountTransactionHistory(TransactionFilter $filter, $page =
/**
* Get complete information about the specified payment.
*
* @see https://dataapi21.docs.apiary.io/#reference/0/project-level-resources/get-payment-detail
* @see https://thepay.docs.apiary.io/#reference/0/project-level-resources/get-payment-detail
*
* @param Identifier $paymentUid
*
Expand All @@ -202,7 +202,7 @@ public function getPayment(Identifier $paymentUid)
/**
* Invalidates the specified payment.
*
* @see https://dataapi21.docs.apiary.io/#reference/0/project-level-resources/invalidate-payment
* @see https://thepay.docs.apiary.io/#reference/0/project-level-resources/invalidate-payment
*
* @param Identifier $paymentUid
*
Expand All @@ -224,7 +224,7 @@ public function invalidatePayment(Identifier $paymentUid)
/**
* Fetch information about payments by filter.
*
* @see https://dataapi21.docs.apiary.io/#reference/projects/payments/get-collection
* @see https://thepay.docs.apiary.io/#reference/projects/payments/get-collection
* @param PaymentsFilter $filter
* @param int $page
* @param null|int $limit
Expand Down Expand Up @@ -495,7 +495,7 @@ public function getPaymentUrlsForPayment(Identifier $uid, LanguageCode $language
/**
* Method will generate PDF file as confirmation for paid payment
*
* @see https://dataapi21.docs.apiary.io/#reference/data-retrieval/payments/get-payment-confirmation
* @see https://thepay.docs.apiary.io/#reference/data-retrieval/payments/get-payment-confirmation
*
* @return string with binary content of PDF file
*
Expand Down
4 changes: 2 additions & 2 deletions src/Service/ApiServiceInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ public function realizePaymentBySavedAuthorization(Identifier $parentPaymentUid,
public function getPayments(PaymentsFilter $filter, $page = 1, $limit = null);

/**
* @see https://dataapi21.docs.apiary.io/#reference/data-retrieval/transactions/get-balance-history
* @see https://thepay.docs.apiary.io/#reference/data-retrieval/transactions/get-balance-history
*
* @param int|null $projectId
*
Expand Down Expand Up @@ -175,7 +175,7 @@ public function getPaymentUrlsForPayment(Identifier $uid, LanguageCode $language
/**
* Method will generate PDF file as confirmation for paid payment
*
* @see https://dataapi21.docs.apiary.io/#reference/data-retrieval/payments/get-payment-confirmation
* @see https://thepay.docs.apiary.io/#reference/data-retrieval/payments/get-payment-confirmation
*
* @return string with binary content of PDF file
*
Expand Down
6 changes: 3 additions & 3 deletions src/TheClient.php
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ public function __construct(
/**
* Fetch all projects for merchant set in TheConfig
*
* @see https://dataapi21.docs.apiary.io/#reference/0/merchant-level-resources/get-projects
* @see https://thepay.docs.apiary.io/#reference/0/merchant-level-resources/get-projects
*
* @return Project[]
* @throws ApiException
Expand All @@ -84,7 +84,7 @@ public function getProjects()
}

/**
* @see https://dataapi21.docs.apiary.io/#reference/data-retrieval/transactions/get-balance-history
* @see https://thepay.docs.apiary.io/#reference/data-retrieval/transactions/get-balance-history
*
* @param string|null $accountIban
* @param int|null $projectId
Expand Down Expand Up @@ -413,7 +413,7 @@ public function createPaymentRefund($paymentUid, $amount, $reason)
/**
* Method will generate PDF file as confirmation for paid payment
*
* @see https://dataapi21.docs.apiary.io/#reference/data-retrieval/payments/get-payment-confirmation
* @see https://thepay.docs.apiary.io/#reference/data-retrieval/payments/get-payment-confirmation
*
* @param non-empty-string $paymentUid
* @param non-empty-string|null $languageCode
Expand Down
2 changes: 1 addition & 1 deletion src/ValueObject/PaymentMethodTag.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
namespace ThePay\ApiClient\ValueObject;

/**
* @see https://dataapi21.docs.apiary.io/#introduction/enums/payment-method-tags
* @see https://thepay.docs.apiary.io/#introduction/enums/payment-method-tags
*/
final class PaymentMethodTag extends EnumValueObject
{
Expand Down
2 changes: 1 addition & 1 deletion tests/BaseTestCase.php
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ protected function getApiaryClient()
'6cdf1b24',
1212,
'password',
'https://private-472c9-dataapi21.apiary-mock.com/',
'https://private-aa6aa3-thepay.apiary-mock.com/',
'https://private-ddc40-gatezalozeniplatby.apiary-mock.com/'
);
return new TheClient($config);
Expand Down

0 comments on commit 4a52764

Please sign in to comment.