Entry point for the SDK exposing functions to interact with the NextEvent API. ### Booking Process and Payment Process 0. Authorize SDK by creating Client instance with credentials 1. <code>getEvents()</code> List events 2. <code>getWidget($hash)->generateEmbedCode($eventId)</code> Embed widget for specific event 3. Get orderId from the widget by postMessage 4. <code>getBasket($orderId)</code> checkout the basket 5. <code>authorizeOrder($orderId)</code> start payment process 6. <code>settlePayment($payment, $customer, $transactionId)</code> settle payment 7. <code>getTicketDocuments($orderId)</code> get TicketDocuments with download urls ### Rebooking 1. <code>rebookOrder()</code> create rebooking basket 2. <code>getWidget($hash)->generateEmbedCode(['basket' => $basket])</code> Embed widget with rebooking basket. 3. Complete order as in regular booking process ### Cancellation 1. <code>requestCancellation()</code> request cancellation authorization for a given order 2. <code>settleCancellation()</code> settle cancellation with the authorization data ### Entrance check information 1. <code>getAccessCodes($query)</code> get a collection of AccessCodes 2. <code>getGate($gateId)</code> get a Gate 3. <code>getGates($query)</code> get a collection Gates 4. <code>getDevice($deviceId)</code> get a Device 5. <code>getDevices($query)</code> get a collection of Devices 6. <code>getScanLogs($query)</code> get a collection of ScanLogs ### Price and category information 1. <code>getBaseCategories($query)</code> get a collection of BaseCategories 2. <code>getCategories($query)</code> get a collection of Categories 3. <code>getBasePrices($query)</code> get a collection of BasePrices 4. <code>getPrices($query)</code> get a collection of Prices ### Persistance 1. <code>createEvent($event)</code> create a new Event 2. <code>createBaseCategory($categories)</code> create new BaseCategories and Categories 3. <code>createBasePrice($prices)</code> create new BasePrices and Prices 4. <code>updateBaseCategory($categories)</code> update BaseCategories and its Categories 5. <code>updateBasePrice($prices)</code> update BasePrices and its Prices

Thrown when a request to the NextEvent API failed with an error response. The exception provides extensive information about the request sent, the response received and the reasons which it didn't succeed. Use the toLogContext() or dumpAsString() methods for logging.

Thrown when a request to the NextEvent API failed with an error response. The exception provides extensive information about the request sent, the response received and the reasons which it didn't succeed. Use the toLogContext() or dumpAsString() methods for logging.

Thrown when a request to the NextEvent API failed with an error response. The exception provides extensive information about the request sent, the response received and the reasons which it didn't succeed. Use the toLogContext() or dumpAsString() methods for logging.

Thrown when a request to the NextEvent API failed with an error response. The exception provides extensive information about the request sent, the response received and the reasons which it didn't succeed. Use the toLogContext() or dumpAsString() methods for logging.

Thrown when a request to the NextEvent API failed with an error response. The exception provides extensive information about the request sent, the response received and the reasons which it didn't succeed. Use the toLogContext() or dumpAsString() methods for logging.

Thrown when a request to the NextEvent API failed with an error response. The exception provides extensive information about the request sent, the response received and the reasons which it didn't succeed. Use the toLogContext() or dumpAsString() methods for logging.

Thrown when a request to the NextEvent API failed with an error response. The exception provides extensive information about the request sent, the response received and the reasons which it didn't succeed. Use the toLogContext() or dumpAsString() methods for logging.

Thrown when a request to the NextEvent API failed with an error response. The exception provides extensive information about the request sent, the response received and the reasons which it didn't succeed. Use the toLogContext() or dumpAsString() methods for logging.

Thrown when a request to the NextEvent API failed with an error response. The exception provides extensive information about the request sent, the response received and the reasons which it didn't succeed. Use the toLogContext() or dumpAsString() methods for logging.

Thrown when a request to the NextEvent API failed with an error response. The exception provides extensive information about the request sent, the response received and the reasons which it didn't succeed. Use the toLogContext() or dumpAsString() methods for logging.

Thrown when a request to the NextEvent API failed with an error response. The exception provides extensive information about the request sent, the response received and the reasons which it didn't succeed. Use the toLogContext() or dumpAsString() methods for logging.

An access code is used in the entrance check process. Each access code owns a (bar)code, a category id and a state. A [Gate](../classes/NextEvent.PHPSDK.Model.Gate.html) is responsible for invalidating, i.e. modifying the `entry_state`, of such an access code.

An instance of this collection can update the entry state of all access codes inside of it with one single API request.

A wrapper class for responses returned by GuzzleHttp. Adds utility functions used by the SDK

Provides the structure for a base category record. Base categories are categories which can not be booked and are never linked to an order item. Base categories are internally used to create category records. All values which are set for a base category will automatically be applied to the related category records.

Provides the structure for a base price record. A base price is a price which applies it's data to actual price records. A base price is never linked to a category record. It rather links to a [BaseCategory](../classes/NextEvent.PHPSDK.Model.BaseCategory.html). Just like a base category, a base price is never linked to an order item.

Represents a basket model retrieved from the API

Model class representing a single item (ticket) of a NextEvent basket

Represents a cancellation request for a given order. Can be used to confirm cancellation in a second step.

Struct for a category record assigned to an order/basket item.

