ShippoClient\Http\Request\Shipments\CreateObject

Complexity

Total Complexity

20

Size/Duplication

Total Lines	260
Duplicated Lines	3.08 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	getObjectPurpose()	8	8	1
A	getAddressFrom()	0	4	1
A	getAddressTo()	0	4	1
A	getParcel()	0	4	1
A	getSubmissionType()	0	13	2
A	getReturnOf()	0	4	1
A	getSubmissionDate()	0	18	3
A	getAddressReturn()	0	4	1
A	getCustomsDeclaration()	0	4	1
A	getInsuranceAmount()	0	4	1
A	getInsuranceCurrency()	0	8	2
A	getExtra()	0	4	1
A	getReference1()	0	4	1
A	getReference2()	0	4	1
A	getCarrierAccounts()	0	4	1
A	toArray()	0	4	1

<?php

namespace ShippoClient\Http\Request\Shipments;

use ShippoClient\Http\Request\CommonParameter;
use TurmericSpice\Container\InvalidAttributeException;
use TurmericSpice\ReadWriteAttributes;

/**
 * The heart of the Shippo API, a Shipment is made up of "to" and "from" Address and the Parcel to be shipped.
 * Once created, a Shipment object can be used to retrieve shipping Rates and purchase a shipping Label.
 */
class CreateObject extends CommonParameter
{
    use ReadWriteAttributes {
        toArray as public __toArray;
    }

    const OBJECT_PURPOSE_QUOTE = 'QUOTE';
    const OBJECT_PURPOSE_PURCHASE = 'PURCHASE';
    const SUBMISSION_TYPE_DROPOFF = 'DROPOFF';
    const SUBMISSION_TYPE_PICKUP = 'PICKUP';

    /**
     * Quote Shipment can only be used to obtain quote Rates;
     * at the same time, they accept any valid or completed Address object.
     * Purchase Shipment can be used to obtain Rates and purchase Labels,
     * but only accept purchase Address that have been fully entered.
     *
     * Required
     *
     * @return string
     * @throws InvalidAttributeException
     */
    public function getObjectPurpose()

This method seems to be duplicated in your project.

    {
        $allowed = [static::OBJECT_PURPOSE_QUOTE, static::OBJECT_PURPOSE_PURCHASE];

        return $this->attributes->mustHave('object_purpose')->asString(function ($value) use ($allowed) {
            return in_array($value, $allowed, true);
        });
    }

    /**
     * ID of the Address object that should be used as sender Address.
     *
     * Required
     *
     * @return string
     * @throws InvalidAttributeException
     */
    public function getAddressFrom()
    {
        return $this->attributes->mustHave('address_from')->asString();
    }

    /**
     * ID of the Address object that should be used as recipient Address.
     *
     * Required
     *
     * @return string
     * @throws InvalidAttributeException
     */
    public function getAddressTo()
    {
        return $this->attributes->mustHave('address_to')->asString();
    }

    /**
     * ID of the Parcel object to be shipped.
     *
     * Required
     *
     * @return string
     * @throws InvalidAttributeException
     */
    public function getParcel()
    {
        return $this->attributes->mustHave('parcel')->asString();
    }

    /**
     * Indicates whether the parcel will be dropped off at a carrier location or will be picked up.
     * Selecting 'PICKUP' does not request a carrier pickup.
     * A pickup always needs to be requested separately.
     *
     * Optional, defaults to DROPOFF
     *
     * @return string
     * @throws InvalidAttributeException
     */
    public function getSubmissionType()
    {
        $allowed = [static::SUBMISSION_TYPE_DROPOFF, static::SUBMISSION_TYPE_PICKUP];

        $submission_type = $this->attributes->mayHave('submission_type');
        if ($submission_type->value() === null) {
            return static::SUBMISSION_TYPE_DROPOFF;
        }

        return $submission_type->asString(function ($value) use ($allowed) {
            return in_array($value, $allowed, true);
        });
    }

    /**
     * ID of the Transaction object of the outbound shipment.
     * This field triggers the creation of a scan-based return shipments.
     * See the Create a return shipment section for more details.
     *
     * Required for return labels
     *
     * @return string
     */
    public function getReturnOf()
    {
        return $this->attributes->mayHave('return_of')->asString();
    }

