Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/speakeasy-sdks/akaris-hotel-python

A python SDK for accessing the akaris-backend API.
https://github.com/speakeasy-sdks/akaris-hotel-python
Last synced: 2 days ago
JSON representation
A python SDK for accessing the akaris-backend API.
Host: GitHub
URL: https://github.com/speakeasy-sdks/akaris-hotel-python
Owner: speakeasy-sdks
License: mit
Created: 2023-10-06T03:51:14.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-04-02T21:46:33.000Z (7 months ago)
Last Synced: 2024-04-28T05:14:36.410Z (6 months ago)
Language: Python
Size: 893 KB
Stars: 0
Watchers: 5
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project

README

        # akaris-backend



    

    

    



## SDK Installation

```bash

pip install git+https://github.com/speakeasy-sdks/akaris-hotel-python.git

```

## SDK Example Usage

### Example

```python

import akaris_backend

from akaris_backend.models import operations, shared

s = akaris_backend.AkarisBackend(

    security=shared.Security(

        o_auth2="Bearer ",

    ),

)

req = operations.CreateHotelAvailabilityRequest(

    catalog_offerings_query_request_hospitality_wrapper=shared.CatalogOfferingsQueryRequestHospitalityWrapper(),

)

res = s.hotel_availability.create_hotel_availability(req)

if res.catalog_offerings_hospitality_response_wrapper is not None:

    # handle response

    pass

```

## Available Resources and Operations

### [hotel_availability](docs/sdks/hotelavailability/README.md)

* [create_hotel_availability](docs/sdks/hotelavailability/README.md#create_hotel_availability) - Request hotel availability

* [hotel_availability_from_properties](docs/sdks/hotelavailability/README.md#hotel_availability_from_properties) - Request hotel availability from precision search response

### [reservation_hotel](docs/sdks/reservationhotel/README.md)

* [build_hotel_reservation](docs/sdks/reservationhotel/README.md#build_hotel_reservation) - Single payload booking request

* [cancel_hotel_offer](docs/sdks/reservationhotel/README.md#cancel_hotel_offer) - Cancel an Offer within a Reservation

* [create_hotel_reservation](docs/sdks/reservationhotel/README.md#create_hotel_reservation) - Create a reservation

* [retrieve_hotel_reservation](docs/sdks/reservationhotel/README.md#retrieve_hotel_reservation) - Retrieve a Reservation

* [update_hotel_reservation](docs/sdks/reservationhotel/README.md#update_hotel_reservation) - Update a reservation

### [hotel_rules](docs/sdks/hotelrules/README.md)

* [build_from_catalog_offerings](docs/sdks/hotelrules/README.md#build_from_catalog_offerings) - To be deprecated and replaced with buildfromcatalogoffering

* [build_hotel_rules_from_catalog_offering](docs/sdks/hotelrules/README.md#build_hotel_rules_from_catalog_offering) - Available January 2023. Build rules by referenceing availability response

* [create_hotel_rules](docs/sdks/hotelrules/README.md#create_hotel_rules) - Full Payload hotel rules request

### [search_hotel](docs/sdks/searchhotel/README.md)

* [create](docs/sdks/searchhotel/README.md#create) - Search hotels by property ID

* [get_properties_detail](docs/sdks/searchhotel/README.md#get_properties_detail) - Request hotel details

* [get_properties_page](docs/sdks/searchhotel/README.md#get_properties_page) - Return additional search results (pagination)

* [search_properties](docs/sdks/searchhotel/README.md#search_properties) - Search hotels by location

### [precision_search_hotel](docs/sdks/precisionsearchhotel/README.md)

* [create_precision](docs/sdks/precisionsearchhotel/README.md#create_precision) - Precision Search hotels by property ID

* [precision_search_properties](docs/sdks/precisionsearchhotel/README.md#precision_search_properties) - Search hotels by location

## Error Handling

Handling errors in this SDK should largely match your expectations.  All operations return a response object or raise an error.  If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.

| Error Object            | Status Code             | Content Type            |

| ----------------------- | ----------------------- | ----------------------- |

| errors.BaseResponse     | 400,401,402,403,404,500 | application/json        |

| errors.SDKError         | 4x-5xx                  | */*                     |

### Example

```python

import akaris_backend

from akaris_backend.models import errors, operations, shared

s = akaris_backend.AkarisBackend(

    security=shared.Security(

        o_auth2="Bearer ",

    ),

)

req = operations.CreateHotelAvailabilityRequest(

    catalog_offerings_query_request_hospitality_wrapper=shared.CatalogOfferingsQueryRequestHospitalityWrapper(),

)

res = None

try:

    res = s.hotel_availability.create_hotel_availability(req)

except errors.BaseResponse as e:

    # handle exception

    raise(e)

except errors.SDKError as e:

    # handle exception

    raise(e)

if res.catalog_offerings_hospitality_response_wrapper is not None:

    # handle response

    pass

```

## Server Selection

### Select Server by Index

You can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

| # | Server | Variables |

| - | ------ | --------- |

| 0 | `https://api.pp.travelport.com/11/hotel` | None |

| 1 | `https://api.travelport.com/11/hotel` | None |

#### Example

```python

import akaris_backend

from akaris_backend.models import operations, shared

s = akaris_backend.AkarisBackend(

    server_idx=1,

    security=shared.Security(

        o_auth2="Bearer ",

    ),

)

req = operations.CreateHotelAvailabilityRequest(

    catalog_offerings_query_request_hospitality_wrapper=shared.CatalogOfferingsQueryRequestHospitalityWrapper(),

)

res = s.hotel_availability.create_hotel_availability(req)

if res.catalog_offerings_hospitality_response_wrapper is not None:

    # handle response

    pass

```

### Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:

```python

import akaris_backend

from akaris_backend.models import operations, shared

s = akaris_backend.AkarisBackend(

    server_url="https://api.pp.travelport.com/11/hotel",

    security=shared.Security(

        o_auth2="Bearer ",

    ),

)

req = operations.CreateHotelAvailabilityRequest(

    catalog_offerings_query_request_hospitality_wrapper=shared.CatalogOfferingsQueryRequestHospitalityWrapper(),

)

res = s.hotel_availability.create_hotel_availability(req)

if res.catalog_offerings_hospitality_response_wrapper is not None:

    # handle response

    pass

```

## Custom HTTP Client

The Python SDK makes API calls using the [requests](https://pypi.org/project/requests/) HTTP library.  In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `requests.Session` object.

For example, you could specify a header for every request that this sdk makes as follows:

```python

import akaris_backend

import requests

http_client = requests.Session()

http_client.headers.update({'x-custom-header': 'someValue'})

s = akaris_backend.AkarisBackend(client: http_client)

```

## Authentication

### Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name         | Type         | Scheme       |

| ------------ | ------------ | ------------ |

| `o_auth2`    | oauth2       | OAuth2 token |

You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. For example:

```python

import akaris_backend

from akaris_backend.models import operations, shared

s = akaris_backend.AkarisBackend(

    security=shared.Security(

        o_auth2="Bearer ",

    ),

)

req = operations.CreateHotelAvailabilityRequest(

    catalog_offerings_query_request_hospitality_wrapper=shared.CatalogOfferingsQueryRequestHospitalityWrapper(),

)

res = s.hotel_availability.create_hotel_availability(req)

if res.catalog_offerings_hospitality_response_wrapper is not None:

    # handle response

    pass

```

# Development

## Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage

to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally

looking for the latest version.

## Contributions

While we value open-source contributions to this SDK, this library is generated programmatically.

Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)