ProductVariantService.php

<?php

namespace Jeppos\ShopifySDK\Service;

use Jeppos\ShopifySDK\Model\ProductVariant;

/**
 * A ProductVariant is a different version of a product, such as differing sizes or differing colors.
 *
 * Without product variants, you would have to treat the small, medium and large versions of a t-shirt as
 * three separate products; product variants let you treat the small, medium and large versions of a
 * t-shirt as variations of the same product.
 *
 * Each product can have a maximum of 100 variants.
 *
 * @see https://help.shopify.com/api/reference/product_variant
 */
class ProductVariantService extends AbstractService
{
    /**
     * Receive a single Product Variant
     *
     * @see https://help.shopify.com/api/reference/product_variant#show
     * @param int $variantId
     * @return ProductVariant
     */
    public function getOne(int $variantId): ProductVariant
    {
        $response = $this->client->get(sprintf('variants/%d.json', $variantId));

        return $this->serializer->deserialize($response, ProductVariant::class);
    }

    /**
     * Receive a list of all Product Variants
     *
     * @see https://help.shopify.com/api/reference/product_variant#index
     * @param int $productId
     * @param array $options
     * @return array
     */
    public function getList(int $productId, array $options = []): array
    {
        $response = $this->client->get(sprintf('products/%d/variants.json', $productId), $options);

        return $this->serializer->deserializeList($response, ProductVariant::class);
    }

    /**
     * Receive a count of all Product Variants
     *
     * @see https://help.shopify.com/api/reference/product_variant#count
     * @param int $productId
     * @param array $options
     * @return int
     */
    public function getCount(int $productId, array $options = []): int
    {
        return $this->client->get(sprintf('products/%d/variants/count.json', $productId), $options);
    }

    /**
     * Create a new Product Variant
     *
     * @see https://help.shopify.com/api/reference/product_variant#create
     * @param ProductVariant $productVariant
     * @return ProductVariant
     */
    public function createOne(ProductVariant $productVariant): ProductVariant
    {
        $response = $this->client->post(
            sprintf('products/%d/variants.json', $productVariant->getProductId()),
            $this->serializer->serialize($productVariant, 'variant', ['post'])
        );

        return $this->serializer->deserialize($response, ProductVariant::class);
    }

    /**
     * Modify an existing Product Variant
     *
     * @see https://help.shopify.com/api/reference/product_variant#update
     * @param ProductVariant $productVariant
     * @return ProductVariant
     */
    public function updateOne(ProductVariant $productVariant): ProductVariant
    {
        $response = $this->client->put(
            sprintf('variants/%d.json', $productVariant->getId()),
            $this->serializer->serialize($productVariant, 'variant', ['put'])
        );

        return $this->serializer->deserialize($response, ProductVariant::class);
    }

    /**
     * Remove a Product Variant from the database
     *
     * @see https://help.shopify.com/api/reference/product_variant#destroy
     * @param int $productId
     * @param int $variantId
     * @return bool
     */
    public function deleteOne(int $productId, int $variantId): bool
    {
        return $this->client->delete(sprintf('products/%d/variants/%s.json', $productId, $variantId));
    }
}