Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/compwright/servicetitan
ServiceTitan v2 API client for PHP
https://github.com/compwright/servicetitan
openapi psr-7 rest-client
Last synced: 18 days ago
JSON representation
ServiceTitan v2 API client for PHP
- Host: GitHub
- URL: https://github.com/compwright/servicetitan
- Owner: compwright
- Created: 2022-04-15T17:55:48.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-12-24T02:32:26.000Z (24 days ago)
- Last Synced: 2024-12-24T03:03:13.614Z (24 days ago)
- Topics: openapi, psr-7, rest-client
- Language: PHP
- Homepage: https://packagist.org/packages/compwright/servicetitan
- Size: 1.44 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ServiceTitan v2 API client for PHP
ServiceTitan v2 API client for PHP
For more information, please visit [https://developer.servicetitan.io](https://developer.servicetitan.io).
## Installation
Install via Composer:
```
composer require compwright/servicetitan
```
## Usage
See [example.php](example/example.php)
## API Endpoints
All URIs are relative to *https://api.servicetitan.io*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*CallsApi* | [**callsGetCalls**](docs/Api/CallsApi.md#callsgetcalls) | **GET** /telecom/v2/tenant/{tenant}/calls | Calls_GetCalls
*CallsApi* | [**callsGetDetails**](docs/Api/CallsApi.md#callsgetdetails) | **GET** /telecom/v2/tenant/{tenant}/calls/{id} | Calls_GetDetails
*CallsApi* | [**callsGetRecording**](docs/Api/CallsApi.md#callsgetrecording) | **GET** /telecom/v2/tenant/{tenant}/calls/{id}/recording | Calls_GetRecording
*CallsApi* | [**callsGetVoiceMail**](docs/Api/CallsApi.md#callsgetvoicemail) | **GET** /telecom/v2/tenant/{tenant}/calls/{id}/voicemail | Calls_GetVoiceMail
*CallsApi* | [**callsUpdate**](docs/Api/CallsApi.md#callsupdate) | **PUT** /telecom/v2/tenant/{tenant}/calls/{id} | Calls_Update
## Models
- [AddressInput](docs/Model/AddressInput.md)
- [AddressOutput](docs/Model/AddressOutput.md)
- [CallDirection](docs/Model/CallDirection.md)
- [CallType](docs/Model/CallType.md)
- [CollectionResultOfModuleTelecomSharedBundleCallModel](docs/Model/CollectionResultOfModuleTelecomSharedBundleCallModel.md)
- [ContactsContractsContactInputModel](docs/Model/ContactsContractsContactInputModel.md)
- [ContactsContractsContactOutputModel](docs/Model/ContactsContractsContactOutputModel.md)
- [CrmContractsCustomersCustomerModel](docs/Model/CrmContractsCustomersCustomerModel.md)
- [CrmContractsCustomersCustomerPhoneModel](docs/Model/CrmContractsCustomersCustomerPhoneModel.md)
- [CrmCustomersCustomerType](docs/Model/CrmCustomersCustomerType.md)
- [CustomFieldApiModel](docs/Model/CustomFieldApiModel.md)
- [CustomerInModel](docs/Model/CustomerInModel.md)
- [JobTypeModel](docs/Model/JobTypeModel.md)
- [LocationInModel](docs/Model/LocationInModel.md)
- [MarketingCoreCampaignCategoryModel](docs/Model/MarketingCoreCampaignCategoryModel.md)
- [MarketingCoreCampaignModel](docs/Model/MarketingCoreCampaignModel.md)
- [MarketingCoreCampaignModelCategory](docs/Model/MarketingCoreCampaignModelCategory.md)
- [MembershipsMembershipModel](docs/Model/MembershipsMembershipModel.md)
- [MembershipsMembershipTypeModel](docs/Model/MembershipsMembershipTypeModel.md)
- [ModuleAdminSharedBusinessUnitAddressModel](docs/Model/ModuleAdminSharedBusinessUnitAddressModel.md)
- [ModuleAdminSharedBusinessUnitModel](docs/Model/ModuleAdminSharedBusinessUnitModel.md)
- [ModuleAdminSharedBusinessUnitTenantModel](docs/Model/ModuleAdminSharedBusinessUnitTenantModel.md)
- [ModuleTelecomSharedBundleCallModel](docs/Model/ModuleTelecomSharedBundleCallModel.md)
- [ModuleTelecomSharedCallAgentModel](docs/Model/ModuleTelecomSharedCallAgentModel.md)
- [ModuleTelecomSharedCallInUpdateModelV2](docs/Model/ModuleTelecomSharedCallInUpdateModelV2.md)
- [ModuleTelecomSharedCallModel](docs/Model/ModuleTelecomSharedCallModel.md)
- [ModuleTelecomSharedCallReasonModel](docs/Model/ModuleTelecomSharedCallReasonModel.md)
- [ModuleTelecomSharedDetailedBundleCallModel](docs/Model/ModuleTelecomSharedDetailedBundleCallModel.md)
- [ModuleTelecomSharedDetailedCallModel](docs/Model/ModuleTelecomSharedDetailedCallModel.md)
- [ModuleTelecomSharedDetailedCallModelCallType](docs/Model/ModuleTelecomSharedDetailedCallModelCallType.md)
- [ModuleTelecomSharedReasonInModel](docs/Model/ModuleTelecomSharedReasonInModel.md)
- [ServicesNamedModel](docs/Model/ServicesNamedModel.md)
## Authorization
Authentication schemes defined for the API:
### appKey
- **Type**: API key
- **API key parameter name**: ST-App-Key
- **Location**: HTTP header
### bearerToken
- **Type**: Bearer authentication
## Tests
To run the tests, use:
```bash
composer install
vendor/bin/phpunit
```
## Author
Jonathon Hill, CompWright Enterprises LLC (https://compwright.com)
## About this package
This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: `1.0`
- Generator version: `7.10.0`
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`