Skip to content

Latest commit

 

History

History
284 lines (191 loc) · 7.82 KB

EmployeeAPIKeysApi.md

File metadata and controls

284 lines (191 loc) · 7.82 KB

OpenAPI\Client\EmployeeAPIKeysApi

All URIs are relative to https://api.wall.et, except if the operation defines another base path.

Method HTTP request Description
archiveEmployeeAPIKeys() DELETE /v2/employee/apiKeys/{id} Archive employee API Key
createEmployeeAPIKeys() POST /v2/employee/apiKeys Create employee API Key
fetchAllEmployeeAPIKeys() GET /v2/employee/apiKeys/all Fetch all employee API Keys
fetchEmployeeAPIKeyById() GET /v2/employee/apiKeys/{id} Fetch API Key
updateEmployeeAPIKeys() PUT /v2/employee/apiKeys/{id} Update employee API Key

archiveEmployeeAPIKeys()

archiveEmployeeAPIKeys($id): \OpenAPI\Client\Model\EmployeeAPIKey

Archive employee API Key

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeeAPIKeysApi(
    // 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()
);
$id = NULL; // mixed

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

Parameters

Name Type Description Notes
id mixed

Return type

\OpenAPI\Client\Model\EmployeeAPIKey

Authorization

No authorization required

HTTP request headers

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

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

createEmployeeAPIKeys()

createEmployeeAPIKeys($wt_employee_api_key_create_params): \OpenAPI\Client\Model\EmployeeAPIKey

Create employee API Key

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeeAPIKeysApi(
    // 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()
);
$wt_employee_api_key_create_params = new \OpenAPI\Client\Model\WTEmployeeAPIKeyCreateParams(); // \OpenAPI\Client\Model\WTEmployeeAPIKeyCreateParams

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

Parameters

Name Type Description Notes
wt_employee_api_key_create_params \OpenAPI\Client\Model\WTEmployeeAPIKeyCreateParams

Return type

\OpenAPI\Client\Model\EmployeeAPIKey

Authorization

No authorization required

HTTP request headers

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

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

fetchAllEmployeeAPIKeys()

fetchAllEmployeeAPIKeys($is_archive_included): \OpenAPI\Client\Model\EmployeeAPIKey[]

Fetch all employee API Keys

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeeAPIKeysApi(
    // 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()
);
$is_archive_included = True; // bool

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

Parameters

Name Type Description Notes
is_archive_included bool [optional]

Return type

\OpenAPI\Client\Model\EmployeeAPIKey[]

Authorization

No authorization required

HTTP request headers

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

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

fetchEmployeeAPIKeyById()

fetchEmployeeAPIKeyById($id): \OpenAPI\Client\Model\WTEmployeeAPIKey

Fetch API Key

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeeAPIKeysApi(
    // 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()
);
$id = NULL; // mixed

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

Parameters

Name Type Description Notes
id mixed

Return type

\OpenAPI\Client\Model\WTEmployeeAPIKey

Authorization

No authorization required

HTTP request headers

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

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

updateEmployeeAPIKeys()

updateEmployeeAPIKeys($id, $wt_employee_api_key_update_params): \OpenAPI\Client\Model\EmployeeAPIKey

Update employee API Key

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeeAPIKeysApi(
    // 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()
);
$id = NULL; // mixed
$wt_employee_api_key_update_params = new \OpenAPI\Client\Model\WTEmployeeAPIKeyUpdateParams(); // \OpenAPI\Client\Model\WTEmployeeAPIKeyUpdateParams

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

Parameters

Name Type Description Notes
id mixed
wt_employee_api_key_update_params \OpenAPI\Client\Model\WTEmployeeAPIKeyUpdateParams

Return type

\OpenAPI\Client\Model\EmployeeAPIKey

Authorization

No authorization required

HTTP request headers

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

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