Automated commit message

Author: PayPalServerSDKs

README.md

@@ -23,15 +23,15 @@ The package is compatible with Python versions `3.7+`.
 Install the package from PyPi using the following pip command:
 
 ```bash
-pip install paypal-server-sdk==2.0.0
+pip install paypal-server-sdk==2.1.0
 ```
 
 You can also view the package at:
-https://pypi.python.org/pypi/paypal-server-sdk/2.0.0
+https://pypi.python.org/pypi/paypal-server-sdk/2.1.0
 
 ## Initialize the API Client
 
-**_Note:_** Documentation for the client can be found [here.](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.0.0/doc/client.md)
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.1.0/doc/client.md)
 
 The following parameters are configurable for the API Client:
 
@@ -46,12 +46,14 @@ The following parameters are configurable for the API Client:
 | 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']** |
-| proxy_settings | [`ProxySettings`](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.0.0/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
-| logging_configuration | [`LoggingConfiguration`](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.0.0/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/2.0.0/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
+| proxy_settings | [`ProxySettings`](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.1.0/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| logging_configuration | [`LoggingConfiguration`](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.1.0/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/2.1.0/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:
 
+### Code-Based Client Initialization
+
 ```python
 import logging
 
@@ -80,6 +82,17 @@ client = PaypalServersdkClient(
 )
 ```
 
+### Environment-Based Client Initialization
+
+```python
+from paypalserversdk.paypal_serversdk_client import PaypalServersdkClient
+
+# Specify the path to your .env file if it’s located outside the project’s root directory.
+client = PaypalServersdkClient.from_environment(dotenv_path='/path/to/.env')
+```
+
+See the [Environment-Based Client Initialization](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.1.0/doc/environment-based-client-initialization.md) section for details.
+
 ## Environments
 
 The SDK can be configured to use a different environment for making API calls. Available environments are:
@@ -95,36 +108,37 @@ 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-Python-Server-SDK/tree/2.0.0/doc/auth/oauth-2-client-credentials-grant.md)
+* [`Oauth2 (OAuth 2 Client Credentials Grant)`](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.1.0/doc/auth/oauth-2-client-credentials-grant.md)
 
 ## List of APIs
 
-* [Transactionsearch](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.0.0/doc/controllers/transactionsearch.md)
-* [Orders](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.0.0/doc/controllers/orders.md)
-* [Payments](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.0.0/doc/controllers/payments.md)
-* [Vault](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.0.0/doc/controllers/vault.md)
-* [Subscriptions](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.0.0/doc/controllers/subscriptions.md)
+* [Orders](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.1.0/doc/controllers/orders.md)
+* [Payments](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.1.0/doc/controllers/payments.md)
+* [Vault](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.1.0/doc/controllers/vault.md)
+* [Transaction Search](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.1.0/doc/controllers/transaction-search.md)
+* [Subscriptions](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.1.0/doc/controllers/subscriptions.md)
 
 ## SDK Infrastructure
 
 ### Configuration
 
-* [ProxySettings](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.0.0/doc/proxy-settings.md)
-* [AbstractLogger](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.0.0/doc/abstract-logger.md)
-* [LoggingConfiguration](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.0.0/doc/logging-configuration.md)
-* [RequestLoggingConfiguration](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.0.0/doc/request-logging-configuration.md)
-* [ResponseLoggingConfiguration](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.0.0/doc/response-logging-configuration.md)
+* [ProxySettings](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.1.0/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.1.0/doc/environment-based-client-initialization.md)
+* [AbstractLogger](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.1.0/doc/abstract-logger.md)
+* [LoggingConfiguration](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.1.0/doc/logging-configuration.md)
+* [RequestLoggingConfiguration](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.1.0/doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.1.0/doc/response-logging-configuration.md)
 
 ### HTTP
 
-* [HttpResponse](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.0.0/doc/http-response.md)
-* [HttpRequest](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.0.0/doc/http-request.md)
+* [HttpResponse](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.1.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.1.0/doc/http-request.md)
 
 ### Utilities
 
-* [ApiResponse](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.0.0/doc/api-response.md)
-* [ApiHelper](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.0.0/doc/api-helper.md)
-* [HttpDateTime](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.0.0/doc/http-date-time.md)
-* [RFC3339DateTime](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.0.0/doc/rfc3339-date-time.md)
-* [UnixDateTime](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.0.0/doc/unix-date-time.md)
+* [ApiResponse](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.1.0/doc/api-response.md)
+* [ApiHelper](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.1.0/doc/api-helper.md)
+* [HttpDateTime](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.1.0/doc/http-date-time.md)
+* [RFC3339DateTime](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.1.0/doc/rfc3339-date-time.md)
+* [UnixDateTime](https://www.github.com/paypal/PayPal-Python-Server-SDK/tree/2.1.0/doc/unix-date-time.md)
 

doc/client.md

@@ -20,6 +20,8 @@ The following parameters are configurable for the API Client:
 
 The API client can be initialized as follows:
 
+## Code-Based Client Initialization
+
 ```python
 import logging
 
@@ -48,6 +50,17 @@ client = PaypalServersdkClient(
 )
 ```
 
+## Environment-Based Client Initialization
+
+```python
+from paypalserversdk.paypal_serversdk_client import PaypalServersdkClient
+
+# Specify the path to your .env file if it’s located outside the project’s root directory.
+client = PaypalServersdkClient.from_environment(dotenv_path='/path/to/.env')
+```
+
+See the [Environment-Based Client Initialization](../doc/environment-based-client-initialization.md) section for details.
+
 ## PayPal Server SDK Client
 
 The gateway for the SDK. This class acts as a factory for the Controllers and also holds the configuration of the SDK.

doc/controllers/transactionsearch.md renamed to doc/controllers/transaction-search.md

@@ -1,17 +1,19 @@
-# Transactionsearch
+# Transaction Search
+
+Use the `/transactions` resource to list transactions and the `/balances` resource to list balances.
 
 ```python
-transactionsearch_controller = client.transactionsearch
+transaction_search_controller = client.transaction_search
 ```
 
 ## Class Name
 
-`TransactionsearchController`
+`TransactionSearchController`
 
 ## Methods
 
-* [Search Transactions](../../doc/controllers/transactionsearch.md#search-transactions)
-* [Search Balances](../../doc/controllers/transactionsearch.md#search-balances)
+* [Search Transactions](../../doc/controllers/transaction-search.md#search-transactions)
+* [Search Balances](../../doc/controllers/transaction-search.md#search-balances)
 
 
 # Search Transactions

doc/environment-based-client-initialization.md

@@ -0,0 +1,74 @@
+
+# Environment-Based Client Initialization
+
+The SDK client can also be initialized directly from environment variables using the `from_environment()` class method. This allows the SDK to automatically read configuration values from the runtime environment or a .env file.
+
+## Example
+
+```python
+from paypalserversdk.paypal_serversdk_client import PaypalServersdkClient
+
+# Specify the path to your .env file if it’s located outside the project’s root directory.
+client = PaypalServersdkClient.from_environment(dotenv_path='/path/to/.env')
+```
+
+You can also specify a path to a `.env` file by passing it to the `from_environment()` method:
+
+The same method can accept keyword arguments to override any values read from the environment, and the arguments to override values should follow the same approach as code-based client initialization.
+
+```python
+from paypalserversdk.paypal_serversdk_client import PaypalServersdkClient
+
+client = PaypalServersdkClient.from_environment(
+    dotenv_path='/path/to/.env',
+    timeout=0,  # overrides timeout from environment variable
+)
+```
+
+Values provided through arguments take precedence over those defined in environment variables.
+
+## Example `.env` File
+
+```python
+ENVIRONMENT=sandbox
+
+O_AUTH_CLIENT_ID=ExampleOAuthClientId
+O_AUTH_CLIENT_SECRET=ExampleOAuthClientSecret
+O_AUTH_CLOCK_SKEW=5
+
+TIMEOUT=60
+MAX_RETRIES=3
+BACKOFF_FACTOR=2
+RETRY_STATUSES=408,413
+RETRY_METHODS=GET,PUT,DELETE
+
+# Logging Configuration
+LOG_LEVEL=DEBUG
+MASK_SENSITIVE_HEADERS=true
+
+# Request Logging Configuration
+REQUEST_LOG_BODY=true
+REQUEST_LOG_HEADERS=true
+REQUEST_INCLUDE_QUERY_IN_PATH=true
+REQUEST_HEADERS_TO_INCLUDE=Content-Type,X-Request-ID
+REQUEST_HEADERS_TO_EXCLUDE=Authorization
+REQUEST_HEADERS_TO_UNMASK=X-Request-ID
+
+# Response Logging Configuration
+RESPONSE_LOG_BODY=true
+RESPONSE_LOG_HEADERS=true
+RESPONSE_HEADERS_TO_INCLUDE=Content-Type,X-Correlation-ID,Date,Server
+RESPONSE_HEADERS_TO_EXCLUDE=Set-Cookie,Authorization,X-API-Key
+RESPONSE_HEADERS_TO_UNMASK=X-Correlation-ID
+
+# Proxy Configuration
+PROXY_ADDRESS=http://localhost:3000
+PROXY_PORT=8080
+PROXY_USERNAME=username
+PROXY_PASSWORD=password
+```
+
+## Note
+
+- If an environment variable is not defined, the default SDK configuration value will be used.
+

doc/models/order-tracker-request.md

@@ -25,7 +25,7 @@ The tracking details of an order.
   "capture_id": "capture_id0",
   "notify_payer": false,
   "tracking_number": "tracking_number6",
-  "carrier": "ZELERIS",
+  "carrier": "ACS_GR",
   "carrier_name_other": "carrier_name_other0",
   "items": [
     {

doc/models/shipment-carrier.md

@@ -1423,4 +1423,5 @@ The carrier for the shipment. Some carriers have a global version as well as loc
 | `SWIFTX` | Swiftx. |
 | `SFYDEXPRESS` | Sfyd Express. |
 | `TOPTRANS` | Toptrans. |
+| `OTHER` | Other. |
 

paypalserversdk/configuration.py

@@ -7,7 +7,11 @@
  https://www.apimatic.io ).
 """
 
+import os
+from dotenv import load_dotenv
+from paypalserversdk.http.proxy_settings import ProxySettings
 from enum import Enum
+from paypalserversdk.logging.configuration.api_logging_configuration import LoggingConfiguration
 from apimatic_core.http.configurations.http_client_configuration import HttpClientConfiguration
 from apimatic_requests_client_adapter.requests_client import RequestsClient
 
@@ -19,11 +23,65 @@ class Environment(Enum):
     # PayPal Sandbox Environment
     SANDBOX = 1
 
+    @classmethod
+    def from_value(cls, value, default=None):
+        """
+        Convert a value (string or int) to an Environment enum member.
+
+        Args:
+            value (Union[str, int]): The value to convert.
+            default (Environment): The fallback enum member if conversion fails.
+
+        Returns:
+            Environment: Matching enum member or fallback if invalid.
+        """
+        if value is None:
+            return default
+
+        # Try to match directly by enum member
+        if isinstance(value, cls):
+            return value
+
+        # Handle integer or string conversion
+        for member in cls:
+            if str(member.value).lower() == str(value).lower() or member.name.lower() == str(value).lower():
+                return member
+
+        # Fallback to provided default
+        return default
+
 
 class Server(Enum):
     """An enum for API servers"""
     DEFAULT = 0
 
+    @classmethod
+    def from_value(cls, value, default=None):
+        """
+        Convert a value (string or int) to an Server enum member.
+
+        Args:
+            value (Union[str, int]): The value to convert.
+            default (Server): The fallback enum member if conversion fails.
+
+        Returns:
+            Server: Matching enum member or fallback if invalid.
+        """
+        if value is None:
+            return default
+
+        # Try to match directly by enum member
+        if isinstance(value, cls):
+            return value
+
+        # Handle integer or string conversion
+        for member in cls:
+            if str(member.value).lower() == str(value).lower() or member.name.lower() == str(value).lower():
+                return member
+
+        # Fallback to provided default
+        return default
+
 
 class Configuration(HttpClientConfiguration):
     """A class used for configuring the SDK by a user.
@@ -129,3 +187,46 @@ def get_base_uri(self, server=Server.DEFAULT):
 
         """
         return self.environments[self.environment][server]
+
+    @classmethod
+    def from_environment(cls, dotenv_path=None, **overrides):
+        """
+        Creates a Configuration object using values from a .env file, environment variables, and optional overrides.
+
+        Args:
+            dotenv_path (str, optional): Path to the .env file to load. If None, the default .env file is used.
+            **overrides: Additional configuration values to override those loaded from the .env file and environment variables.
+
+        Returns:
+            Configuration: A configuration object populated with the resolved values.
+        """
+
+        # load .env automatically
+        load_dotenv(dotenv_path or None, override=True)
+
+        override_http_client_configuration = os.getenv('OVERRIDE_HTTP_CLIENT_CONFIGURATION', 'false').lower() == 'true'
+        timeout = int(os.getenv('TIMEOUT', '60'))
+        max_retries = int(os.getenv('MAX_RETRIES', '0'))
+        backoff_factor = float(os.getenv('BACKOFF_FACTOR', '2'))
+        statuses = os.getenv('RETRY_STATUSES', None)
+        retry_statuses = [int(v.strip()) for v in statuses.split(',') if v.strip().isdigit()] if statuses else None
+        methods = os.getenv('RETRY_METHODS', None)
+        retry_methods = [v.strip() for v in methods.split(',') if v.strip()] if methods else None
+        environment = Environment.from_value(os.getenv('ENVIRONMENT'), Environment.SANDBOX)
+
+        from paypalserversdk.http.auth.o_auth_2 import ClientCredentialsAuthCredentials
+        # Preparing default configuration
+        default_config = cls(
+            override_http_client_configuration=override_http_client_configuration,
+            timeout=timeout,
+            max_retries=max_retries,
+            backoff_factor=backoff_factor,
+            retry_statuses=retry_statuses,
+            retry_methods=retry_methods,
+            environment=environment,
+            proxy_settings=ProxySettings.from_environment(),
+            logging_configuration=LoggingConfiguration.from_environment(),
+            client_credentials_auth_credentials=ClientCredentialsAuthCredentials.from_environment()
+        )
+
+        return default_config.clone_with(**overrides)

paypalserversdk/controllers/base_controller.py

@@ -30,7 +30,7 @@ class BaseController(object):
 
     @staticmethod
     def user_agent():
-        return 'PayPal REST API Python SDK, Version: 2.0.0, on OS {os-info}'
+        return 'PayPal REST API Python SDK, Version: 2.1.0, on OS {os-info}'
 
     @staticmethod
     def user_agent_parameters():