thampe / troi-sdk
This is the official API documentation of Troi. # Authentication Troi offers basic auth for authentication. <security-definitions />
1.4.3
2024-10-06 13:01 UTC
Requires
- php: ^7.4 || ^8.0
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.3
- guzzlehttp/psr7: ^1.7 || ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.5
- phpunit/phpunit: ^8.0 || ^9.0
README
This is the official API documentation of Troi.
Authentication
Troi offers basic auth for authentication.
Installation & Usage
Requirements
PHP 7.4 and later. Should also work with PHP 8.0+.
Composer
To install the bindings via Composer, run the following:
composer require thampe/troi-sdk
Then run composer install
Manual Installation
Download the files and include autoload.php
:
<?php require_once('/path/to/vendor/autoload.php');
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure HTTP basic authorization: basicAuth $config = Troi\Configuration::getDefaultConfiguration() ->setHost('YOUR_HOST') ->setUsername('YOUR_USERNAME') ->setPassword('YOUR_V2_TOKEN'); $apiInstance = new Troi\Api\AbsencesApi( // 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 ); try { $result = $apiInstance->absencesGet($start, $end, $employee_id); print_r($result); } catch (Exception $e) { echo 'Exception when calling AbsencesApi->absencesGet: ', $e->getMessage(), PHP_EOL; }
API Endpoints
All URIs are relative to https://demo.troi.software/api/v2/rest
Models
- AbsencesGet400Response
- AbsencesGet401Response
- AbsencesIdPutRequest
- AbsencesPost404Response
- AbsencesPostRequest
- AccountGroupsIdPutRequest
- AccountGroupsPostRequest
- AccountingEntriesIdPutRequest
- AccountingEntriesPostRequest
- AccountingEntryCollectionsPostRequest
- AccountsPostRequest
- ApiAbsence
- ApiAbsenceType
- ApiAccount
- ApiAccountGroup
- ApiAccountingEntry
- ApiAccountingEntryCollection
- ApiBookingYear
- ApiCalculationPosition
- ApiCalendarEvent
- ApiCalendarEventParticipant
- ApiClient
- ApiContact
- ApiContactCategory
- ApiCurrency
- ApiCustomer
- ApiEmployee
- ApiHourBilling
- ApiHourBillingCalculationPosition
- ApiHourBillingClient
- ApiHourBillingEmployee
- ApiListItem
- ApiPaymentTerm
- ApiProject
- ApiProjectFolder
- ApiProjectStatus
- ApiProjectType
- ApiService
- ApiSubproject
- ApiSupplier
- ApiSyncItem
- ApiUnit
- ApiWorkingHour
- BillingsHoursIdPutRequest
- BillingsHoursPostRequest
- BookingYearsPostRequest
- CalculationPositionsPostRequest
- CalendarEventParticipantsPostRequest
- CalendarEventsPostRequest
- ContactAccessGroupsGet200ResponseInner
- ContactCategoriesPostRequest
- ContactsPostRequest
- CustomersPostRequest
- ProjectsGetProjectStatusIdParameter
- ProjectsPostRequest
- SuppliersIdPutRequest
- SuppliersPostRequest
Authorization
Authentication schemes defined for the API:
basicAuth
- Type: HTTP basic authentication
Tests
To run the tests, use:
composer install vendor/bin/phpunit
About this package
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
2.0.0
- Build package:
org.openapitools.codegen.languages.PhpClientCodegen