Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
37.04%
10 / 27
36.84%
7 / 19
 CRAP
0.00%
0 / 1
SearchEventsResponse
37.04%
10 / 27
36.84%
7 / 19
 155.04
0.00%
0 / 1
 __construct
100.00%
2 / 2
100.00%
1 / 1
 3
 __toString
0.00%
0 / 1
0.00%
0 / 1
 2
 swaggerTypes
100.00%
1 / 1
100.00%
1 / 1
 1
 swaggerFormats
0.00%
0 / 1
0.00%
0 / 1
 2
 attributeMap
100.00%
1 / 1
100.00%
1 / 1
 1
 setters
100.00%
1 / 1
100.00%
1 / 1
 1
 getters
0.00%
0 / 1
0.00%
0 / 1
 2
 getModelName
0.00%
0 / 1
0.00%
0 / 1
 2
 listInvalidProperties
0.00%
0 / 1
0.00%
0 / 1
 2
 valid
0.00%
0 / 1
0.00%
0 / 1
 2
 getEvents
100.00%
1 / 1
100.00%
1 / 1
 1
 setEvents
100.00%
2 / 2
100.00%
1 / 1
 1
 getPaginationKey
0.00%
0 / 1
0.00%
0 / 1
 2
 setPaginationKey
100.00%
2 / 2
100.00%
1 / 1
 1
 offsetExists
0.00%
0 / 1
0.00%
0 / 1
 2
 offsetGet
0.00%
0 / 1
0.00%
0 / 1
 6
 offsetSet
0.00%
0 / 3
0.00%
0 / 1
 6
 offsetUnset
0.00%
0 / 1
0.00%
0 / 1
 2
 toPrettyString
0.00%
0 / 4
0.00%
0 / 1
 2
