Sid Gifari File Manager
🏠 Root
/
home2
/
meumer25
/
meupet.app
/
wp-content
/
plugins
/
wpforms-lite
/
vendor_prefixed
/
square
/
square
/
src
/
Models
/
Editing: BatchUpsertCatalogObjectsRequest.php
<?php declare (strict_types=1); namespace WPForms\Vendor\Square\Models; use stdClass; class BatchUpsertCatalogObjectsRequest implements \JsonSerializable { /** * @var string */ private $idempotencyKey; /** * @var CatalogObjectBatch[] */ private $batches; /** * @param string $idempotencyKey * @param CatalogObjectBatch[] $batches */ public function __construct(string $idempotencyKey, array $batches) { $this->idempotencyKey = $idempotencyKey; $this->batches = $batches; } /** * Returns Idempotency Key. * A value you specify that uniquely identifies this * request among all your requests. A common way to create * a valid idempotency key is to use a Universally unique * identifier (UUID). * * If you're unsure whether a particular request was successful, * you can reattempt it with the same idempotency key without * worrying about creating duplicate objects. * * See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) * for more information. */ public function getIdempotencyKey() : string { return $this->idempotencyKey; } /** * Sets Idempotency Key. * A value you specify that uniquely identifies this * request among all your requests. A common way to create * a valid idempotency key is to use a Universally unique * identifier (UUID). * * If you're unsure whether a particular request was successful, * you can reattempt it with the same idempotency key without * worrying about creating duplicate objects. * * See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) * for more information. * * @required * @maps idempotency_key */ public function setIdempotencyKey(string $idempotencyKey) : void { $this->idempotencyKey = $idempotencyKey; } /** * Returns Batches. * A batch of CatalogObjects to be inserted/updated atomically. * The objects within a batch will be inserted in an all-or-nothing fashion, i.e., if an error occurs * attempting to insert or update an object within a batch, the entire batch will be rejected. However, * an error * in one batch will not affect other batches within the same request. * * For each object, its `updated_at` field is ignored and replaced with a current [timestamp](https: * //developer.squareup.com/docs/build-basics/working-with-dates), and its * `is_deleted` field must not be set to `true`. * * To modify an existing object, supply its ID. To create a new object, use an ID starting * with `#`. These IDs may be used to create relationships between an object and attributes of * other objects that reference it. For example, you can create a CatalogItem with * ID `#ABC` and a CatalogItemVariation with its `item_id` attribute set to * `#ABC` in order to associate the CatalogItemVariation with its parent * CatalogItem. * * Any `#`-prefixed IDs are valid only within a single atomic batch, and will be replaced by server- * generated IDs. * * Each batch may contain up to 1,000 objects. The total number of objects across all batches for a * single request * may not exceed 10,000. If either of these limits is violated, an error will be returned and no * objects will * be inserted or updated. * * @return CatalogObjectBatch[] */ public function getBatches() : array { return $this->batches; } /** * Sets Batches. * A batch of CatalogObjects to be inserted/updated atomically. * The objects within a batch will be inserted in an all-or-nothing fashion, i.e., if an error occurs * attempting to insert or update an object within a batch, the entire batch will be rejected. However, * an error * in one batch will not affect other batches within the same request. * * For each object, its `updated_at` field is ignored and replaced with a current [timestamp](https: * //developer.squareup.com/docs/build-basics/working-with-dates), and its * `is_deleted` field must not be set to `true`. * * To modify an existing object, supply its ID. To create a new object, use an ID starting * with `#`. These IDs may be used to create relationships between an object and attributes of * other objects that reference it. For example, you can create a CatalogItem with * ID `#ABC` and a CatalogItemVariation with its `item_id` attribute set to * `#ABC` in order to associate the CatalogItemVariation with its parent * CatalogItem. * * Any `#`-prefixed IDs are valid only within a single atomic batch, and will be replaced by server- * generated IDs. * * Each batch may contain up to 1,000 objects. The total number of objects across all batches for a * single request * may not exceed 10,000. If either of these limits is violated, an error will be returned and no * objects will * be inserted or updated. * * @required * @maps batches * * @param CatalogObjectBatch[] $batches */ public function setBatches(array $batches) : void { $this->batches = $batches; } /** * Encode this object to JSON * * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields * are set. (default: false) * * @return array|stdClass */ #[\ReturnTypeWillChange] public function jsonSerialize(bool $asArrayWhenEmpty = \false) { $json = []; $json['idempotency_key'] = $this->idempotencyKey; $json['batches'] = $this->batches; $json = \array_filter($json, function ($val) { return $val !== null; }); return !$asArrayWhenEmpty && empty($json) ? new stdClass() : $json; } }
Save
Cancel