README

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

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

API version: 0.2.22
Build package: io.swagger.codegen.languages.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/gengo/qualification-client-php.git"
    }
  ],
  "require": {
    "gengo/qualification-client-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/QualificationClient/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 QualificationClient\Api\CustomerApi(
    // 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()
);
$user_id = 56; // int | Customer user ID.
$preferred_translators = array(new \QualificationClient\Model\PreferredTranslatorRequest()); // \QualificationClient\Model\PreferredTranslatorRequest[] | 

try {
    $result = $apiInstance->addPreferredTranslators($user_id, $preferred_translators);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->addPreferredTranslators: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
CustomerApi	addPreferredTranslators	PATCH /customer/{user_id}/translators/add_preferred	Add preferred translators
CustomerApi	removePreferredTranslators	PATCH /customer/{user_id}/translators/remove_preferred	Remove preferred translators
QualificationApi	createWorkerQualification	POST /workers/{worker_id}/qualifications/{qualification_type}	Create a new qualification
QualificationApi	endTranslatorProbation	PATCH /workers/qualifications/probations/end	Remove worker from probation
QualificationApi	getQualificationHistory	GET /qualifications/{qualification_type}/{qualification_id}/history	Get qualification history
QualificationApi	getQualificationTypes	GET /qualifications	Get all types of qualifications
QualificationApi	getQualifications	GET /qualifications/{qualification_type}/workers	Get all qualifications of the given qualification type
QualificationApi	getWorkerQualificationsHistory	GET /workers/{worker_id}/qualification-history/{qualification_type}	Get worker's qualifications history
QualificationApi	revokeWorkerQualification	PATCH /workers/qualifications/revoke	Revoke worker qualification
QualificationApi	startTranslatorProbation	PATCH /workers/qualifications/probations/start	Place worker on probation
QualificationApi	unrevokeWorkerQualification	PATCH /workers/qualifications/unrevoke	Unrevoke worker qualification
QualificationApi	updateWorkerQualification	PATCH /workers/{worker_id}/qualifications/{qualification_type}/{qualification_id}	Update qualification
StatusApi	getStatus	GET /status	Returns the API version
WorkerApi	createWorker	POST /workers	Create a new worker
WorkerApi	createWorkerDomain	POST /workers/{worker_id}/domains	Add a worker specialization
WorkerApi	getWorkerQualifications	GET /workers/{worker_id}/qualifications	Get worker qualifications
WorkerApi	getWorkers	GET /workers	Get workers

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

gengo / qualification-client-php

Maintainers

Details