terapi-integrations / terapi-php
dev-main
2024-11-26 13:33 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
This package is auto-updated.
Last update: 2025-05-26 14:53:44 UTC
README
No description provided (generated by Terapi https://github.com/terapi-integrations)
This PHP package is automatically generated by the Terapi project:
- API version: 1.0
- Build package: io.Terapi.codegen.v3.generators.php.PhpClientCodegen
Requirements
PHP 5.5 and later
Installation & Usage
Composer
To install the bindings via Composer, add the following to composer.json
:
{
"repositories": [
{
"type": "git",
"url": "https://github.com/git_user_id/git_repo_id.git"
}
],
"require": {
"git_user_id/git_repo_id": "*@dev"
}
}
Then run composer install
Manual Installation
Download the files and include autoload.php
:
require_once('/path/to/terapi-client-php/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'); $apiInstance = new Terapi\Client\Api\ApiProxyApi( // 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 ); $endpoint = "endpoint_example"; // string | $body = new \Terapi\Client\Model\ApiproxyEndpointBody6(); // \Terapi\Client\Model\ApiproxyEndpointBody6 | try { $result = $apiInstance->apiProxyEndpointDelete($endpoint, $body); print_r($result); } catch (Exception $e) { echo 'Exception when calling ApiProxyApi->apiProxyEndpointDelete: ', $e->getMessage(), PHP_EOL; } $apiInstance = new Terapi\Client\Api\ApiProxyApi( // 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 ); $integration_name = "integration_name_example"; // string | $endpoint = "endpoint_example"; // string | $x_tenant_id = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string | try { $result = $apiInstance->apiProxyEndpointGet($integration_name, $endpoint, $x_tenant_id); print_r($result); } catch (Exception $e) { echo 'Exception when calling ApiProxyApi->apiProxyEndpointGet: ', $e->getMessage(), PHP_EOL; } $apiInstance = new Terapi\Client\Api\ApiProxyApi( // 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 ); $endpoint = "endpoint_example"; // string | $body = new \Terapi\Client\Model\ApiproxyEndpointBody9(); // \Terapi\Client\Model\ApiproxyEndpointBody9 | try { $result = $apiInstance->apiProxyEndpointPatch($endpoint, $body); print_r($result); } catch (Exception $e) { echo 'Exception when calling ApiProxyApi->apiProxyEndpointPatch: ', $e->getMessage(), PHP_EOL; } $apiInstance = new Terapi\Client\Api\ApiProxyApi( // 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 ); $endpoint = "endpoint_example"; // string | $body = new \Terapi\Client\Model\ApiproxyEndpointBody3(); // \Terapi\Client\Model\ApiproxyEndpointBody3 | try { $result = $apiInstance->apiProxyEndpointPost($endpoint, $body); print_r($result); } catch (Exception $e) { echo 'Exception when calling ApiProxyApi->apiProxyEndpointPost: ', $e->getMessage(), PHP_EOL; } $apiInstance = new Terapi\Client\Api\ApiProxyApi( // 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 ); $endpoint = "endpoint_example"; // string | $body = new \Terapi\Client\Model\ApiproxyEndpointBody(); // \Terapi\Client\Model\ApiproxyEndpointBody | try { $result = $apiInstance->apiProxyEndpointPut($endpoint, $body); print_r($result); } catch (Exception $e) { echo 'Exception when calling ApiProxyApi->apiProxyEndpointPut: ', $e->getMessage(), PHP_EOL; } $apiInstance = new Terapi\Client\Api\ApiProxyApi( // 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 ); $tenant_id = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string | $external_id = "external_id_example"; // string | try { $result = $apiInstance->apiProxyOauth2ChallengeGet($tenant_id, $external_id); print_r($result); } catch (Exception $e) { echo 'Exception when calling ApiProxyApi->apiProxyOauth2ChallengeGet: ', $e->getMessage(), PHP_EOL; } $apiInstance = new Terapi\Client\Api\ApiProxyApi( // 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 ); $external_id = "external_id_example"; // string | try { $result = $apiInstance->apiProxyUnifiedContactsExternalIdGet($external_id); print_r($result); } catch (Exception $e) { echo 'Exception when calling ApiProxyApi->apiProxyUnifiedContactsExternalIdGet: ', $e->getMessage(), PHP_EOL; } $apiInstance = new Terapi\Client\Api\ApiProxyApi( // 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->apiProxyUnifiedContactsGet(); print_r($result); } catch (Exception $e) { echo 'Exception when calling ApiProxyApi->apiProxyUnifiedContactsGet: ', $e->getMessage(), PHP_EOL; } ?>
Documentation for API Endpoints
All URIs are relative to /
Class | Method | HTTP request | Description |
---|---|---|---|
ApiProxyApi | apiProxyEndpointDelete | DELETE /api-proxy/{endpoint} | 21_997 |
ApiProxyApi | apiProxyEndpointGet | GET /api-proxy/{endpoint} | 21_997 |
ApiProxyApi | apiProxyEndpointPatch | PATCH /api-proxy/{endpoint} | 21_997 |
ApiProxyApi | apiProxyEndpointPost | POST /api-proxy/{endpoint} | 21_997 |
ApiProxyApi | apiProxyEndpointPut | PUT /api-proxy/{endpoint} | 21_997 |
ApiProxyApi | apiProxyOauth2ChallengeGet | GET /api-proxy/oauth2/challenge | 21_999 |
ApiProxyApi | apiProxyUnifiedContactsExternalIdGet | GET /api-proxy/unified/contacts/{externalId} | |
ApiProxyApi | apiProxyUnifiedContactsGet | GET /api-proxy/unified/contacts | |
ApplicationApi | applicationCreatePost | POST /application/create | 15_999 |
ApplicationApi | applicationDeleteDelete | DELETE /application/delete | 15_997 |
ApplicationApi | applicationListGet | GET /application/list | 15_996 |
ApplicationApi | applicationUpdatePut | PUT /application/update | 15_998 |
ApplicationApiKeyApi | applicationApikeyGeneratePost | POST /application-apikey/generate | 16_999 |
ApplicationApiKeyApi | applicationApikeyGetByApplicationIdGet | GET /application-apikey/get-by-application-id | 16_995 |
ApplicationApiKeyApi | applicationApikeyRevokeDelete | DELETE /application-apikey/revoke | 16_998 |
ApplicationIntegrationApi | applicationIntegrationAddIntegrationToApplicationPost | POST /application-integration/add-integration-to-application | 18_999 |
ApplicationIntegrationApi | applicationIntegrationApplicationIntegrationListByApplicationIdGet | GET /application-integration/application-integration-list-by-application-id | 18_997 |
AuthApi | authAuthenticatePost | POST /auth/authenticate | 23_999 |
AuthApi | authRefreshPost | POST /auth/refresh | 23_998 |
CategoryApi | categoryListGet | GET /category/list | 19_999 |
IntegrationApi | integrationGetGet | GET /integration/get | 17_997 |
IntegrationApi | integrationListGet | GET /integration/list | 17_999 |
StatisticsApi | statisticsUserProfileGet | GET /statistics/user-profile | 14_997 |
TenantApi | tenantDeclineTenantIdGet | GET /tenant/decline-tenant/{id} | 20_996 |
TenantApi | tenantInviteTenantByApplicationIntegrationIdPost | POST /tenant/invite-tenant-by-application-integration-id | 20_998 |
TenantApi | tenantInviteTenantPost | POST /tenant/invite-tenant | 20_998 |
TenantApi | tenantUpdateTenantConnectionPost | POST /tenant/update-tenant-connection | 20_997 |
TenantApi | tenantUserTenantListGet | GET /tenant/user-tenant-list | 20_999 |
UserApi | userCreateOrGetUserProfilePost | POST /user/create-or-get-user-profile | 14_998 |
Documentation For Models
- AddIntegrationToApplicationError
- AddIntegrationToApplicationRequest
- AddIntegrationToApplicationRequestDto
- AddIntegrationToApplicationRequestErrorCodes
- AddIntegrationToApplicationResponse
- AllOfAddIntegrationToApplicationErrorCode
- AllOfAddIntegrationToApplicationErrorType
- AllOfAddIntegrationToApplicationRequestDto
- AllOfAddIntegrationToApplicationResponseError
- AllOfApplicationApiKeyByApplicationIdErrorCode
- AllOfApplicationApiKeyByApplicationIdErrorType
- AllOfApplicationApiKeyByApplicationIdResponseData
- AllOfApplicationApiKeyByApplicationIdResponseError
- AllOfApplicationIntegrationDtoApplication
- AllOfApplicationIntegrationDtoIntegration
- AllOfApplicationIntegrationListByApplicationIdErrorCode
- AllOfApplicationIntegrationListByApplicationIdErrorType
- AllOfApplicationIntegrationListByApplicationIdResponseData
- AllOfApplicationIntegrationListByApplicationIdResponseError
- AllOfCallActionErrorCode
- AllOfCallActionErrorType
- AllOfCallActionResponseData
- AllOfCallActionResponseError
- AllOfCategoryListErrorCode
- AllOfCategoryListErrorType
- AllOfCategoryListResponseData
- AllOfCategoryListResponseError
- AllOfCreateApplicationApiKeyErrorCode
- AllOfCreateApplicationApiKeyErrorType
- AllOfCreateApplicationApiKeyRequestDto
- AllOfCreateApplicationApiKeyResponseData
- AllOfCreateApplicationApiKeyResponseError
- AllOfCreateApplicationErrorCode
- AllOfCreateApplicationErrorType
- AllOfCreateApplicationRequestDto
- AllOfCreateApplicationResponseData
- AllOfCreateApplicationResponseError
- AllOfCreateUserProfileErrorCode
- AllOfCreateUserProfileErrorType
- AllOfCreateUserProfileResponseData
- AllOfCreateUserProfileResponseError
- AllOfDeclineTenantInvitationErrorCode
- AllOfDeclineTenantInvitationErrorType
- AllOfDeclineTenantInvitationResponseError
- AllOfDeleteApplicationErrorCode
- AllOfDeleteApplicationErrorType
- AllOfDeleteApplicationResponseError
- AllOfErrorType
- AllOfGetAuthenticationTokenErrorCode
- AllOfGetAuthenticationTokenErrorType
- AllOfGetAuthenticationTokenResponseData
- AllOfGetAuthenticationTokenResponseError
- AllOfGetOneIntegrationErrorCode
- AllOfGetOneIntegrationErrorType
- AllOfGetOneIntegrationResponseData
- AllOfGetOneIntegrationResponseError
- AllOfIntegrationDtoReleaseStatus
- AllOfIntegrationListErrorCode
- AllOfIntegrationListErrorType
- AllOfIntegrationListResponseData
- AllOfIntegrationListResponseError
- AllOfInviteTenantByApplicationIntegrationIdErrorCode
- AllOfInviteTenantByApplicationIntegrationIdErrorType
- AllOfInviteTenantByApplicationIntegrationIdRequestDto
- AllOfInviteTenantByApplicationIntegrationIdResponseData
- AllOfInviteTenantByApplicationIntegrationIdResponseError
- AllOfInviteTenantErrorCode
- AllOfInviteTenantErrorType
- AllOfInviteTenantRequestDto
- AllOfInviteTenantResponseData
- AllOfInviteTenantResponseError
- AllOfOAuth2ChallengeDtoTokens
- AllOfOAuth2ChallengeErrorCode
- AllOfOAuth2ChallengeErrorType
- AllOfOAuth2ChallengeResponseData
- AllOfOAuth2ChallengeResponseError
- AllOfRefreshAuthenticationTokenErrorCode
- AllOfRefreshAuthenticationTokenErrorType
- AllOfRefreshAuthenticationTokenResponseData
- AllOfRefreshAuthenticationTokenResponseError
- AllOfResponseError
- AllOfRevokeApplicationApiKeyErrorCode
- AllOfRevokeApplicationApiKeyErrorType
- AllOfRevokeApplicationApiKeyResponseError
- AllOfTenantDtoApplicationIntegration
- AllOfTenantDtoInvitationStatus
- AllOfUnifiedContactResponseData
- AllOfUnifiedContactResponseError
- AllOfUnifiedContactsListResponseData
- AllOfUnifiedContactsListResponseError
- AllOfUpdateApplicationErrorCode
- AllOfUpdateApplicationErrorType
- AllOfUpdateApplicationRequestDto
- AllOfUpdateApplicationResponseData
- AllOfUpdateApplicationResponseError
- AllOfUpdateTenantConnectionErrorCode
- AllOfUpdateTenantConnectionErrorType
- AllOfUpdateTenantConnectionRequestDto
- AllOfUpdateTenantConnectionResponseError
- AllOfUserApplicationListErrorCode
- AllOfUserApplicationListErrorType
- AllOfUserApplicationListResponseData
- AllOfUserApplicationListResponseError
- AllOfUserProfileStatisticsErrorCode
- AllOfUserProfileStatisticsErrorType
- AllOfUserProfileStatisticsResponseData
- AllOfUserProfileStatisticsResponseError
- AllOfUserTenantListErrorCode
- AllOfUserTenantListErrorType
- AllOfUserTenantListResponseData
- AllOfUserTenantListResponseError
- ApiproxyEndpointBody
- ApiproxyEndpointBody1
- ApiproxyEndpointBody10
- ApiproxyEndpointBody11
- ApiproxyEndpointBody2
- ApiproxyEndpointBody3
- ApiproxyEndpointBody4
- ApiproxyEndpointBody5
- ApiproxyEndpointBody6
- ApiproxyEndpointBody7
- ApiproxyEndpointBody8
- ApiproxyEndpointBody9
- ApplicationApiKeyByApplicationIdError
- ApplicationApiKeyByApplicationIdErrorCodes
- ApplicationApiKeyByApplicationIdResponse
- ApplicationApiKeyDto
- ApplicationCreateBody
- ApplicationCreateBody1
- ApplicationCreateBody2
- ApplicationDto
- ApplicationIntegrationDto
- ApplicationIntegrationListByApplicationIdError
- ApplicationIntegrationListByApplicationIdRequestErrorCodes
- ApplicationIntegrationListByApplicationIdResponse
- ApplicationIntegrationListDto
- ApplicationListDto
- ApplicationUpdateBody
- ApplicationUpdateBody1
- ApplicationUpdateBody2
- ApplicationapikeyGenerateBody
- ApplicationapikeyGenerateBody1
- ApplicationapikeyGenerateBody2
- ApplicationintegrationAddintegrationtoapplicationBody
- ApplicationintegrationAddintegrationtoapplicationBody1
- ApplicationintegrationAddintegrationtoapplicationBody2
- CallActionBodyDto
- CallActionDto
- CallActionError
- CallActionErrorCodes
- CallActionResponse
- CategoryDto
- CategoryListDto
- CategoryListError
- CategoryListRequestErrorCodes
- CategoryListResponse
- ClientErrorType
- CreateApplicationApiKeyError
- CreateApplicationApiKeyRequest
- CreateApplicationApiKeyRequestDto
- CreateApplicationApiKeyRequestErrorCodes
- CreateApplicationApiKeyResponse
- CreateApplicationError
- CreateApplicationRequest
- CreateApplicationRequestDto
- CreateApplicationRequestErrorCodes
- CreateApplicationResponse
- CreateUserProfileError
- CreateUserProfileRequestErrorCodes
- CreateUserProfileResponse
- DeclineTenantInvitationError
- DeclineTenantInvitationRequestErrorCodes
- DeclineTenantInvitationResponse
- DeleteApplicationError
- DeleteApplicationRequestErrorCodes
- DeleteApplicationResponse
- Error
- GetAuthenticationTokenDto
- GetAuthenticationTokenError
- GetAuthenticationTokenRequestErrorCodes
- GetAuthenticationTokenResponse
- GetOneIntegrationError
- GetOneIntegrationRequestErrorCodes
- GetOneIntegrationResponse
- IntegrationDto
- IntegrationEndpointDto
- IntegrationEventDto
- IntegrationFieldDto
- IntegrationListDto
- IntegrationListError
- IntegrationListRequestErrorCodes
- IntegrationListResponse
- InvitationStatus
- InvitationStatus1
- InviteTenantByApplicationIntegrationIdError
- InviteTenantByApplicationIntegrationIdRequest
- InviteTenantByApplicationIntegrationIdRequestDto
- InviteTenantByApplicationIntegrationIdResponse
- InviteTenantError
- InviteTenantRequest
- InviteTenantRequestDto
- InviteTenantRequestErrorCodes
- InviteTenantResponse
- OAuth2ChallengeDto
- OAuth2ChallengeError
- OAuth2ChallengeErrorCodes
- OAuth2ChallengeResponse
- OAuth2ChallengeTokenDto
- RefreshAuthenticationTokenDto
- RefreshAuthenticationTokenError
- RefreshAuthenticationTokenRequestErrorCodes
- RefreshAuthenticationTokenResponse
- ReleaseStatus
- Response
- RevokeApplicationApiKeyError
- RevokeApplicationApiKeyRequestErrorCodes
- RevokeApplicationApiKeyResponse
- TenantDto
- TenantInvitetenantBody
- TenantInvitetenantBody1
- TenantInvitetenantBody2
- TenantInvitetenantbyapplicationintegrationidBody
- TenantInvitetenantbyapplicationintegrationidBody1
- TenantInvitetenantbyapplicationintegrationidBody2
- TenantListDto
- TenantUpdatetenantconnectionBody
- TenantUpdatetenantconnectionBody1
- TenantUpdatetenantconnectionBody2
- UnifiedContact
- UnifiedContactResponse
- UnifiedContactsList
- UnifiedContactsListResponse
- UpdateApplicationError
- UpdateApplicationRequest
- UpdateApplicationRequestDto
- UpdateApplicationRequestErrorCodes
- UpdateApplicationResponse
- UpdateTenantConnectionError
- UpdateTenantConnectionRequest
- UpdateTenantConnectionRequestDto
- UpdateTenantConnectionRequestErrorCodes
- UpdateTenantConnectionResponse
- UserApplicationListError
- UserApplicationListRequestErrorCodes
- UserApplicationListResponse
- UserDto
- UserProfileStatisticsDto
- UserProfileStatisticsError
- UserProfileStatisticsErrorCodes
- UserProfileStatisticsResponse
- UserTenantListError
- UserTenantListRequestErrorCodes
- UserTenantListResponse
Documentation For Authorization
Bearer
- Type: HTTP bearer authentication