ths-apimatic-sdk-sdk 1.0.0
ThoughtSpot APIMatic SDKs
Requires Python: >=3.7


# Getting Started with ThoughtSpot Public REST 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 ths-apimatic-sdk-sdk==1.0.0
```

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

## Initialize the API Client

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

The following parameters are configurable for the API Client:

| Parameter | Type | Description |
|  --- | --- | --- |
| base_url | `str` | *Default*: `"https://localhost:443"` |
| environment | [`Environment`](https://www.github.com/sdks-io/ths-apimatic-sdk-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: 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/ths-apimatic-sdk-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/ths-apimatic-sdk-python-sdk/tree/1.0.0/doc/logging-configuration.md) | The SDK logging configuration for API calls |
| bearer_auth_credentials | [`BearerAuthCredentials`](https://www.github.com/sdks-io/ths-apimatic-sdk-python-sdk/tree/1.0.0/doc/auth/oauth-2-bearer-token.md) | The credential object for OAuth 2 Bearer token |

The API client can be initialized as follows:

### Code-Based Client Initialization

```python
import logging

from thoughtspotpublicrestapi.configuration import Environment
from thoughtspotpublicrestapi.http.auth.oauth_2 import BearerAuthCredentials
from thoughtspotpublicrestapi.logging.configuration.api_logging_configuration import LoggingConfiguration
from thoughtspotpublicrestapi.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from thoughtspotpublicrestapi.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from thoughtspotpublicrestapi.thoughtspotpublicrestapi_client import ThoughtspotpublicrestapiClient

client = ThoughtspotpublicrestapiClient(
    bearer_auth_credentials=BearerAuthCredentials(
        access_token='AccessToken'
    ),
    environment=Environment.PRODUCTION,
    base_url='https://localhost:443',
    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 thoughtspotpublicrestapi.thoughtspotpublicrestapi_client import ThoughtspotpublicrestapiClient

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

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

## Authorization

This API uses the following authentication schemes.

* [`bearerAuth (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/ths-apimatic-sdk-python-sdk/tree/1.0.0/doc/auth/oauth-2-bearer-token.md)

## List of APIs

* [Connection Configurations](https://www.github.com/sdks-io/ths-apimatic-sdk-python-sdk/tree/1.0.0/doc/controllers/connection-configurations.md)
* [Custom Action](https://www.github.com/sdks-io/ths-apimatic-sdk-python-sdk/tree/1.0.0/doc/controllers/custom-action.md)
* [Custom Calendars](https://www.github.com/sdks-io/ths-apimatic-sdk-python-sdk/tree/1.0.0/doc/controllers/custom-calendars.md)
* [Email Customization](https://www.github.com/sdks-io/ths-apimatic-sdk-python-sdk/tree/1.0.0/doc/controllers/email-customization.md)
* [Version Control](https://www.github.com/sdks-io/ths-apimatic-sdk-python-sdk/tree/1.0.0/doc/controllers/version-control.md)
* [AI](https://www.github.com/sdks-io/ths-apimatic-sdk-python-sdk/tree/1.0.0/doc/controllers/ai.md)
* [Authentication](https://www.github.com/sdks-io/ths-apimatic-sdk-python-sdk/tree/1.0.0/doc/controllers/authentication.md)
* [Collections](https://www.github.com/sdks-io/ths-apimatic-sdk-python-sdk/tree/1.0.0/doc/controllers/collections.md)
* [Connections](https://www.github.com/sdks-io/ths-apimatic-sdk-python-sdk/tree/1.0.0/doc/controllers/connections.md)
* [Data](https://www.github.com/sdks-io/ths-apimatic-sdk-python-sdk/tree/1.0.0/doc/controllers/data.md)
* [DBT](https://www.github.com/sdks-io/ths-apimatic-sdk-python-sdk/tree/1.0.0/doc/controllers/dbt.md)
* [Groups](https://www.github.com/sdks-io/ths-apimatic-sdk-python-sdk/tree/1.0.0/doc/controllers/groups.md)
* [Jobs](https://www.github.com/sdks-io/ths-apimatic-sdk-python-sdk/tree/1.0.0/doc/controllers/jobs.md)
* [Log](https://www.github.com/sdks-io/ths-apimatic-sdk-python-sdk/tree/1.0.0/doc/controllers/log.md)
* [Metadata](https://www.github.com/sdks-io/ths-apimatic-sdk-python-sdk/tree/1.0.0/doc/controllers/metadata.md)
* [Orgs](https://www.github.com/sdks-io/ths-apimatic-sdk-python-sdk/tree/1.0.0/doc/controllers/orgs.md)
* [Reports](https://www.github.com/sdks-io/ths-apimatic-sdk-python-sdk/tree/1.0.0/doc/controllers/reports.md)
* [Roles](https://www.github.com/sdks-io/ths-apimatic-sdk-python-sdk/tree/1.0.0/doc/controllers/roles.md)
* [Schedules](https://www.github.com/sdks-io/ths-apimatic-sdk-python-sdk/tree/1.0.0/doc/controllers/schedules.md)
* [Security](https://www.github.com/sdks-io/ths-apimatic-sdk-python-sdk/tree/1.0.0/doc/controllers/security.md)
* [System](https://www.github.com/sdks-io/ths-apimatic-sdk-python-sdk/tree/1.0.0/doc/controllers/system.md)
* [Tags](https://www.github.com/sdks-io/ths-apimatic-sdk-python-sdk/tree/1.0.0/doc/controllers/tags.md)
* [Users](https://www.github.com/sdks-io/ths-apimatic-sdk-python-sdk/tree/1.0.0/doc/controllers/users.md)
* [Variable](https://www.github.com/sdks-io/ths-apimatic-sdk-python-sdk/tree/1.0.0/doc/controllers/variable.md)
* [Webhooks](https://www.github.com/sdks-io/ths-apimatic-sdk-python-sdk/tree/1.0.0/doc/controllers/webhooks.md)

## SDK Infrastructure

### Configuration

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

### HTTP

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

### Utilities

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