Metadata-Version: 2.4
Name: ezero-apimatic-sdk
Version: 0.0.1
Summary: Sample SDKs for ezero by APIMatic
Author-email: Muhammad Rafay <muhammad.rafay@apimatic.io>
Project-URL: Documentation, https://docs.envzero.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
Provides-Extra: testutils
Requires-Dist: pytest>=7.2.2; extra == "testutils"
Dynamic: license-file


# Getting Started with env zero API

## Introduction

This document describes the resources that make up the official env zero REST API.

### Base URL

`https://api.env0.com`

### Content types

All requests should be in JSON format and include the `accept: application/json` header.

### Authentication

HTTP Basic authentication. Send the **API Key ID** as the username and the **API Key Secret** as the password. Keys are created under *Organization Settings -> API Keys* (Admin or User scope) or *Personal Settings -> API Keys* (Personal scope).

### Scope of this document

This specification covers the environment drift-governance surface of the env zero API and the environment, deployment, template, configuration and project endpoints that support it. It was reconstructed from the OpenAPI fragments published on https://docs.envzero.com and is a subset of the full API.

### Error responses

`401` and `403` responses return `{ "message": string }` and are documented on every operation. The upstream documentation does not define response bodies for other non-2xx status codes, so none are asserted here.

## 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 ezero-apimatic-sdk==0.0.1
```

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

## Initialize the API Client

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

The following parameters are configurable for the API Client:

| Parameter | Type | Description |
|  --- | --- | --- |
| 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/ezero-apimatic-python-sdk/tree/0.0.1/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/ezero-apimatic-python-sdk/tree/0.0.1/doc/logging-configuration.md) | The SDK logging configuration for API calls |
| basic_auth_credentials | [`BasicAuthCredentials`](https://www.github.com/sdks-io/ezero-apimatic-python-sdk/tree/0.0.1/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 envzeroapi.configuration import Environment
from envzeroapi.envzeroapi_client import EnvzeroapiClient
from envzeroapi.http.auth.basic_auth import BasicAuthCredentials
from envzeroapi.logging.configuration.api_logging_configuration import LoggingConfiguration
from envzeroapi.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from envzeroapi.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration

client = EnvzeroapiClient(
    basic_auth_credentials=BasicAuthCredentials(
        username='BasicAuthUserName',
        password='BasicAuthPassword'
    ),
    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 envzeroapi.envzeroapi_client import EnvzeroapiClient

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

See the [Environment-Based Client Initialization](https://www.github.com/sdks-io/ezero-apimatic-python-sdk/tree/0.0.1/doc/environment-based-client-initialization.md) section for details.

## Authorization

This API uses the following authentication schemes.

* [`env0_API_Key (Basic Authentication)`](https://www.github.com/sdks-io/ezero-apimatic-python-sdk/tree/0.0.1/doc/auth/basic-authentication.md)

## List of APIs

* [Bulk Operations](https://www.github.com/sdks-io/ezero-apimatic-python-sdk/tree/0.0.1/doc/controllers/bulk-operations.md)
* [Deployment Logs](https://www.github.com/sdks-io/ezero-apimatic-python-sdk/tree/0.0.1/doc/controllers/deployment-logs.md)
* [Approval Policy](https://www.github.com/sdks-io/ezero-apimatic-python-sdk/tree/0.0.1/doc/controllers/approval-policy.md)
* [Environment Outputs](https://www.github.com/sdks-io/ezero-apimatic-python-sdk/tree/0.0.1/doc/controllers/environment-outputs.md)
* [Environments](https://www.github.com/sdks-io/ezero-apimatic-python-sdk/tree/0.0.1/doc/controllers/environments.md)
* [Drift](https://www.github.com/sdks-io/ezero-apimatic-python-sdk/tree/0.0.1/doc/controllers/drift.md)
* [Scheduling](https://www.github.com/sdks-io/ezero-apimatic-python-sdk/tree/0.0.1/doc/controllers/scheduling.md)
* [Templates](https://www.github.com/sdks-io/ezero-apimatic-python-sdk/tree/0.0.1/doc/controllers/templates.md)
* [Configuration](https://www.github.com/sdks-io/ezero-apimatic-python-sdk/tree/0.0.1/doc/controllers/configuration.md)
* [Projects](https://www.github.com/sdks-io/ezero-apimatic-python-sdk/tree/0.0.1/doc/controllers/projects.md)
* [Organization](https://www.github.com/sdks-io/ezero-apimatic-python-sdk/tree/0.0.1/doc/controllers/organization.md)
* [Notifications](https://www.github.com/sdks-io/ezero-apimatic-python-sdk/tree/0.0.1/doc/controllers/notifications.md)
* [Credentials](https://www.github.com/sdks-io/ezero-apimatic-python-sdk/tree/0.0.1/doc/controllers/credentials.md)

## SDK Infrastructure

### Configuration

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

### HTTP

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

### Utilities

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

