Skip to content

Latest commit

 

History

History
66 lines (48 loc) · 2.38 KB

DocumentBlockApi.md

File metadata and controls

66 lines (48 loc) · 2.38 KB

Swagger\Client\DocumentBlockApi

All URIs are relative to https://api.billingo.hu/v3

Method HTTP request Description
listDocumentBlock GET /document-blocks List all document blocks

listDocumentBlock

\Swagger\Client\Model\DocumentBlockList listDocumentBlock($page, $per_page, $type)

List all document blocks

Returns a list of your document blocks. The document blocks are returned sorted by creation date, with the most recent document blocks appearing first.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$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\DocumentBlockApi(
    // 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
);
$page = 56; // int | 
$per_page = 25; // int | 
$type = new \Swagger\Client\Model\DocumentBlockType(); // \Swagger\Client\Model\DocumentBlockType | Filter document blocks by type

try {
    $result = $apiInstance->listDocumentBlock($page, $per_page, $type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentBlockApi->listDocumentBlock: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
page int [optional]
per_page int [optional] [default to 25]
type \Swagger\Client\Model\DocumentBlockType Filter document blocks by type [optional]

Return type

\Swagger\Client\Model\DocumentBlockList

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]