EmployeesApi.md

OpenAPI\Client\EmployeesApi

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

Method	HTTP request	Description
addPeerToRoles()	POST /v2/employee/roles/peer/{userID}	Add peer to roles
createDocument()	POST /v2/employee/document	Create document
createEmployeePeer()	POST /v2/employee/peer	Create employee peer
createFile()	POST /v2/employee/file/create	Create file
createMediaFile()	POST /v2/employee/mediaFile	Create media file
createStaticVoucherCampaignsGroup()	POST /v2/employee/staticVoucherCampaignsGroup	Create static voucher campaign group
deleteDocument()	DELETE /v2/employee/document/{documentID}	Delete document
deleteMediaFile()	DELETE /v2/employee/mediaFile/{mediaFileID}	Delete media file
downloadFile()	GET /v2/employee/file/download/{fileID}	Fetch URL for file download
exportClubMembers()	PUT /v2/employee/export/members	Export club members
exportMerchantCredits()	PUT /v2/employee/export/merchantCredits	Export merchant credits
exportStaticVoucherCampaign()	PUT /v2/employee/export/staticVoucherCampaign/{campaignID}	Export static voucher campaign
failedImport()	GET /v2/employee/file/imports/failed/{fileID}	Fetch URL to download a failed import
fetchDocuments()	GET /v2/employee/documents/all	Fetch all documents
fetchDynamicVouchers()	GET /v2/employee/dynamicVouchers/all	Fetch all dynamic vouchers
fetchEmployeeStaticVoucherCampaignGroups()	GET /v2/employee/staticVoucherCampaignGroups/all	Fetch static voucher campaign groups
fetchEmployeeStaticVoucherCampaigns()	GET /v2/employee/staticVoucherCampaigns/all	Fetch static voucher campaigns
fetchMediaFiles()	GET /v2/employee/mediaFiles/all	Fetch all media files
fetchMerchant()	GET /v2/employee/merchant	Create employee alert
fetchMessages()	GET /v2/employee/messages/all	Fetch all messages
fetchOptInListSource()	GET /v2/employee/optInListSource/{sourceID}	Fetch opt in list source
fetchOptInListSourcesCreatedByEmployee()	GET /v2/employee/optInListSources/all	Fetch all opt in list sources
fetchPeerActivity()	GET /v2/employee/peer/activity/{employeeID}	Fetch peer activity
fetchPeersPermissions()	GET /v2/employee/peer/permissions/{userID}	Fetch peer permissions
fetchProfileInfo()	GET /v2/employee	Retrieve employee's webpages
importClubMembers()	POST /v2/employee/import/members	Import club members
importMerchantCredits()	POST /v2/employee/import/merchantCredits	Import merchant credits
loadWebpagesOfEmployee()	GET /v2/employee/webpages/all	Retrieve employee's webpages
modifyPeersRoles()	PUT /v2/employee/peer/permissions/{userID}	Modify peer's roles
presignFile()	POST /v2/employee/file/presign	Presign file for upload
removePeerFromAllRoles()	DELETE /v2/employee/peer/permissions/{userID}	Remove peer from all roles
scheduleAdvertisementCredit()	POST /v2/employee/sms/schedule/adCredit/{advertisementCreditID}	Schedule Ad Credit
scheduleDynamicVoucher()	POST /v2/employee/sms/schedule/dynamicVoucher/{dynamicVoucherID}	Schedule Dynamic Voucher to list
scheduleDynamicVoucherToRecipient()	POST /v2/employee/sms/schedule/recipient/dynamicVoucher/{dynamicVoucherID}	Schedule Dyanamic Voucher to recipient
scheduleSimpleSMS()	POST /v2/employee/sms/schedule/simple	Schedule Simple SMS broadcast to list
scheduleSimpleSMSToRecipient()	POST /v2/employee/sms/schedule/recipient/simple	Schedule Simple SMS broadcast to recipient
sendHelpDeskResponse()	POST /v2/employee/helpDesk/response	Send help desk response
sendSmsCampaignBroadcast()	POST /v2/employee/sms/schedule/campaign/{staticVoucherCampaignID}	Schedule SMS Campaign Broadcast
setAlertsRead()	PATCH /v2/employee/alerts	Mark alerts as read
setExportDataFilesRead()	PUT /v2/employee/export/dataFiles	Mark export data files as read
setHelpDeskRequestResolved()	PATCH /v2/employee/helpDesk/request/{helpDeskRequestID}	Resolve help desk request
setMessagesRead()	PATCH /v2/employee/messages	Mark messages as read
setProfilePicture()	PUT /v2/employee/profile/picture	Set profile picture
updateClubMembers()	PUT /v2/employee/update/members	Update club members
updateEmailNotificationPreference()	PUT /v2/employee/emailNotificationPreference	Changes the employee's email notification preference to enabled or disabled
updateEmployeePeer()	PUT /v2/employee/peer/{userID}	Update peer

