Skip to content

Latest commit

 

History

History
744 lines (507 loc) · 19.8 KB

PerformancesApi.md

File metadata and controls

744 lines (507 loc) · 19.8 KB

OpenAPI\Client\PerformancesApi

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

Method HTTP request Description
archivePerformance() DELETE /v2/performances/{id} Archive performance
countClaimedComps() GET /v2/performances/{id}/claimed/count Count number claimed
countRedeemedComps() GET /v2/performances/{id}/redeemed/count Count number redeemed
createPerformance() POST /v2/performances Create performance
exportTickets() POST /v2/performances/{id}/tickets/export Update performance
fetchAllPerformanceTickets() GET /v2/performances/tickets/all/{id} Fetch all tickets
fetchAllPerformances() GET /v2/performances/all Fetch all performances
fetchPerformance() GET /v2/performances/{id} Fetch a single performance
fetchPerformanceTicketsPage() GET /v2/performances/tickets/page/{performanceID} Fetch tickets by page
importTickets() POST /v2/performances/{id}/tickets/import Update performance
restorePerformance() PATCH /v2/performances/{id} Restore performance
saveTicketSettings() POST /v2/performances/{id} Update performance
updatePerformance() PUT /v2/performances/{id} Update performance

archivePerformance()

archivePerformance($id): \OpenAPI\Client\Model\Performance

Archive performance

Example

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



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

Parameters

Name Type Description Notes
id mixed

Return type

\OpenAPI\Client\Model\Performance

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]

countClaimedComps()

countClaimedComps($id): \OpenAPI\Client\Model\CountClaimedComps200Response

Count number claimed

Example

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



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

Parameters

Name Type Description Notes
id mixed

Return type

\OpenAPI\Client\Model\CountClaimedComps200Response

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]

countRedeemedComps()

countRedeemedComps($id): \OpenAPI\Client\Model\CountClaimedComps200Response

Count number redeemed

Example

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



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

Parameters

Name Type Description Notes
id mixed

Return type

\OpenAPI\Client\Model\CountClaimedComps200Response

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]

createPerformance()

createPerformance($wt_performance_create_params): \OpenAPI\Client\Model\Performance

Create performance

Example

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



$apiInstance = new OpenAPI\Client\Api\PerformancesApi(
    // 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_performance_create_params = new \OpenAPI\Client\Model\WTPerformanceCreateParams(); // \OpenAPI\Client\Model\WTPerformanceCreateParams

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

Parameters

Name Type Description Notes
wt_performance_create_params \OpenAPI\Client\Model\WTPerformanceCreateParams

Return type

\OpenAPI\Client\Model\Performance

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]

exportTickets()

exportTickets($id): \OpenAPI\Client\Model\Ticket[]

Update performance

Example

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



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

Parameters

Name Type Description Notes
id mixed

Return type

\OpenAPI\Client\Model\Ticket[]

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]

fetchAllPerformanceTickets()

fetchAllPerformanceTickets($id, $is_archive_included): \OpenAPI\Client\Model\Ticket[]

Fetch all tickets

Example

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



$apiInstance = new OpenAPI\Client\Api\PerformancesApi(
    // 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
$is_archive_included = True; // bool

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

Parameters

Name Type Description Notes
id mixed
is_archive_included bool [optional]

Return type

\OpenAPI\Client\Model\Ticket[]

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]

fetchAllPerformances()

fetchAllPerformances($is_archive_included): mixed

Fetch all performances

Example

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



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

fetchPerformance()

fetchPerformance($id): \OpenAPI\Client\Model\Performance

Fetch a single performance

Example

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



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

Parameters

Name Type Description Notes
id mixed

Return type

\OpenAPI\Client\Model\Performance

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]

fetchPerformanceTicketsPage()

fetchPerformanceTicketsPage($performance_id, $page_num, $page_size, $filter_comps, $filter_claimed, $sort_by, $sort_direction, $is_archive_included): \OpenAPI\Client\Model\FetchPerformanceTicketsPage200Response

Fetch tickets by page

Example

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



$apiInstance = new OpenAPI\Client\Api\PerformancesApi(
    // 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()
);
$performance_id = NULL; // mixed
$page_num = 3.4; // float
$page_size = 3.4; // float
$filter_comps = True; // bool
$filter_claimed = True; // bool
$sort_by = NULL; // mixed
$sort_direction = NULL; // mixed
$is_archive_included = True; // bool

try {
    $result = $apiInstance->fetchPerformanceTicketsPage($performance_id, $page_num, $page_size, $filter_comps, $filter_claimed, $sort_by, $sort_direction, $is_archive_included);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PerformancesApi->fetchPerformanceTicketsPage: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
performance_id mixed
page_num float
page_size float
filter_comps bool [optional]
filter_claimed bool [optional]
sort_by mixed [optional]
sort_direction mixed [optional]
is_archive_included bool [optional]

Return type

\OpenAPI\Client\Model\FetchPerformanceTicketsPage200Response

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]

importTickets()

importTickets($id, $import_tickets_request): string

Update performance

Example

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



$apiInstance = new OpenAPI\Client\Api\PerformancesApi(
    // 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
$import_tickets_request = new \OpenAPI\Client\Model\ImportTicketsRequest(); // \OpenAPI\Client\Model\ImportTicketsRequest

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

Parameters

Name Type Description Notes
id mixed
import_tickets_request \OpenAPI\Client\Model\ImportTicketsRequest

Return type

string

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]

restorePerformance()

restorePerformance($id): \OpenAPI\Client\Model\Performance

Restore performance

Example

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



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

Parameters

Name Type Description Notes
id mixed

Return type

\OpenAPI\Client\Model\Performance

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]

saveTicketSettings()

saveTicketSettings($id, $save_ticket_settings_request): \OpenAPI\Client\Model\Performance

Update performance

Example

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



$apiInstance = new OpenAPI\Client\Api\PerformancesApi(
    // 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
$save_ticket_settings_request = new \OpenAPI\Client\Model\SaveTicketSettingsRequest(); // \OpenAPI\Client\Model\SaveTicketSettingsRequest

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

Parameters

Name Type Description Notes
id mixed
save_ticket_settings_request \OpenAPI\Client\Model\SaveTicketSettingsRequest

Return type

\OpenAPI\Client\Model\Performance

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]

updatePerformance()

updatePerformance($id, $wt_performance_update_params): \OpenAPI\Client\Model\Performance

Update performance

Example

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



$apiInstance = new OpenAPI\Client\Api\PerformancesApi(
    // 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_performance_update_params = new \OpenAPI\Client\Model\WTPerformanceUpdateParams(); // \OpenAPI\Client\Model\WTPerformanceUpdateParams

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

Parameters

Name Type Description Notes
id mixed
wt_performance_update_params \OpenAPI\Client\Model\WTPerformanceUpdateParams

Return type

\OpenAPI\Client\Model\Performance

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]