Metadata-Version: 2.4
Name: xero-apimatic-sdk
Version: 1.0.0
Summary: Xero APIMatic SDKs
Author-email: Muhammad Rafay <muhammad.rafay@apimatic.io>
Project-URL: Documentation, https://developer.xero.com/
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 XERO APIs

## Introduction

The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc., The Bank Feeds API is a closed API that is only available to financial institutions that have an established financial services partnership with Xero. If you're an existing financial services partner that wants access, contact your local Partner Manager. If you're a financial institution who wants to provide bank feeds to your business customers, contact us to become a financial services partner., These endpoints are related to managing authentication tokens and identity for Xero API, This is the Xero Projects 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 xero-apimatic-sdk==1.0.0
```

You can also view the package at:
https://pypi.python.org/pypi/xero-apimatic-sdk/1.0.0

## Initialize the API Client

**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/xero-apimatic-python-sdk/tree/1.0.0/doc/client.md)

The following parameters are configurable for the API Client:

| Parameter | Type | Description |
|  --- | --- | --- |
| environment | [`Environment`](https://www.github.com/sdks-io/xero-apimatic-python-sdk/tree/1.0.0/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]** |
| 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/sdks-io/xero-apimatic-python-sdk/tree/1.0.0/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/xero-apimatic-python-sdk/tree/1.0.0/doc/logging-configuration.md) | The SDK logging configuration for API calls |
| oauth_2_credentials | [`Oauth2Credentials`](https://www.github.com/sdks-io/xero-apimatic-python-sdk/tree/1.0.0/doc/auth/oauth-2-authorization-code-grant.md) | The credential object for OAuth 2 Authorization Code Grant |
| basic_auth_credentials | [`BasicAuthCredentials`](https://www.github.com/sdks-io/xero-apimatic-python-sdk/tree/1.0.0/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |

The API client can be initialized as follows:

### Code-Based Client Initialization

```python
import logging

from xeroapis.configuration import Environment
from xeroapis.http.auth.basic_auth import BasicAuthCredentials
from xeroapis.http.auth.oauth_2 import Oauth2Credentials
from xeroapis.logging.configuration.api_logging_configuration import LoggingConfiguration
from xeroapis.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from xeroapis.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from xeroapis.models.oauth_scope_oauth_2 import OauthScopeOauth2
from xeroapis.xeroapis_client import XeroapisClient

client = XeroapisClient(
    oauth_2_credentials=Oauth2Credentials(
        oauth_client_id='OAuthClientId',
        oauth_client_secret='OAuthClientSecret',
        oauth_redirect_uri='OAuthRedirectUri',
        oauth_scopes=[
            OauthScopeOauth2.EMAIL,
            OauthScopeOauth2.OPENID
        ]
    ),
    basic_auth_credentials=BasicAuthCredentials(
        username='Username',
        password='Password'
    ),
    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 xeroapis.xeroapis_client import XeroapisClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = XeroapisClient.from_environment(dotenv_path='/path/to/.env')
```

See the [Environment-Based Client Initialization](https://www.github.com/sdks-io/xero-apimatic-python-sdk/tree/1.0.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:

### Fields

| Name | Description |
|  --- | --- |
| PRODUCTION | **Default** The Xero Accounting API exposes accounting and related functions of the main Xero application and can be used for a variety of purposes such as creating transactions like invoices and credit notes, right through to extracting accounting data via our reports endpoint., Xero API servers, Xero Bank Feeds API base url, Xero Identity service API, Xero API server for projects |

## Authorization

This API uses the following authentication schemes.

* [`OAuth2 (OAuth 2 Authorization Code Grant)`](https://www.github.com/sdks-io/xero-apimatic-python-sdk/tree/1.0.0/doc/auth/oauth-2-authorization-code-grant.md)
* [`BasicAuth (Basic Authentication)`](https://www.github.com/sdks-io/xero-apimatic-python-sdk/tree/1.0.0/doc/auth/basic-authentication.md)

## List of APIs

* [Accounting](https://www.github.com/sdks-io/xero-apimatic-python-sdk/tree/1.0.0/doc/controllers/accounting.md)
* [Asset](https://www.github.com/sdks-io/xero-apimatic-python-sdk/tree/1.0.0/doc/controllers/asset.md)
* [Bank Feeds](https://www.github.com/sdks-io/xero-apimatic-python-sdk/tree/1.0.0/doc/controllers/bank-feeds.md)
* [Identity](https://www.github.com/sdks-io/xero-apimatic-python-sdk/tree/1.0.0/doc/controllers/identity.md)
* [Project](https://www.github.com/sdks-io/xero-apimatic-python-sdk/tree/1.0.0/doc/controllers/project.md)

## SDK Infrastructure

### Configuration

* [ProxySettings](https://www.github.com/sdks-io/xero-apimatic-python-sdk/tree/1.0.0/doc/proxy-settings.md)
* [Environment-Based Client Initialization](https://www.github.com/sdks-io/xero-apimatic-python-sdk/tree/1.0.0/doc/environment-based-client-initialization.md)
* [AbstractLogger](https://www.github.com/sdks-io/xero-apimatic-python-sdk/tree/1.0.0/doc/abstract-logger.md)
* [LoggingConfiguration](https://www.github.com/sdks-io/xero-apimatic-python-sdk/tree/1.0.0/doc/logging-configuration.md)
* [RequestLoggingConfiguration](https://www.github.com/sdks-io/xero-apimatic-python-sdk/tree/1.0.0/doc/request-logging-configuration.md)
* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/xero-apimatic-python-sdk/tree/1.0.0/doc/response-logging-configuration.md)

### HTTP

* [HttpResponse](https://www.github.com/sdks-io/xero-apimatic-python-sdk/tree/1.0.0/doc/http-response.md)
* [HttpRequest](https://www.github.com/sdks-io/xero-apimatic-python-sdk/tree/1.0.0/doc/http-request.md)

### Utilities

* [ApiResponse](https://www.github.com/sdks-io/xero-apimatic-python-sdk/tree/1.0.0/doc/api-response.md)
* [ApiHelper](https://www.github.com/sdks-io/xero-apimatic-python-sdk/tree/1.0.0/doc/api-helper.md)
* [HttpDateTime](https://www.github.com/sdks-io/xero-apimatic-python-sdk/tree/1.0.0/doc/http-date-time.md)
* [RFC3339DateTime](https://www.github.com/sdks-io/xero-apimatic-python-sdk/tree/1.0.0/doc/rfc3339-date-time.md)
* [UnixDateTime](https://www.github.com/sdks-io/xero-apimatic-python-sdk/tree/1.0.0/doc/unix-date-time.md)

