io.sphere.sdk.orders.Delivery Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of commercetools-models Show documentation

There is a newer version: 2.16.0

package io.sphere.sdk.orders;

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import io.sphere.sdk.annotations.HasUpdateAction;
import io.sphere.sdk.annotations.PropertySpec;
import io.sphere.sdk.annotations.ResourceValue;
import io.sphere.sdk.models.Address;
import io.sphere.sdk.models.CreationTimestamped;
import io.sphere.sdk.models.Identifiable;
import io.sphere.sdk.types.CustomFields;

import javax.annotation.Nullable;
import java.time.ZonedDateTime;
import java.util.List;

/**
 * Deliveries are compilations of information on how the articles are being shipped to the customers. A delivery can contain multiple items. All items in a delivery can be shipped with several parcels. To create a delivery, it is necessary to have a shipment method assigned to the order. A sample use case for a delivery object is to create a delivery note.
 *
 * @see io.sphere.sdk.orders.commands.updateactions.AddDelivery
 * @see io.sphere.sdk.orders.messages.DeliveryAddedMessage
 */
@JsonDeserialize(as = DeliveryImpl.class)
@ResourceValue
public interface Delivery extends Identifiable, CreationTimestamped {
    @Override
    String getId();

    @Override
    ZonedDateTime getCreatedAt();

    @HasUpdateAction(value = "setDeliveryItems", fields = {
            @PropertySpec(name = "deliveryId", type = String.class),
            @PropertySpec(name = "items", type = DeliveryItem[].class),
    })
    List getItems();

    @HasUpdateAction(value = "removeParcelFromDelivery", fields = {
            @PropertySpec(name = "parcelId", type = String.class)
    })
    List getParcels();

    @Nullable
    Address getAddress();

    @Nullable
    CustomFields getCustom();

    static Delivery of(final String id, final ZonedDateTime createdAt, final List items, final List parcels) {
        return new DeliveryImpl(null, createdAt, null, id, items, parcels);
    }
}