Composable Commerce PHP SDKPHP SDK
  • Namespace
  • Class
  • Tree

Namespaces

  • Commercetools
    • Commons
      • Helper
    • Core
      • Builder
        • Request
        • Update
      • Cache
      • Client
        • Adapter
        • OAuth
      • Error
      • Helper
        • Annotate
        • State
          • Renderer
        • Subscriber
          • Log
      • Model
        • ApiClient
        • Cart
        • CartDiscount
        • Category
        • Channel
        • Common
        • Customer
        • CustomerGroup
        • CustomField
        • CustomObject
        • DiscountCode
        • Extension
        • Inventory
        • Message
        • Order
        • OrderEdit
        • Payment
        • Product
          • Search
        • ProductDiscount
        • ProductSelection
        • ProductType
        • Project
        • Review
        • ShippingMethod
        • ShoppingList
        • State
        • Store
        • Subscription
        • TaxCategory
        • Type
        • Zone
      • Request
        • ApiClients
        • CartDiscounts
          • Command
        • Carts
          • Command
        • Categories
          • Command
        • Channels
          • Command
        • CustomerGroups
          • Command
        • Customers
          • Command
        • CustomField
          • Command
        • CustomObjects
        • DiscountCodes
          • Command
        • Extensions
          • Command
        • GraphQL
        • InStores
        • Inventory
          • Command
        • Me
          • Command
        • Messages
        • OrderEdits
          • Command
          • StagedOrder
            • Command
        • Orders
          • Command
        • Payments
          • Command
        • ProductDiscounts
          • Command
        • Products
          • Command
        • ProductSelections
          • Command
        • ProductTypes
          • Command
        • Project
          • Command
        • Query
        • Reviews
          • Command
        • ShippingMethods
          • Command
        • ShoppingLists
          • Command
        • States
          • Command
        • Stores
          • Command
        • Subscriptions
          • Command
        • TaxCategories
          • Command
        • Types
          • Command
        • Zones
          • Command
      • Response

Classes

  • AzureEventGridDestination
  • AzureServiceBusDestination
  • ChangeSubscription
  • ChangeSubscriptionCollection
  • Delivery
  • Destination
  • GoogleCloudPubSubDestination
  • IronMQDestination
  • MessageDelivery
  • MessageSubscription
  • MessageSubscriptionCollection
  • PayloadNotIncluded
  • ResourceCreatedDelivery
  • ResourceDeletedDelivery
  • ResourceUpdatedDelivery
  • SNSDestination
  • SQSDestination
  • Subscription
  • SubscriptionCollection
  • SubscriptionDraft
  • SubscriptionReference

Class Subscription

Commercetools\Core\Model\Common\AbstractJsonDeserializeObject implements Commercetools\Core\Model\Common\JsonDeserializeInterface, Commercetools\Core\Model\Common\ObjectTreeInterface uses Commercetools\Core\Model\Common\ObjectTreeTrait
Extended by Commercetools\Core\Model\Common\JsonObject implements JsonSerializable uses Commercetools\Core\Model\Common\ContextTrait
Extended by Commercetools\Core\Model\Common\Resource implements Commercetools\Core\Model\Common\ReferenceObjectInterface
Extended by Commercetools\Core\Model\Subscription\Subscription
Namespace: Commercetools\Core\Model\Subscription
API documentation: https://docs.commercetools.com/http-api-projects-subscriptions.html#subscription
Located at Core/Model/Subscription/Subscription.php

Methods summary

Methods inherited from Commercetools\Core\Model\Common\Resource

getReference(), getReferenceIdentifier()

Methods inherited from Commercetools\Core\Model\Common\JsonObject

__construct(), __get(), hasField(), isOptional()

Methods inherited from Commercetools\Core\Model\Common\AbstractJsonDeserializeObject

__sleep(), fromArray(), jsonSerialize(), of(), toArray()

Methods inherited from Commercetools\Core\Model\Common\ObjectTreeInterface

parentSet(), rootGet(), rootSet()

Methods inherited from Commercetools\Core\Model\Common\ContextAwareInterface

getContext(), getContextCallback(), setContext(), setContextIfNull()

Methods used from Commercetools\Core\Model\Common\ContextTrait

getContext(), getContextCallback(), setContext(), setContextIfNull()

Methods used from Commercetools\Core\Model\Common\ObjectTreeTrait

parentSet(), rootGet(), rootSet()

Magic methods summary

public string
# getId( )

Returns

string
public Commercetools\Core\Model\Subscription\Subscription
# setId( string $id = null )

Parameters

$id

Returns