addPeerToRoles()

addPeerToRoles($user_id, $wt_employee_peer_roles): string

Add peer to roles

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeesApi(
    // 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()
);
$user_id = NULL; // mixed
$wt_employee_peer_roles = new \OpenAPI\Client\Model\WTEmployeePeerRoles(); // \OpenAPI\Client\Model\WTEmployeePeerRoles

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

Parameters

Name	Type	Description	Notes
user_id	mixed
wt_employee_peer_roles	\OpenAPI\Client\Model\WTEmployeePeerRoles

Return type

string

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]

createDocument()

createDocument($wt_employee_create_document): \OpenAPI\Client\Model\Document

Create document

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeesApi(
    // 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_create_document = new \OpenAPI\Client\Model\WTEmployeeCreateDocument(); // \OpenAPI\Client\Model\WTEmployeeCreateDocument

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

Parameters

Name	Type	Description	Notes
wt_employee_create_document	\OpenAPI\Client\Model\WTEmployeeCreateDocument

Return type

\OpenAPI\Client\Model\Document

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]

createEmployeePeer()

createEmployeePeer($wt_employee_create): \OpenAPI\Client\Model\Employee

Create employee peer

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeesApi(
    // 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_create = new \OpenAPI\Client\Model\WTEmployeeCreate(); // \OpenAPI\Client\Model\WTEmployeeCreate

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

Parameters

Name	Type	Description	Notes
wt_employee_create	\OpenAPI\Client\Model\WTEmployeeCreate

Return type

\OpenAPI\Client\Model\Employee

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]

createFile()

createFile($wt_employee_file_create): \OpenAPI\Client\Model\CreateFile200Response

Create file

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeesApi(
    // 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_file_create = new \OpenAPI\Client\Model\WTEmployeeFileCreate(); // \OpenAPI\Client\Model\WTEmployeeFileCreate

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

Parameters

Name	Type	Description	Notes
wt_employee_file_create	\OpenAPI\Client\Model\WTEmployeeFileCreate

Return type

\OpenAPI\Client\Model\CreateFile200Response

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]

createMediaFile()

createMediaFile($wt_employee_create_media_file): \OpenAPI\Client\Model\MediaFile

Create media file

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeesApi(
    // 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_create_media_file = new \OpenAPI\Client\Model\WTEmployeeCreateMediaFile(); // \OpenAPI\Client\Model\WTEmployeeCreateMediaFile

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

Parameters

Name	Type	Description	Notes
wt_employee_create_media_file	\OpenAPI\Client\Model\WTEmployeeCreateMediaFile

Return type

\OpenAPI\Client\Model\MediaFile

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]

createStaticVoucherCampaignsGroup()

createStaticVoucherCampaignsGroup($wt_employee_create_static_voucher_campaign_group): \OpenAPI\Client\Model\StaticVoucherCampaignGroup

Create static voucher campaign group

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeesApi(
    // 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_create_static_voucher_campaign_group = new \OpenAPI\Client\Model\WTEmployeeCreateStaticVoucherCampaignGroup(); // \OpenAPI\Client\Model\WTEmployeeCreateStaticVoucherCampaignGroup

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

Parameters

Name	Type	Description	Notes
wt_employee_create_static_voucher_campaign_group	\OpenAPI\Client\Model\WTEmployeeCreateStaticVoucherCampaignGroup

Return type

\OpenAPI\Client\Model\StaticVoucherCampaignGroup

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]