It has meta information about the total amount of items, pages and references to other pages. Further more it allows to iterate over all total items, by simply fetching the next page if the bounds of the current page have been reached. If you want to fetch the next page manually, you can call [Collection::fetchNextPage()](../classes/NextEvent.PHPSDK.Model.Collection.html#method_fetchNextPage). This will fetch the next page, if it is available and apply the content to this collection. In order to fetch a specific page and apply it to the collection, you can fetch it with the rest client and then apply it via [Collection::setData()](../classes/NextEvent.PHPSDK.Model.Collection.html#method_setData). Whether you want to reset the current data or not can be controlled with the flag `reset`.

Extend the default DateTime class with a flag indicating that it only represent a date and the time should be ignored.

A device entity represents a real world device. It holds information such as the device UUID, platform(os) and it's version and the device name. A device can also tell on which gate it is logged in and when it has been logged in the last time.

Struct for a discount code record assigned to an order/basket item or a DiscountGroup relation.

Struct for a discount group registered in the system.

Model class for an event record registered in NextEvent. Provides simplified access to event title, details, start/end dates, etc.

A gate represents an entity which is responsible for invalidating access codes. It can only invalidate those access codes whose category id matches one of the gate's category ids.

Struct for a pair of geographic coordinates as defined in the World Geodetic System (WGS 84).

Represents a geographic place, like the location of an event.

Data structures retrieved from the NextEvent API are wrapped into dependants of this class in order to provide a well-defined struct for accessing these informations. With the Serializable interface implemented, all models can easily be serialized and stored in session data.

An instance of a mutable model provides setters for any property. This means you can call e.g. `$model->setFoo($val)` which will will store the value at the index `foo` in the internal source array. You can also override the whole source at once with the [MutableModel::setSource()](../classes/NextEvent.PHPSDK.Model.MutableModel.html#method_setSource).

Represents an order record retrieved from the API.

Represents a printable PDF document attached to an order

Model class representing a single item of a NextEvent order

Represents an organization entity

Represents a payment authorization record issued by the API. Can be used to process payment and finally settle orders.

Represents an postal address data structure

Model class exposing price properties like title, price, currency

A scan log holds entry information of an access code. Those information contain process time, gate which scanned the code and which device has done it. Furthermore it holds connection state information and the validation message. This model can be used to analyze the entrance checks.

Struct for seat information assigend an order/basket item.

Model class representing a booked ticket

Represents a printable PDF document attached to a ticket

Helper for handling changing variables in different environments Known environment variables: - <code>string iam_service_url</code> the Url to the IAM Service - <code>string payment_service_url</code> the Url to the Payment Service - <code>string locale</code> language code, use only 2 letters like 'en'

Example: ``` $filter = new Filter('created', '2018-10-23', '>='); ``` If you want to filter for `NULL` values, you can pass the string `'NULL'` as value.

This is only the Wrapper for a PSR Logger and not the actual Logger. Implements some convenience functions for better logging.

You should use it to pass query and filter parameters to the Client's get* methods. For example: ``` $myQuery = new Query(); $myQuery->set('foo', 'bar'); $myQuery->setPageSize(10); $myQuery->addFilter(new Filter('field', 'value')); ```

For integrating the booking process into a partner platform, a widget is available. Widgets are referenced by Widget-Hash. You need to embed the Widget <code>/assets/js/widgetapi.js</code> into your hostpage and use the <code>NextEventWidgetAPI</code> to interact with the widget. ### Embed Widget ```php <?php use NextEvent\PHPSDK\Client; $appUrl = 'https://myapp.nextevent.com'; $credentials = [...]; $widgetHash = 's67fa757df4a76s5'; $client = new Client($appUrl, $credentials, $widgetHash); // get Widget $widget = $client->getWidget(); // embed Widget echo $widget->generateEmbedCode($event_id); ``` ### NextEventWidgetAPI The <code>NextEventWidgetAPI</code> is a JavaSrcipt script, which you can use to register Message Handlers. Therefore the script has to be included into the hostpage. Use <code>NextEventWidgetAPI</code> for retrieving the <code>order_id</code> and send it to your server. Use <code>NextEventWidgetAPI</code> to show your own payment step on <code>current_step</code> message ```html <script src="/assets/js/widgetapi.js"></script> ``` When the script is included the NextEventWidgetAPI is available by <code>window .NextEventWidgetAPI</code> ```js function custom_handler(data) { // do something with the data } // handler can be added window.NextEventWidgetAPI.addMessageHandler('current_step', custom_handler); // and removed window.NextEventWidgetAPI.removeMessageHandler('current_step', custom_handler); ``` ### Widget Messages #### current_step This message is send on changing routes. <code>step</code> current step a path example data: ```js { step: '/event/42' } { step: '/payment' } { step: '/checkout' } ``` #### basket_update This message is send when the basket is updated <code>order_id</code> id from current basket example data: ```js { order_id: 5005 } ```

If __opcache__ is available, us this to cache temp file for performance improvement.

```php // Get AccessToken by IAM <?php use NextEvent\PHPSDK\Client; use NextEvent\PHPSDK\Auth\IAMClient; $credentials = ['user', 'password', 'scope']; // Your Credentials $client = new Client($appUrl, $credentials, $widgetHash); // stand alone $iam_client = new IAMClient($credentials, $cache); $token = $iam_client->getToken(); ``` With the Token you can authorize requests to the NextEvent application by setting the <code>Authorization</code> Header. ```php $http->get( $url, ['headers' => [ 'Authorization' => $token->getAuthorizationHeader() ]]); ```

Parse Token issued by the IAMClient and provide some helper functions

A wrapper class for Responses returned by GuzzleHttp. The Responses are parsed as HAL+JSON and made accessible by this class.