faxto/faxto-php

dev-master 2017-05-11 15:16 UTC

Requires

• php: >=5.4
• ext-curl: *
• ext-json: *
• ext-mbstring: *

Requires (Dev)

• friendsofphp/php-cs-fixer: ~1.12
• phpunit/phpunit: ~4.8
• satooshi/php-coveralls: ~1.0
• squizlabs/php_codesniffer: ~2.6

proprietary

• Swagger and contributors

• php
• api
• sdk
• swagger

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.0.1
• Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

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

{
  "require": {
    "faxto/faxto-php": "dev-master"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

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

$api_instance = new Swagger\Client\Api\AccountApi();
$api_key = "api_key_example"; // string | API Key

try {
    $api_instance->balanceGet($api_key);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->balanceGet: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://fax.to/api/v1

Class	Method	HTTP request	Description
AccountApi	balanceGet	GET /balance
FaxApi	faxDocumentIdCostsGet	GET /fax/{document_id}/costs
FaxApi	faxHistoryGet	GET /fax-history
FaxApi	faxJobIdStatusGet	GET /fax/{job_id}/status
FaxApi	faxPost	POST /fax
FilesApi	filesGet	GET /files
FilesApi	filesIdDelete	DELETE /files/{id}
FilesApi	filesPost	POST /files

Documentation For Models

• File

Documentation For Authorization

All endpoints do not require authorization.

Author