Commercetools\Core\Model\Subscription\Subscription
public integer
# getVersion( )

Returns

integer
public Commercetools\Core\Model\Subscription\Subscription
# setVersion( integer $version = null )

Parameters

$version

Returns

Commercetools\Core\Model\Subscription\Subscription
public Commercetools\Core\Model\Common\DateTimeDecorator
# getCreatedAt( )

Returns

Commercetools\Core\Model\Common\DateTimeDecorator
public Commercetools\Core\Model\Subscription\Subscription
# setCreatedAt( DateTime $createdAt = null )

Parameters

$createdAt

Returns

Commercetools\Core\Model\Subscription\Subscription
public Commercetools\Core\Model\Common\DateTimeDecorator
# getLastModifiedAt( )

Returns

Commercetools\Core\Model\Common\DateTimeDecorator
public Commercetools\Core\Model\Subscription\Subscription
# setLastModifiedAt( DateTime $lastModifiedAt = null )

Parameters

$lastModifiedAt

Returns

Commercetools\Core\Model\Subscription\Subscription
public string
# getKey( )

Returns

string
public Commercetools\Core\Model\Subscription\Subscription
# setKey( string $key = null )

Parameters

$key

Returns

Commercetools\Core\Model\Subscription\Subscription
public Commercetools\Core\Model\Subscription\Destination
# getDestination( )

Returns

Commercetools\Core\Model\Subscription\Destination
public Commercetools\Core\Model\Subscription\Subscription
# setDestination( Commercetools\Core\Model\Subscription\Destination $destination = null )

Parameters

$destination

Returns

Commercetools\Core\Model\Subscription\Subscription
public Commercetools\Core\Model\Subscription\MessageSubscriptionCollection
# getMessages( )

Returns

Commercetools\Core\Model\Subscription\MessageSubscriptionCollection
public Commercetools\Core\Model\Subscription\Subscription
# setMessages( Commercetools\Core\Model\Subscription\MessageSubscriptionCollection $messages = null )

Parameters

$messages

Returns

Commercetools\Core\Model\Subscription\Subscription
public Commercetools\Core\Model\Subscription\ChangeSubscriptionCollection
# getChanges( )

Returns

Commercetools\Core\Model\Subscription\ChangeSubscriptionCollection
public Commercetools\Core\Model\Subscription\Subscription
# setChanges( Commercetools\Core\Model\Subscription\ChangeSubscriptionCollection $changes = null )

Parameters

$changes

Returns

Commercetools\Core\Model\Subscription\Subscription
public string
# getStatus( )

Returns

string
public Commercetools\Core\Model\Subscription\Subscription
# setStatus( string $status = null )

Parameters

$status

Returns

Commercetools\Core\Model\Subscription\Subscription
public Commercetools\Core\Model\Common\CreatedBy
# getCreatedBy( )

Returns

Commercetools\Core\Model\Common\CreatedBy
public Commercetools\Core\Model\Subscription\Subscription
# setCreatedBy( Commercetools\Core\Model\Common\CreatedBy $createdBy = null )

Parameters

$createdBy

Returns

Commercetools\Core\Model\Subscription\Subscription
public Commercetools\Core\Model\Common\LastModifiedBy
# getLastModifiedBy( )

Returns

Commercetools\Core\Model\Common\LastModifiedBy
public Commercetools\Core\Model\Subscription\Subscription
# setLastModifiedBy( Commercetools\Core\Model\Common\LastModifiedBy $lastModifiedBy = null )

Parameters

$lastModifiedBy

Returns

Commercetools\Core\Model\Subscription\Subscription
public Commercetools\Core\Model\Subscription\SubscriptionReference
# getReference( )

Returns

Commercetools\Core\Model\Subscription\SubscriptionReference

Overrides

Commercetools\Core\Model\Common\Resource::getReference

Constants summary

string STATUS_HEALTHY
# 'Healthy'
string STATUS_CONFIGURATION_ERROR
# 'ConfigurationError'
string STATUS_CONFIGURATION_ERROR_DELIVERY_STOPPED
# 'ConfigurationErrorDeliveryStopped'
string STATUS_TEMPORARY_ERROR
# 'TemporaryError'

Constants inherited from Commercetools\Core\Model\Common\JsonObject

DECORATOR, ELEMENT_TYPE, INITIALIZED, OPTIONAL, TYPE

Constants inherited from Commercetools\Core\Model\Common\AbstractJsonDeserializeObject

JSON_DESERIALIZE_INTERFACE, TYPEABLE_INTERFACE

PHP SDK API documentation generated by ApiGen