OpenAPI\Client\MembershipTiersApi

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

Method	HTTP request	Description
archiveMembershipTier()	DELETE /v2/membership/tier/{id}	Archive tier
createMembershipTier()	POST /v2/membership/tier	Create tier
fetchAllMembershipTiers()	GET /v2/membership/tier/all	Fetch all tiers
fetchAllMembershipTiersWithMemberCount()	GET /v2/membership/tier/allWithMemberCount	Fetch all tiers with member count
fetchMembershipTierById()	GET /v2/membership/tier/{id}	Fetch tier
fetchMembershipTierHistoryLog()	POST /v2/membership/tier/history/log	Fetch history
fetchMembershipTierRedemptionLog()	POST /v2/membership/tier/redemption/log	Fetch redemption log
restoreMembershipTier()	PATCH /v2/membership/tier/{id}	Restore tier
updateMembershipTier()	PUT /v2/membership/tier/{id}	Update tier

`archiveMembershipTier()`

archiveMembershipTier($id): \OpenAPI\Client\Model\WTMembershipTier

Archive tier

Example

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



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

Parameters

Name	Type	Description	Notes
id	mixed

Return type

\OpenAPI\Client\Model\WTMembershipTier

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]

`createMembershipTier()`

createMembershipTier($wt_membership_tier_creation_params): \OpenAPI\Client\Model\WTMembershipTier

Create tier

Example

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



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

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

Parameters

Name	Type	Description	Notes
wt_membership_tier_creation_params	\OpenAPI\Client\Model\WTMembershipTierCreationParams

Return type

\OpenAPI\Client\Model\WTMembershipTier

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]

`fetchAllMembershipTiers()`

fetchAllMembershipTiers($is_archive_included): \OpenAPI\Client\Model\WTMembershipTier[]

Fetch all tiers

Example

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



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

Parameters

Name	Type	Description	Notes
is_archive_included	bool		[optional]

Return type

\OpenAPI\Client\Model\WTMembershipTier[]

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]

`fetchAllMembershipTiersWithMemberCount()`

fetchAllMembershipTiersWithMemberCount($is_archive_included): \OpenAPI\Client\Model\WTMembershipTierWithMemberCount[]

Fetch all tiers with member count

Example

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



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

Parameters

Name	Type	Description	Notes
is_archive_included	bool		[optional]

Return type

\OpenAPI\Client\Model\WTMembershipTierWithMemberCount[]

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]

`fetchMembershipTierById()`

fetchMembershipTierById($id): \OpenAPI\Client\Model\WTMembershipTier

Fetch tier

Example

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



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

Parameters

Name	Type	Description	Notes
id	mixed

Return type

\OpenAPI\Client\Model\WTMembershipTier

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]

`fetchMembershipTierHistoryLog()`

fetchMembershipTierHistoryLog($pagination_request_with_id_and_without_sort_options): \OpenAPI\Client\Model\MSMembershipTierHistoryPagination

Fetch history

Example

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



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

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

Parameters

Name	Type	Description	Notes
pagination_request_with_id_and_without_sort_options	\OpenAPI\Client\Model\PaginationRequestWithIDAndWithoutSortOptions

Return type

\OpenAPI\Client\Model\MSMembershipTierHistoryPagination

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]

`fetchMembershipTierRedemptionLog()`

fetchMembershipTierRedemptionLog($pagination_request_with_id_and_without_sort_options): \OpenAPI\Client\Model\MSMembershipTierRedemptionPagination

Fetch redemption log

Example

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



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

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

Parameters

Name	Type	Description	Notes
pagination_request_with_id_and_without_sort_options	\OpenAPI\Client\Model\PaginationRequestWithIDAndWithoutSortOptions

Return type

\OpenAPI\Client\Model\MSMembershipTierRedemptionPagination

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]

`restoreMembershipTier()`

restoreMembershipTier($id): \OpenAPI\Client\Model\WTMembershipTier

Restore tier

Example

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



$apiInstance = new OpenAPI\Client\Api\MembershipTiersApi(
    // 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 = 'id_example'; // string

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

Parameters

Name	Type	Description	Notes
id	string

Return type

\OpenAPI\Client\Model\WTMembershipTier

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]

`updateMembershipTier()`

updateMembershipTier($id, $wt_membership_tier_update_params): \OpenAPI\Client\Model\WTMembershipTier

Update tier

Example

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



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

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

Parameters

Name	Type	Description	Notes
id	mixed
wt_membership_tier_update_params	\OpenAPI\Client\Model\WTMembershipTierUpdateParams

Return type

\OpenAPI\Client\Model\WTMembershipTier

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]

Files

MembershipTiersApi.md

Latest commit

History

MembershipTiersApi.md

File metadata and controls

OpenAPI\Client\MembershipTiersApi

archiveMembershipTier()

Example

Parameters

Return type

Authorization

HTTP request headers

createMembershipTier()

Example

Parameters

Return type

Authorization

HTTP request headers

fetchAllMembershipTiers()

Example

Parameters

Return type

Authorization

HTTP request headers

fetchAllMembershipTiersWithMemberCount()

Example

Parameters

Return type

Authorization

HTTP request headers

fetchMembershipTierById()

Example

Parameters

Return type

Authorization

HTTP request headers

fetchMembershipTierHistoryLog()

Example

Parameters

Return type

Authorization

HTTP request headers

fetchMembershipTierRedemptionLog()

Example

Parameters

Return type

Authorization

HTTP request headers

restoreMembershipTier()

Example

Parameters

Return type

Authorization

HTTP request headers

updateMembershipTier()

Example

Parameters

Return type

Authorization

HTTP request headers

`archiveMembershipTier()`

`createMembershipTier()`

`fetchAllMembershipTiers()`

`fetchAllMembershipTiersWithMemberCount()`

`fetchMembershipTierById()`

`fetchMembershipTierHistoryLog()`

`fetchMembershipTierRedemptionLog()`

`restoreMembershipTier()`

`updateMembershipTier()`