Metadata-Version: 2.4
Name: apimatic-bcd-travel-sdk
Version: 0.0.2
Summary: This is a Sample API generated by APIMatic
Author-email: developer sdksio <developer+sdksio@apimatic.io>
Project-URL: Documentation, https://apimatic.io
Keywords: Apimatic,sdksio
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
Provides-Extra: testutils
Requires-Dist: pytest>=7.2.2; extra == "testutils"
Dynamic: license-file


# Getting Started with ASB 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 apimatic-bcd-travel-sdk==0.0.2
```

You can also view the package at:
https://pypi.python.org/pypi/apimatic-bcd-travel-sdk/0.0.2

## Test the SDK

You can test the generated SDK and the server with test cases. `unittest` is used as the testing framework and `pytest` is used as the test runner. You can run the tests as follows:

Navigate to the root directory of the SDK and run the following commands


pip install -r test-requirements.txt
pytest


## Initialize the API Client

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

The following parameters are configurable for the API Client:

| Parameter | Type | Description |
|  --- | --- | --- |
| version | `str` | *Default*: `"DefaultParameterValue"` |
| environment | [`Environment`](https://www.github.com/sdks-io/apimatic-bcd-travel-python-sdk/tree/0.0.2/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: 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"]** |
| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/apimatic-bcd-travel-python-sdk/tree/0.0.2/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |

The API client can be initialized as follows:

### Code-Based Client Initialization

```python
from asbapi.asbapi_client import AsbapiClient
from asbapi.configuration import Environment

client = AsbapiClient(
    environment=Environment.PRODUCTION,
    version='DefaultParameterValue'
)
```

### Environment-Based Client Initialization

```python
from asbapi.asbapi_client import AsbapiClient

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

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

## List of APIs

* [Hotels](https://www.github.com/sdks-io/apimatic-bcd-travel-python-sdk/tree/0.0.2/doc/controllers/hotels.md)
* [Cars](https://www.github.com/sdks-io/apimatic-bcd-travel-python-sdk/tree/0.0.2/doc/controllers/cars.md)
* [Air-Fare-Search-Simple](https://www.github.com/sdks-io/apimatic-bcd-travel-python-sdk/tree/0.0.2/doc/controllers/air-fare-search-simple.md)
* [Air-Fare-Search-Select-Seat](https://www.github.com/sdks-io/apimatic-bcd-travel-python-sdk/tree/0.0.2/doc/controllers/air-fare-search-select-seat.md)
* [Air-Fare-Search-Optional-Services](https://www.github.com/sdks-io/apimatic-bcd-travel-python-sdk/tree/0.0.2/doc/controllers/air-fare-search-optional-services.md)
* [Air-Availability-Return-Flight](https://www.github.com/sdks-io/apimatic-bcd-travel-python-sdk/tree/0.0.2/doc/controllers/air-availability-return-flight.md)
* [Air](https://www.github.com/sdks-io/apimatic-bcd-travel-python-sdk/tree/0.0.2/doc/controllers/air.md)
* [V2 1](https://www.github.com/sdks-io/apimatic-bcd-travel-python-sdk/tree/0.0.2/doc/controllers/v2-1.md)
* [V2 0](https://www.github.com/sdks-io/apimatic-bcd-travel-python-sdk/tree/0.0.2/doc/controllers/v2-0.md)

## SDK Infrastructure

### Configuration

* [ProxySettings](https://www.github.com/sdks-io/apimatic-bcd-travel-python-sdk/tree/0.0.2/doc/proxy-settings.md)
* [Environment-Based Client Initialization](https://www.github.com/sdks-io/apimatic-bcd-travel-python-sdk/tree/0.0.2/doc/environment-based-client-initialization.md)

### HTTP

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

### Utilities

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

