CTP SDK : File Core/Builder/Request/SubscriptionRequestBuilder.php

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115

<?php
// phpcs:disable Generic.Files.LineLength
namespace Commercetools\Core\Builder\Request;

use Commercetools\Core\Request\Subscriptions\SubscriptionByIdGetRequest;
use Commercetools\Core\Request\Subscriptions\SubscriptionByKeyGetRequest;
use Commercetools\Core\Request\Subscriptions\SubscriptionCreateRequest;
use Commercetools\Core\Model\Subscription\SubscriptionDraft;
use Commercetools\Core\Request\Subscriptions\SubscriptionDeleteByKeyRequest;
use Commercetools\Core\Model\Subscription\Subscription;
use Commercetools\Core\Request\Subscriptions\SubscriptionDeleteRequest;
use Commercetools\Core\Request\Subscriptions\SubscriptionQueryRequest;
use Commercetools\Core\Request\Subscriptions\SubscriptionUpdateByKeyRequest;
use Commercetools\Core\Request\Subscriptions\SubscriptionUpdateRequest;

class SubscriptionRequestBuilder
{

    /**
     * @link https://docs.commercetools.com/http-api-projects-subscriptions.html#get-a-subscription-by-id
     * @param string $id
     * @return SubscriptionByIdGetRequest
     */
    public function getById($id)
    {
        $request = SubscriptionByIdGetRequest::ofId($id);
        return $request;
    }

    /**
     *
     * @param string $key
     * @return SubscriptionByKeyGetRequest
     */
    public function getByKey($key)
    {
        $request = SubscriptionByKeyGetRequest::ofKey($key);
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-subscriptions.html#create-a-subscription
     * @param SubscriptionDraft $subscription
     * @return SubscriptionCreateRequest
     */
    public function create(SubscriptionDraft $subscription)
    {
        $request = SubscriptionCreateRequest::ofDraft($subscription);
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-subscriptions.html#delete-subscription-by-key
     * @param Subscription $subscription
     * @return SubscriptionDeleteByKeyRequest
     */
    public function deleteByKey(Subscription $subscription)
    {
        $request = SubscriptionDeleteByKeyRequest::ofKeyAndVersion($subscription->getKey(), $subscription->getVersion());
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-subscriptions.html#delete-subscription
     * @param Subscription $subscription
     * @return SubscriptionDeleteRequest
     */
    public function delete(Subscription $subscription)
    {
        $request = SubscriptionDeleteRequest::ofIdAndVersion($subscription->getId(), $subscription->getVersion());
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-subscriptions.html#query-subscriptions
     *
     * @return SubscriptionQueryRequest
     */
    public function query()
    {
        $request = SubscriptionQueryRequest::of();
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-subscriptions.html#update-subscription-by-key
     * @param Subscription $subscription
     * @return SubscriptionUpdateByKeyRequest
     */
    public function updateByKey(Subscription $subscription)
    {
        $request = SubscriptionUpdateByKeyRequest::ofKeyAndVersion($subscription->getKey(), $subscription->getVersion());
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-subscriptions.html#update-subscription
     * @param Subscription $subscription
     * @return SubscriptionUpdateRequest
     */
    public function update(Subscription $subscription)
    {
        $request = SubscriptionUpdateRequest::ofIdAndVersion($subscription->getId(), $subscription->getVersion());
        return $request;
    }

    /**
     * @return SubscriptionRequestBuilder
     */
    public function of()
    {
        return new self();
    }
}

Namespaces

Classes