timelight-ai/php-api-client

1.0.5 2019-12-23 16:16 UTC

Requires

• php: >=5.5
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^6.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ~2.12
• phpunit/phpunit: ^4.8
• squizlabs/php_codesniffer: ~2.6

proprietary

• Swagger and contributors

• php
• api
• sdk
• swagger

README

A PHP library for easy use of the Timelight AI API.

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 1.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.PhpClientCodegen

Documentation

Generic documentation and tutorials of the API can be found at api.timelight.tech.

Full client reference can be found in the docs folder

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

Run composer require timelight-ai/php-api-client

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/php-api-client/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
$config = TimelightAi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TimelightAi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new TimelightAi\Api\AIApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$source_id = 8.14; // float | 

try {
    $result = $apiInstance->v1AiAnomaliesSourceIdGet($source_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AIApi->v1AiAnomaliesSourceIdGet: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to http://localhost

Documentation For Models

• AlertCommentDto
• AlertDto
• AlertFavoriteDto
• AlertListDto
• AlertRefDto
• AlertRefListDto
• AlertRefResultDto
• AnomaliesResponseDto
• CreateSourceDayDto
• CreateSourceDto
• DayContext
• DayListDto
• DayModelDto
• DayPatchDto
• DayTrend
• DayTrendInput
• DayTrendInputListDto
• DayTrendListDto
• DaysNearDateResultDto
• DaysPatchDto
• GeneratedDayContextBulkDto
• GeneratedDayTrendBulkDto
• ImportDayDto
• ImportDaysDto
• LoginDto
• LoginResponseDto
• ModelDto
• ModelListDto
• ModelPatchDto
• ModelsPatchDto
• PrevisionApplyGroupDto
• PrevisionApplyGroupResponseDto
• PrevisionBulkSaveDto
• PrevisionBulkSaveResultDto
• PrevisionDto
• PrevisionListDto
• PrevisionPatchDto
• PrevisionSaveDto
• PrevisionUpdateResultDto
• RecomputeDayModelsResponseDto
• RecomputeDaysProjectionResponseDto
• RecomputeModelsResponseDto
• RecomputeSourceModelsResponseDto
• RequestDemoDto
• SourceDto
• SourceGroupCreateDto
• SourceGroupDto
• SourceGroupListDto
• SourceGroupPatchDto
• SourceListDto
• SourcePatchDto
• SourcePatchGroupDto
• UserDto

Documentation For Authorization

bearer

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Author