disophisis/sdk-php

SwaggerClient-php

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.

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

• API version: null
• Build package: io.swagger.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/xactimate-one/sdk-php.git"
    }
  ],
  "require": {
    "xactimate-one/sdk-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-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');

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

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

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

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

Documentation for API Endpoints

All URIs are relative to /

Class	Method	HTTP request	Description
HealthApi	healthAliveGet	GET /health/alive	Returns "alive" if the service is available.
HealthApi	healthDetailsGet	GET /health/details	Returns the health details of the service and its dependencies.
PropertyClaimsMediaApi	v1PropertyClaimsClaimIdMediaGet	GET /v1/property/claims/{claimId}/media	Get claim media
PropertyClaimsMediaApi	v1PropertyClaimsClaimIdMediaMediaIdGet	GET /v1/property/claims/{claimId}/media/{mediaId}	Get claim media item
PropertyClaimsMediaApi	v1PropertyClaimsClaimIdMediaMediaIdPut	PUT /v1/property/claims/{claimId}/media/{mediaId}	Update claim media
PropertyClaimsMediaApi	v1PropertyClaimsClaimIdMediaPost	POST /v1/property/claims/{claimId}/media	Create claim media
PropertyClaimsReportsApi	v1PropertyClaimsClaimIdReportsGet	GET /v1/property/claims/{claimId}/reports	Get reports for claim
PropertyClaimsReportsApi	v1PropertyClaimsClaimIdReportsPost	POST /v1/property/claims/{claimId}/reports	Create a claim report
PropertyClaimsReportsApi	v1PropertyClaimsClaimIdReportsReportIdGet	GET /v1/property/claims/{claimId}/reports/{reportId}	Get a specific claim report
PropertyClaimsRolesApi	v1PropertyClaimsClaimIdClaimManagerAccountUserEmailDelete	DELETE /v1/property/claims/{claimId}/claim-manager/account-user/{email}	Remove claim manager
PropertyClaimsRolesApi	v1PropertyClaimsClaimIdClaimManagerAccountUserEmailPut	PUT /v1/property/claims/{claimId}/claim-manager/account-user/{email}	Add claim manager
PropertyClaimsRolesApi	v1PropertyClaimsClaimIdRolesRoleIdAccountUserEmailDelete	DELETE /v1/property/claims/{claimId}/roles/{roleId}/account-user/{email}	Remove user from role
PropertyClaimsRolesApi	v1PropertyClaimsClaimIdRolesRoleIdAccountUserEmailPut	PUT /v1/property/claims/{claimId}/roles/{roleId}/account-user/{email}	Add user to role
PropertyClaimsStakeholdersApi	v1PropertyClaimsClaimIdStakeholdersGet	GET /v1/property/claims/{claimId}/stakeholders	Get claim stakeholders
PropertyClaimsStakeholdersApi	v1PropertyClaimsClaimIdStakeholdersPost	POST /v1/property/claims/{claimId}/stakeholders	Add claim stakeholder
PropertyClaimsStakeholdersApi	v1PropertyClaimsClaimIdStakeholdersStakeholderIdGet	GET /v1/property/claims/{claimId}/stakeholders/{stakeholderId}	Get claim stakeholder
PropertyClaimsStakeholdersApi	v1PropertyClaimsClaimIdStakeholdersStakeholderIdPut	PUT /v1/property/claims/{claimId}/stakeholders/{stakeholderId}	Update claim stakeholder
PropertyClaimsStatusApi	v1PropertyClaimsClaimIdStatusPut	PUT /v1/property/claims/{claimId}/status	Updates status for property claim
PropertyTemplatesApi	v1PropertyTemplatesClaimsClaimTemplateIdFormsGet	GET /v1/property/templates/claims/{claimTemplateId}/forms	Get claim template form templates
PropertyTemplatesApi	v1PropertyTemplatesClaimsClaimTemplateIdReportsGet	GET /v1/property/templates/claims/{claimTemplateId}/reports	Gets claim template report templates
PropertyTemplatesApi	v1PropertyTemplatesClaimsClaimTemplateIdRolesGet	GET /v1/property/templates/claims/{claimTemplateId}/roles	Get claim template role templates
PropertyTemplatesApi	v1PropertyTemplatesClaimsClaimTemplateIdStatusChangeReasonsGet	GET /v1/property/templates/claims/{claimTemplateId}/status-change-reasons	Get claim template status change reason templates
PropertyTemplatesApi	v1PropertyTemplatesClaimsGet	GET /v1/property/templates/claims	Gets claim templates
PropertyTemplatesApi	v1PropertyTemplatesFormsGet	GET /v1/property/templates/forms	Get form templates
PropertyTemplatesApi	v1PropertyTemplatesPerilsGet	GET /v1/property/templates/perils	Get peril templates
PropertyTemplatesApi	v1PropertyTemplatesPerilsPerilIdCausesGet	GET /v1/property/templates/perils/{perilId}/causes	Get peril causes templates
PropertyTemplatesApi	v1PropertyTemplatesPoliciesGet	GET /v1/property/templates/policies	Get policy templates
PropertyTemplatesApi	v1PropertyTemplatesReportsGet	GET /v1/property/templates/reports	Get instance report templates
PropertyTemplatesApi	v1PropertyTemplatesRoleGet	GET /v1/property/templates/role	Get role templates

Documentation For Models

• AccountMetadataResponse
• ClaimStatusChangeRequest
• ClaimStatusType
• DependencyHealthDetails
• IStakeholderCreateRequest
• IStakeholderResponse
• IStakeholderUpdateRequest
• MediaCreateRequest
• MediaCreatedResponse
• MediaResponse
• MediaUpdateRequest
• MediaUpdatedResponse
• ProblemDetails
• ReportCreateRequest
• ReportResponse
• ServiceStatus
• StakeholderType
• TemplateMetadataResponse

Documentation For Authorization

ApiKey

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

Author