README

The Xactimate One API allows you to integrate your current services and applications directly with Xactimate One. It creates a seamless experience for your company as it manages claims with your internal software by sending and receiving data from the Xactimate One platform.

Installation & Usage

Requirements

PHP 7.3 and later. Should also work with PHP 8.0 but has not been tested.

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/xactimate-one/sdk-php.git"
    }
  ],
  "require": {
    "xactimate-one/sdk-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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



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


$apiInstance = new OpenAPI\Client\Api\HealthApi(
    // 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->alive();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HealthApi->alive: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
HealthApi	alive	GET /health/alive	Returns "alive" if the service is available.
HealthApi	details	GET /health/details	Returns the health details of the service and its dependencies.
PropertyClaimsApi	createClaim	POST /v1/property/claims	Create a claim
PropertyClaimsApi	getClaim	GET /v1/property/claims/{claimId}	Get claim
PropertyClaimsApi	updateClaim	PUT /v1/property/claims/{claimId}	Update claim
PropertyClaimsCalculationsApi	getClaimCalculations	GET /v1/property/claims/{claimId}/calculations
PropertyClaimsEstimationApi	getClaimEstimates	GET /v1/property/claims/{claimId}/estimates	Get claim estimates
PropertyClaimsEstimationApi	getEstimateByEstimateId	GET /v1/property/claims/{claimId}/estimates/{estimateId}	Get estimate by estimate id
PropertyClaimsFormsApi	createPropertyClaimForm	POST /v1/property/claims/{claimId}/forms	Create a form
PropertyClaimsFormsApi	getPropertyClaimForm	GET /v1/property/claims/{claimId}/forms/{formId}	Get a form
PropertyClaimsFormsApi	getPropertyClaimForms	GET /v1/property/claims/{claimId}/forms	Get forms
PropertyClaimsFormsApi	updatePropertyClaimForm	PUT /v1/property/claims/{claimId}/forms/{formId}	Update a form
PropertyClaimsLossApi	getClaimLoss	GET /v1/property/claims/{claimId}/loss	Get claim loss
PropertyClaimsLossApi	updateClaimLoss	PUT /v1/property/claims/{claimId}/loss	Update claim loss
PropertyClaimsMediaApi	createMedia	POST /v1/property/claims/{claimId}/media	Create claim media
PropertyClaimsMediaApi	getMedia	GET /v1/property/claims/{claimId}/media	Get claim media
PropertyClaimsMediaApi	getMediaById	GET /v1/property/claims/{claimId}/media/{mediaId}	Get claim media item
PropertyClaimsMediaApi	updateMedia	PUT /v1/property/claims/{claimId}/media/{mediaId}	Update claim media
PropertyClaimsPolicyApi	getClaimPolicy	GET /v1/property/claims/{claimId}/policy	Get claim policy
PropertyClaimsPolicyApi	updateClaimPolicy	PUT /v1/property/claims/{claimId}/policy	Update claim policy
PropertyClaimsReportsApi	createClaimReport	POST /v1/property/claims/{claimId}/reports	Create a claim report
PropertyClaimsReportsApi	getClaimReportById	GET /v1/property/claims/{claimId}/reports/{reportId}	Get a specific claim report
PropertyClaimsReportsApi	getClaimReports	GET /v1/property/claims/{claimId}/reports	Get reports for claim
PropertyClaimsRolesApi	addClaimManagerByEmail	PUT /v1/property/claims/{claimId}/claim-manager/account-user/{email}	Add claim manager
PropertyClaimsRolesApi	addRoleByEmail	PUT /v1/property/claims/{claimId}/roles/{roleId}/account-user/{email}	Add user to role
PropertyClaimsRolesApi	removeClaimManagerByEmail	DELETE /v1/property/claims/{claimId}/claim-manager/account-user/{email}	Remove claim manager
PropertyClaimsRolesApi	removeRoleByEmail	DELETE /v1/property/claims/{claimId}/roles/{roleId}/account-user/{email}	Remove user from role
PropertyClaimsStakeholdersApi	createClaimStakeholder	POST /v1/property/claims/{claimId}/stakeholders	Add claim stakeholder
PropertyClaimsStakeholdersApi	getClaimStakeholderById	GET /v1/property/claims/{claimId}/stakeholders/{stakeholderId}	Get claim stakeholder
PropertyClaimsStakeholdersApi	getClaimStakeholders	GET /v1/property/claims/{claimId}/stakeholders	Get claim stakeholders
PropertyClaimsStakeholdersApi	updateClaimStakeholder	PUT /v1/property/claims/{claimId}/stakeholders/{stakeholderId}	Update claim stakeholder
PropertyClaimsStatusApi	updateClaimStatus	PUT /v1/property/claims/{claimId}/status	Updates status for property claim
PropertyTemplatesApi	getClaimTemplateFormTemplates	GET /v1/property/templates/claims/{claimTemplateId}/forms	Get claim template form templates
PropertyTemplatesApi	getClaimTemplateReportTemplates	GET /v1/property/templates/claims/{claimTemplateId}/reports	Get claim template report templates
PropertyTemplatesApi	getClaimTemplateRoleTemplates	GET /v1/property/templates/claims/{claimTemplateId}/roles	Get claim template role templates
PropertyTemplatesApi	getClaimTemplateStatusChangeReasonTemplates	GET /v1/property/templates/claims/{claimTemplateId}/status-change-reasons	Get claim template status change reason templates
PropertyTemplatesApi	getClaimTemplates	GET /v1/property/templates/claims	Get claim templates
PropertyTemplatesApi	getFormTemplates	GET /v1/property/templates/forms	Get form templates
PropertyTemplatesApi	getPerilCauseTemplates	GET /v1/property/templates/perils/{perilId}/causes	Get peril causes templates
PropertyTemplatesApi	getPerilsTemplates	GET /v1/property/templates/perils	Get peril templates
PropertyTemplatesApi	getPolicyTemplates	GET /v1/property/templates/policies	Get policy templates
PropertyTemplatesApi	getReportTemplates	GET /v1/property/templates/reports	Get instance report templates
PropertyTemplatesApi	getRoleTemplates	GET /v1/property/templates/roles	Get role templates

Models

Authorization

ApiKey

Type: API key
API key parameter name: x-api-key
Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

xactimate-one / sdk-php

Maintainers

Details