Skip to content

Latest commit

 

History

History
284 lines (191 loc) · 7.81 KB

QuickLinksSectionApi.md

File metadata and controls

284 lines (191 loc) · 7.81 KB

OpenAPI\Client\QuickLinksSectionApi

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

Method HTTP request Description
archiveLinkBookSection() DELETE /v2/linkBookSection/{id} Archive link book section
createLinkBookSection() POST /v2/linkBookSection Create link book section
fetchAllLinkBookSections() GET /v2/linkBookSection/all Fetch all link book sections
restoreLinkBookSection() PATCH /v2/linkBookSection/{id} Restore link book section
updateLinkBookSection() PUT /v2/linkBookSection/{id} Update link book section

archiveLinkBookSection()

archiveLinkBookSection($id): \OpenAPI\Client\Model\LinkBookSection

Archive link book section

Example

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



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

Parameters

Name Type Description Notes
id mixed

Return type

\OpenAPI\Client\Model\LinkBookSection

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]

createLinkBookSection()

createLinkBookSection($wt_link_book_section_create_params): \OpenAPI\Client\Model\LinkBookSection

Create link book section

Example

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



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

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

Parameters

Name Type Description Notes
wt_link_book_section_create_params \OpenAPI\Client\Model\WTLinkBookSectionCreateParams

Return type

\OpenAPI\Client\Model\LinkBookSection

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]

fetchAllLinkBookSections()

fetchAllLinkBookSections($is_archive_included): mixed

Fetch all link book sections

Example

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



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

restoreLinkBookSection()

restoreLinkBookSection($id): \OpenAPI\Client\Model\LinkBookSection

Restore link book section

Example

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



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

Parameters

Name Type Description Notes
id mixed

Return type

\OpenAPI\Client\Model\LinkBookSection

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]

updateLinkBookSection()

updateLinkBookSection($id, $wt_link_book_section_update_params): \OpenAPI\Client\Model\LinkBookSection

Update link book section

Example

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



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

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

Parameters

Name Type Description Notes
id mixed
wt_link_book_section_update_params \OpenAPI\Client\Model\WTLinkBookSectionUpdateParams

Return type

\OpenAPI\Client\Model\LinkBookSection

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]