Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder Class Reference

Inheritance diagram for Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder:

Public Member Functions
	getId ()
	getVersion ()
	getCreatedAt ()
	getLastModifiedAt ()
	getLastModifiedBy ()
	getCreatedBy ()
	getSequenceNumber ()
	getResource ()
	getResourceVersion ()
	getResourceUserProvidedIdentifiers ()
	getStatus ()
	getOrder ()
	withId (?string $id)
	withVersion (?int $version)
	withCreatedAt (?DateTimeImmutable $createdAt)
	withLastModifiedAt (?DateTimeImmutable $lastModifiedAt)
	withLastModifiedBy (?LastModifiedBy $lastModifiedBy)
	withCreatedBy (?CreatedBy $createdBy)
	withSequenceNumber (?int $sequenceNumber)
	withResource (?Reference $resource)
	withResourceVersion (?int $resourceVersion)
	withResourceUserProvidedIdentifiers (?UserProvidedIdentifiers $resourceUserProvidedIdentifiers)
	withStatus (?string $status)
	withOrder (?OrderReference $order)
	withLastModifiedByBuilder (?LastModifiedByBuilder $lastModifiedBy)
	withCreatedByBuilder (?CreatedByBuilder $createdBy)
	withResourceBuilder (?ReferenceBuilder $resource)
	withResourceUserProvidedIdentifiersBuilder (?UserProvidedIdentifiersBuilder $resourceUserProvidedIdentifiers)
	withOrderBuilder (?OrderReferenceBuilder $order)
	build ()

Static Public Member Functions
static	of ()

Detailed Description

<ApprovalFlowCompletedMessage>

Definition at line 30 of file ApprovalFlowCompletedMessageBuilder.php.

Member Function Documentation

build()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::build

(

)

@psalm-return T

Implements Commercetools\Base\Builder.

Definition at line 424 of file ApprovalFlowCompletedMessageBuilder.php.

getCreatedAt()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::getCreatedAt

(

)

Date and time (UTC) the Message was generated.

Returns

null|DateTimeImmutable

Definition at line 132 of file ApprovalFlowCompletedMessageBuilder.php.

getCreatedBy()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::getCreatedBy

(

)

IDs and references that created the Message.

Returns

null|CreatedBy

Definition at line 165 of file ApprovalFlowCompletedMessageBuilder.php.

getId()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::getId

(

)

Unique identifier of the Message. Can be used to track which Messages have been processed.

Returns

null|string

Definition at line 110 of file ApprovalFlowCompletedMessageBuilder.php.

getLastModifiedAt()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::getLastModifiedAt

(

)

Value of createdAt.

Returns

null|DateTimeImmutable

Definition at line 143 of file ApprovalFlowCompletedMessageBuilder.php.

getLastModifiedBy()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::getLastModifiedBy

(

)

IDs and references that last modified the Message.

Returns

null|LastModifiedBy

Definition at line 154 of file ApprovalFlowCompletedMessageBuilder.php.

getOrder()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::getOrder

(

)

Reference to the Order related to the completed Approval Flow.

Returns

null|OrderReference

Definition at line 232 of file ApprovalFlowCompletedMessageBuilder.php.

getResource()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::getResource

(

)

Reference to the resource on which the change or action was performed.

Returns

null|Reference

Definition at line 188 of file ApprovalFlowCompletedMessageBuilder.php.

getResourceUserProvidedIdentifiers()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::getResourceUserProvidedIdentifiers

(

)

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

Returns

null|UserProvidedIdentifiers

Definition at line 210 of file ApprovalFlowCompletedMessageBuilder.php.

getResourceVersion()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::getResourceVersion

(

)

Version of the resource on which the change or action was performed.

Returns

null|int

Definition at line 199 of file ApprovalFlowCompletedMessageBuilder.php.

getSequenceNumber()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::getSequenceNumber

(

)

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

Returns

null|int

Definition at line 177 of file ApprovalFlowCompletedMessageBuilder.php.

getStatus()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::getStatus

(

)

Final status of the Approval Flow.

Returns

null|string

Definition at line 221 of file ApprovalFlowCompletedMessageBuilder.php.

getVersion()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::getVersion

(

)

Version of a resource. In case of Messages, this is always 1.

Returns

null|int

Definition at line 121 of file ApprovalFlowCompletedMessageBuilder.php.

of()

static Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::of ( )

static

Definition at line 442 of file ApprovalFlowCompletedMessageBuilder.php.

