|
6 | 6 | ### Important Notes |
7 | 7 |
|
8 | 8 | - **Available Features:** This SDK currently contains only 3 of PayPal's API endpoints. Additional endpoints and functionality will be added in the future. |
9 | | -- **API Changes:** Expect potential changes in APIs and features as we finalize the product. |
10 | 9 |
|
11 | 10 | ### Information |
12 | 11 |
|
13 | 12 | The PayPal Server SDK provides integration access to the PayPal REST APIs. The API endpoints are divided into distinct controllers: |
14 | 13 |
|
15 | | -- Orders Controller: <a href="https://developer.paypal.com/docs/api/orders/v2/">Orders API v2</a> |
16 | | -- Payments Controller: <a href="https://developer.paypal.com/docs/api/payments/v2/">Payments API v2</a> |
17 | | -- Vault Controller: <a href="https://developer.paypal.com/docs/api/payment-tokens/v3/">Payment Method Tokens API v3</a> *Available in the US only.* |
18 | | - |
19 | | -Find out more here: [https://developer.paypal.com/docs/api/orders/v2/](https://developer.paypal.com/docs/api/orders/v2/) |
| 14 | +- Orders Controller: [Orders API v2](https://developer.paypal.com/docs/api/orders/v2/) |
| 15 | +- Payments Controller: [Payments API v2](https://developer.paypal.com/docs/api/payments/v2 |
| 16 | +- Vault Controller: [Payment Method Tokens API v3](https://developer.paypal.com/docs/api/payment-tokens/v3/) *Available in the US only.* |
20 | 17 |
|
21 | 18 | ## Install the Package |
22 | 19 |
|
23 | 20 | The package is compatible with Python versions `3.7+`. |
24 | 21 | Install the package from PyPi using the following pip command: |
25 | 22 |
|
26 | 23 | ```bash |
27 | | -pip install paypal-server-sdk==1.0.0 |
| 24 | +pip install paypal-server-sdk==1.1.0 |
28 | 25 | ``` |
29 | 26 |
|
30 | 27 | You can also view the package at: |
31 | | -https://pypi.python.org/pypi/paypal-server-sdk/1.0.0 |
| 28 | +https://pypi.python.org/pypi/paypal-server-sdk/1.1.0 |
32 | 29 |
|
33 | 30 | ## Initialize the API Client |
34 | 31 |
|
35 | | -**_Note:_** Documentation for the client can be found [here.](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.0.0/doc/client.md) |
| 32 | +**_Note:_** Documentation for the client can be found [here.](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.1.0/doc/client.md) |
36 | 33 |
|
37 | 34 | The following parameters are configurable for the API Client: |
38 | 35 |
|
39 | 36 | | Parameter | Type | Description | |
40 | 37 | | --- | --- | --- | |
41 | | -| `environment` | `Environment` | The API environment. <br> **Default: `Environment.SANDBOX`** | |
42 | | -| `http_client_instance` | `HttpClient` | The Http Client passed from the sdk user for making requests | |
43 | | -| `override_http_client_configuration` | `bool` | The value which determines to override properties of the passed Http Client from the sdk user | |
44 | | -| `http_call_back` | `HttpCallBack` | The callback value that is invoked before and after an HTTP call is made to an endpoint | |
45 | | -| `timeout` | `float` | The value to use for connection timeout. <br> **Default: 60** | |
46 | | -| `max_retries` | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** | |
47 | | -| `backoff_factor` | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** | |
48 | | -| `retry_statuses` | `Array of int` | The http statuses on which retry is to be done. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** | |
49 | | -| `retry_methods` | `Array of string` | The http methods on which retry is to be done. <br> **Default: ['GET', 'PUT']** | |
50 | | -| `logging_configuration` | [`LoggingConfiguration`](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.0.0/doc/logging-configuration.md) | The SDK logging configuration for API calls | |
51 | | -| `client_credentials_auth_credentials` | [`ClientCredentialsAuthCredentials`](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.0.0/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant | |
| 38 | +| environment | `Environment` | The API environment. <br> **Default: `Environment.SANDBOX`** | |
| 39 | +| http_client_instance | `HttpClient` | The Http Client passed from the sdk user for making requests | |
| 40 | +| override_http_client_configuration | `bool` | The value which determines to override properties of the passed Http Client from the sdk user | |
| 41 | +| http_call_back | `HttpCallBack` | The callback value that is invoked before and after an HTTP call is made to an endpoint | |
| 42 | +| timeout | `float` | The value to use for connection timeout. <br> **Default: 60** | |
| 43 | +| max_retries | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** | |
| 44 | +| backoff_factor | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** | |
| 45 | +| retry_statuses | `Array of int` | The http statuses on which retry is to be done. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** | |
| 46 | +| retry_methods | `Array of string` | The http methods on which retry is to be done. <br> **Default: ['GET', 'PUT']** | |
| 47 | +| logging_configuration | [`LoggingConfiguration`](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.1.0/doc/logging-configuration.md) | The SDK logging configuration for API calls | |
| 48 | +| client_credentials_auth_credentials | [`ClientCredentialsAuthCredentials`](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.1.0/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant | |
52 | 49 |
|
53 | 50 | The API client can be initialized as follows: |
54 | 51 |
|
@@ -86,22 +83,33 @@ The SDK can be configured to use a different environment for making API calls. A |
86 | 83 |
|
87 | 84 | This API uses the following authentication schemes. |
88 | 85 |
|
89 | | -* [`Oauth2 (OAuth 2 Client Credentials Grant)`](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.0.0/doc/auth/oauth-2-client-credentials-grant.md) |
| 86 | +* [`Oauth2 (OAuth 2 Client Credentials Grant)`](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.1.0/doc/auth/oauth-2-client-credentials-grant.md) |
90 | 87 |
|
91 | 88 | ## List of APIs |
92 | 89 |
|
93 | | -* [Orders](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.0.0/doc/controllers/orders.md) |
94 | | -* [Payments](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.0.0/doc/controllers/payments.md) |
95 | | -* [Vault](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.0.0/doc/controllers/vault.md) |
| 90 | +* [Orders](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.1.0/doc/controllers/orders.md) |
| 91 | +* [Payments](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.1.0/doc/controllers/payments.md) |
| 92 | +* [Vault](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.1.0/doc/controllers/vault.md) |
| 93 | + |
| 94 | +## SDK Infrastructure |
| 95 | + |
| 96 | +### Configuration |
| 97 | + |
| 98 | +* [AbstractLogger](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.1.0/doc/abstract-logger.md) |
| 99 | +* [LoggingConfiguration](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.1.0/doc/logging-configuration.md) |
| 100 | +* [RequestLoggingConfiguration](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.1.0/doc/request-logging-configuration.md) |
| 101 | +* [ResponseLoggingConfiguration](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.1.0/doc/response-logging-configuration.md) |
| 102 | + |
| 103 | +### HTTP |
| 104 | + |
| 105 | +* [HttpResponse](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.1.0/doc/http-response.md) |
| 106 | +* [HttpRequest](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.1.0/doc/http-request.md) |
96 | 107 |
|
97 | | -## Classes Documentation |
| 108 | +### Utilities |
98 | 109 |
|
99 | | -* [Utility Classes](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.0.0/doc/utility-classes.md) |
100 | | -* [HttpResponse](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.0.0/doc/http-response.md) |
101 | | -* [HttpRequest](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.0.0/doc/http-request.md) |
102 | | -* [ApiResponse](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.0.0/doc/api-response.md) |
103 | | -* [LoggingConfiguration](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.0.0/doc/logging-configuration.md) |
104 | | -* [RequestLoggingConfiguration](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.0.0/doc/request-logging-configuration.md) |
105 | | -* [ResponseLoggingConfiguration](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.0.0/doc/response-logging-configuration.md) |
106 | | -* [AbstractLogger](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.0.0/doc/abstract-logger.md) |
| 110 | +* [ApiResponse](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.1.0/doc/api-response.md) |
| 111 | +* [ApiHelper](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.1.0/doc/api-helper.md) |
| 112 | +* [HttpDateTime](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.1.0/doc/http-date-time.md) |
| 113 | +* [RFC3339DateTime](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.1.0/doc/rfc3339-date-time.md) |
| 114 | +* [UnixDateTime](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/1.1.0/doc/unix-date-time.md) |
107 | 115 |
|
0 commit comments