Skip to content

Latest commit

 

History

History
315 lines (237 loc) · 13.2 KB

CustomerApi.md

File metadata and controls

315 lines (237 loc) · 13.2 KB
Raw

Swagger\Client\CustomerApi

All URIs are relative to https://api.easybill.de/rest/v1

Method HTTP request Description
customersGet GET /customers Fetch customers list
customersIdDelete DELETE /customers/{id} Delete customer
customersIdGet GET /customers/{id} Fetch customer
customersIdPut PUT /customers/{id} Update Customer
customersPost POST /customers Create customer

customersGet

\Swagger\Client\Model\Customers customersGet($limit, $page, $group_id, $additional_group_id, $number, $country, $zip_code, $emails, $first_name, $last_name, $company_name, $created_at)

Fetch customers list

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Bearer
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Swagger\Client\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(),
    $config
);
$limit = 56; // int | Limited the result. Default is 100. Maximum can be 1000.
$page = 56; // int | Set current Page. Default is 1.
$group_id = "group_id_example"; // string | Filter customers by group_id. You can add multiple group ids separate by comma like id,id,id.
$additional_group_id = "additional_group_id_example"; // string | Filter customers by additional_group_id. You can add multiple group ids separate by comma like id,id,id.
$number = "number_example"; // string | Filter customers by number. You can add multiple numbers separate by comma like no,no,no.
$country = "country_example"; // string | Filter customers by country. You can add multiple countries separate by comma like DE,PL,FR.
$zip_code = "zip_code_example"; // string | Filter customers by zip_code. You can add multiple zip codes separate by comma like zip,zip,zip.
$emails = "emails_example"; // string | Filter customers by emails. You can add multiple emails separate by comma like mail,mail,mail.
$first_name = "first_name_example"; // string | Filter customers by first_name. You can add multiple names separate by comma like name,name,name.
$last_name = "last_name_example"; // string | Filter customers by first_name. You can add multiple names separate by comma like name,name,name.
$company_name = "company_name_example"; // string | Filter customers by first_name. You can add multiple names separate by comma like name,name,name.
$created_at = "created_at_example"; // string | Filter customers by created_at. You can filter one date with created_at=2014-12-10 or between like 2015-01-01,2015-12-31.

try {
    $result = $apiInstance->customersGet($limit, $page, $group_id, $additional_group_id, $number, $country, $zip_code, $emails, $first_name, $last_name, $company_name, $created_at);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->customersGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
limit int Limited the result. Default is 100. Maximum can be 1000. [optional]
page int Set current Page. Default is 1. [optional]
group_id string Filter customers by group_id. You can add multiple group ids separate by comma like id,id,id. [optional]
additional_group_id string Filter customers by additional_group_id. You can add multiple group ids separate by comma like id,id,id. [optional]
number string Filter customers by number. You can add multiple numbers separate by comma like no,no,no. [optional]
country string Filter customers by country. You can add multiple countries separate by comma like DE,PL,FR. [optional]
zip_code string Filter customers by zip_code. You can add multiple zip codes separate by comma like zip,zip,zip. [optional]
emails string Filter customers by emails. You can add multiple emails separate by comma like mail,mail,mail. [optional]
first_name string Filter customers by first_name. You can add multiple names separate by comma like name,name,name. [optional]
last_name string Filter customers by first_name. You can add multiple names separate by comma like name,name,name. [optional]
company_name string Filter customers by first_name. You can add multiple names separate by comma like name,name,name. [optional]
created_at string Filter customers by created_at. You can filter one date with created_at=2014-12-10 or between like 2015-01-01,2015-12-31. [optional]

Return type

\Swagger\Client\Model\Customers

Authorization

Bearer, basicAuth

HTTP request headers

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

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

customersIdDelete

customersIdDelete($id)

Delete customer

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Bearer
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Swagger\Client\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(),
    $config
);
$id = 789; // int | ID of customer that needs to be deleted

try {
    $apiInstance->customersIdDelete($id);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->customersIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int ID of customer that needs to be deleted

Return type

void (empty response body)

Authorization

Bearer, basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

customersIdGet

\Swagger\Client\Model\Customer customersIdGet($id)

Fetch customer

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Bearer
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Swagger\Client\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(),
    $config
);
$id = 789; // int | ID of customer that needs to be fetched

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

Parameters

Name Type Description Notes
id int ID of customer that needs to be fetched

Return type

\Swagger\Client\Model\Customer

Authorization

Bearer, basicAuth

HTTP request headers

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

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

customersIdPut

\Swagger\Client\Model\Customer customersIdPut($body, $id)

Update Customer

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Bearer
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Swagger\Client\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(),
    $config
);
$body = new \Swagger\Client\Model\Customer(); // \Swagger\Client\Model\Customer | 
$id = 789; // int | ID of customer that needs to be updated

try {
    $result = $apiInstance->customersIdPut($body, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->customersIdPut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \Swagger\Client\Model\Customer
id int ID of customer that needs to be updated

Return type

\Swagger\Client\Model\Customer

Authorization

Bearer, basicAuth

HTTP request headers

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

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

customersPost

\Swagger\Client\Model\Customer customersPost($body)

Create customer

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Bearer
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Swagger\Client\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(),
    $config
);
$body = new \Swagger\Client\Model\Customer(); // \Swagger\Client\Model\Customer | 

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

Parameters

Name Type Description Notes
body \Swagger\Client\Model\Customer

Return type

\Swagger\Client\Model\Customer

Authorization

Bearer, basicAuth

HTTP request headers

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

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