deleteDocument()

deleteDocument($document_id): \OpenAPI\Client\Model\Document

Delete document

Example

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



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

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

Parameters

Name	Type	Description	Notes
document_id	mixed

Return type

\OpenAPI\Client\Model\Document

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]

deleteMediaFile()

deleteMediaFile($media_file_id): \OpenAPI\Client\Model\MediaFile

Delete media file

Example

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



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

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

Parameters

Name	Type	Description	Notes
media_file_id	mixed

Return type

\OpenAPI\Client\Model\MediaFile

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]

downloadFile()

downloadFile($file_id): string

Fetch URL for file download

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeesApi(
    // 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()
);
$file_id = 'file_id_example'; // string

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

Parameters

Name	Type	Description	Notes
file_id	string

Return type

string

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]

exportClubMembers()

exportClubMembers(): string

Export club members

Example

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



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

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

Parameters

This endpoint does not need any parameter.

Return type

string

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]

exportMerchantCredits()

exportMerchantCredits(): string

Export merchant credits

Example

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



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

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

Parameters

This endpoint does not need any parameter.

Return type

string

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]

exportStaticVoucherCampaign()

exportStaticVoucherCampaign($campaign_id): string

Export static voucher campaign

Example

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



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

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

Parameters

Name	Type	Description	Notes
campaign_id	mixed

Return type

string

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]

failedImport()

failedImport($file_id): string

Fetch URL to download a failed import

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeesApi(
    // 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()
);
$file_id = 'file_id_example'; // string

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

Parameters

Name	Type	Description	Notes
file_id	string

Return type

string

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]

fetchDocuments()

fetchDocuments($folder): \OpenAPI\Client\Model\Document[]

Fetch all documents

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeesApi(
    // 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()
);
$folder = 'folder_example'; // string

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

Parameters

Name	Type	Description	Notes
folder	string		[optional]

Return type

\OpenAPI\Client\Model\Document[]

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]

fetchDynamicVouchers()

fetchDynamicVouchers($is_archive_included): \OpenAPI\Client\Model\DynamicVoucher[]

Fetch all dynamic vouchers

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeesApi(
    // 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->fetchDynamicVouchers($is_archive_included);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmployeesApi->fetchDynamicVouchers: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
is_archive_included	bool		[optional]

Return type

\OpenAPI\Client\Model\DynamicVoucher[]

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]

fetchEmployeeStaticVoucherCampaignGroups()

fetchEmployeeStaticVoucherCampaignGroups(): \OpenAPI\Client\Model\StaticVoucherCampaignGroup[]

Fetch static voucher campaign groups

Example

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



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

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

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\StaticVoucherCampaignGroup[]

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]

fetchEmployeeStaticVoucherCampaigns()

fetchEmployeeStaticVoucherCampaigns($is_archive_included, $source_id): \OpenAPI\Client\Model\StaticVoucherCampaign[]

Fetch static voucher campaigns

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeesApi(
    // 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
$source_id = 3.4; // float

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

Parameters

Name	Type	Description	Notes
is_archive_included	bool		[optional]
source_id	float		[optional]

Return type

\OpenAPI\Client\Model\StaticVoucherCampaign[]

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]

fetchMediaFiles()

fetchMediaFiles($folder): \OpenAPI\Client\Model\MediaFile[]

Fetch all media files

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeesApi(
    // 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()
);
$folder = 'folder_example'; // string

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

Parameters

Name	Type	Description	Notes
folder	string		[optional]

Return type

\OpenAPI\Client\Model\MediaFile[]

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]

fetchMerchant()

fetchMerchant(): mixed

Create employee alert

Example

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



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

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

Parameters

This endpoint does not need any parameter.

Return type

mixed

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]

fetchMessages()

fetchMessages(): \OpenAPI\Client\Model\Message[]

Fetch all messages

Example

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



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

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

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\Message[]

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]

fetchOptInListSource()

fetchOptInListSource($source_id): \OpenAPI\Client\Model\OptInListSource