withCreatedAt()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::withCreatedAt

(

?DateTimeImmutable

$createdAt

)

Parameters

?DateTimeImmutable

$createdAt

Returns

$this

Definition at line 263 of file ApprovalFlowCompletedMessageBuilder.php.

withCreatedBy()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::withCreatedBy

(

?CreatedBy

$createdBy

)

Parameters

?CreatedBy

$createdBy

Returns

$this

Definition at line 296 of file ApprovalFlowCompletedMessageBuilder.php.

withCreatedByBuilder()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::withCreatedByBuilder

(

?CreatedByBuilder

$createdBy

)

Deprecated:

use withCreatedBy() instead

Returns

$this

Definition at line 384 of file ApprovalFlowCompletedMessageBuilder.php.

withId()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::withId

(

?string

$id

)

Parameters

?string

$id

Returns

$this

Definition at line 241 of file ApprovalFlowCompletedMessageBuilder.php.

withLastModifiedAt()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::withLastModifiedAt

(

?DateTimeImmutable

$lastModifiedAt

)

Parameters

?DateTimeImmutable

$lastModifiedAt

Returns

$this

Definition at line 274 of file ApprovalFlowCompletedMessageBuilder.php.

withLastModifiedBy()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::withLastModifiedBy

(

?LastModifiedBy

$lastModifiedBy

)

Parameters

?LastModifiedBy

$lastModifiedBy

Returns

$this

Definition at line 285 of file ApprovalFlowCompletedMessageBuilder.php.

withLastModifiedByBuilder()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::withLastModifiedByBuilder

(

?LastModifiedByBuilder

$lastModifiedBy

)

Deprecated:

use withLastModifiedBy() instead

Returns

$this

Definition at line 373 of file ApprovalFlowCompletedMessageBuilder.php.

withOrder()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::withOrder

(

?OrderReference

$order

)

Parameters

?OrderReference

$order

Returns

$this

Definition at line 362 of file ApprovalFlowCompletedMessageBuilder.php.

withOrderBuilder()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::withOrderBuilder

(

?OrderReferenceBuilder

$order

)

Deprecated:

use withOrder() instead

Returns

$this

Definition at line 417 of file ApprovalFlowCompletedMessageBuilder.php.

withResource()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::withResource

(

?Reference

$resource

)

Parameters

?Reference

$resource

Returns

$this

Definition at line 318 of file ApprovalFlowCompletedMessageBuilder.php.

withResourceBuilder()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::withResourceBuilder

(

?ReferenceBuilder

$resource

)

Deprecated:

use withResource() instead

Returns

$this

Definition at line 395 of file ApprovalFlowCompletedMessageBuilder.php.

withResourceUserProvidedIdentifiers()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::withResourceUserProvidedIdentifiers

(

?UserProvidedIdentifiers

$resourceUserProvidedIdentifiers

)

Parameters

?UserProvidedIdentifiers

$resourceUserProvidedIdentifiers

Returns

$this

Definition at line 340 of file ApprovalFlowCompletedMessageBuilder.php.

withResourceUserProvidedIdentifiersBuilder()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::withResourceUserProvidedIdentifiersBuilder

(

?UserProvidedIdentifiersBuilder

$resourceUserProvidedIdentifiers

)

Deprecated:

use withResourceUserProvidedIdentifiers() instead

Returns

$this

Definition at line 406 of file ApprovalFlowCompletedMessageBuilder.php.

withResourceVersion()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::withResourceVersion

(

?int

$resourceVersion

)

Parameters

?int	$resourceVersion

Returns

$this

Definition at line 329 of file ApprovalFlowCompletedMessageBuilder.php.

withSequenceNumber()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::withSequenceNumber

(

?int

$sequenceNumber

)

Parameters

?int	$sequenceNumber

Returns

$this

Definition at line 307 of file ApprovalFlowCompletedMessageBuilder.php.

withStatus()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::withStatus

(

?string

$status

)

Parameters

?string

$status

Returns

$this

Definition at line 351 of file ApprovalFlowCompletedMessageBuilder.php.

withVersion()

Commercetools\Api\Models\Message\ApprovalFlowCompletedMessageBuilder::withVersion

(

?int

$version

)

Parameters

?int

$version

Returns

$this

Definition at line 252 of file ApprovalFlowCompletedMessageBuilder.php.

---

The documentation for this class was generated from the following file:

• lib/commercetools-api/src/Models/Message/ApprovalFlowCompletedMessageBuilder.php