Fiteco\KimaiClient\CustomerApi

All URIs are relative to http://localhost.

Method	HTTP request	Description
apiCustomersGet()	GET /api/customers	Returns a collection of customers
apiCustomersIdGet()	GET /api/customers/{id}	Returns one customer
apiCustomersIdMetaPatch()	PATCH /api/customers/{id}/meta	Sets the value of a meta-field for an existing customer
apiCustomersIdPatch()	PATCH /api/customers/{id}	Update an existing customer
apiCustomersIdRatesGet()	GET /api/customers/{id}/rates	Returns a collection of all rates for one customer
apiCustomersIdRatesPost()	POST /api/customers/{id}/rates	Adds a new rate to a customer
apiCustomersIdRatesRateIdDelete()	DELETE /api/customers/{id}/rates/{rateId}	Deletes one rate for an customer
apiCustomersPost()	POST /api/customers	Creates a new customer

`apiCustomersGet()`

apiCustomersGet($visible, $order, $orderBy, $term): \Fiteco\KimaiClient\Model\CustomerCollection[]

Returns a collection of customers

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiToken
$config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKey('X-AUTH-TOKEN', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-AUTH-TOKEN', 'Bearer');

// Configure API key authorization: apiUser
$config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKey('X-AUTH-USER', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-AUTH-USER', 'Bearer');


$apiInstance = new Fiteco\KimaiClient\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
);
$visible = 'visible_example'; // string | Visibility status to filter activities (1=visible, 2=hidden, 3=both)
$order = 'order_example'; // string | The result order. Allowed values: ASC, DESC (default: ASC)
$orderBy = 'orderBy_example'; // string | The field by which results will be ordered. Allowed values: id, name (default: name)
$term = 'term_example'; // string | Free search term

try {
    $result = $apiInstance->apiCustomersGet($visible, $order, $orderBy, $term);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->apiCustomersGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
visible	string	Visibility status to filter activities (1=visible, 2=hidden, 3=both)	[optional]
order	string	The result order. Allowed values: ASC, DESC (default: ASC)	[optional]
orderBy	string	The field by which results will be ordered. Allowed values: id, name (default: name)	[optional]
term	string	Free search term	[optional]

Return type

\Fiteco\KimaiClient\Model\CustomerCollection[]

Authorization

apiToken, apiUser

HTTP request headers

Content-Type: Not defined
Accept: */*

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

`apiCustomersIdGet()`

apiCustomersIdGet($id): \Fiteco\KimaiClient\Model\CustomerEntity

Returns one customer

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiToken
$config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKey('X-AUTH-TOKEN', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-AUTH-TOKEN', 'Bearer');

// Configure API key authorization: apiUser
$config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKey('X-AUTH-USER', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-AUTH-USER', 'Bearer');


$apiInstance = new Fiteco\KimaiClient\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 = 'id_example'; // string

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

Parameters

Name	Type	Description	Notes
id	string

Return type

\Fiteco\KimaiClient\Model\CustomerEntity

Authorization

apiToken, apiUser

HTTP request headers

Content-Type: Not defined
Accept: */*

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

`apiCustomersIdMetaPatch()`

apiCustomersIdMetaPatch($id, $body): \Fiteco\KimaiClient\Model\CustomerEntity

Sets the value of a meta-field for an existing customer

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiToken
$config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKey('X-AUTH-TOKEN', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-AUTH-TOKEN', 'Bearer');

// Configure API key authorization: apiUser
$config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKey('X-AUTH-USER', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-AUTH-USER', 'Bearer');


$apiInstance = new Fiteco\KimaiClient\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 = 56; // int | Customer record ID to set the meta-field value for
$body = new \Fiteco\KimaiClient\Model\InlineObject1(); // \Fiteco\KimaiClient\Model\InlineObject1

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

Parameters

Name	Type	Description	Notes
id	int	Customer record ID to set the meta-field value for
body	\Fiteco\KimaiClient\Model\InlineObject1		[optional]

Return type

\Fiteco\KimaiClient\Model\CustomerEntity

Authorization

apiToken, apiUser

HTTP request headers

Content-Type: Not defined
Accept: */*

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

`apiCustomersIdPatch()`

apiCustomersIdPatch($id, $body): \Fiteco\KimaiClient\Model\CustomerEntity

Update an existing customer

Update an existing customer, you can pass all or just a subset of all attributes

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiToken
$config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKey('X-AUTH-TOKEN', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-AUTH-TOKEN', 'Bearer');

// Configure API key authorization: apiUser
$config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKey('X-AUTH-USER', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-AUTH-USER', 'Bearer');


$apiInstance = new Fiteco\KimaiClient\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 = 56; // int | Customer ID to update
$body = new \Fiteco\KimaiClient\Model\CustomerEditForm(); // \Fiteco\KimaiClient\Model\CustomerEditForm

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

Parameters

Name	Type	Description	Notes
id	int	Customer ID to update
body	\Fiteco\KimaiClient\Model\CustomerEditForm

Return type

\Fiteco\KimaiClient\Model\CustomerEntity

Authorization

apiToken, apiUser

HTTP request headers

Content-Type: Not defined
Accept: */*

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

`apiCustomersIdRatesGet()`

apiCustomersIdRatesGet($id): \Fiteco\KimaiClient\Model\CustomerRate[]

Returns a collection of all rates for one customer

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiToken
$config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKey('X-AUTH-TOKEN', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-AUTH-TOKEN', 'Bearer');

// Configure API key authorization: apiUser
$config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKey('X-AUTH-USER', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-AUTH-USER', 'Bearer');


$apiInstance = new Fiteco\KimaiClient\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 = 56; // int | The customer whose rates will be returned

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

Parameters

Name	Type	Description	Notes
id	int	The customer whose rates will be returned

Return type

\Fiteco\KimaiClient\Model\CustomerRate[]

Authorization

apiToken, apiUser

HTTP request headers

Content-Type: Not defined
Accept: */*

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

`apiCustomersIdRatesPost()`

apiCustomersIdRatesPost($id, $body): \Fiteco\KimaiClient\Model\CustomerRate

Adds a new rate to a customer

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiToken
$config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKey('X-AUTH-TOKEN', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-AUTH-TOKEN', 'Bearer');

// Configure API key authorization: apiUser
$config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKey('X-AUTH-USER', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-AUTH-USER', 'Bearer');


$apiInstance = new Fiteco\KimaiClient\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 = 56; // int | The customer to add the rate for
$body = new \Fiteco\KimaiClient\Model\CustomerRateForm(); // \Fiteco\KimaiClient\Model\CustomerRateForm

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

Parameters

Name	Type	Description	Notes
id	int	The customer to add the rate for
body	\Fiteco\KimaiClient\Model\CustomerRateForm

Return type

\Fiteco\KimaiClient\Model\CustomerRate

Authorization

apiToken, apiUser

HTTP request headers

Content-Type: Not defined
Accept: */*

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

`apiCustomersIdRatesRateIdDelete()`

apiCustomersIdRatesRateIdDelete($id, $rateId)

Deletes one rate for an customer

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiToken
$config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKey('X-AUTH-TOKEN', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-AUTH-TOKEN', 'Bearer');

// Configure API key authorization: apiUser
$config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKey('X-AUTH-USER', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-AUTH-USER', 'Bearer');


$apiInstance = new Fiteco\KimaiClient\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 = 56; // int | The customer whose rate will be removed
$rateId = 56; // int | The rate to remove

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

Parameters

Name	Type	Description	Notes
id	int	The customer whose rate will be removed
rateId	int	The rate to remove

Return type

void (empty response body)

Authorization

apiToken, apiUser

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`apiCustomersPost()`

apiCustomersPost($body): \Fiteco\KimaiClient\Model\CustomerEntity

Creates a new customer

Creates a new customer and returns it afterwards

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiToken
$config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKey('X-AUTH-TOKEN', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-AUTH-TOKEN', 'Bearer');

// Configure API key authorization: apiUser
$config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKey('X-AUTH-USER', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Fiteco\KimaiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-AUTH-USER', 'Bearer');


$apiInstance = new Fiteco\KimaiClient\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 \Fiteco\KimaiClient\Model\CustomerEditForm(); // \Fiteco\KimaiClient\Model\CustomerEditForm

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

Parameters

Name	Type	Description	Notes
body	\Fiteco\KimaiClient\Model\CustomerEditForm

Return type

\Fiteco\KimaiClient\Model\CustomerEntity

Authorization

apiToken, apiUser

HTTP request headers

Content-Type: Not defined
Accept: */*

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

Files

CustomerApi.md

Latest commit

History

CustomerApi.md

File metadata and controls

Fiteco\KimaiClient\CustomerApi

apiCustomersGet()

Example

Parameters

Return type

Authorization

HTTP request headers

apiCustomersIdGet()

Example

Parameters

Return type

Authorization

HTTP request headers

apiCustomersIdMetaPatch()

Example

Parameters

Return type

Authorization

HTTP request headers

apiCustomersIdPatch()

Example

Parameters

Return type

Authorization

HTTP request headers

apiCustomersIdRatesGet()

Example

Parameters

Return type

Authorization

HTTP request headers

apiCustomersIdRatesPost()

Example

Parameters

Return type

Authorization

HTTP request headers

apiCustomersIdRatesRateIdDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

apiCustomersPost()

Example

Parameters

Return type

Authorization

HTTP request headers

`apiCustomersGet()`

`apiCustomersIdGet()`

`apiCustomersIdMetaPatch()`

`apiCustomersIdPatch()`

`apiCustomersIdRatesGet()`

`apiCustomersIdRatesPost()`

`apiCustomersIdRatesRateIdDelete()`

`apiCustomersPost()`