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: v18.0.4
Build package: io.swagger.codegen.languages.PhpClientCodegen For more information, please visit https://airkey.evva.com

Requirements

PHP 5.5 and later

Installation & Usage

Composer

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

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/Coucounco/airkey-api-client.git"
    }
  ],
  "require": {
    "Coucounco/airkey-api-client": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

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

// 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\AcosApi(
    // 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
);

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

?>

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AcosApi	getAdmins	GET /v1/acos	Gets all access control operators.
AcosApi	getSupportEnabledAcos	GET /v1/acos/support	Gets all support logins.
AreasApi	getArea	GET /v1/areas/{areaId}	Gets a specific area.
AreasApi	getAreas	GET /v1/areas	Gets all available areas.
AuthorizationsApi	createOrFetchSimpleAuthorization	POST /v1/authorizations/simple	Creates simple authorizations
AuthorizationsApi	createOrUpdateAuthorizationsWithAdvancedOptions	POST /v1/authorizations/advanced	Creates new and updates existing authorizations (advanced version - can be used to create/update all types of authorizations).
AuthorizationsApi	deleteAuthorization	PUT /v1/authorizations	Requests deletion of provided authorizations.
AuthorizationsApi	getAuthorization	GET /v1/authorizations/{authorizationId}	Gets a specific authorization.
AuthorizationsApi	getAuthorizations	GET /v1/authorizations	Gets all authorizations for locks and areas.
BlacklistsApi	getBlacklists	GET /v1/blacklists	Gets all available blacklist entries.
CreditsApi	getCredits	GET /v1/credits	Gets available credit information.
CreditsApi	getCreditsProtocol	GET /v1/credits-protocol	Gets protocol of credits.
CustomerApi	getCustomerData	GET /v1/customer	Gets customer details.
EventsApi	getEvent	GET /v1/events/{eventId}	Gets a specific event.
EventsApi	getEvents	GET /v1/events	Gets a list of events.
HolidayCalendarsApi	createHolidayCalendarSlot	POST /v1/holiday-calendars/{holidayCalendarId}/slots	Adds a new holiday calendar slot to the holiday calendar.
HolidayCalendarsApi	deleteHolidayCalendarSlot	DELETE /v1/holiday-calendars/{holidayCalendarId}/slots/{holidayCalendarSlotId}	Deletes provided holiday calendar slot.
HolidayCalendarsApi	getHolidayCalendar	GET /v1/holiday-calendars/{holidayCalendarId}	Gets a specific holiday calendar.
HolidayCalendarsApi	getHolidayCalendarSlot	GET /v1/holiday-calendars/{holidayCalendarId}/slots/{holidayCalendarSlotId}	Gets a specific holiday calendar slot.
HolidayCalendarsApi	getHolidayCalendars	GET /v1/holiday-calendars	Gets all holiday calendars.
HolidayCalendarsApi	getLocksByCalendarId	GET /v1/holiday-calendars/{holidayCalendarId}/locks	Gets all locks using the holiday calendar.
HolidayCalendarsApi	updateHolidayCalendar	PUT /v1/holiday-calendars/{holidayCalendarId}	Activates or deactivates the holiday calendar.
HolidayCalendarsApi	updateHolidayCalendarSlot	PUT /v1/holiday-calendars/{holidayCalendarId}/slots/{holidayCalendarSlotId}	Updates a holiday calendar slot of the holiday calendar.
LockProtocolApi	getLockProtocol	GET /v1/lock-protocol	Deprecated/Legacy: This resource will be removed in future versions. Please use resource "/v1/lock-protocol-limit" instead.
LockProtocolApi	getLockProtocolLimited	GET /v1/lock-protocol-limit	Gets protocol of locks.
LocksApi	addSharedLock	POST /v1/locks/add-shared-lock	Redeems a sharing code to add a lock from another access control system.
LocksApi	assignAreas	POST /v1/locks/{lockId}/settings/assigned-areas/add	Assigns areas to the specific lock.
LocksApi	createSharingCode	POST /v1/locks/{lockId}/settings/sharing-codes	Creates sharing code for a specific lock.
LocksApi	deleteSharingCode	DELETE /v1/locks/{lockId}/settings/sharing-codes/{sharingCodeId}	Removes sharing code from the specific lock.
LocksApi	getActiveShares	GET /v1/locks/{lockId}/settings/active-shares	Returns a list of other access control systems your lock has been shared with.
LocksApi	getAssignedAreas	GET /v1/locks/{lockId}/settings/assigned-areas	Gets assigned areas of a specific lock.
LocksApi	getLock	GET /v1/locks/{lockId}	Gets information of a specific lock.
LocksApi	getLockSettings	GET /v1/locks/{lockId}/settings	Gets settings of a specific lock.
LocksApi	getLocks	GET /v1/locks	Gets information of all locks.
LocksApi	getSharingCodes	GET /v1/locks/{lockId}/settings/sharing-codes	Returns a list of sharing codes for a specific lock.
LocksApi	markLockAsToBeRemoved	POST /v1/locks/{lockId}/remove	Marks a lock as to be removed. Lock needs to be synchronized to be actually removed.
LocksApi	removeActiveShares	POST /v1/locks/{lockId}/settings/active-shares/remove	Removes shares for a specific lock.
LocksApi	unassignAreas	POST /v1/locks/{lockId}/settings/assigned-areas/remove	Unassigns areas from the specific lock.
LocksApi	unmarkLockAsToBeRemoved	POST /v1/locks/{lockId}/abort-remove	Aborts removal of a lock (removes the to be removed mark on the lock)
LocksApi	updateLock	PUT /v1/locks/{lockId}	Updates the provided lock.
LocksApi	updateLockSettings	PUT /v1/locks/{lockId}/settings	Updates settings of the lock.
MaintenanceTasksApi	getMaintenanceTasks	GET /v1/maintenance-tasks	Gets all maintenance tasks.
MediaApi	approvePendingPhoneReplacement	POST /v1/pending-phone-replacements/{replacementId}/approve	Approves pending phone replacement
MediaApi	assignOwnerToMedium	POST /v1/media/assign	Assigns a person to a medium for each provided assignment.
MediaApi	cancelMediumAssignments	POST /v1/media/cancel-assignment	Cancels assignments of media.
MediaApi	createPhones	POST /v1/media/phones	Adds list of new phones.
MediaApi	deactivateMedium	POST /v1/media/{mediumId}/deactivate	Deactivates provided medium.
MediaApi	deletePhones	DELETE /v1/media/phones	Deletes provided phones.
MediaApi	emptyMedium	POST /v1/media/{mediumId}/empty	Empties provided medium.
MediaApi	generatePairingCodeForPhone	POST /v1/media/phones/{phoneId}/pairing	Generates a new pairing code for a phone.
MediaApi	getCard	GET /v1/media/cards/{cardId}	Gets information of specific card.
MediaApi	getCards	GET /v1/media/cards	Gets information of all cards.
MediaApi	getMedia	GET /v1/media	Gets information of all media.
MediaApi	getMedium	GET /v1/media/{mediumId}	Gets information of a specific medium.
MediaApi	getPendingPhoneReplacements	GET /v1/pending-phone-replacements	Gets all pending phone replacements.
MediaApi	getPhone	GET /v1/media/phones/{phoneId}	Gets information of specific phone.
MediaApi	getPhones	GET /v1/media/phones	Gets information of all phones.
MediaApi	reactivateMedium	POST /v1/media/{mediumId}/reactivate	Reactivates provided medium.
MediaApi	rejectPendingPhoneReplacement	POST /v1/pending-phone-replacements/{replacementId}/reject	Rejects pending phone replacement
MediaApi	resetPinOfPhone	POST /v1/media/phones/{phoneId}/pin-reset	Resets PIN of the phone.
MediaApi	sendRegistrationCodeToPhone	POST /v1/media/phones/{phoneId}/send-registration-code-with-parameters	Deprecated/Legacy: This resource will be removed in future versions. Please use resource "/v1/media/phones/{phoneId}/send-registration-code/sms" instead.
MediaApi	sendRegistrationCodeToPhone1	POST /v1/media/phones/{phoneId}/send-registration-code	Deprecated/Legacy: This resource will be removed in future versions. Please use resource "/v1/media/phones/{phoneId}/send-registration-code/sms" instead.
MediaApi	sendRegistrationCodeToPhoneViaMail	POST /v1/media/phones/{phoneId}/send-registration-code/mail	Sends a pairing code while the email subject and text to be sent can be configured.
MediaApi	sendRegistrationCodeToPhoneViaSms	POST /v1/media/phones/{phoneId}/send-registration-code/sms	Sends pairing code to phone while the SMS text to be sent can be configured.
MediaApi	updateCards	PUT /v1/media/cards	Updates list of cards.
MediaApi	updatePhones	PUT /v1/media/phones	Updates list of phones.
MediumProtocolApi	getMediumProtocol	GET /v1/medium-protocol	Deprecated/Legacy: This resource will be removed in future versions. Please use resource "/v1/medium-protocol-limit" instead.
MediumProtocolApi	getMediumProtocolLimited	GET /v1/medium-protocol-limit	Gets protocol of media.
PersonsApi	createPersons	POST /v1/persons	Adds list of new persons.
PersonsApi	deletePersons	DELETE /v1/persons	Deletes provided persons.
PersonsApi	getPerson	GET /v1/persons/{personId}	Gets a specific person.
PersonsApi	getPersons	GET /v1/persons	Gets all persons.
PersonsApi	updatePersons	PUT /v1/persons	Updates list of persons.
PublicMgmtApi	resetTestData	POST /v1/public-mgmt/reset-test-data	Resets test data in the integration environment.
SendAKeyApi	sendAKey	POST /v1/send-a-key	Deprecated/Legacy: This resource will be removed in future versions. Please use resource "/v1/send-a-key/sms" instead.
SendAKeyApi	sendAKeyViaMail	POST /v1/send-a-key/mail	Sends a registration code via email and creates all necessary prerequisites if needed.
SendAKeyApi	sendAKeyViaSms	POST /v1/send-a-key/sms	Sends a registration code to the phone and creates all necessary prerequisites if needed.
SettingsApi	getCustomerSettings	GET /v1/settings	Gets settings details.
SystemProtocolApi	getSystemProtocol	GET /v1/system-protocol	Deprecated/Legacy: This resource will be removed in future versions. Please use resource "/v1/system-protocol-limit" instead.
SystemProtocolApi	getSystemProtocolLimited	GET /v1/system-protocol-limit	Gets system protocol.

Documentation For Models

Documentation For Authorization

X-API-Key

Type: API key
API key parameter name: X-API-Key
Location: HTTP header

Author

office-wien@evva.com

coucounco / airkey-api-client

Maintainers

Details