Skip to content

Latest commit

 

History

History
284 lines (191 loc) · 7.06 KB

ServicesApi.md

File metadata and controls

284 lines (191 loc) · 7.06 KB

OpenAPI\Client\ServicesApi

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

Method HTTP request Description
archiveService() DELETE /v2/services/{id} Archive service
createService() POST /v2/services Create service
fetchAllServices() GET /v2/services/all Fetch all services
restoreService() PATCH /v2/services/{id} Restore service
updateService() PUT /v2/services/{id} Update service

archiveService()

archiveService($id): \OpenAPI\Client\Model\Service

Archive service

Example

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



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

Parameters

Name Type Description Notes
id mixed

Return type

\OpenAPI\Client\Model\Service

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]

createService()

createService($wt_service_create_params): \OpenAPI\Client\Model\Service

Create service

Example

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



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

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

Parameters

Name Type Description Notes
wt_service_create_params \OpenAPI\Client\Model\WTServiceCreateParams

Return type

\OpenAPI\Client\Model\Service

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]

fetchAllServices()

fetchAllServices($is_archive_included): mixed

Fetch all services

Example

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



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

restoreService()

restoreService($id): \OpenAPI\Client\Model\Service

Restore service

Example

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



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

Parameters

Name Type Description Notes
id mixed

Return type

\OpenAPI\Client\Model\Service

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]

updateService()

updateService($id, $wt_service_update_params): \OpenAPI\Client\Model\Service

Update service

Example

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



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

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

Parameters

Name Type Description Notes
id mixed
wt_service_update_params \OpenAPI\Client\Model\WTServiceUpdateParams

Return type

\OpenAPI\Client\Model\Service

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]