README

Environment: Production
Product Version: 1.0.0-0.37.11-20220624.1

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/jpvdw86/abby-vantage.git"
    }
  ],
  "require": {
    "jpvdw86/abby-vantage": "*@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 OAuth2 access token for authorization: OAuth2Security
$config = jpvdw86\AbbyVantage\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new jpvdw86\AbbyVantage\Api\CatalogRecordsApi(
    // 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
);
$catalog_id = "catalog_id_example"; // string | Catalog identifier. You can find it in the list of all catalogs.
$body = array(new \jpvdw86\AbbyVantage\Model\AbbyyVantagePublicApiContractCatalogsRequestsRecordModel()); // \jpvdw86\AbbyVantage\Model\AbbyyVantagePublicApiContractCatalogsRequestsRecordModel[] | Records to add

try {
    $result = $apiInstance->addRecords($catalog_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CatalogRecordsApi->addRecords: ', $e->getMessage(), PHP_EOL;
}

// Configure OAuth2 access token for authorization: OAuth2Security
$config = jpvdw86\AbbyVantage\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new jpvdw86\AbbyVantage\Api\CatalogRecordsApi(
    // 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
);
$catalog_id = "catalog_id_example"; // string | Catalog identifier. You can find it in the list of all catalogs.
$body = array("body_example"); // string[] | An array of record identifiers to delete

try {
    $apiInstance->deleteRecords($catalog_id, $body);
} catch (Exception $e) {
    echo 'Exception when calling CatalogRecordsApi->deleteRecords: ', $e->getMessage(), PHP_EOL;
}

// Configure OAuth2 access token for authorization: OAuth2Security
$config = jpvdw86\AbbyVantage\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new jpvdw86\AbbyVantage\Api\CatalogRecordsApi(
    // 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
);
$catalog_id = "catalog_id_example"; // string | Catalog identifier. You can find it in the list of all catalogs.
$record_id = "record_id_example"; // string | Record identifier. You can find it in the list of records.

try {
    $result = $apiInstance->getRecord($catalog_id, $record_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CatalogRecordsApi->getRecord: ', $e->getMessage(), PHP_EOL;
}

// Configure OAuth2 access token for authorization: OAuth2Security
$config = jpvdw86\AbbyVantage\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new jpvdw86\AbbyVantage\Api\CatalogRecordsApi(
    // 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
);
$catalog_id = "catalog_id_example"; // string | Catalog identifier. You can find it in the list of all catalogs.
$offset = 0; // int | Pagination offset
$limit = 1000; // int | Maximum number of items to return

try {
    $result = $apiInstance->getRecords($catalog_id, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CatalogRecordsApi->getRecords: ', $e->getMessage(), PHP_EOL;
}
?>

Documentation for API Endpoints

All URIs are relative to /

Documentation For Models

• AbbyyVantagePublicApiContractCatalogsColumnType
• AbbyyVantagePublicApiContractCatalogsReindexState
• AbbyyVantagePublicApiContractCatalogsRequestsRecordModel
• AbbyyVantagePublicApiContractCatalogsResultsAddRecordsResultResult
• AbbyyVantagePublicApiContractCatalogsResultsCatalogDto
• AbbyyVantagePublicApiContractCatalogsResultsCatalogListItemDto
• AbbyyVantagePublicApiContractCatalogsResultsColumnDto
• AbbyyVantagePublicApiContractCatalogsResultsRecordDto
• AbbyyVantagePublicApiContractCatalogsResultsReindexOperationResult
• AbbyyVantagePublicApiContractFieldType
• AbbyyVantagePublicApiContractSkillsResultsFieldDto
• AbbyyVantagePublicApiContractSkillsResultsInnerSkillDto
• AbbyyVantagePublicApiContractSkillsResultsSkillClassDto
• AbbyyVantagePublicApiContractSkillsResultsSkillDto
• AbbyyVantagePublicApiContractSkillsResultsSkillListItemDto
• AbbyyVantagePublicApiContractSkillsSkillType
• AbbyyVantagePublicApiContractSkillsTextFieldFormat
• AbbyyVantagePublicApiContractTransactionsRequestsImageProcessingOptions
• AbbyyVantagePublicApiContractTransactionsRequestsPreprocessingOperationSwitcher
• AbbyyVantagePublicApiContractTransactionsRequestsTransactionCreateRequest
• AbbyyVantagePublicApiContractTransactionsRequestsTransactionDocumentCreateRequest
• AbbyyVantagePublicApiContractTransactionsRequestsTransactionDocumentFileMetadataDto
• AbbyyVantagePublicApiContractTransactionsRequestsTransactionDocumentMetadataDto
• AbbyyVantagePublicApiContractTransactionsRequestsTransactionFileMetadataDto
• AbbyyVantagePublicApiContractTransactionsRequestsTransactionFileRegistrationParameter
• AbbyyVantagePublicApiContractTransactionsRequestsTransactionLaunchMetadataDto
• AbbyyVantagePublicApiContractTransactionsRequestsTransactionMetadataDto
• AbbyyVantagePublicApiContractTransactionsRequestsTransactionRegistrationParameter
• AbbyyVantagePublicApiContractTransactionsResultFileType
• AbbyyVantagePublicApiContractTransactionsResultsClassDto
• AbbyyVantagePublicApiContractTransactionsResultsClassificationConfidenceDto
• AbbyyVantagePublicApiContractTransactionsResultsClassificationDto
• AbbyyVantagePublicApiContractTransactionsResultsCreatedTransactionResult
• AbbyyVantagePublicApiContractTransactionsResultsDocumentBusinessRulesErrorDto
• AbbyyVantagePublicApiContractTransactionsResultsExtractedDocumentDto
• AbbyyVantagePublicApiContractTransactionsResultsFileDto
• AbbyyVantagePublicApiContractTransactionsResultsMobileInputLinkResult
• AbbyyVantagePublicApiContractTransactionsResultsNewTransactionDocumentResult
• AbbyyVantagePublicApiContractTransactionsResultsNewTransactionResult
• AbbyyVantagePublicApiContractTransactionsResultsResultFileDto
• AbbyyVantagePublicApiContractTransactionsResultsTransactionDocumentResult
• AbbyyVantagePublicApiContractTransactionsResultsTransactionDto
• AbbyyVantagePublicApiContractTransactionsResultsTransactionRegistrationParameterDto
• AbbyyVantagePublicApiContractTransactionsTransactionStatus
• Apipublicapiv1transactionslaunchModel
• Apipublicapiv1transactionstransactionIddocumentsdocumentIdsourceFilesModel
• Apipublicapiv1transactionstransactionIdfilesModel
• DocumentIdSourceFilesBody
• MicrosoftAspNetCoreMvcProblemDetails
• TransactionIdFilesBody
• TransactionsLaunchBody

Documentation For Authorization

OAuth2Security

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://vantage-eu.abbyy.com/auth2/connect/authorize
• Scopes:
• openid: User Id
• permissions: User permissions

Author

Jean-Paul van der Wegen Generated by swagger-codegen

swagger-codegen generate -l php -i https://vantage-eu.abbyy.com/api/swagger/publicapi/v1 --git-repo-id abby-vantage --git-user-id jpvdw86 --invoker-package "jpvdw86\abby-vantage" -o /Volumes/Development/AbbyVantage