# ringer-business
This API provides endpoints for managing customer accounts in the Ringer Business system.
It allows for retrieving account details, updating account information, managing account status (activation/closure),
and updating associated addresses.

Account operations typically require authentication and appropriate permissions (e.g., administrator role for certain updates).


This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0
- Package version: 1.0.0
- Generator version: 7.13.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://docs.ringer.tel/support](https://docs.ringer.tel/support)

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import ringer_business
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import ringer_business
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import ringer_business
from ringer_business.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.ringer.tel/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = ringer_business.Configuration(
    host = "https://api.ringer.tel/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]


# Enter a context with an instance of the API client
with ringer_business.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ringer_business.AccountsApi(api_client)

    try:
        # Activate Current Account
        api_response = api_instance.activate_account()
        print("The response of AccountsApi->activate_account:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountsApi->activate_account: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://api.ringer.tel/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AccountsApi* | [**activate_account**](docs/AccountsApi.md#activate_account) | **PATCH** /account | Activate Current Account
*AccountsApi* | [**close_account**](docs/AccountsApi.md#close_account) | **DELETE** /account | Close Current Account
*AccountsApi* | [**get_account_details**](docs/AccountsApi.md#get_account_details) | **GET** /account | Get Current Account Details
*AccountsApi* | [**update_account**](docs/AccountsApi.md#update_account) | **PUT** /account | Update Current Account Information


## Documentation For Models

 - [AccountResponse](docs/AccountResponse.md)
 - [AccountUpdateRequest](docs/AccountUpdateRequest.md)
 - [AddressCore](docs/AddressCore.md)
 - [AddressResponse](docs/AddressResponse.md)
 - [Error](docs/Error.md)
 - [Link](docs/Link.md)
 - [UserSummary](docs/UserSummary.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="oAuth2"></a>
### oAuth2

- **Type**: OAuth
- **Flow**: application
- **Authorization URL**: 
- **Scopes**: 
 - **read**: Read access to API resources
 - **write**: Write access to API resources
 - **admin**: Administrative access for sensitive operations.


## Author

support@ringer.tel


