Skip to content

Latest commit

 

History

History
556 lines (373 loc) · 16.1 KB

ClubMembersPointsApi.md

File metadata and controls

556 lines (373 loc) · 16.1 KB

OpenAPI\Client\ClubMembersPointsApi

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

Method HTTP request Description
archiveMember() DELETE /v2/membership/member/{id} Archive member
createMember() POST /v2/membership/member Create member
fetchMemberById() GET /v2/membership/member/{id} Fetch member
fetchMemberHistoryLog() POST /v2/membership/member/history/log Fetch history
fetchMemberRedemptionLog() POST /v2/membership/member/redemption/log Fetch redemption log
fetchMembersByPage() POST /v2/membership/member/page Fetch members by page
fetchMembersCount() GET /v2/membership/member/count Count active members
restoreMember() PATCH /v2/membership/member/{id} Restore member
searchMembers() POST /v2/membership/member/search Search for members
updateMember() PUT /v2/membership/member/{id} Update member

archiveMember()

archiveMember($id): \OpenAPI\Client\Model\WTMember

Archive member

Example

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



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

Parameters

Name Type Description Notes
id mixed

Return type

\OpenAPI\Client\Model\WTMember

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]

createMember()

createMember($wt_member_creation_params): \OpenAPI\Client\Model\WTMember

Create member

Example

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



$apiInstance = new OpenAPI\Client\Api\ClubMembersPointsApi(
    // 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_member_creation_params = new \OpenAPI\Client\Model\WTMemberCreationParams(); // \OpenAPI\Client\Model\WTMemberCreationParams

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

Parameters

Name Type Description Notes
wt_member_creation_params \OpenAPI\Client\Model\WTMemberCreationParams

Return type

\OpenAPI\Client\Model\WTMember

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]

fetchMemberById()

fetchMemberById($id): \OpenAPI\Client\Model\WTMember

Fetch member

Example

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



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

Parameters

Name Type Description Notes
id mixed

Return type

\OpenAPI\Client\Model\WTMember

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]

fetchMemberHistoryLog()

fetchMemberHistoryLog($pagination_request_with_id_and_without_sort_options): \OpenAPI\Client\Model\MSMemberHistoryPagination

Fetch history

Example

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



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

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]

fetchMemberRedemptionLog()

fetchMemberRedemptionLog($pagination_request_with_id_and_without_sort_options): \OpenAPI\Client\Model\MSMemberRedemptionPagination

Fetch redemption log

Example

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



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

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]

fetchMembersByPage()

fetchMembersByPage($pagination_request_with_sort_options): \OpenAPI\Client\Model\WTMember[]

Fetch members by page

Example

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



$apiInstance = new OpenAPI\Client\Api\ClubMembersPointsApi(
    // 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_sort_options = new \OpenAPI\Client\Model\PaginationRequestWithSortOptions(); // \OpenAPI\Client\Model\PaginationRequestWithSortOptions

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

Parameters

Name Type Description Notes
pagination_request_with_sort_options \OpenAPI\Client\Model\PaginationRequestWithSortOptions

Return type

\OpenAPI\Client\Model\WTMember[]

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]

fetchMembersCount()

fetchMembersCount(): \OpenAPI\Client\Model\FetchMembersCount200Response

Count active members

Example

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



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

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\FetchMembersCount200Response

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]

restoreMember()

restoreMember($id): \OpenAPI\Client\Model\WTMember

Restore member

Example

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



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

Parameters

Name Type Description Notes
id mixed

Return type

\OpenAPI\Client\Model\WTMember

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]

searchMembers()

searchMembers($member_search): \OpenAPI\Client\Model\PaginatedWTMembers

Search for members

Example

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



$apiInstance = new OpenAPI\Client\Api\ClubMembersPointsApi(
    // 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()
);
$member_search = new \OpenAPI\Client\Model\MemberSearch(); // \OpenAPI\Client\Model\MemberSearch

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

Parameters

Name Type Description Notes
member_search \OpenAPI\Client\Model\MemberSearch

Return type

\OpenAPI\Client\Model\PaginatedWTMembers

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]

updateMember()

updateMember($id, $pick_wt_member_member_idor_first_name_or_last_name_or_membership_tier_idor_points_accrued_or_mobile_number_or_email_or_birthday): \OpenAPI\Client\Model\WTMember

Update member

Example

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



$apiInstance = new OpenAPI\Client\Api\ClubMembersPointsApi(
    // 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
$pick_wt_member_member_idor_first_name_or_last_name_or_membership_tier_idor_points_accrued_or_mobile_number_or_email_or_birthday = new \OpenAPI\Client\Model\PickWTMemberMemberIDOrFirstNameOrLastNameOrMembershipTierIDOrPointsAccruedOrMobileNumberOrEmailOrBirthday(); // \OpenAPI\Client\Model\PickWTMemberMemberIDOrFirstNameOrLastNameOrMembershipTierIDOrPointsAccruedOrMobileNumberOrEmailOrBirthday

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

Parameters

Name Type Description Notes
id mixed
pick_wt_member_member_idor_first_name_or_last_name_or_membership_tier_idor_points_accrued_or_mobile_number_or_email_or_birthday \OpenAPI\Client\Model\PickWTMemberMemberIDOrFirstNameOrLastNameOrMembershipTierIDOrPointsAccruedOrMobileNumberOrEmailOrBirthday

Return type

\OpenAPI\Client\Model\WTMember

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]