AmenitiesApi.md

OpenAPI\Client\AmenitiesApi

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

Method	HTTP request	Description
archiveAmenity()	DELETE /v2/amenities/{id}	Archive amenity
createAmenity()	POST /v2/amenities	Create amenity
fetchAllAmenities()	GET /v2/amenities/all	Fetch all amenities
restoreAmenity()	PATCH /v2/amenities/{id}	Restore amenity
updateAmenity()	PUT /v2/amenities/{id}	Update amenity

archiveAmenity()

archiveAmenity($id): \OpenAPI\Client\Model\Amenity

Archive amenity

Example

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



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

Parameters

Name	Type	Description	Notes
id	mixed

Return type

\OpenAPI\Client\Model\Amenity

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]

createAmenity()

createAmenity($wt_amenity_create_params): \OpenAPI\Client\Model\Amenity

Create amenity

Example

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



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

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

Parameters

Name	Type	Description	Notes
wt_amenity_create_params	\OpenAPI\Client\Model\WTAmenityCreateParams

Return type

\OpenAPI\Client\Model\Amenity

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]

fetchAllAmenities()

fetchAllAmenities($is_archive_included): mixed

Fetch all amenities

Example

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



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

Parameters

Name	Type	Description	Notes
is_archive_included	bool		[optional]

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]

restoreAmenity()

restoreAmenity($id): \OpenAPI\Client\Model\Amenity

Restore amenity

Example

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



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

Parameters

Name	Type	Description	Notes
id	mixed

Return type

\OpenAPI\Client\Model\Amenity

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]

updateAmenity()

updateAmenity($id, $wt_amenity_update_params): \OpenAPI\Client\Model\Amenity

Update amenity

Example

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



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

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

Parameters

Name	Type	Description	Notes
id	mixed
wt_amenity_update_params	\OpenAPI\Client\Model\WTAmenityUpdateParams

Return type

\OpenAPI\Client\Model\Amenity

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]