coucounco / airkey-api-client
0.1.6
2021-10-26 11:05 UTC
Requires
- php: >=8
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.3.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ~2.12
- phpunit/phpunit: ^9
- squizlabs/php_codesniffer: ~2.6
This package is not auto-updated.
Last update: 2024-05-09 13:09:36 UTC
README
This is a Swagger client generated for EVVA AirKey
This PHP package is automatically generated by the Swagger Codegen project:
- API version: v14.40.2
- Build package: io.swagger.codegen.languages.PhpClientCodegen For more information, please visit https://airkey.evva.com
Re-generate this library
- Go to https://generator.swagger.io
- Click on "clients" → "POST /gen/clients/{language}"
- Click on "Try it out"
- Select the programming language of choice
php
- Set the "body" field as follows:
{
"spec": {},
"options": {
"composerVendorName": "Coucounco",
"composerProjectName": "airkey-api-client",
"srcBasePath": "src",
"invokerPackage": "Coucounco\\Airkey\\Swagger\\Client"
},
"swaggerUrl": "https://integration.api.airkey.evva.com/docs/swagger.json"
}
- Then click the blue "Execute" button
- You can now download the generated lib at the URL given in the "Response body"
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
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\AreasApi( // 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 ); $area_id = 789; // int | Unique identifier of the area try { $result = $apiInstance->getArea($area_id); print_r($result); } catch (Exception $e) { echo 'Exception when calling AreasApi->getArea: ', $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 |
---|---|---|---|
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. |
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} | Updates 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 | Gets protocol of locks. |
LocksApi | getLock | GET /v1/locks/{lockId} | Gets information of a specific lock. |
LocksApi | getLocks | GET /v1/locks | Gets information of all locks. |
LocksApi | updateLock | PUT /v1/locks/{lockId} | Updates the provided lock. |
MaintenanceTasksApi | getMaintenanceTasks | GET /v1/maintenance-tasks | Gets all maintenance tasks. |
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 | 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 | resetPinOfPhone | POST /v1/media/phones/{phoneId}/pin-reset | Resets PIN of the phone. |
MediaApi | sendRegistrationCodeToPhone | POST /v1/media/phones/{phoneId}/send-registration-code | Sends pairing code to phone. |
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 | 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 | Sends a registration code to the phone and creates all necessary prerequisites if needed. |
SystemProtocolApi | getSystemProtocol | GET /v1/system-protocol | Gets system protocol. |
Documentation For Models
- Area
- AreaPagingList
- Authorization
- AuthorizationChange
- AuthorizationCreate
- AuthorizationDelete
- AuthorizationInfo
- AuthorizationPagingList
- AuthorizationSyncDetails
- BlacklistEntry
- CardPagingList
- CreditInfo
- Customer
- Event
- EventDetails
- EventPagingList
- FixedMediumSimpleAuthorizationCreate
- HolidayCalendar
- HolidayCalendarList
- HolidayCalendarSeries
- HolidayCalendarSeriesCreate
- HolidayCalendarSlot
- HolidayCalendarSlotCreate
- HolidayCalendarSlotDelete
- HolidayCalendarSlotUpdate
- JsonNode
- Lock
- LockDoor
- LockFirmware
- LockMaintenanceTask
- LockPagingList
- LockProtocol
- LockProtocolDetails
- LockProtocolEntry
- LockProtocolEvent
- LockProtocolPagingList
- MaintenanceTaskPagingList
- Medium
- MediumAssignment
- MediumPagingList
- PeriodicalPeriod
- Person
- PersonCreate
- PersonPagingList
- PhoneCreate
- PhonePagingList
- PhoneSettings
- SendAKeyPhone
- SendAKeyRequest
- SendAKeyResponse
- SimpleArea
- SimpleAuthorizationCreate
- SimpleLock
- SimpleMedium
- SystemProtocol
- SystemProtocolDetails
- SystemProtocolEntry
- SystemProtocolEvent
- SystemProtocolPagingList
- AppPairedEventDetails
- AuthorizationSynchronizedEventDetails
- Card
- OneDayAuthorizationInfo
- PeriodicalAuthorizationInfo
- PermanentAuthorizationInfo
- Phone
- SimpleAuthorizationInfo
- UnlockingEventDetails
Documentation For Authorization
X-API-Key
- Type: API key
- API key parameter name: X-API-Key
- Location: HTTP header