1<?php
2/**
3 * SearchEventsResponse.
4 *
5 * @category Class
6 *
7 * @author   Swagger Codegen team
8 *
9 * @see     https://github.com/swagger-api/swagger-codegen
10 */
11
12/**
13 * Fingerprint Pro Server API.
14 *
15 * Fingerprint Pro Server API allows you to get information about visitors and about individual events in a server environment. It can be used for data exports, decision-making, and data analysis scenarios. Server API is intended for server-side usage, it's not intended to be used from the client side, whether it's a browser or a mobile device.
16 *
17 * OpenAPI spec version: 3
18 * Contact: support@fingerprint.com
19 * Generated by: https://github.com/swagger-api/swagger-codegen.git
20 * Swagger Codegen version: 3.0.34
21 */
22/**
23 * NOTE: This class is auto generated by the swagger code generator program.
24 * https://github.com/swagger-api/swagger-codegen
25 * Do not edit the class manually.
26 */
27
28namespace Fingerprint\ServerAPI\Model;
29
30use Fingerprint\ServerAPI\ObjectSerializer;
31
32/**
33 * SearchEventsResponse Class Doc Comment.
34 *
35 * @category Class
36 *
37 * @description Contains a list of all identification events matching the specified search criteria.
38 *
39 * @author   Swagger Codegen team
40 *
41 * @see     https://github.com/swagger-api/swagger-codegen
42 */
43class SearchEventsResponse implements ModelInterface, \ArrayAccess
44{
45    /**
46     * The original name of the model.
47     *
48     */
49    protected static string $swaggerModelName = 'SearchEventsResponse';
50
51    /**
52     * Array of property to type mappings. Used for (de)serialization.
53     *
54     * @var string[]
55     */
56    protected static array $swaggerTypes = [
57        'events' => '\Fingerprint\ServerAPI\Model\SearchEventsResponseEvents[]',
58        'pagination_key' => 'string'];
59
60    /**
61     * Array of property to format mappings. Used for (de)serialization.
62     *
63     * @var string[]
64     */
65    protected static array $swaggerFormats = [
66        'events' => null,
67        'pagination_key' => null];
68
69    /**
70     * Array of attributes where the key is the local name,
71     * and the value is the original name.
72     *
73     * @var string[]
74     */
75    protected static array $attributeMap = [
76        'events' => 'events',
77        'pagination_key' => 'paginationKey'];
78
79    /**
80     * Array of attributes to setter functions (for deserialization of responses).
81     *
82     * @var string[]
83     */
84    protected static array $setters = [
85        'events' => 'setEvents',
86        'pagination_key' => 'setPaginationKey'];
87
88    /**
89     * Array of attributes to getter functions (for serialization of requests).
90     *
91     * @var string[]
92     */
93    protected static array $getters = [
94        'events' => 'getEvents',
95        'pagination_key' => 'getPaginationKey'];
96
97    /**
98     * Associative array for storing property values.
99     *
100     * @var mixed[]
101     */
102    protected array $container = [];
103
104    /**
105     * Constructor.
106     *
107     * @param mixed[] $data Associated array of property values
108     *                      initializing the model
109     */
110    public function __construct(?array $data = null)
111    {
112        $this->container['events'] = isset($data['events']) ? $data['events'] : null;
113        $this->container['pagination_key'] = isset($data['pagination_key']) ? $data['pagination_key'] : null;
114    }
115
116    /**
117     * Gets the string presentation of the object.
118     *
119     */
120    public function __toString(): string
121    {
122        return json_encode(ObjectSerializer::sanitizeForSerialization($this));
123    }
124
125    /**
126     * Array of property to type mappings. Used for (de)serialization.
127     */
128    public static function swaggerTypes(): array
129    {
130        return self::$swaggerTypes;
131    }
132
133    /**
134     * Array of property to format mappings. Used for (de)serialization.
135     */
136    public static function swaggerFormats(): array
137    {
138        return self::$swaggerFormats;
139    }
140
141    /**
142     * Array of attributes where the key is the local name,
143     * and the value is the original name.
144     */
145    public static function attributeMap(): array
146    {
147        return self::$attributeMap;
148    }
149
150    /**
151     * Array of attributes to setter functions (for deserialization of responses).
152     */
153    public static function setters(): array
154    {
155        return self::$setters;
156    }
157
158    /**
159     * Array of attributes to getter functions (for serialization of requests).
160     */
161    public static function getters(): array
162    {
163        return self::$getters;
164    }
165
166    /**
167     * The original name of the model.
168     */
169    public function getModelName(): string
170    {
171        return self::$swaggerModelName;
172    }
173
174    /**
175     * Show all the invalid properties with reasons.
176     *
177     * @return array invalid properties with reasons
178     */
179    public function listInvalidProperties(): array
180    {
181        return [];
182    }
183
184    /**
185     * Validate all the properties in the model
186     * return true if all passed.
187     *
188     * @return bool True if all properties are valid
189     */
190    public function valid(): bool
191    {
192        return 0 === count($this->listInvalidProperties());
193    }
194
195    /**
196     * Gets events.
197     *
198     * @return ?\Fingerprint\ServerAPI\Model\SearchEventsResponseEvents[]
199     */
200    public function getEvents(): ?array
201    {
202        return $this->container['events'];
203    }
204
205    /**
206     * Sets events.
207     *
208     * @param ?\Fingerprint\ServerAPI\Model\SearchEventsResponseEvents[] $events events
209     *
210     * @return $this
211     */
212    public function setEvents(?array $events): self
213    {
214        $this->container['events'] = $events;
215
216        return $this;
217    }
218
219    /**
220     * Gets pagination_key.
221     */
222    public function getPaginationKey(): ?string
223    {
224        return $this->container['pagination_key'];
225    }
226
227    /**
228     * Sets pagination_key.
229     *
230     * @param ?string $pagination_key use this value in the `pagination_key` parameter to request the next page of search results
231     *
232     * @return $this
233     */
234    public function setPaginationKey(?string $pagination_key): self
235    {
236        $this->container['pagination_key'] = $pagination_key;
237
238        return $this;
239    }
240
241    /**
242     * Returns true if offset exists. False otherwise.
243     *
244     * @param int $offset Offset
245     */
246    public function offsetExists($offset): bool
247    {
248        return isset($this->container[$offset]);
249    }
250
251    /**
252     * Gets offset.
253     *
254     * @param int $offset Offset
255     */
256    public function offsetGet($offset): mixed
257    {
258        return isset($this->container[$offset]) ? $this->container[$offset] : null;
259    }
260
261    /**
262     * Sets value based on offset.
263     *
264     * @param int   $offset Offset
265     * @param mixed $value  Value to be set
266     */
267    public function offsetSet($offset, mixed $value): void
268    {
269        if (is_null($offset)) {
270            $this->container[] = $value;
271        } else {
272            $this->container[$offset] = $value;
273        }
274    }
275
276    /**
277     * Unsets offset.
278     *
279     * @param int $offset Offset
280     */
281    public function offsetUnset($offset): void
282    {
283        unset($this->container[$offset]);
284    }
285
286    /**
287     * Gets the string presentation of the object in a pretty JSON format.
288     *
289     */
290    public function toPrettyString(): string
291    {
292        return json_encode(
293            ObjectSerializer::sanitizeForSerialization($this),
294            JSON_PRETTY_PRINT
295        );
296    }
297}