Beta Release 0.5.1 (#3)

* Automated commit message

* Automated commit message

* Automated commit message

* Automated commit message

---------

Co-authored-by: PayPalServerSDKs <[email protected]>

Author: DPoplin

.gitignore

@@ -0,0 +1 @@
+*.pyc

LICENSE

@@ -0,0 +1,35 @@
+The PayPal Server SDK is released under the following license:
+
+    Copyright (c) 2024 PAYPAL, INC.
+
+    SDK LICENSE
+
+NOTICE TO USER:  PayPal, Inc. is providing the Software and Documentation for use under the terms of this Agreement. Any use, reproduction, modification or distribution of the Software or Documentation, or any derivatives or portions hereof, constitutes your acceptance of this Agreement.
+As used in this Agreement, "PayPal" means PayPal, Inc.  "Software" means the software code accompanying this agreement. "Documentation" means the documents, specifications and all other items accompanying this Agreement other than the Software.   
+
+1.  LICENSE GRANT 
+Subject to the terms of this Agreement, PayPal hereby grants you a non-exclusive, worldwide, royalty free license to use, reproduce, prepare derivative works from, publicly display, publicly perform, distribute and sublicense the Software for any purpose, other than perpetration of any fraud or violation of any law, statute, ordinance, or regulation (for example, those governing financial services, consumer protections, unfair competition, anti-discrimination or false advertising), provided the copyright notice below appears in a conspicuous location within the source code of the distributed Software and this license is distributed in the supporting documentation of the Software you distribute. Furthermore, you must comply with all third party licenses in order to use the third party software contained in the Software.
+Subject to the terms of this Agreement, PayPal hereby grants you a non-exclusive, worldwide, royalty free license to use, reproduce, publicly display, publicly perform, distribute and sublicense the Documentation for any purpose, other than perpetration of any fraud or violation of any law, statute, ordinance, or regulation (for example, those governing financial services, consumer protections, unfair competition, anti-discrimination or false advertising).  You may not modify the Documentation.
+No title to the intellectual property in the Software or Documentation is transferred to you under the terms of this Agreement. You do not acquire any rights to the Software or the Documentation except as expressly set forth in this Agreement.
+Nothing in this Agreement provides you with any right, title, or license to use PayPal’s or any third party’s copyright, patent, trademark, trade secret, or other intellectual property rights, or rights of publicity or privacy, beyond the rights specifically granted herein. You may not infringe PayPal’s or any third party’s copyright, patent, trademark, trade secret, or other intellectual property rights, or rights of publicity or privacy.  
+If you choose to distribute the Software in a commercial product, you do so with the understanding that you agree to defend, indemnify and hold harmless PayPal and its suppliers against any losses, damages and costs arising from the claims, lawsuits or other legal actions arising out of such distribution.  You may distribute the Software in object code form under your own license, provided that your license agreement:
+    (a)     complies with the terms and conditions of this license agreement; 
+    (b)     effectively disclaims all warranties and conditions, express or implied, on behalf of PayPal;
+    (c)     effectively excludes all liability for damages on behalf of PayPal;
+    (d)     states that any provisions that differ from this Agreement are offered by you alone and not PayPal; and
+    (e)     states that the Software is available from you or PayPal and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.  
+
+2.  DISCLAIMER OF WARRANTY
+PAYPAL LICENSES THE SOFTWARE AND DOCUMENTATION TO YOU ONLY ON AN "AS IS" BASIS WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  PAYPAL MAKES NO WARRANTY THAT THE SOFTWARE OR DOCUMENTATION WILL BE ERROR-FREE. Each user of the Software or Documentation is solely responsible for determining the appropriateness of using and distributing the Software and Documentation and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs, or equipment, and unavailability or interruption of operations.  Use of the Software and Documentation is made with the understanding that PayPal will not provide you with any technical or customer support or maintenance.  Some states or jurisdictions do not allow the exclusion of implied warranties or limitations on how long an implied warranty may last, so the above limitations may not apply to you.  To the extent permissible, any implied warranties are limited to ninety (90) days.
+
+3.  LIMITATION OF LIABILITY
+PAYPAL AND ITS SUPPLIERS SHALL NOT BE LIABLE FOR LOSS OR DAMAGE ARISING OUT OF THIS AGREEMENT OR FROM THE USE OF THE SOFTWARE OR DOCUMENTATION.  IN NO EVENT WILL PAYPAL OR ITS SUPPLIERS BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, INCIDENTAL, OR SPECIAL DAMAGES INCLUDING LOST PROFITS, LOST SAVINGS, COSTS, FEES, OR EXPENSES OF ANY KIND ARISING OUT OF ANY PROVISION OF THIS AGREEMENT OR THE USE OR THE INABILITY TO USE THE SOFTWARE OR DOCUMENTATION, HOWEVER CAUSED AND UNDER ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY OR TORT INCLUDING NEGLIGENCE (OR OTHERWISE), EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. PAYPAL'S AGGREGATE LIABILITY AND THAT OF ITS SUPPLIERS UNDER OR IN CONNECTION WITH THIS AGREEMENT SHALL BE LIMITED TO THE AMOUNT PAID BY YOU FOR THE SOFTWARE AND DOCUMENTATION. 
+
+4.  TRADEMARK USAGE
+PayPal is a trademark PayPal, Inc. in the United States and other countries.  Such trademarks may not be used to endorse or promote any product unless expressly permitted under separate agreement with PayPal.  
+
+5.  TERM
+Your rights under this Agreement shall terminate if you fail to comply with any of the material terms or conditions of this Agreement and do not cure such failure in a reasonable period of time after becoming aware of such noncompliance.  If all your rights under this Agreement terminate, you agree to cease use and distribution of the Software and Documentation as soon as reasonably practicable. 
+
+6. GOVERNING LAW AND JURISDICTION. 
+This Agreement is governed by the statutes and laws of the State of California, without regard to the conflicts of law principles thereof.  If any part of this Agreement is found void and unenforceable, it will not affect the validity of the balance of the Agreement, which shall remain valid and enforceable according to its terms.  Any dispute arising out of or related to this Agreement shall be brought in the courts of Santa Clara County, California, USA.

MANIFEST.in

@@ -0,0 +1,2 @@
+include LICENSE
+include README.md

README.md

@@ -1 +1,107 @@
-# PayPal-Python-Server-SDK
+
+# Getting Started with Paypal Server SDK
+
+## Introduction
+
+An order represents a payment between two or more parties. Use the Orders API to create, update, retrieve, authorize, and capture orders., Call the Payments API to authorize payments, capture authorized payments, refund payments that have already been captured, and show payment information. Use the Payments API in conjunction with the <a href="/docs/api/orders/v2/">Orders API</a>. For more information, see the <a href="/docs/checkout/">PayPal Checkout Overview</a>., The Payment Method Tokens API saves payment methods so payers don't have to enter details for future transactions. Payers can check out faster or pay without being present after they agree to save a payment method.<br><br>The API associates a payment method with a temporary setup token. Pass the setup token to the API to exchange the setup token for a permanent token.<br><br>The permanent token represents a payment method that's saved to the vault. This token can be used repeatedly for checkout or recurring transactions such as subscriptions.<br><br>The Payment Method Tokens API is available in the US only.
+
+Find out more here: [https://developer.paypal.com/docs/api/orders/v2/](https://developer.paypal.com/docs/api/orders/v2/)
+
+## Install the Package
+
+The package is compatible with Python versions `3 >=3.7, <= 3.11`.
+Install the package from PyPi using the following pip command:
+
+```python
+pip install paypal-server-sdk==0.5.1
+```
+
+You can also view the package at:
+https://pypi.python.org/pypi/paypal-server-sdk/0.5.1
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/0.5.1/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| `environment` | `Environment` | The API environment. <br> **Default: `Environment.SANDBOX`** |
+| `http_client_instance` | `HttpClient` | The Http Client passed from the sdk user for making requests |
+| `override_http_client_configuration` | `bool` | The value which determines to override properties of the passed Http Client from the sdk user |
+| `http_call_back` | `HttpCallBack` | The callback value that is invoked before and after an HTTP call is made to an endpoint |
+| `timeout` | `float` | The value to use for connection timeout. <br> **Default: 60** |
+| `max_retries` | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
+| `backoff_factor` | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |
+| `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]** |
+| `retry_methods` | `Array of string` | The http methods on which retry is to be done. <br> **Default: ['GET', 'PUT']** |
+| `logging_configuration` | [`LoggingConfiguration`](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/0.5.1/doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| `client_credentials_auth_credentials` | [`ClientCredentialsAuthCredentials`](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/0.5.1/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
+
+The API client can be initialized as follows:
+
+```python
+client = PaypalserversdkClient(
+    client_credentials_auth_credentials=ClientCredentialsAuthCredentials(
+        o_auth_client_id='OAuthClientId',
+        o_auth_client_secret='OAuthClientSecret'
+    ),
+    environment=Environment.SANDBOX,
+    logging_configuration=LoggingConfiguration(
+        log_level=logging.INFO,
+        request_logging_config=RequestLoggingConfiguration(
+            log_body=True
+        ),
+        response_logging_config=ResponseLoggingConfiguration(
+            log_headers=True
+        )
+    )
+)
+```
+
+API calls return an `ApiResponse` object that includes the following fields:
+
+| Field | Description |
+|  --- | --- |
+| `status_code` | Status code of the HTTP response |
+| `reason_phrase` | Reason phrase of the HTTP response |
+| `headers` | Headers of the HTTP response as a dictionary |
+| `text` | The body of the HTTP response as a string |
+| `request` | HTTP request info |
+| `errors` | Errors, if they exist |
+| `body` | The deserialized body of the HTTP response |
+
+## Environments
+
+The SDK can be configured to use a different environment for making API calls. Available environments are:
+
+### Fields
+
+| Name | Description |
+|  --- | --- |
+| Production | PayPal Live Environment |
+| Sandbox | **Default** PayPal Sandbox Environment |
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`Oauth2 (OAuth 2 Client Credentials Grant)`](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/0.5.1/doc/auth/oauth-2-client-credentials-grant.md)
+
+## List of APIs
+
+* [Orders](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/0.5.1/doc/controllers/orders.md)
+* [Payments](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/0.5.1/doc/controllers/payments.md)
+* [Vault](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/0.5.1/doc/controllers/vault.md)
+
+## Classes Documentation
+
+* [Utility Classes](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/0.5.1/doc/utility-classes.md)
+* [HttpResponse](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/0.5.1/doc/http-response.md)
+* [HttpRequest](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/0.5.1/doc/http-request.md)
+* [LoggingConfiguration](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/0.5.1/doc/logging-configuration.md)
+* [RequestLoggingConfiguration](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/0.5.1/doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/0.5.1/doc/response-logging-configuration.md)
+* [AbstractLogger](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/0.5.1/doc/abstract-logger.md)
+

doc/abstract-logger.md

@@ -0,0 +1,47 @@
+
+# AbstractLogger Class
+
+An abstract class for custom logger implementation.
+
+## Abstract Methods
+
+| Name | Description | Return Type | Parameters | Method Signature |
+|  --- | --- | --- | --- | --- |
+| log | Logs a message with a specified log level and additional parameters. | None | 1. level (int): The log level of the message.<br>2. message (str): The message template to log.<br>3. params: (Dict[str, Any]): The parameters to include in the log message. | log(self, level, message, params) |
+
+## Usage Example
+
+### Client Initialization with Custom Logger
+
+In order to provide custom logger implementation, the `AbstractLogger` class must be inherited so that you can override the `log` behavior.
+
+```python
+import structlog
+from paypalserversdk.logging.sdk_logger import AbstractLogger
+
+
+class CustomLogger(AbstractLogger):
+
+    def __init__(self):
+        structlog.configure(
+            processors=[
+                structlog.processors.TimeStamper(fmt="iso"),
+                structlog.processors.JSONRenderer(),
+            ]
+        )
+        self._logger = structlog.get_logger()
+
+    def log(self, level, message, params):
+        self._logger.log(level, message, *params.values(), **params)
+```
+
+Following is how the custom logger implementation can be injected in the SDK client.
+
+```python
+client = PaypalserversdkClient(
+    logging_configuration=LoggingConfiguration(
+        logger=CustomLogger()
+    )
+)
+```
+

doc/auth/oauth-2-client-credentials-grant.md

@@ -0,0 +1,82 @@
+
+# OAuth 2 Client Credentials Grant
+
+
+
+Documentation for accessing and setting credentials for Oauth2.
+
+## Auth Credentials
+
+| Name | Type | Description | Getter |
+|  --- | --- | --- | --- |
+| OAuthClientId | `str` | OAuth 2 Client ID | `o_auth_client_id` |
+| OAuthClientSecret | `str` | OAuth 2 Client Secret | `o_auth_client_secret` |
+| OAuthToken | `OAuthToken` | Object for storing information about the OAuth token | `o_auth_token` |
+| OAuthTokenProvider | `Callable[[OAuthToken, OAuth2], OAuthToken]` | Registers a callback for oAuth Token Provider used for automatic token fetching/refreshing. | `o_auth_token_provider` |
+| OAuthOnTokenUpdate | `Callable[[OAuthToken], None]` | Registers a callback for token update event. | `o_auth_on_token_update` |
+| OAuthClockSkew | `int` | Clock skew time in seconds applied while checking the OAuth Token expiry. | `o_auth_clock_skew` |
+
+
+
+**Note:** Auth credentials can be set using `ClientCredentialsAuthCredentials` object, passed in as named parameter `client_credentials_auth_credentials` in the client initialization.
+
+## Usage Example
+
+### Client Initialization
+
+You must initialize the client with *OAuth 2.0 Client Credentials Grant* credentials as shown in the following code snippet. This will fetch the OAuth token automatically when any of the endpoints, requiring *OAuth 2.0 Client Credentials Grant* autentication, are called.
+
+```python
+client = PaypalserversdkClient(
+    client_credentials_auth_credentials=ClientCredentialsAuthCredentials(
+        o_auth_client_id='OAuthClientId',
+        o_auth_client_secret='OAuthClientSecret'
+    )
+)
+```
+
+
+
+Your application can also manually provide an OAuthToken using the setter `o_auth_token` in `ClientCredentialsAuthCredentials` object. This function takes in an instance of OAuthToken containing information for authorizing client requests and refreshing the token itself.
+
+### Adding OAuth Token Update Callback
+
+Whenever the OAuth Token gets updated, the provided callback implementation will be executed. For instance, you may use it to store your access token whenever it gets updated.
+
+```python
+client = PaypalserversdkClient(
+    client_credentials_auth_credentials=ClientCredentialsAuthCredentials(
+        o_auth_client_id='OAuthClientId',
+        o_auth_client_secret='OAuthClientSecret',
+        o_auth_on_token_update=(lambda o_auth_token:
+                                # Add the callback handler to perform operations like save to DB or file etc.
+                                # It will be triggered whenever the token gets updated
+                                save_token_to_database(o_auth_token))
+    )
+)
+```
+
+### Adding Custom OAuth Token Provider
+
+To authorize a client using a stored access token, set up the `o_auth_token_provider` in `ClientCredentialsAuthCredentials` along with the other auth parameters before creating the client:
+
+```python
+def _o_auth_token_provider(last_oauth_token, auth_manager):
+    # Add the callback handler to provide a new OAuth token
+    # It will be triggered whenever the last provided o_auth_token is null or expired
+    o_auth_token = load_token_from_database()
+    if o_auth_token is None:
+        o_auth_token = auth_manager.fetch_token()
+    return o_auth_token
+
+
+client = PaypalserversdkClient(
+    client_credentials_auth_credentials=ClientCredentialsAuthCredentials(
+        o_auth_client_id='OAuthClientId',
+        o_auth_client_secret='OAuthClientSecret',
+        o_auth_token_provider=_o_auth_token_provider
+    )
+)
+```
+
+