Fetch opt in list source

Example

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



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

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

Parameters

Name	Type	Description	Notes
source_id	mixed

Return type

\OpenAPI\Client\Model\OptInListSource

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]

fetchOptInListSourcesCreatedByEmployee()

fetchOptInListSourcesCreatedByEmployee(): \OpenAPI\Client\Model\OptInListSource[]

Fetch all opt in list sources

Example

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



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

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

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\OptInListSource[]

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]

fetchPeerActivity()

fetchPeerActivity($employee_id): \OpenAPI\Client\Model\EmployeeActivityLog[]

Fetch peer activity

Example

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



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

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

Parameters

Name	Type	Description	Notes
employee_id	mixed

Return type

\OpenAPI\Client\Model\EmployeeActivityLog[]

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]

fetchPeersPermissions()

fetchPeersPermissions($user_id): mixed[]

Fetch peer permissions

Example

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



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

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

Parameters

Name	Type	Description	Notes
user_id	mixed

Return type

mixed[]

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]

fetchProfileInfo()

fetchProfileInfo(): \OpenAPI\Client\Model\Employee

Retrieve employee's webpages

Example

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



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

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

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\Employee

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]

importClubMembers()

importClubMembers($wt_employee_import_records): string

Import club members

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeesApi(
    // 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_import_records = new \OpenAPI\Client\Model\WTEmployeeImportRecords(); // \OpenAPI\Client\Model\WTEmployeeImportRecords

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

Parameters

Name	Type	Description	Notes
wt_employee_import_records	\OpenAPI\Client\Model\WTEmployeeImportRecords

Return type

string

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]

importMerchantCredits()

importMerchantCredits($wt_employee_import_records): string

Import merchant credits

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeesApi(
    // 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_import_records = new \OpenAPI\Client\Model\WTEmployeeImportRecords(); // \OpenAPI\Client\Model\WTEmployeeImportRecords

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

Parameters

Name	Type	Description	Notes
wt_employee_import_records	\OpenAPI\Client\Model\WTEmployeeImportRecords

Return type

string

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]

loadWebpagesOfEmployee()

loadWebpagesOfEmployee(): \OpenAPI\Client\Model\Webpage[]

Retrieve employee's webpages

Example

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



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

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

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\Webpage[]

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]

modifyPeersRoles()

modifyPeersRoles($user_id, $wt_employee_peer_roles): mixed[]

Modify peer's roles

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeesApi(
    // 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()
);
$user_id = NULL; // mixed
$wt_employee_peer_roles = new \OpenAPI\Client\Model\WTEmployeePeerRoles(); // \OpenAPI\Client\Model\WTEmployeePeerRoles

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

Parameters

Name	Type	Description	Notes
user_id	mixed
wt_employee_peer_roles	\OpenAPI\Client\Model\WTEmployeePeerRoles

Return type

mixed[]

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]

presignFile()

presignFile($wt_employee_s3_file_presign): \OpenAPI\Client\Model\PresignedPost

Presign file for upload

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeesApi(
    // 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_s3_file_presign = new \OpenAPI\Client\Model\WTEmployeeS3FilePresign(); // \OpenAPI\Client\Model\WTEmployeeS3FilePresign

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

Parameters

Name	Type	Description	Notes
wt_employee_s3_file_presign	\OpenAPI\Client\Model\WTEmployeeS3FilePresign

Return type

\OpenAPI\Client\Model\PresignedPost

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]

removePeerFromAllRoles()

removePeerFromAllRoles($user_id): bool

Remove peer from all roles

Example

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



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

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

Parameters

Name	Type	Description	Notes
user_id	mixed

Return type

bool

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]

scheduleAdvertisementCredit()

scheduleAdvertisementCredit($advertisement_credit_id, $wt_employee_schedule_simple_sms): \OpenAPI\Client\Model\AdvertisementCreditBroadcast

Schedule Ad Credit

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeesApi(
    // 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()
);
$advertisement_credit_id = NULL; // mixed
$wt_employee_schedule_simple_sms = new \OpenAPI\Client\Model\WTEmployeeScheduleSimpleSMS(); // \OpenAPI\Client\Model\WTEmployeeScheduleSimpleSMS

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

