|
| 1 | +<?php |
| 2 | +/** |
| 3 | + * AssetRenderResponse |
| 4 | + * |
| 5 | + * PHP version 7.2 |
| 6 | + * |
| 7 | + * @category Class |
| 8 | + * @package Shotstack\Client |
| 9 | + * @author OpenAPI Generator team |
| 10 | + * @link https://openapi-generator.tech |
| 11 | + */ |
| 12 | + |
| 13 | +/** |
| 14 | + * Shotstack |
| 15 | + * |
| 16 | + * <p>Shotstack is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the API which will render your video and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation. </p> <p> There are two main API's, one for editing videos and images (Edit API) and one for managing hosted assets (Serve API). </p> <p> The Edit API base URL is: <b>https://api.shotstack.io/{version}</b> </p> <p> The Serve API base URL is: <b>https://api.shotstack.io/serve/{version}</b> </p> |
| 17 | + * |
| 18 | + * The version of the OpenAPI document: v1 |
| 19 | + * |
| 20 | + * Generated by: https://openapi-generator.tech |
| 21 | + * OpenAPI Generator version: 5.0.0 |
| 22 | + */ |
| 23 | + |
| 24 | +/** |
| 25 | + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). |
| 26 | + * https://openapi-generator.tech |
| 27 | + * Do not edit the class manually. |
| 28 | + */ |
| 29 | + |
| 30 | +namespace Shotstack\Client\Model; |
| 31 | + |
| 32 | +use \ArrayAccess; |
| 33 | +use \Shotstack\Client\ObjectSerializer; |
| 34 | + |
| 35 | +/** |
| 36 | + * AssetRenderResponse Class Doc Comment |
| 37 | + * |
| 38 | + * @category Class |
| 39 | + * @description The response returned by the Serve API [get asset by render id](#get-asset-by-render-id) request. The response is an array of asset resources, including video, image, audio, thumbnail and poster image. The response follows the [json:api](https://jsonapi.org/) specification. |
| 40 | + * @package Shotstack\Client |
| 41 | + * @author OpenAPI Generator team |
| 42 | + * @link https://openapi-generator.tech |
| 43 | + * @implements \ArrayAccess<TKey, TValue> |
| 44 | + * @template TKey int|null |
| 45 | + * @template TValue mixed|null |
| 46 | + */ |
| 47 | +class AssetRenderResponse implements ModelInterface, ArrayAccess, \JsonSerializable |
| 48 | +{ |
| 49 | + public const DISCRIMINATOR = null; |
| 50 | + |
| 51 | + /** |
| 52 | + * The original name of the model. |
| 53 | + * |
| 54 | + * @var string |
| 55 | + */ |
| 56 | + protected static $openAPIModelName = 'AssetRenderResponse'; |
| 57 | + |
| 58 | + /** |
| 59 | + * Array of property to type mappings. Used for (de)serialization |
| 60 | + * |
| 61 | + * @var string[] |
| 62 | + */ |
| 63 | + protected static $openAPITypes = [ |
| 64 | + 'data' => '\Shotstack\Client\Model\AssetResponseData[]' |
| 65 | + ]; |
| 66 | + |
| 67 | + /** |
| 68 | + * Array of property to format mappings. Used for (de)serialization |
| 69 | + * |
| 70 | + * @var string[] |
| 71 | + * @phpstan-var array<string, string|null> |
| 72 | + * @psalm-var array<string, string|null> |
| 73 | + */ |
| 74 | + protected static $openAPIFormats = [ |
| 75 | + 'data' => null |
| 76 | + ]; |
| 77 | + |
| 78 | + /** |
| 79 | + * Array of property to type mappings. Used for (de)serialization |
| 80 | + * |
| 81 | + * @return array |
| 82 | + */ |
| 83 | + public static function openAPITypes() |
| 84 | + { |
| 85 | + return self::$openAPITypes; |
| 86 | + } |
| 87 | + |
| 88 | + /** |
| 89 | + * Array of property to format mappings. Used for (de)serialization |
| 90 | + * |
| 91 | + * @return array |
| 92 | + */ |
| 93 | + public static function openAPIFormats() |
| 94 | + { |
| 95 | + return self::$openAPIFormats; |
| 96 | + } |
| 97 | + |
| 98 | + /** |
| 99 | + * Array of attributes where the key is the local name, |
| 100 | + * and the value is the original name |
| 101 | + * |
| 102 | + * @var string[] |
| 103 | + */ |
| 104 | + protected static $attributeMap = [ |
| 105 | + 'data' => 'data' |
| 106 | + ]; |
| 107 | + |
| 108 | + /** |
| 109 | + * Array of attributes to setter functions (for deserialization of responses) |
| 110 | + * |
| 111 | + * @var string[] |
| 112 | + */ |
| 113 | + protected static $setters = [ |
| 114 | + 'data' => 'setData' |
| 115 | + ]; |
| 116 | + |
| 117 | + /** |
| 118 | + * Array of attributes to getter functions (for serialization of requests) |
| 119 | + * |
| 120 | + * @var string[] |
| 121 | + */ |
| 122 | + protected static $getters = [ |
| 123 | + 'data' => 'getData' |
| 124 | + ]; |
| 125 | + |
| 126 | + /** |
| 127 | + * Array of attributes where the key is the local name, |
| 128 | + * and the value is the original name |
| 129 | + * |
| 130 | + * @return array |
| 131 | + */ |
| 132 | + public static function attributeMap() |
| 133 | + { |
| 134 | + return self::$attributeMap; |
| 135 | + } |
| 136 | + |
| 137 | + /** |
| 138 | + * Array of attributes to setter functions (for deserialization of responses) |
| 139 | + * |
| 140 | + * @return array |
| 141 | + */ |
| 142 | + public static function setters() |
| 143 | + { |
| 144 | + return self::$setters; |
| 145 | + } |
| 146 | + |
| 147 | + /** |
| 148 | + * Array of attributes to getter functions (for serialization of requests) |
| 149 | + * |
| 150 | + * @return array |
| 151 | + */ |
| 152 | + public static function getters() |
| 153 | + { |
| 154 | + return self::$getters; |
| 155 | + } |
| 156 | + |
| 157 | + /** |
| 158 | + * The original name of the model. |
| 159 | + * |
| 160 | + * @return string |
| 161 | + */ |
| 162 | + public function getModelName() |
| 163 | + { |
| 164 | + return self::$openAPIModelName; |
| 165 | + } |
| 166 | + |
| 167 | + |
| 168 | + |
| 169 | + |
| 170 | + |
| 171 | + /** |
| 172 | + * Associative array for storing property values |
| 173 | + * |
| 174 | + * @var mixed[] |
| 175 | + */ |
| 176 | + protected $container = []; |
| 177 | + |
| 178 | + /** |
| 179 | + * Constructor |
| 180 | + * |
| 181 | + * @param mixed[] $data Associated array of property values |
| 182 | + * initializing the model |
| 183 | + */ |
| 184 | + public function __construct(array $data = null) |
| 185 | + { |
| 186 | + $this->container['data'] = $data['data'] ?? null; |
| 187 | + } |
| 188 | + |
| 189 | + /** |
| 190 | + * Show all the invalid properties with reasons. |
| 191 | + * |
| 192 | + * @return array invalid properties with reasons |
| 193 | + */ |
| 194 | + public function listInvalidProperties() |
| 195 | + { |
| 196 | + $invalidProperties = []; |
| 197 | + |
| 198 | + return $invalidProperties; |
| 199 | + } |
| 200 | + |
| 201 | + /** |
| 202 | + * Validate all the properties in the model |
| 203 | + * return true if all passed |
| 204 | + * |
| 205 | + * @return bool True if all properties are valid |
| 206 | + */ |
| 207 | + public function valid() |
| 208 | + { |
| 209 | + return count($this->listInvalidProperties()) === 0; |
| 210 | + } |
| 211 | + |
| 212 | + |
| 213 | + /** |
| 214 | + * Gets data |
| 215 | + * |
| 216 | + * @return \Shotstack\Client\Model\AssetResponseData[]|null |
| 217 | + */ |
| 218 | + public function getData() |
| 219 | + { |
| 220 | + return $this->container['data']; |
| 221 | + } |
| 222 | + |
| 223 | + /** |
| 224 | + * Sets data |
| 225 | + * |
| 226 | + * @param \Shotstack\Client\Model\AssetResponseData[]|null $data An array of asset resources grouped by render id. |
| 227 | + * |
| 228 | + * @return self |
| 229 | + */ |
| 230 | + public function setData($data) |
| 231 | + { |
| 232 | + $this->container['data'] = $data; |
| 233 | + |
| 234 | + return $this; |
| 235 | + } |
| 236 | + /** |
| 237 | + * Returns true if offset exists. False otherwise. |
| 238 | + * |
| 239 | + * @param integer $offset Offset |
| 240 | + * |
| 241 | + * @return boolean |
| 242 | + */ |
| 243 | + public function offsetExists($offset) |
| 244 | + { |
| 245 | + return isset($this->container[$offset]); |
| 246 | + } |
| 247 | + |
| 248 | + /** |
| 249 | + * Gets offset. |
| 250 | + * |
| 251 | + * @param integer $offset Offset |
| 252 | + * |
| 253 | + * @return mixed|null |
| 254 | + */ |
| 255 | + public function offsetGet($offset) |
| 256 | + { |
| 257 | + return $this->container[$offset] ?? null; |
| 258 | + } |
| 259 | + |
| 260 | + /** |
| 261 | + * Sets value based on offset. |
| 262 | + * |
| 263 | + * @param int|null $offset Offset |
| 264 | + * @param mixed $value Value to be set |
| 265 | + * |
| 266 | + * @return void |
| 267 | + */ |
| 268 | + public function offsetSet($offset, $value) |
| 269 | + { |
| 270 | + if (is_null($offset)) { |
| 271 | + $this->container[] = $value; |
| 272 | + } else { |
| 273 | + $this->container[$offset] = $value; |
| 274 | + } |
| 275 | + } |
| 276 | + |
| 277 | + /** |
| 278 | + * Unsets offset. |
| 279 | + * |
| 280 | + * @param integer $offset Offset |
| 281 | + * |
| 282 | + * @return void |
| 283 | + */ |
| 284 | + public function offsetUnset($offset) |
| 285 | + { |
| 286 | + unset($this->container[$offset]); |
| 287 | + } |
| 288 | + |
| 289 | + /** |
| 290 | + * Serializes the object to a value that can be serialized natively by json_encode(). |
| 291 | + * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php |
| 292 | + * |
| 293 | + * @return mixed Returns data which can be serialized by json_encode(), which is a value |
| 294 | + * of any type other than a resource. |
| 295 | + */ |
| 296 | + public function jsonSerialize() |
| 297 | + { |
| 298 | + return ObjectSerializer::sanitizeForSerialization($this); |
| 299 | + } |
| 300 | + |
| 301 | + /** |
| 302 | + * Gets the string presentation of the object |
| 303 | + * |
| 304 | + * @return string |
| 305 | + */ |
| 306 | + public function __toString() |
| 307 | + { |
| 308 | + return json_encode( |
| 309 | + ObjectSerializer::sanitizeForSerialization($this), |
| 310 | + JSON_PRETTY_PRINT |
| 311 | + ); |
| 312 | + } |
| 313 | + |
| 314 | + /** |
| 315 | + * Gets a header-safe presentation of the object |
| 316 | + * |
| 317 | + * @return string |
| 318 | + */ |
| 319 | + public function toHeaderValue() |
| 320 | + { |
| 321 | + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); |
| 322 | + } |
| 323 | +} |
| 324 | + |
| 325 | + |
0 commit comments