Yoast\MyYoastApiClient\DefaultApi

All URIs are relative to https://my.yoast.test

Method	HTTP request	Description
acceptInvitation	POST /api/v1/access/{subscriptionId}/invites/{id}/accept
checkHealth	POST /api/tmp
deprecationsProvisioningDownloadsCurrentVersionV1	GET /api/docs/deprecations/provisioning-downloads-v1
getLicenseStatus	GET /api/v1/license-validation/{product_id}
getOptions	GET /api/v1/installation/options
getOptionsForOrder	GET /api/v1/installation/options/{invoiceNumber}
getSites	GET /api/v1/installation/sites
getSitesForOrder	GET /api/v1/installation/sites/{invoiceNumber}
inviteEmail	POST /api/v1/access/{subscriptionId}/invites
revokeInvitation	DELETE /api/v1/access/{subscriptionId}/invites/{id}

acceptInvitation

acceptInvitation($body, $id, $subscriptionId)

Example

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

$apiInstance = new Yoast\MyYoastApiClient\Api\DefaultApi(
    // 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()
);
$body = new \Yoast\MyYoastApiClient\Model\AcceptInvitationBodyDto(); // \Yoast\MyYoastApiClient\Model\AcceptInvitationBodyDto | 
$id = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string | 
$subscriptionId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string | 

try {
    $apiInstance->acceptInvitation($body, $id, $subscriptionId);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->acceptInvitation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Yoast\MyYoastApiClient\Model\AcceptInvitationBodyDto
id	string
subscriptionId	string

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

checkHealth

checkHealth()

Example

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

$apiInstance = new Yoast\MyYoastApiClient\Api\DefaultApi(
    // 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 {
    $apiInstance->checkHealth();
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->checkHealth: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

deprecationsProvisioningDownloadsCurrentVersionV1

deprecationsProvisioningDownloadsCurrentVersionV1()

Example

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

$apiInstance = new Yoast\MyYoastApiClient\Api\DefaultApi(
    // 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 {
    $apiInstance->deprecationsProvisioningDownloadsCurrentVersionV1();
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deprecationsProvisioningDownloadsCurrentVersionV1: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

getLicenseStatus

\Yoast\MyYoastApiClient\Model\LicenseValidationResult getLicenseStatus($productId, $email)

Example

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

$apiInstance = new Yoast\MyYoastApiClient\Api\DefaultApi(
    // 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()
);
$productId = "productId_example"; // string | 
$email = "email_example"; // string | 

try {
    $result = $apiInstance->getLicenseStatus($productId, $email);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getLicenseStatus: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
productId	string
email	string

Return type

\Yoast\MyYoastApiClient\Model\LicenseValidationResult

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]

getOptions

getOptions()

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Yoast\MyYoastApiClient\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yoast\MyYoastApiClient\Api\DefaultApi(
    // 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(),
    $config
);

try {
    $apiInstance->getOptions();
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getOptions: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

getOptionsForOrder

getOptionsForOrder($invoiceNumber)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Yoast\MyYoastApiClient\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yoast\MyYoastApiClient\Api\DefaultApi(
    // 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(),
    $config
);
$invoiceNumber = "invoiceNumber_example"; // string | 

try {
    $apiInstance->getOptionsForOrder($invoiceNumber);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getOptionsForOrder: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
invoiceNumber	string

Return type

void (empty response body)

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

getSites

getSites()

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Yoast\MyYoastApiClient\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yoast\MyYoastApiClient\Api\DefaultApi(
    // 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(),
    $config
);

try {
    $apiInstance->getSites();
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getSites: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

getSitesForOrder

getSitesForOrder($invoiceNumber)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Yoast\MyYoastApiClient\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yoast\MyYoastApiClient\Api\DefaultApi(
    // 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(),
    $config
);
$invoiceNumber = "invoiceNumber_example"; // string | 

try {
    $apiInstance->getSitesForOrder($invoiceNumber);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getSitesForOrder: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
invoiceNumber	string

Return type

void (empty response body)

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

inviteEmail

\Yoast\MyYoastApiClient\Model\InviteResponseDto inviteEmail($body, $subscriptionId)

Example

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

$apiInstance = new Yoast\MyYoastApiClient\Api\DefaultApi(
    // 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()
);
$body = new \Yoast\MyYoastApiClient\Model\InviteBodyDto(); // \Yoast\MyYoastApiClient\Model\InviteBodyDto | 
$subscriptionId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string | 

try {
    $result = $apiInstance->inviteEmail($body, $subscriptionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->inviteEmail: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Yoast\MyYoastApiClient\Model\InviteBodyDto
subscriptionId	string

Return type

\Yoast\MyYoastApiClient\Model\InviteResponseDto

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]

revokeInvitation

revokeInvitation($id, $subscriptionId)

Example

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

$apiInstance = new Yoast\MyYoastApiClient\Api\DefaultApi(
    // 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 = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string | 
$subscriptionId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string | 

try {
    $apiInstance->revokeInvitation($id, $subscriptionId);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->revokeInvitation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string
subscriptionId	string

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

FilesExpand file tree

DefaultApi.md

Latest commit

History

DefaultApi.md

File metadata and controls

Yoast\MyYoastApiClient\DefaultApi

acceptInvitation

Example

Parameters

Return type

Authorization

HTTP request headers

checkHealth

Example

Parameters

Return type

Authorization

HTTP request headers

deprecationsProvisioningDownloadsCurrentVersionV1

Example

Parameters

Return type

Authorization

HTTP request headers

getLicenseStatus

Example

Parameters

Return type

Authorization

HTTP request headers

getOptions

Example

Parameters

Return type

Authorization

HTTP request headers

getOptionsForOrder

Example

Parameters

Return type

Authorization

HTTP request headers

getSites

Example

Parameters

Return type

Authorization

HTTP request headers

getSitesForOrder

Example

Parameters

Return type

Authorization

HTTP request headers

inviteEmail

Example

Parameters

Return type

Authorization

HTTP request headers

revokeInvitation

Example

Parameters

Return type

Authorization

HTTP request headers