uv-apimatic-sdk 0.0.1__tar.gz

uv_apimatic_sdk-0.0.1/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2026 APIMATIC Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

uv_apimatic_sdk-0.0.1/MANIFEST.in

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

uv_apimatic_sdk-0.0.1/PKG-INFO

@@ -0,0 +1,208 @@
+Metadata-Version: 2.4
+Name: uv-apimatic-sdk
+Version: 0.0.1
+Summary: Sample SDKs for UV by APIMatic
+Author-email: Muhammad Rafay <muhammad.rafay@apimatic.io>
+Project-URL: Documentation, https://docs.upvest.co/
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: apimatic-core>=0.2.24,~=0.2.0
+Requires-Dist: apimatic-core-interfaces>=0.1.8,~=0.1.0
+Requires-Dist: apimatic-requests-client-adapter>=0.1.10,~=0.1.0
+Requires-Dist: python-dotenv<2.0,>=0.21
+Requires-Dist: deprecation~=2.1
+Provides-Extra: testutils
+Requires-Dist: pytest>=7.2.2; extra == "testutils"
+Dynamic: license-file
+
+
+# Getting Started with Upvest Investment API
+
+## Introduction
+
+Upvest Investment API.
+
+## Install the Package
+
+The package is compatible with Python versions `3.7+`.
+Install the package from PyPi using the following pip command:
+
+```bash
+pip install uv-apimatic-sdk==0.0.1
+```
+
+You can also view the package at:
+https://pypi.python.org/pypi/uv-apimatic-sdk/0.0.1
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| environment | [`Environment`](README.md#environments) | The API environment. <br> **Default: `Environment.PRODUCTION`** |
+| http_client_instance | `Union[Session, HttpClientProvider]` | 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: 30** |
+| 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, 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", "GET", "PUT"]** |
+| proxy_settings | [`ProxySettings`](doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| logging_configuration | [`LoggingConfiguration`](doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| client_credentials_auth_credentials | [`ClientCredentialsAuthCredentials`](doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
+| http_signature_credentials | [`HttpSignatureCredentials`](doc/http-signatures.md) | The key material used to sign every request with an HTTP message signature |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```python
+import logging
+
+from upvestinvestmentapi.configuration import Environment
+from upvestinvestmentapi.http.auth.oauth_2 import ClientCredentialsAuthCredentials
+from upvestinvestmentapi.http.signature import HttpSignatureCredentials
+from upvestinvestmentapi.logging.configuration.api_logging_configuration import LoggingConfiguration
+from upvestinvestmentapi.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
+from upvestinvestmentapi.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
+from upvestinvestmentapi.models.oauth_scope import OauthScope
+from upvestinvestmentapi.upvestinvestmentapi_client import UpvestinvestmentapiClient
+
+client = UpvestinvestmentapiClient(
+    client_credentials_auth_credentials=ClientCredentialsAuthCredentials(
+        oauth_client_id='OAuthClientId',
+        oauth_client_secret='OAuthClientSecret',
+        oauth_scopes=[
+            OauthScope.ACCOUNTSREAD,
+            OauthScope.ACCOUNTSADMIN
+        ]
+    ),
+    http_signature_credentials=HttpSignatureCredentials(
+        key_id='KeyId',
+        private_key_file='/path/to/upvest-http-sign-key.pem',
+        private_key_passphrase='PrivateKeyPassphrase'
+    ),
+    environment=Environment.PRODUCTION,
+    logging_configuration=LoggingConfiguration(
+        log_level=logging.INFO,
+        request_logging_config=RequestLoggingConfiguration(
+            log_body=True
+        ),
+        response_logging_config=ResponseLoggingConfiguration(
+            log_headers=True
+        )
+    )
+)
+```
+
+### Environment-Based Client Initialization
+
+```python
+from upvestinvestmentapi.upvestinvestmentapi_client import UpvestinvestmentapiClient
+
+# Specify the path to your .env file if it’s located outside the project’s root directory.
+client = UpvestinvestmentapiClient.from_environment(dotenv_path='/path/to/.env')
+```
+
+See the [Environment-Based Client Initialization](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:
+
+### Fields
+
+| Name | Description |
+|  --- | --- |
+| PRODUCTION | **Default** Sandbox environment |
+| ENVIRONMENT2 | Live environment |
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`oauth-client-credentials (OAuth 2 Client Credentials Grant)`](doc/auth/oauth-2-client-credentials-grant.md)
+
+## HTTP Signatures
+
+On top of the OAuth 2 token, every request to the Upvest Investment API has to
+carry a cryptographic signature. The SDK creates it for you once you pass
+`http_signature_credentials` to the client — see
+[HTTP Signatures](doc/http-signatures.md) for details.
+
+## List of APIs
+
+* [Access Tokens](doc/controllers/access-tokens.md)
+* [Webhook Subscriptions](doc/controllers/webhook-subscriptions.md)
+* [User Identifiers](doc/controllers/user-identifiers.md)
+* [User Checks](doc/controllers/user-checks.md)
+* [Tax Exemptions](doc/controllers/tax-exemptions.md)
+* [Tax Wrappers](doc/controllers/tax-wrappers.md)
+* [Account Groups](doc/controllers/account-groups.md)
+* [Reference Accounts](doc/controllers/reference-accounts.md)
+* [Direct Debits](doc/controllers/direct-debits.md)
+* [Credit Fundings](doc/controllers/credit-fundings.md)
+* [Cash Balance Transfers](doc/controllers/cash-balance-transfers.md)
+* [Virtual Bank Accounts](doc/controllers/virtual-bank-accounts.md)
+* [Cash Balances](doc/controllers/cash-balances.md)
+* [Price Data](doc/controllers/price-data.md)
+* [Tax Residencies](doc/controllers/tax-residencies.md)
+* [Fees Configurations](doc/controllers/fees-configurations.md)
+* [Transaction Fees Models](doc/controllers/transaction-fees-models.md)
+* [Portfolios Rebalancing](doc/controllers/portfolios-rebalancing.md)
+* [Virtual Cash Balances](doc/controllers/virtual-cash-balances.md)
+* [Savings Plans](doc/controllers/savings-plans.md)
+* [Securities Transfers](doc/controllers/securities-transfers.md)
+* [Account Transfers](doc/controllers/account-transfers.md)
+* [ISA Transfers](doc/controllers/isa-transfers.md)
+* [Business Checks](doc/controllers/business-checks.md)
+* [Files](doc/controllers/files.md)
+* [Users](doc/controllers/users.md)
+* [Accounts](doc/controllers/accounts.md)
+* [Mandates](doc/controllers/mandates.md)
+* [Top-Ups](doc/controllers/top-ups.md)
+* [Withdrawals](doc/controllers/withdrawals.md)
+* [Instruments](doc/controllers/instruments.md)
+* [Orders](doc/controllers/orders.md)
+* [Positions](doc/controllers/positions.md)
+* [Reports](doc/controllers/reports.md)
+* [Transactions](doc/controllers/transactions.md)
+* [Fees](doc/controllers/fees.md)
+* [Portfolios](doc/controllers/portfolios.md)
+* [Valuations](doc/controllers/valuations.md)
+* [Liquidations](doc/controllers/liquidations.md)
+* [Returns](doc/controllers/returns.md)
+* [Tests](doc/controllers/tests.md)
+* [Businesses](doc/controllers/businesses.md)
+* [Roles](doc/controllers/roles.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](doc/proxy-settings.md)
+* [Environment-Based Client Initialization](doc/environment-based-client-initialization.md)
+* [AbstractLogger](doc/abstract-logger.md)
+* [LoggingConfiguration](doc/logging-configuration.md)
+* [RequestLoggingConfiguration](doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](doc/response-logging-configuration.md)
+
+### HTTP
+
+* [HttpResponse](doc/http-response.md)
+* [HttpRequest](doc/http-request.md)
+* [HTTP Signatures](doc/http-signatures.md)
+
+### Utilities
+
+* [ApiResponse](doc/api-response.md)
+* [ApiHelper](doc/api-helper.md)
+* [HttpDateTime](doc/http-date-time.md)
+* [RFC3339DateTime](doc/rfc3339-date-time.md)
+* [UnixDateTime](doc/unix-date-time.md)
+

uv_apimatic_sdk-0.0.1/README.md

@@ -0,0 +1,190 @@
+
+# Getting Started with Upvest Investment API
+
+## Introduction
+
+Upvest Investment API.
+
+## Install the Package
+
+The package is compatible with Python versions `3.7+`.
+Install the package from PyPi using the following pip command:
+
+```bash
+pip install uv-apimatic-sdk==0.0.1
+```
+
+You can also view the package at:
+https://pypi.python.org/pypi/uv-apimatic-sdk/0.0.1
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| environment | [`Environment`](README.md#environments) | The API environment. <br> **Default: `Environment.PRODUCTION`** |
+| http_client_instance | `Union[Session, HttpClientProvider]` | 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: 30** |
+| 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, 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", "GET", "PUT"]** |
+| proxy_settings | [`ProxySettings`](doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| logging_configuration | [`LoggingConfiguration`](doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| client_credentials_auth_credentials | [`ClientCredentialsAuthCredentials`](doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
+| http_signature_credentials | [`HttpSignatureCredentials`](doc/http-signatures.md) | The key material used to sign every request with an HTTP message signature |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```python
+import logging
+
+from upvestinvestmentapi.configuration import Environment
+from upvestinvestmentapi.http.auth.oauth_2 import ClientCredentialsAuthCredentials
+from upvestinvestmentapi.http.signature import HttpSignatureCredentials
+from upvestinvestmentapi.logging.configuration.api_logging_configuration import LoggingConfiguration
+from upvestinvestmentapi.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
+from upvestinvestmentapi.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
+from upvestinvestmentapi.models.oauth_scope import OauthScope
+from upvestinvestmentapi.upvestinvestmentapi_client import UpvestinvestmentapiClient
+
+client = UpvestinvestmentapiClient(
+    client_credentials_auth_credentials=ClientCredentialsAuthCredentials(
+        oauth_client_id='OAuthClientId',
+        oauth_client_secret='OAuthClientSecret',
+        oauth_scopes=[
+            OauthScope.ACCOUNTSREAD,
+            OauthScope.ACCOUNTSADMIN
+        ]
+    ),
+    http_signature_credentials=HttpSignatureCredentials(
+        key_id='KeyId',
+        private_key_file='/path/to/upvest-http-sign-key.pem',
+        private_key_passphrase='PrivateKeyPassphrase'
+    ),
+    environment=Environment.PRODUCTION,
+    logging_configuration=LoggingConfiguration(
+        log_level=logging.INFO,
+        request_logging_config=RequestLoggingConfiguration(
+            log_body=True
+        ),
+        response_logging_config=ResponseLoggingConfiguration(
+            log_headers=True
+        )
+    )
+)
+```
+
+### Environment-Based Client Initialization
+
+```python
+from upvestinvestmentapi.upvestinvestmentapi_client import UpvestinvestmentapiClient
+
+# Specify the path to your .env file if it’s located outside the project’s root directory.
+client = UpvestinvestmentapiClient.from_environment(dotenv_path='/path/to/.env')
+```
+
+See the [Environment-Based Client Initialization](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:
+
+### Fields
+
+| Name | Description |
+|  --- | --- |
+| PRODUCTION | **Default** Sandbox environment |
+| ENVIRONMENT2 | Live environment |
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`oauth-client-credentials (OAuth 2 Client Credentials Grant)`](doc/auth/oauth-2-client-credentials-grant.md)
+
+## HTTP Signatures
+
+On top of the OAuth 2 token, every request to the Upvest Investment API has to
+carry a cryptographic signature. The SDK creates it for you once you pass
+`http_signature_credentials` to the client — see
+[HTTP Signatures](doc/http-signatures.md) for details.
+
+## List of APIs
+
+* [Access Tokens](doc/controllers/access-tokens.md)
+* [Webhook Subscriptions](doc/controllers/webhook-subscriptions.md)
+* [User Identifiers](doc/controllers/user-identifiers.md)
+* [User Checks](doc/controllers/user-checks.md)
+* [Tax Exemptions](doc/controllers/tax-exemptions.md)
+* [Tax Wrappers](doc/controllers/tax-wrappers.md)
+* [Account Groups](doc/controllers/account-groups.md)
+* [Reference Accounts](doc/controllers/reference-accounts.md)
+* [Direct Debits](doc/controllers/direct-debits.md)
+* [Credit Fundings](doc/controllers/credit-fundings.md)
+* [Cash Balance Transfers](doc/controllers/cash-balance-transfers.md)
+* [Virtual Bank Accounts](doc/controllers/virtual-bank-accounts.md)
+* [Cash Balances](doc/controllers/cash-balances.md)
+* [Price Data](doc/controllers/price-data.md)
+* [Tax Residencies](doc/controllers/tax-residencies.md)
+* [Fees Configurations](doc/controllers/fees-configurations.md)
+* [Transaction Fees Models](doc/controllers/transaction-fees-models.md)
+* [Portfolios Rebalancing](doc/controllers/portfolios-rebalancing.md)
+* [Virtual Cash Balances](doc/controllers/virtual-cash-balances.md)
+* [Savings Plans](doc/controllers/savings-plans.md)
+* [Securities Transfers](doc/controllers/securities-transfers.md)
+* [Account Transfers](doc/controllers/account-transfers.md)
+* [ISA Transfers](doc/controllers/isa-transfers.md)
+* [Business Checks](doc/controllers/business-checks.md)
+* [Files](doc/controllers/files.md)
+* [Users](doc/controllers/users.md)
+* [Accounts](doc/controllers/accounts.md)
+* [Mandates](doc/controllers/mandates.md)
+* [Top-Ups](doc/controllers/top-ups.md)
+* [Withdrawals](doc/controllers/withdrawals.md)
+* [Instruments](doc/controllers/instruments.md)
+* [Orders](doc/controllers/orders.md)
+* [Positions](doc/controllers/positions.md)
+* [Reports](doc/controllers/reports.md)
+* [Transactions](doc/controllers/transactions.md)
+* [Fees](doc/controllers/fees.md)
+* [Portfolios](doc/controllers/portfolios.md)
+* [Valuations](doc/controllers/valuations.md)
+* [Liquidations](doc/controllers/liquidations.md)
+* [Returns](doc/controllers/returns.md)
+* [Tests](doc/controllers/tests.md)
+* [Businesses](doc/controllers/businesses.md)
+* [Roles](doc/controllers/roles.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](doc/proxy-settings.md)
+* [Environment-Based Client Initialization](doc/environment-based-client-initialization.md)
+* [AbstractLogger](doc/abstract-logger.md)
+* [LoggingConfiguration](doc/logging-configuration.md)
+* [RequestLoggingConfiguration](doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](doc/response-logging-configuration.md)
+
+### HTTP
+
+* [HttpResponse](doc/http-response.md)
+* [HttpRequest](doc/http-request.md)
+* [HTTP Signatures](doc/http-signatures.md)
+
+### Utilities
+
+* [ApiResponse](doc/api-response.md)
+* [ApiHelper](doc/api-helper.md)
+* [HttpDateTime](doc/http-date-time.md)
+* [RFC3339DateTime](doc/rfc3339-date-time.md)
+* [UnixDateTime](doc/unix-date-time.md)
+

uv_apimatic_sdk-0.0.1/pyproject.toml

@@ -0,0 +1,25 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+[project]
+name = "uv-apimatic-sdk"
+description = "Sample SDKs for UV by APIMatic"
+version = "0.0.1"
+readme = "README.md"
+keywords = []
+dependencies = ["apimatic-core~=0.2.0, >= 0.2.24", "apimatic-core-interfaces~=0.1.0, >= 0.1.8", "apimatic-requests-client-adapter~=0.1.0, >= 0.1.10", "python-dotenv>=0.21, <2.0", "deprecation~=2.1"]
+classifiers = []
+requires-python = ">=3.7"
+[[project.authors]]
+name = "Muhammad Rafay"
+email = "muhammad.rafay@apimatic.io"
+
+[project.urls]
+Documentation = "https://docs.upvest.co/"
+[project.optional-dependencies]
+testutils = ["pytest>=7.2.2"]
+[tool]
+[tool.setuptools]
+[tool.setuptools.packages]
+[tool.setuptools.packages.find]
+exclude = ["tests", "tests.*"]

uv_apimatic_sdk-0.0.1/setup.cfg

@@ -0,0 +1,8 @@
+[meta-data]
+license_files = 
+	LICENSE
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

uv_apimatic_sdk-0.0.1/upvestinvestmentapi/__init__.py

@@ -0,0 +1,13 @@
+# ruff: noqa: D104 | Missing docstring in public package
+# ruff: noqa: RUF022 | `__all__` is not sorted
+__all__ = [
+    "api_helper",
+    "apis",
+    "configuration",
+    "exceptions",
+    "http",
+    "logging",
+    "models",
+    "upvestinvestmentapi_client",
+    "utilities",
+]

uv_apimatic_sdk-0.0.1/upvestinvestmentapi/api_helper.py

@@ -0,0 +1,19 @@
+"""
+upvestinvestmentapi
+
+This file was automatically generated by APIMATIC v3.0 (
+ https://www.apimatic.io ).
+"""
+
+from apimatic_core.utilities.api_helper import ApiHelper as CoreApiHelper
+
+
+class APIHelper(CoreApiHelper):
+    """
+    A Helper Class for various functions associated with API Calls.
+
+    This class contains static methods for operations that need to be
+    performed during API requests. All of the methods inside this class are
+    static methods, there is no need to ever initialise an instance of this
+    class.
+    """

uv_apimatic_sdk-0.0.1/upvestinvestmentapi/apis/__init__.py

@@ -0,0 +1,49 @@
+# ruff: noqa: D104 | Missing docstring in public package
+# ruff: noqa: RUF022 | `__all__` is not sorted
+__all__ = [
+    "access_tokens_api",
+    "account_groups_api",
+    "account_transfers_api",
+    "accounts_api",
+    "base_api",
+    "business_checks_api",
+    "businesses_api",
+    "cash_balance_transfers_api",
+    "cash_balances_api",
+    "credit_fundings_api",
+    "direct_debits_api",
+    "fees_api",
+    "fees_configurations_api",
+    "files_api",
+    "instruments_api",
+    "isa_transfers_api",
+    "liquidations_api",
+    "mandates_api",
+    "oauth_authorization_api",
+    "orders_api",
+    "portfolios_api",
+    "portfolios_rebalancing_api",
+    "positions_api",
+    "price_data_api",
+    "reference_accounts_api",
+    "reports_api",
+    "returns_api",
+    "roles_api",
+    "savings_plans_api",
+    "securities_transfers_api",
+    "tax_exemptions_api",
+    "tax_residencies_api",
+    "tax_wrappers_api",
+    "tests_api",
+    "top_ups_api",
+    "transaction_fees_models_api",
+    "transactions_api",
+    "user_checks_api",
+    "user_identifiers_api",
+    "users_api",
+    "valuations_api",
+    "virtual_bank_accounts_api",
+    "virtual_cash_balances_api",
+    "webhook_subscriptions_api",
+    "withdrawals_api",
+]