apimatic-ths / ths-apimatic-sdk-sdk
ThoughtSpot APIMatic SDKs
Installs: 0
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
pkg:composer/apimatic-ths/ths-apimatic-sdk-sdk
Requires
- php: ^7.2 || ^8.0
- ext-curl: *
- ext-json: *
- apimatic/core: ~0.3.17
- apimatic/core-interfaces: ~0.1.5
- apimatic/unirest-php: ^4.0.6
Requires (Dev)
- phan/phan: 5.4.5
- squizlabs/php_codesniffer: ^3.5
README
Install the Package
Run the following command to install the package and automatically add the dependency to your composer.json file:
composer require "apimatic-ths/ths-apimatic-sdk-sdk:1.0.1"
Or add it to the composer.json file manually as given below:
"require": { "apimatic-ths/ths-apimatic-sdk-sdk": "1.0.1" }
You can also view the package at: https://packagist.org/packages/apimatic-ths/ths-apimatic-sdk-sdk#1.0.1
Initialize the API Client
Note: Documentation for the client can be found here.
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
|---|---|---|
| baseUrl | string |
Default: 'https://localhost:443' |
| environment | Environment |
The API environment. Default: Environment.PRODUCTION |
| timeout | int |
Timeout for API calls in seconds. Default: 0 |
| enableRetries | bool |
Whether to enable retries and backoff feature. Default: false |
| numberOfRetries | int |
The number of retries to make. Default: 0 |
| retryInterval | float |
The retry time interval between the endpoint calls. Default: 1 |
| backOffFactor | float |
Exponential backoff factor to increase interval between retries. Default: 2 |
| maximumRetryWaitTime | int |
The maximum wait time in seconds for overall retrying requests. Default: 0 |
| retryOnTimeout | bool |
Whether to retry on request timeout. Default: true |
| httpStatusCodesToRetry | array |
Http status codes to retry against. Default: 408, 413, 429, 500, 502, 503, 504, 521, 522, 524 |
| httpMethodsToRetry | array |
Http methods to retry against. Default: 'GET', 'PUT' |
| loggingConfiguration | LoggingConfigurationBuilder |
Represents the logging configurations for API calls |
| proxyConfiguration | ProxyConfigurationBuilder |
Represents the proxy configurations for API calls |
| bearerAuthCredentials | BearerAuthCredentials |
The Credentials Setter for OAuth 2 Bearer token |
The API client can be initialized as follows:
use ThoughtSpotPublicRestApiLib\Logging\LoggingConfigurationBuilder; use ThoughtSpotPublicRestApiLib\Logging\RequestLoggingConfigurationBuilder; use ThoughtSpotPublicRestApiLib\Logging\ResponseLoggingConfigurationBuilder; use Psr\Log\LogLevel; use ThoughtSpotPublicRestApiLib\Environment; use ThoughtSpotPublicRestApiLib\Authentication\BearerAuthCredentialsBuilder; use ThoughtSpotPublicRestApiLib\ThoughtSpotPublicRestApiClientBuilder; $client = ThoughtSpotPublicRestApiClientBuilder::init() ->bearerAuthCredentials( BearerAuthCredentialsBuilder::init( 'AccessToken' ) ) ->environment(Environment::PRODUCTION) ->baseUrl('https://localhost:443') ->loggingConfiguration( LoggingConfigurationBuilder::init() ->level(LogLevel::INFO) ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true)) ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true)) ) ->build();
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.
List of APIs
- Connection Configurations
- Custom Action
- Custom Calendars
- Email Customization
- Version Control
- AI
- Authentication
- Collections
- Connections
- Data
- DBT
- Groups
- Jobs
- Log
- Metadata
- Orgs
- Reports
- Roles
- Schedules
- Security
- System
- Tags
- Users
- Variable
- Webhooks
SDK Infrastructure
Configuration
- ProxyConfigurationBuilder
- LoggingConfigurationBuilder
- RequestLoggingConfigurationBuilder
- ResponseLoggingConfigurationBuilder