forked from LiveCarta/PayPal-PHP-Server-SDK
Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
66fd3341bb |
40
README.md
40
README.md
@@ -3,11 +3,7 @@
|
||||
|
||||
## Introduction
|
||||
|
||||
### ⚠️ Beta Release Notice
|
||||
|
||||
This version is considered a **beta release**. While we have done our best to ensure stability and functionality, there may still be bugs, incomplete features, or breaking changes in future updates.
|
||||
|
||||
#### Important Notes
|
||||
### Important Notes
|
||||
|
||||
- **Available Features:** This SDK currently contains only 3 of PayPal's API endpoints. Additional endpoints and functionality will be added in the future.
|
||||
- **API Changes:** Expect potential changes in APIs and features as we finalize the product.
|
||||
@@ -27,23 +23,23 @@ Find out more here: [https://developer.paypal.com/docs/api/orders/v2/](https://d
|
||||
Run the following command to install the package and automatically add the dependency to your composer.json file:
|
||||
|
||||
```bash
|
||||
composer require "paypal/paypal-server-sdk:0.7.0"
|
||||
composer require "paypal/paypal-server-sdk:1.0.0"
|
||||
```
|
||||
|
||||
Or add it to the composer.json file manually as given below:
|
||||
|
||||
```json
|
||||
"require": {
|
||||
"paypal/paypal-server-sdk": "0.7.0"
|
||||
"paypal/paypal-server-sdk": "1.0.0"
|
||||
}
|
||||
```
|
||||
|
||||
You can also view the package at:
|
||||
https://packagist.org/packages/paypal/paypal-server-sdk#0.7.0
|
||||
https://packagist.org/packages/paypal/paypal-server-sdk#1.0.0
|
||||
|
||||
## Initialize the API Client
|
||||
|
||||
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.7.0/doc/client.md)
|
||||
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/1.0.0/doc/client.md)
|
||||
|
||||
The following parameters are configurable for the API Client:
|
||||
|
||||
@@ -59,8 +55,8 @@ The following parameters are configurable for the API Client:
|
||||
| `retryOnTimeout` | `bool` | Whether to retry on request timeout.<br>*Default*: `true` |
|
||||
| `httpStatusCodesToRetry` | `array` | Http status codes to retry against.<br>*Default*: `408, 413, 429, 500, 502, 503, 504, 521, 522, 524` |
|
||||
| `httpMethodsToRetry` | `array` | Http methods to retry against.<br>*Default*: `'GET', 'PUT'` |
|
||||
| `loggingConfiguration` | [`LoggingConfigurationBuilder`](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.7.0/doc/logging-configuration-builder.md) | Represents the logging configurations for API calls |
|
||||
| `clientCredentialsAuth` | [`ClientCredentialsAuth`](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.7.0/doc/auth/oauth-2-client-credentials-grant.md) | The Credentials Setter for OAuth 2 Client Credentials Grant |
|
||||
| `loggingConfiguration` | [`LoggingConfigurationBuilder`](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/1.0.0/doc/logging-configuration-builder.md) | Represents the logging configurations for API calls |
|
||||
| `clientCredentialsAuth` | [`ClientCredentialsAuth`](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/1.0.0/doc/auth/oauth-2-client-credentials-grant.md) | The Credentials Setter for OAuth 2 Client Credentials Grant |
|
||||
|
||||
The API client can be initialized as follows:
|
||||
|
||||
@@ -97,21 +93,21 @@ The SDK can be configured to use a different environment for making API calls. A
|
||||
|
||||
This API uses the following authentication schemes.
|
||||
|
||||
* [`Oauth2 (OAuth 2 Client Credentials Grant)`](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.7.0/doc/auth/oauth-2-client-credentials-grant.md)
|
||||
* [`Oauth2 (OAuth 2 Client Credentials Grant)`](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/1.0.0/doc/auth/oauth-2-client-credentials-grant.md)
|
||||
|
||||
## List of APIs
|
||||
|
||||
* [Orders](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.7.0/doc/controllers/orders.md)
|
||||
* [Payments](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.7.0/doc/controllers/payments.md)
|
||||
* [Vault](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.7.0/doc/controllers/vault.md)
|
||||
* [Orders](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/1.0.0/doc/controllers/orders.md)
|
||||
* [Payments](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/1.0.0/doc/controllers/payments.md)
|
||||
* [Vault](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/1.0.0/doc/controllers/vault.md)
|
||||
|
||||
## Classes Documentation
|
||||
|
||||
* [ApiException](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.7.0/doc/api-exception.md)
|
||||
* [ApiResponse](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.7.0/doc/api-response.md)
|
||||
* [HttpRequest](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.7.0/doc/http-request.md)
|
||||
* [HttpResponse](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.7.0/doc/http-response.md)
|
||||
* [LoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.7.0/doc/logging-configuration-builder.md)
|
||||
* [RequestLoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.7.0/doc/request-logging-configuration-builder.md)
|
||||
* [ResponseLoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.7.0/doc/response-logging-configuration-builder.md)
|
||||
* [ApiException](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/1.0.0/doc/api-exception.md)
|
||||
* [ApiResponse](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/1.0.0/doc/api-response.md)
|
||||
* [HttpRequest](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/1.0.0/doc/http-request.md)
|
||||
* [HttpResponse](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/1.0.0/doc/http-response.md)
|
||||
* [LoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/1.0.0/doc/logging-configuration-builder.md)
|
||||
* [RequestLoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/1.0.0/doc/request-logging-configuration-builder.md)
|
||||
* [ResponseLoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/1.0.0/doc/response-logging-configuration-builder.md)
|
||||
|
||||
|
||||
@@ -62,7 +62,7 @@ class PaypalServerSdkClient implements ConfigurationInterface
|
||||
->converter(new CompatibilityConverter())
|
||||
->jsonHelper(ApiHelper::getJsonHelper())
|
||||
->apiCallback($this->config['httpCallback'] ?? null)
|
||||
->userAgent('PayPal REST API PHP SDK, Version: 0.7.0, on OS {os-info}')
|
||||
->userAgent('PayPal REST API PHP SDK, Version: 1.0.0, on OS {os-info}')
|
||||
->serverUrls(self::ENVIRONMENT_MAP[$this->getEnvironment()], Server::DEFAULT_)
|
||||
->authManagers(['Oauth2' => $this->clientCredentialsAuthManager])
|
||||
->loggingConfiguration($loggingConfiguration)
|
||||
|
||||
Reference in New Issue
Block a user