    /**
     * Desired pickup date. Must be in the format "2014-01-18T00:35:03.463Z" (ISO 8601 date).
     * Please note that for some carriers, not all pickup dates are available.
     * The API will return the corresponding error message if not available.
     * If no pickup_date is given, the value will default to tomorrow's date
     * (including Saturday or Sunday, which can lead to no carrier availability).
     *
     * Required if submission_type is 'PICKUP'. Defaults to current date (UTC) for 'DROPOFF'
     *
     * @return string
     * @throws InvalidAttributeException
     */
    public function getSubmissionDate()
    {
        $isIOS8601Format = function ($datetime) {
            // this pattern is not strict but is sufficient
            return preg_match('/^(\d{4}-\d{2}-\d{2}|\d{8})[t|T]\d{2}:\d{2}:\d{2}([,|\.]\d+[z|Z]|\+\d+)$/', $datetime);
        };

        $submission_date = $this->attributes->mayHave('submission_date');
        if ($submission_date->value() === null) {
            if ($this->getSubmissionType() !== static::SUBMISSION_TYPE_PICKUP) {
                return null;
            }

            return (new \DateTime('now', new \DateTimeZone('UTC')))->format(\DateTime::ISO8601);
        }

        return $submission_date->asString($isIOS8601Format);
    }

    /**
     * ID of the Address object where the shipment will be sent back to if it is not delivered
     * (Only available for UPS, USPS, and Fedex shipments).
     * If this field is not set, your shipments will be returned to the address_form.
     *
     * Optional
     *
     * @return string
     */
    public function getAddressReturn()
    {
        return $this->attributes->mayHave('address_return')->asString();
    }

    /**
     * ID of the Customs Declarations object for an international shipment.
     *
     * Optional
     *
     * @return string
     */
    public function getCustomsDeclaration()
    {
        return $this->attributes->mayHave('customs_declaration')->asString();
    }

    /**
     * Total Parcel value to be insured.
     * Please note that you need to specify the "insurance_currency" as well as the "insurance_content"
     * (via the extra field below, if your package content is not general cargo) as well.
     *
     * Optional
     *
     * @return float
     */
    public function getInsuranceAmount()
    {
        return $this->attributes->mayHave('insurance_amount')->asFloat();
    }

    /**
     * Currency used for insurance_amount.
     * The official ISO 4217 currency codes are used, e.g. "USD" or "EUR".
     *
     * Required if insurance_amount is set
     *
     * @return string
     * @throws InvalidAttributeException
     */
    public function getInsuranceCurrency()
    {
        if ($this->attributes->mayHave('insurance_amount')->value() === null) {
            return $this->attributes->mayHave('insurance_currency')->asString();
        }

        return $this->attributes->mustHave('insurance_currency')->asString();
    }

    /**
     * An array of extra services to be requested.
     * The following services are currently available. We are continuously adding new ones.
     *     - signature_confirmation (string, "standard" for standard signature confirmation, "adult" for adult signature)

This line exceeds maximum limit of 120 characters; contains 121 characters

     *     - insurance_content (string, specify package content for insurance)
     *     - saturday_delivery (boolean, marks shipment as to be delivered on a Saturday)
     *     - bypass_address_validation (boolean, bypassed address validation, if applicable)
     *     - use_manifests (boolean, shipment to be linked with a manifest (Canada Post only), if applicable)
     *     - saturday_delivery (boolean, marks shipment as to be delivered on a Saturday. Available for UPS and FedEx.)
     *     - bypass_address_validation (boolean, bypassed address validation. Available for USPS, FedEx and UPS.)
     *     - request_retail_rates (boolean, request retail/list rates. Available for FedEx.)
     *     - use_manifests (boolean, shipment to be linked with a manifest (Canada Post only), if applicable)
     *
     * Optional
     *
     * @return array
     */
    public function getExtra()
    {
        return $this->attributes->mayHave('extra')->asArray();
    }

    /**
     * Optional text to be printed on the shipping label.
     *
     * Optional
     *
     * @return string
     */
    public function getReference1()
    {
        return $this->attributes->mayHave('reference_1')->asString();
    }

    /**
     * Optional text to be printed on the shipping label.
     *
     * Optional
     *
     * @return string
     */
    public function getReference2()
    {
        return $this->attributes->mayHave('reference_2')->asString();
    }

    /**
     * An array of object_ids of the carrier account objects to be used for getting shipping rates for this shipment.
     * If no carrier account object_ids are set in this field,
     * Shippo will attempt to generate rates using all the carrier accounts that have the 'active' field set.
     *
     * @return string
     */
    public function getCarrierAccounts()
    {
        return $this->attributes->mayHave('carrier_accounts')->asArray();
    }

    public function toArray()
    {
        return array_filter($this->__toArray());
    }
}