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 /

Class	Method	HTTP request	Description
CatalogRecordsApi	addRecords	POST /api/publicapi/v1/catalogs/{catalogId}/records	Adds records to the specified catalog
CatalogRecordsApi	deleteRecords	POST /api/publicapi/v1/catalogs/{catalogId}/records/delete	Deletes the specified records from the catalog
CatalogRecordsApi	getRecord	GET /api/publicapi/v1/catalogs/{catalogId}/records/{recordId}	Gets a record
CatalogRecordsApi	getRecords	GET /api/publicapi/v1/catalogs/{catalogId}/records	Lists a portion of the records in the specified catalog
CatalogsApi	clearCatalog	POST /api/publicapi/v1/catalogs/{catalogId}/clear	Deletes all records from the catalog
CatalogsApi	getCatalog	GET /api/publicapi/v1/catalogs/{catalogId}	Gets detailed information about the catalog
CatalogsApi	getCatalogs	GET /api/publicapi/v1/catalogs	Lists all available catalogs
CatalogsApi	getReindexOperation	GET /api/publicapi/v1/catalogs/{catalogId}/reindex/{reindexOperationId}	Gets detailed information of reindex operation
CatalogsApi	startCatalogReindex	POST /api/publicapi/v1/catalogs/{catalogId}/reindex	Starts a catalog reindex operation
SkillsApi	getAvailableSkills	GET /api/publicapi/v1/skills	Lists all available skills
SkillsApi	getSkillInfo	GET /api/publicapi/v1/skills/{skillId}	Gets the detailed information about a skill
TransactionDocumentsApi	addFilesToTransactionDocument	POST /api/publicapi/v1/transactions/{transactionId}/documents/{documentId}/sourceFiles	Adds files to the transaction document
TransactionDocumentsApi	createTransactionDocument	POST /api/publicapi/v1/transactions/{transactionId}/documents	Creates a transaction document that will be used to group some files in single processing unit
TransactionDocumentsApi	deleteTransactionDocument	DELETE /api/publicapi/v1/transactions/{transactionId}/documents/{documentId}	Deletes the document from specified transaction
TransactionDocumentsApi	downloadTransactionDocumentSourceFile	GET /api/publicapi/v1/transactions/{transactionId}/documents/{documentId}/sourceFiles/{fileId}/download	Downloads the source file of the transaction
TransactionDocumentsApi	getTransactionDocument	GET /api/publicapi/v1/transactions/{transactionId}/documents/{documentId}	Gets transaction document info
TransactionDocumentsApi	getTransactionDocuments	GET /api/publicapi/v1/transactions/{transactionId}/documents	Gets transaction documents
TransactionsApi	addFilesToTransaction	POST /api/publicapi/v1/transactions/{transactionId}/files	Adds files to the transaction
TransactionsApi	createTransaction	POST /api/publicapi/v1/transactions	Creates a processing transaction
TransactionsApi	deleteTransaction	DELETE /api/publicapi/v1/transactions/{transactionId}	Deletes the transaction
TransactionsApi	downloadFile	GET /api/publicapi/v1/transactions/{transactionId}/files/{fileId}/download	Downloads the result files
TransactionsApi	generateMobileInputLink	POST /api/publicapi/v1/transactions/{transactionId}/mobileInputLink	Generates link to run mobile input with one time auth token to inject image to specific transaction
TransactionsApi	getTransactionInfo	GET /api/publicapi/v1/transactions/{transactionId}	Gets transaction info
TransactionsApi	getTransactionRegistrationParameters	GET /api/publicapi/v1/transactions/{transactionId}/registrationParameters	Gets registration parameters for the transaction
TransactionsApi	launchTransaction	POST /api/publicapi/v1/transactions/launch	Starts processing of the files in new transaction
TransactionsApi	startTransaction	POST /api/publicapi/v1/transactions/{transactionId}/start	Starts the transaction

Documentation For Models

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

jpvdw86 / abby-vantage

Maintainers

Details