Parameters

Name	Type	Description	Notes
advertisement_credit_id	mixed
wt_employee_schedule_simple_sms	\OpenAPI\Client\Model\WTEmployeeScheduleSimpleSMS

Return type

\OpenAPI\Client\Model\AdvertisementCreditBroadcast

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]

scheduleDynamicVoucher()

scheduleDynamicVoucher($dynamic_voucher_id, $wt_employee_schedule_simple_sms): \OpenAPI\Client\Model\DynamicVoucherBroadcast

Schedule Dynamic Voucher to list

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeesApi(
    // 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()
);
$dynamic_voucher_id = NULL; // mixed
$wt_employee_schedule_simple_sms = new \OpenAPI\Client\Model\WTEmployeeScheduleSimpleSMS(); // \OpenAPI\Client\Model\WTEmployeeScheduleSimpleSMS

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

Parameters

Name	Type	Description	Notes
dynamic_voucher_id	mixed
wt_employee_schedule_simple_sms	\OpenAPI\Client\Model\WTEmployeeScheduleSimpleSMS

Return type

\OpenAPI\Client\Model\DynamicVoucherBroadcast

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]

scheduleDynamicVoucherToRecipient()

scheduleDynamicVoucherToRecipient($dynamic_voucher_id, $wt_employee_schedule_simple_smsto_recipient): \OpenAPI\Client\Model\DynamicVoucherBroadcast

Schedule Dyanamic Voucher to recipient

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeesApi(
    // 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()
);
$dynamic_voucher_id = NULL; // mixed
$wt_employee_schedule_simple_smsto_recipient = new \OpenAPI\Client\Model\WTEmployeeScheduleSimpleSMSToRecipient(); // \OpenAPI\Client\Model\WTEmployeeScheduleSimpleSMSToRecipient

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

Parameters

Name	Type	Description	Notes
dynamic_voucher_id	mixed
wt_employee_schedule_simple_smsto_recipient	\OpenAPI\Client\Model\WTEmployeeScheduleSimpleSMSToRecipient

Return type

\OpenAPI\Client\Model\DynamicVoucherBroadcast

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]

scheduleSimpleSMS()

scheduleSimpleSMS($wt_employee_schedule_simple_sms): bool

Schedule Simple SMS broadcast to list

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeesApi(
    // 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_schedule_simple_sms = new \OpenAPI\Client\Model\WTEmployeeScheduleSimpleSMS(); // \OpenAPI\Client\Model\WTEmployeeScheduleSimpleSMS

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

Parameters

Name	Type	Description	Notes
wt_employee_schedule_simple_sms	\OpenAPI\Client\Model\WTEmployeeScheduleSimpleSMS

Return type

bool

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]

scheduleSimpleSMSToRecipient()

scheduleSimpleSMSToRecipient($wt_employee_schedule_simple_smsto_recipient): bool

Schedule Simple SMS broadcast to recipient

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeesApi(
    // 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_schedule_simple_smsto_recipient = new \OpenAPI\Client\Model\WTEmployeeScheduleSimpleSMSToRecipient(); // \OpenAPI\Client\Model\WTEmployeeScheduleSimpleSMSToRecipient

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

Parameters

Name	Type	Description	Notes
wt_employee_schedule_simple_smsto_recipient	\OpenAPI\Client\Model\WTEmployeeScheduleSimpleSMSToRecipient

Return type

bool

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]

sendHelpDeskResponse()

sendHelpDeskResponse($wt_employee_send_help_desk_response): \OpenAPI\Client\Model\OutboundSMS

Send help desk response

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeesApi(
    // 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_send_help_desk_response = new \OpenAPI\Client\Model\WTEmployeeSendHelpDeskResponse(); // \OpenAPI\Client\Model\WTEmployeeSendHelpDeskResponse

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

Parameters

Name	Type	Description	Notes
wt_employee_send_help_desk_response	\OpenAPI\Client\Model\WTEmployeeSendHelpDeskResponse

Return type

\OpenAPI\Client\Model\OutboundSMS

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]

