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

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

namespace Commercetools\Core\Model\Subscription;

use Commercetools\Core\Model\Common\CreatedBy;
use Commercetools\Core\Model\Common\LastModifiedBy;
use Commercetools\Core\Model\Common\Resource;
use Commercetools\Core\Model\Common\LocalizedString;
use Commercetools\Core\Model\Common\DateTimeDecorator;
use Commercetools\Core\Model\CustomField\CustomFieldObject;
use Commercetools\Core\Model\Review\ReviewRatingStatistics;
use Commercetools\Core\Model\Common\Address;
use DateTime;

/**
 * @package Commercetools\Core\Model\Subscription
 * @link https://docs.commercetools.com/http-api-projects-subscriptions.html#subscription
 * @method string getId()
 * @method Subscription setId(string $id = null)
 * @method int getVersion()
 * @method Subscription setVersion(int $version = null)
 * @method DateTimeDecorator getCreatedAt()
 * @method Subscription setCreatedAt(DateTime $createdAt = null)
 * @method DateTimeDecorator getLastModifiedAt()
 * @method Subscription setLastModifiedAt(DateTime $lastModifiedAt = null)
 * @method string getKey()
 * @method Subscription setKey(string $key = null)
 * @method Destination getDestination()
 * @method Subscription setDestination(Destination $destination = null)
 * @method MessageSubscriptionCollection getMessages()
 * @method Subscription setMessages(MessageSubscriptionCollection $messages = null)
 * @method ChangeSubscriptionCollection getChanges()
 * @method Subscription setChanges(ChangeSubscriptionCollection $changes = null)
 * @method string getStatus()
 * @method Subscription setStatus(string $status = null)
 * @method CreatedBy getCreatedBy()
 * @method Subscription setCreatedBy(CreatedBy $createdBy = null)
 * @method LastModifiedBy getLastModifiedBy()
 * @method Subscription setLastModifiedBy(LastModifiedBy $lastModifiedBy = null)
 * @method SubscriptionReference getReference()
 */
class Subscription extends Resource
{
    const STATUS_HEALTHY = 'Healthy';
    const STATUS_CONFIGURATION_ERROR = 'ConfigurationError';
    const STATUS_CONFIGURATION_ERROR_DELIVERY_STOPPED = 'ConfigurationErrorDeliveryStopped';
    const STATUS_TEMPORARY_ERROR = 'TemporaryError';

    public function fieldDefinitions()
    {
        return [
            'id' => [static::TYPE => 'string'],
            'version' => [static::TYPE => 'int'],
            'createdAt' => [
                static::TYPE => DateTime::class,
                static::DECORATOR => DateTimeDecorator::class
            ],
            'lastModifiedAt' => [
                static::TYPE => DateTime::class,
                static::DECORATOR => DateTimeDecorator::class
            ],
            'key' => [static::TYPE => 'string', static::OPTIONAL => true],
            'destination' => [static::TYPE => Destination::class],
            'messages' => [static::TYPE => MessageSubscriptionCollection::class],
            'changes' => [static::TYPE => ChangeSubscriptionCollection::class],
            'status' => [static::TYPE => 'string'],
            'createdBy' => [static::TYPE => CreatedBy::class, static::OPTIONAL => true],
            'lastModifiedBy' => [static::TYPE => LastModifiedBy::class, static::OPTIONAL => true],
        ];
    }
}

Namespaces

Classes