MediaApi.md

Coucounco\Airkey\Swagger\Client\MediaApi

All URIs are relative to https://integration.api.airkey.evva.com:443/cloud

Method	HTTP request	Description
assignOwnerToMedium	POST /v1/media/assign	Assigns a person to a medium for each provided assignment.
cancelMediumAssignments	POST /v1/media/cancel-assignment	Cancels assignments of media.
createPhones	POST /v1/media/phones	Adds list of new phones.
deactivateMedium	POST /v1/media/{mediumId}/deactivate	Deactivates provided medium.
deletePhones	DELETE /v1/media/phones	Deletes provided phones.
emptyMedium	POST /v1/media/{mediumId}/empty	Empties provided medium.
generatePairingCodeForPhone	POST /v1/media/phones/{phoneId}/pairing	Generates a new pairing code for a phone.
getCard	GET /v1/media/cards/{cardId}	Gets information of specific card.
getCards	GET /v1/media/cards	Gets information of all cards.
getMedia	GET /v1/media	Gets information of all media.
getMedium	GET /v1/media/{mediumId}	Gets information of a specific medium.
getPhone	GET /v1/media/phones/{phoneId}	Gets information of specific phone.
getPhones	GET /v1/media/phones	Gets information of all phones.
reactivateMedium	POST /v1/media/{mediumId}/reactivate	Reactivates provided medium.
resetPinOfPhone	POST /v1/media/phones/{phoneId}/pin-reset	Resets PIN of the phone.
sendRegistrationCodeToPhone	POST /v1/media/phones/{phoneId}/send-registration-code	Sends pairing code to phone.
updateCards	PUT /v1/media/cards	Updates list of cards.
updatePhones	PUT /v1/media/phones	Updates list of phones.

assignOwnerToMedium

\Coucounco\Airkey\Swagger\Client\Model\MediumAssignment[] assignOwnerToMedium($body)

Assigns a person to a medium for each provided assignment.

Creates a person assignment for a medium according to the provided list of assignments and returns the resulting assignment list.

Example

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

// Configure API key authorization: X-API-Key
$config = Coucounco\Airkey\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 = Coucounco\Airkey\Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

