CTP SDK : File Core/Model/Subscription/SubscriptionDraft.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

<?php
/**
 * @author @jenschude <jens.schulze@commercetools.de>
 */

namespace Commercetools\Core\Model\Subscription;

use Commercetools\Core\Model\Common\Context;
use Commercetools\Core\Model\Common\JsonObject;
use Commercetools\Core\Model\Common\LocalizedString;
use Commercetools\Core\Model\CustomField\CustomFieldObjectDraft;
use Commercetools\Core\Model\Common\Address;

/**
 * @package Commercetools\Core\Model\Subscription
 * @link https://docs.commercetools.com/http-api-projects-subscriptions.html#subscriptiondraft
 * @method string getKey()
 * @method SubscriptionDraft setKey(string $key = null)
 * @method Destination getDestination()
 * @method SubscriptionDraft setDestination(Destination $destination = null)
 * @method MessageSubscriptionCollection getMessages()
 * @method SubscriptionDraft setMessages(MessageSubscriptionCollection $messages = null)
 * @method ChangeSubscriptionCollection getChanges()
 * @method SubscriptionDraft setChanges(ChangeSubscriptionCollection $changes = null)
 */
class SubscriptionDraft extends JsonObject
{
    public function fieldDefinitions()
    {
        return [
            'key' => [static::TYPE => 'string', static::OPTIONAL => true],
            'destination' => [static::TYPE => Destination::class],
            'messages' => [static::TYPE => MessageSubscriptionCollection::class, static::OPTIONAL => true],
            'changes' => [static::TYPE => ChangeSubscriptionCollection::class, static::OPTIONAL => true],
        ];
    }

    /**
     * @param Destination $destination
     * @param MessageSubscriptionCollection $messages
     * @param Context|callable $context
     * @return SubscriptionDraft
     */
    public static function ofDestinationAndMessages(
        Destination $destination,
        MessageSubscriptionCollection $messages,
        $context = null
    ) {
        return static::of($context)->setDestination($destination)->setMessages($messages);
    }

    /**
     * @param Destination $destination
     * @param ChangeSubscriptionCollection $changes
     * @param Context|callable $context
     * @return SubscriptionDraft
     */
    public static function ofDestinationAndChanges(
        Destination $destination,
        ChangeSubscriptionCollection $changes,
        $context = null
    ) {
        return static::of($context)->setDestination($destination)->setChanges($changes);
    }

    /**
     * @param string $key
     * @param Destination $destination
     * @param MessageSubscriptionCollection $messages
     * @param Context|callable $context
     * @return SubscriptionDraft
     */
    public static function ofKeyDestinationAndMessages(
        $key,
        Destination $destination,
        MessageSubscriptionCollection $messages,
        $context = null
    ) {
        return static::of($context)->setKey($key)->setDestination($destination)->setMessages($messages);
    }
}

Namespaces

Classes