sendSmsCampaignBroadcast()

sendSmsCampaignBroadcast($static_voucher_campaign_id, $wt_employee_schedule_sms_campaign_broadcast): \OpenAPI\Client\Model\StaticVoucherCampaignBroadcast

Schedule SMS Campaign Broadcast

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeesApi(
    // 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()
);
$static_voucher_campaign_id = NULL; // mixed
$wt_employee_schedule_sms_campaign_broadcast = new \OpenAPI\Client\Model\WTEmployeeScheduleSMSCampaignBroadcast(); // \OpenAPI\Client\Model\WTEmployeeScheduleSMSCampaignBroadcast

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

Parameters

Name	Type	Description	Notes
static_voucher_campaign_id	mixed
wt_employee_schedule_sms_campaign_broadcast	\OpenAPI\Client\Model\WTEmployeeScheduleSMSCampaignBroadcast

Return type

\OpenAPI\Client\Model\StaticVoucherCampaignBroadcast

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]

setAlertsRead()

setAlertsRead(): bool

Mark alerts as read

Example

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



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

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

Parameters

This endpoint does not need any parameter.

Return type

bool

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]

setExportDataFilesRead()

setExportDataFilesRead(): bool

Mark export data files as read

Example

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



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

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

Parameters

This endpoint does not need any parameter.

Return type

bool

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]

setHelpDeskRequestResolved()

setHelpDeskRequestResolved($help_desk_request_id): \OpenAPI\Client\Model\HelpDeskRequest

Resolve help desk request

Example

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



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

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

Parameters

Name	Type	Description	Notes
help_desk_request_id	mixed

Return type

\OpenAPI\Client\Model\HelpDeskRequest

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]

setMessagesRead()

setMessagesRead(): bool

Mark messages as read

Example

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



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

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

Parameters

This endpoint does not need any parameter.

Return type

bool

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]

setProfilePicture()

setProfilePicture($wt_employee_create_media_file): string

Set profile picture

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeesApi(
    // 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_create_media_file = new \OpenAPI\Client\Model\WTEmployeeCreateMediaFile(); // \OpenAPI\Client\Model\WTEmployeeCreateMediaFile

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

Parameters

Name	Type	Description	Notes
wt_employee_create_media_file	\OpenAPI\Client\Model\WTEmployeeCreateMediaFile

Return type

string

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]

updateClubMembers()

updateClubMembers($wt_employee_update_records): string

Update club members

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeesApi(
    // 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_update_records = new \OpenAPI\Client\Model\WTEmployeeUpdateRecords(); // \OpenAPI\Client\Model\WTEmployeeUpdateRecords

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

Parameters

Name	Type	Description	Notes
wt_employee_update_records	\OpenAPI\Client\Model\WTEmployeeUpdateRecords

Return type

string

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]

updateEmailNotificationPreference()

updateEmailNotificationPreference($update_email_notification_preference_request): \OpenAPI\Client\Model\Employee

Changes the employee's email notification preference to enabled or disabled

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeesApi(
    // 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()
);
$update_email_notification_preference_request = new \OpenAPI\Client\Model\UpdateEmailNotificationPreferenceRequest(); // \OpenAPI\Client\Model\UpdateEmailNotificationPreferenceRequest

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

Parameters

Name	Type	Description	Notes
update_email_notification_preference_request	\OpenAPI\Client\Model\UpdateEmailNotificationPreferenceRequest

Return type

\OpenAPI\Client\Model\Employee

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]

updateEmployeePeer()

updateEmployeePeer($user_id, $wt_employee_update): \OpenAPI\Client\Model\Employee

Update peer

Example

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



$apiInstance = new OpenAPI\Client\Api\EmployeesApi(
    // 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()
);
$user_id = 'user_id_example'; // string
$wt_employee_update = new \OpenAPI\Client\Model\WTEmployeeUpdate(); // \OpenAPI\Client\Model\WTEmployeeUpdate

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

Parameters

Name	Type	Description	Notes
user_id	string
wt_employee_update	\OpenAPI\Client\Model\WTEmployeeUpdate

Return type

\OpenAPI\Client\Model\Employee

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]