$apiInstance = new Coucounco\Airkey\Swagger\Client\Api\MediaApi(
    // 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 = array(new \Coucounco\Airkey\Swagger\Client\Model\MediumAssignment()); // \Coucounco\Airkey\Swagger\Client\Model\MediumAssignment[] | List of medium assignments

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

Parameters

Name	Type	Description	Notes
body	\Coucounco\Airkey\Swagger\Client\Model\MediumAssignment[]	List of medium assignments

Return type

\Coucounco\Airkey\Swagger\Client\Model\MediumAssignment[]

Authorization

X-API-Key

HTTP request headers

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

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

cancelMediumAssignments

int[] cancelMediumAssignments($body)

Cancels assignments of media.

Cancels the person assignments of the provided list of media and returns a list of identifiers of the updated medium objects.

Example

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

// Configure API key authorization: X-API-Key
$config = Coucounco\Airkey\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 = Coucounco\Airkey\Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

$apiInstance = new Coucounco\Airkey\Swagger\Client\Api\MediaApi(
    // 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 = array(new \Coucounco\Airkey\Swagger\Client\Model\int[]()); // int[] | List of unique medium identifiers

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

Parameters

Name	Type	Description	Notes
body	int[]	List of unique medium identifiers

Return type

int[]

Authorization

X-API-Key

HTTP request headers

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

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

createPhones

\Coucounco\Airkey\Swagger\Client\Model\Phone[] createPhones($body)

Adds list of new phones.

Creates and adds the provided phones to the access control system and returns a list of the new phone objects. Please check before if a phone already exists with the given phone number to prevent duplicates.

Example

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

// Configure API key authorization: X-API-Key
$config = Coucounco\Airkey\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 = Coucounco\Airkey\Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

$apiInstance = new Coucounco\Airkey\Swagger\Client\Api\MediaApi(
    // 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 = array(new \Coucounco\Airkey\Swagger\Client\Model\PhoneCreate()); // \Coucounco\Airkey\Swagger\Client\Model\PhoneCreate[] | List of phones to be added

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

Parameters

Name	Type	Description	Notes
body	\Coucounco\Airkey\Swagger\Client\Model\PhoneCreate[]	List of phones to be added

Return type

\Coucounco\Airkey\Swagger\Client\Model\Phone[]

Authorization

X-API-Key

HTTP request headers

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

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

deactivateMedium

\Coucounco\Airkey\Swagger\Client\Model\Medium deactivateMedium($medium_id, $reason, $comment)

Deactivates provided medium.

Deactivates the provided medium and returns a new version of the medium object. The fields "reason" and "comment" are saved in the system protocol and are not part of the response.

Example

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

// Configure API key authorization: X-API-Key
$config = Coucounco\Airkey\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 = Coucounco\Airkey\Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

$apiInstance = new Coucounco\Airkey\Swagger\Client\Api\MediaApi(
    // 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
);
$medium_id = 789; // int | Unique identifier of the medium to be deactivated
$reason = "reason_example"; // string | Reason of deactivation
$comment = "comment_example"; // string | Additional comment of deactivation

try {
    $result = $apiInstance->deactivateMedium($medium_id, $reason, $comment);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MediaApi->deactivateMedium: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
medium_id	int	Unique identifier of the medium to be deactivated
reason	string	Reason of deactivation
comment	string	Additional comment of deactivation	[optional]

Return type

\Coucounco\Airkey\Swagger\Client\Model\Medium

Authorization

X-API-Key

HTTP request headers

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

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

deletePhones

int[] deletePhones($body)

Deletes provided phones.

Deletes the provided phones and returns a list of identifiers of all deleted objects.

Example

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

// Configure API key authorization: X-API-Key
$config = Coucounco\Airkey\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 = Coucounco\Airkey\Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

$apiInstance = new Coucounco\Airkey\Swagger\Client\Api\MediaApi(
    // 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 = array(new \Coucounco\Airkey\Swagger\Client\Model\int[]()); // int[] | List of unique identifiers of all phones to be deleted

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

Parameters

Name	Type	Description	Notes
body	int[]	List of unique identifiers of all phones to be deleted

Return type

int[]

Authorization

X-API-Key

HTTP request headers

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

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

emptyMedium

\Coucounco\Airkey\Swagger\Client\Model\Medium emptyMedium($medium_id)

Empties provided medium.

Empties the provided medium and returns a new version of the medium object. All authorizations will be deleted from the medium. The person assignment of the medium does not get cancelled.

Example

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

// Configure API key authorization: X-API-Key
$config = Coucounco\Airkey\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 = Coucounco\Airkey\Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

$apiInstance = new Coucounco\Airkey\Swagger\Client\Api\MediaApi(
    // 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
);
$medium_id = 789; // int | Unique identifier of the medium

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

Parameters

Name	Type	Description	Notes
medium_id	int	Unique identifier of the medium

Return type

\Coucounco\Airkey\Swagger\Client\Model\Medium

Authorization

X-API-Key

HTTP request headers

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

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

generatePairingCodeForPhone

\Coucounco\Airkey\Swagger\Client\Model\Phone generatePairingCodeForPhone($phone_id)

Generates a new pairing code for a phone.

Generates a new pairing code for the provided phone and returns a new version of the phone object.

Example

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

// Configure API key authorization: X-API-Key
$config = Coucounco\Airkey\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 = Coucounco\Airkey\Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

$apiInstance = new Coucounco\Airkey\Swagger\Client\Api\MediaApi(
    // 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
);
$phone_id = 789; // int | Unique identifier of the phone

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

Parameters

Name	Type	Description	Notes
phone_id	int	Unique identifier of the phone

Return type

\Coucounco\Airkey\Swagger\Client\Model\Phone

Authorization

X-API-Key

HTTP request headers

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

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

getCard

\Coucounco\Airkey\Swagger\Client\Model\Card getCard($card_id)

Gets information of specific card.

Returns all information of provided medium of type 'card'.

Example

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

// Configure API key authorization: X-API-Key
$config = Coucounco\Airkey\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 = Coucounco\Airkey\Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

$apiInstance = new Coucounco\Airkey\Swagger\Client\Api\MediaApi(
    // 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
);
$card_id = 789; // int | Unique identifier of the card

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

Parameters

Name	Type	Description	Notes
card_id	int	Unique identifier of the card

Return type

\Coucounco\Airkey\Swagger\Client\Model\Card

Authorization

X-API-Key

HTTP request headers

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

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

getCards

\Coucounco\Airkey\Swagger\Client\Model\CardPagingList getCards($person_id, $assignment_status, $offset, $limit)

Gets information of all cards.

Returns a list of all media of type 'card' defined in the access control system.

Example

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

// Configure API key authorization: X-API-Key
$config = Coucounco\Airkey\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 = Coucounco\Airkey\Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

$apiInstance = new Coucounco\Airkey\Swagger\Client\Api\MediaApi(
    // 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
);
$person_id = 789; // int | Filter cards by person id
$assignment_status = "assignment_status_example"; // string | Filter cards by assignment status
$offset = 56; // int | Offset for paging
$limit = 56; // int | Limit of result size

try {
    $result = $apiInstance->getCards($person_id, $assignment_status, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MediaApi->getCards: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
person_id	int	Filter cards by person id	[optional]
assignment_status	string	Filter cards by assignment status	[optional]
offset	int	Offset for paging	[optional]
limit	int	Limit of result size	[optional]

Return type

\Coucounco\Airkey\Swagger\Client\Model\CardPagingList

Authorization

X-API-Key

HTTP request headers

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

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

getMedia

\Coucounco\Airkey\Swagger\Client\Model\MediumPagingList getMedia($person_id, $assignment_status, $offset, $limit)

Gets information of all media.

Returns a list of all media defined in the access control system, sorted by medium id in ascending order.

Example

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

// Configure API key authorization: X-API-Key
$config = Coucounco\Airkey\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 = Coucounco\Airkey\Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

$apiInstance = new Coucounco\Airkey\Swagger\Client\Api\MediaApi(
    // 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
);
$person_id = 789; // int | Filter media by person id
$assignment_status = "assignment_status_example"; // string | Filter media by assignment status
$offset = 56; // int | Offset for paging
$limit = 56; // int | Limit of result size

try {
    $result = $apiInstance->getMedia($person_id, $assignment_status, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MediaApi->getMedia: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
person_id	int	Filter media by person id	[optional]
assignment_status	string	Filter media by assignment status	[optional]
offset	int	Offset for paging	[optional]
limit	int	Limit of result size	[optional]

Return type

\Coucounco\Airkey\Swagger\Client\Model\MediumPagingList

Authorization

X-API-Key

HTTP request headers

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

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

getMedium

\Coucounco\Airkey\Swagger\Client\Model\Medium getMedium($medium_id)

Gets information of a specific medium.

Returns all information of a specific medium defined in the access control system.

Example

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

// Configure API key authorization: X-API-Key
$config = Coucounco\Airkey\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 = Coucounco\Airkey\Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

$apiInstance = new Coucounco\Airkey\Swagger\Client\Api\MediaApi(
    // 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
);
$medium_id = 789; // int | Unique identifier of the medium

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

Parameters

Name	Type	Description	Notes
medium_id	int	Unique identifier of the medium

Return type

\Coucounco\Airkey\Swagger\Client\Model\Medium

Authorization

X-API-Key

HTTP request headers

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

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

getPhone

\Coucounco\Airkey\Swagger\Client\Model\Phone getPhone($phone_id)

Gets information of specific phone.

Returns all information of provided medium of type 'phone'.

Example

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

// Configure API key authorization: X-API-Key
$config = Coucounco\Airkey\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 = Coucounco\Airkey\Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

$apiInstance = new Coucounco\Airkey\Swagger\Client\Api\MediaApi(
    // 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
);
$phone_id = 789; // int | Unique identifier of the phone

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

Parameters

Name	Type	Description	Notes
phone_id	int	Unique identifier of the phone

Return type

\Coucounco\Airkey\Swagger\Client\Model\Phone

Authorization

X-API-Key

HTTP request headers

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

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

getPhones

\Coucounco\Airkey\Swagger\Client\Model\PhonePagingList getPhones($person_id, $assignment_status, $phone_number, $offset, $limit)

Gets information of all phones.

Returns a list of all media of type 'phone' defined in the access control system.

Example

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

// Configure API key authorization: X-API-Key
$config = Coucounco\Airkey\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 = Coucounco\Airkey\Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

$apiInstance = new Coucounco\Airkey\Swagger\Client\Api\MediaApi(
    // 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
);
$person_id = 789; // int | Filter phones by person id
$assignment_status = "assignment_status_example"; // string | Filter phones by assignment status
$phone_number = "phone_number_example"; // string | Filter phones by phone number
$offset = 56; // int | Offset for paging
$limit = 56; // int | Limit of result size

try {
    $result = $apiInstance->getPhones($person_id, $assignment_status, $phone_number, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MediaApi->getPhones: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
person_id	int	Filter phones by person id	[optional]
assignment_status	string	Filter phones by assignment status	[optional]
phone_number	string	Filter phones by phone number	[optional]
offset	int	Offset for paging	[optional]
limit	int	Limit of result size	[optional]

Return type

\Coucounco\Airkey\Swagger\Client\Model\PhonePagingList

Authorization

X-API-Key

HTTP request headers

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

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

reactivateMedium

\Coucounco\Airkey\Swagger\Client\Model\Medium reactivateMedium($medium_id, $reason, $recover_authorizations, $comment)

Reactivates provided medium.

Reactivates the provided medium and returns a new version of the medium object. The fields "reason" and "comment" are saved in the system protocol and are not part of the response.

Example

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

// Configure API key authorization: X-API-Key
$config = Coucounco\Airkey\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 = Coucounco\Airkey\Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

$apiInstance = new Coucounco\Airkey\Swagger\Client\Api\MediaApi(
    // 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
);
$medium_id = 789; // int | Unique identifier of the medium to be reactivated
$reason = "reason_example"; // string | Reason of reactivation
$recover_authorizations = true; // bool | Recover authorizations available prior to deactivation
$comment = "comment_example"; // string | Additional comment of reactivation

try {
    $result = $apiInstance->reactivateMedium($medium_id, $reason, $recover_authorizations, $comment);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MediaApi->reactivateMedium: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
medium_id	int	Unique identifier of the medium to be reactivated
reason	string	Reason of reactivation
recover_authorizations	bool	Recover authorizations available prior to deactivation
comment	string	Additional comment of reactivation	[optional]

Return type

\Coucounco\Airkey\Swagger\Client\Model\Medium

Authorization

X-API-Key

HTTP request headers

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

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

resetPinOfPhone

\Coucounco\Airkey\Swagger\Client\Model\Phone resetPinOfPhone($phone_id)

Resets PIN of the phone.

Resets the PIN of the provided phone and returns new version of the phone object with set PIN reset time. After the phone was synchronized the PIN flag is reset.

Example

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

// Configure API key authorization: X-API-Key
$config = Coucounco\Airkey\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 = Coucounco\Airkey\Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

$apiInstance = new Coucounco\Airkey\Swagger\Client\Api\MediaApi(
    // 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
);
$phone_id = 789; // int | Unique identifier of the phone to reset the PIN

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

Parameters

Name	Type	Description	Notes
phone_id	int	Unique identifier of the phone to reset the PIN

Return type

\Coucounco\Airkey\Swagger\Client\Model\Phone

Authorization

X-API-Key

HTTP request headers

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

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

sendRegistrationCodeToPhone

\Coucounco\Airkey\Swagger\Client\Model\Phone sendRegistrationCodeToPhone($phone_id)

Sends pairing code to phone.

Sends a generated pairing code per SMS to the phone and returns a new version of the phone object.

Example

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

// Configure API key authorization: X-API-Key
$config = Coucounco\Airkey\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 = Coucounco\Airkey\Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

$apiInstance = new Coucounco\Airkey\Swagger\Client\Api\MediaApi(
    // 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
);
$phone_id = 789; // int | Unique identifier of the phone

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

Parameters

Name	Type	Description	Notes
phone_id	int	Unique identifier of the phone

Return type

\Coucounco\Airkey\Swagger\Client\Model\Phone

Authorization

X-API-Key

HTTP request headers

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

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

updateCards

\Coucounco\Airkey\Swagger\Client\Model\Card[] updateCards($body)

Updates list of cards.

Updates the provided list of cards and returns a list of new object versions.

Example

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

// Configure API key authorization: X-API-Key
$config = Coucounco\Airkey\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 = Coucounco\Airkey\Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

$apiInstance = new Coucounco\Airkey\Swagger\Client\Api\MediaApi(
    // 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 = array(new \Coucounco\Airkey\Swagger\Client\Model\Card()); // \Coucounco\Airkey\Swagger\Client\Model\Card[] | List of cards to be updated

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

Parameters

Name	Type	Description	Notes
body	\Coucounco\Airkey\Swagger\Client\Model\Card[]	List of cards to be updated

Return type

\Coucounco\Airkey\Swagger\Client\Model\Card[]

Authorization

X-API-Key

HTTP request headers

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

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

updatePhones

\Coucounco\Airkey\Swagger\Client\Model\Phone[] updatePhones($body)

Updates list of phones.

Updates the provided list of phones and returns a list of new object versions. Please check before if a phone already exists with the given phone number to prevent duplicates.

Example

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

// Configure API key authorization: X-API-Key
$config = Coucounco\Airkey\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 = Coucounco\Airkey\Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

$apiInstance = new Coucounco\Airkey\Swagger\Client\Api\MediaApi(
    // 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 = array(new \Coucounco\Airkey\Swagger\Client\Model\Phone()); // \Coucounco\Airkey\Swagger\Client\Model\Phone[] | List of phones to be updated

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

Parameters

Name	Type	Description	Notes
body	\Coucounco\Airkey\Swagger\Client\Model\Phone[]	List of phones to be updated

Return type

\Coucounco\Airkey\Swagger\Client\Model\Phone[]

Authorization

X-API-Key

HTTP request headers

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

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