FileMaster

Edit File: Card.php

<?php

declare(strict_types=1);

namespace Square\Models;

use stdClass;

/**
 * Represents the payment details of a card to be used for payments. These
 * details are determined by the payment token generated by Web Payments SDK.
 */
class Card implements \JsonSerializable
{
    /**
     * @var string|null
     */
    private $id;

/**
     * @var string|null
     */
    private $cardBrand;

/**
     * @var string|null
     */
    private $last4;

/**
     * @var array
     */
    private $expMonth = [];

/**
     * @var array
     */
    private $expYear = [];

/**
     * @var array
     */
    private $cardholderName = [];

/**
     * @var Address|null
     */
    private $billingAddress;

/**
     * @var string|null
     */
    private $fingerprint;

/**
     * @var array
     */
    private $customerId = [];

/**
     * @var string|null
     */
    private $merchantId;

/**
     * @var array
     */
    private $referenceId = [];

/**
     * @var bool|null
     */
    private $enabled;

/**
     * @var string|null
     */
    private $cardType;

/**
     * @var string|null
     */
    private $prepaidType;

/**
     * @var string|null
     */
    private $bin;

/**
     * @var int|null
     */
    private $version;

/**
     * @var string|null
     */
    private $cardCoBrand;

/**
     * Returns Id.
     * Unique ID for this card. Generated by Square.
     */
    public function getId(): ?string
    {
        return $this->id;
    }

/**
     * Sets Id.
     * Unique ID for this card. Generated by Square.
     *
     * @maps id
     */
    public function setId(?string $id): void
    {
        $this->id = $id;
    }

/**
     * Returns Card Brand.
     * Indicates a card's brand, such as `VISA` or `MASTERCARD`.
     */
    public function getCardBrand(): ?string
    {
        return $this->cardBrand;
    }

/**
     * Sets Card Brand.
     * Indicates a card's brand, such as `VISA` or `MASTERCARD`.
     *
     * @maps card_brand
     */
    public function setCardBrand(?string $cardBrand): void
    {
        $this->cardBrand = $cardBrand;
    }

/**
     * Returns Last 4.
     * The last 4 digits of the card number.
     */
    public function getLast4(): ?string
    {
        return $this->last4;
    }

/**
     * Sets Last 4.
     * The last 4 digits of the card number.
     *
     * @maps last_4
     */
    public function setLast4(?string $last4): void
    {
        $this->last4 = $last4;
    }

/**
     * Returns Exp Month.
     * The expiration month of the associated card as an integer between 1 and 12.
     */
    public function getExpMonth(): ?int
    {
        if (count($this->expMonth) == 0) {
            return null;
        }
        return $this->expMonth['value'];
    }

/**
     * Sets Exp Month.
     * The expiration month of the associated card as an integer between 1 and 12.
     *
     * @maps exp_month
     */
    public function setExpMonth(?int $expMonth): void
    {
        $this->expMonth['value'] = $expMonth;
    }

/**
     * Unsets Exp Month.
     * The expiration month of the associated card as an integer between 1 and 12.
     */
    public function unsetExpMonth(): void
    {
        $this->expMonth = [];
    }

/**
     * Returns Exp Year.
     * The four-digit year of the card's expiration date.
     */
    public function getExpYear(): ?int
    {
        if (count($this->expYear) == 0) {
            return null;
        }
        return $this->expYear['value'];
    }

/**
     * Sets Exp Year.
     * The four-digit year of the card's expiration date.
     *
     * @maps exp_year
     */
    public function setExpYear(?int $expYear): void
    {
        $this->expYear['value'] = $expYear;
    }

/**
     * Unsets Exp Year.
     * The four-digit year of the card's expiration date.
     */
    public function unsetExpYear(): void
    {
        $this->expYear = [];
    }

/**
     * Returns Cardholder Name.
     * The name of the cardholder.
     */
    public function getCardholderName(): ?string
    {
        if (count($this->cardholderName) == 0) {
            return null;
        }
        return $this->cardholderName['value'];
    }

/**
     * Sets Cardholder Name.
     * The name of the cardholder.
     *
     * @maps cardholder_name
     */
    public function setCardholderName(?string $cardholderName): void
    {
        $this->cardholderName['value'] = $cardholderName;
    }

/**
     * Unsets Cardholder Name.
     * The name of the cardholder.
     */
    public function unsetCardholderName(): void
    {
        $this->cardholderName = [];
    }

/**
     * Returns Billing Address.
     * Represents a postal address in a country.
     * For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-
     * basics/working-with-addresses).
     */
    public function getBillingAddress(): ?Address
    {
        return $this->billingAddress;
    }

/**
     * Sets Billing Address.
     * Represents a postal address in a country.
     * For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-
     * basics/working-with-addresses).
     *
     * @maps billing_address
     */
    public function setBillingAddress(?Address $billingAddress): void
    {
        $this->billingAddress = $billingAddress;
    }

/**
     * Returns Fingerprint.
     * Intended as a Square-assigned identifier, based
     * on the card number, to identify the card across multiple locations within a
     * single application.
     */
    public function getFingerprint(): ?string
    {
        return $this->fingerprint;
    }

/**
     * Sets Fingerprint.
     * Intended as a Square-assigned identifier, based
     * on the card number, to identify the card across multiple locations within a
     * single application.
     *
     * @maps fingerprint
     */
    public function setFingerprint(?string $fingerprint): void
    {
        $this->fingerprint = $fingerprint;
    }

/**
     * Returns Customer Id.
     * **Required** The ID of a customer created using the Customers API to be associated with the card.
     */
    public function getCustomerId(): ?string
    {
        if (count($this->customerId) == 0) {
            return null;
        }
        return $this->customerId['value'];
    }

/**
     * Sets Customer Id.
     * **Required** The ID of a customer created using the Customers API to be associated with the card.
     *
     * @maps customer_id
     */
    public function setCustomerId(?string $customerId): void
    {
        $this->customerId['value'] = $customerId;
    }

/**
     * Unsets Customer Id.
     * **Required** The ID of a customer created using the Customers API to be associated with the card.
     */
    public function unsetCustomerId(): void
    {
        $this->customerId = [];
    }

/**
     * Returns Merchant Id.
     * The ID of the merchant associated with the card.
     */
    public function getMerchantId(): ?string
    {
        return $this->merchantId;
    }

/**
     * Sets Merchant Id.
     * The ID of the merchant associated with the card.
     *
     * @maps merchant_id
     */
    public function setMerchantId(?string $merchantId): void
    {
        $this->merchantId = $merchantId;
    }

/**
     * Returns Reference Id.
     * An optional user-defined reference ID that associates this card with
     * another entity in an external system. For example, a customer ID from an
     * external customer management system.
     */
    public function getReferenceId(): ?string
    {
        if (count($this->referenceId) == 0) {
            return null;
        }
        return $this->referenceId['value'];
    }

/**
     * Sets Reference Id.
     * An optional user-defined reference ID that associates this card with
     * another entity in an external system. For example, a customer ID from an
     * external customer management system.
     *
     * @maps reference_id
     */
    public function setReferenceId(?string $referenceId): void
    {
        $this->referenceId['value'] = $referenceId;
    }

/**
     * Unsets Reference Id.
     * An optional user-defined reference ID that associates this card with
     * another entity in an external system. For example, a customer ID from an
     * external customer management system.
     */
    public function unsetReferenceId(): void
    {
        $this->referenceId = [];
    }

/**
     * Returns Enabled.
     * Indicates whether or not a card can be used for payments.
     */
    public function getEnabled(): ?bool
    {
        return $this->enabled;
    }

/**
     * Sets Enabled.
     * Indicates whether or not a card can be used for payments.
     *
     * @maps enabled
     */
    public function setEnabled(?bool $enabled): void
    {
        $this->enabled = $enabled;
    }

/**
     * Returns Card Type.
     * Indicates a card's type, such as `CREDIT` or `DEBIT`.
     */
    public function getCardType(): ?string
    {
        return $this->cardType;
    }

/**
     * Sets Card Type.
     * Indicates a card's type, such as `CREDIT` or `DEBIT`.
     *
     * @maps card_type
     */
    public function setCardType(?string $cardType): void
    {
        $this->cardType = $cardType;
    }

/**
     * Returns Prepaid Type.
     * Indicates a card's prepaid type, such as `NOT_PREPAID` or `PREPAID`.
     */
    public function getPrepaidType(): ?string
    {
        return $this->prepaidType;
    }

/**
     * Sets Prepaid Type.
     * Indicates a card's prepaid type, such as `NOT_PREPAID` or `PREPAID`.
     *
     * @maps prepaid_type
     */
    public function setPrepaidType(?string $prepaidType): void
    {
        $this->prepaidType = $prepaidType;
    }

/**
     * Returns Bin.
     * The first six digits of the card number, known as the Bank Identification Number (BIN). Only the
     * Payments API
     * returns this field.
     */
    public function getBin(): ?string
    {
        return $this->bin;
    }

/**
     * Sets Bin.
     * The first six digits of the card number, known as the Bank Identification Number (BIN). Only the
     * Payments API
     * returns this field.
     *
     * @maps bin
     */
    public function setBin(?string $bin): void
    {
        $this->bin = $bin;
    }

/**
     * Returns Version.
     * Current version number of the card. Increments with each card update. Requests to update an
     * existing Card object will be rejected unless the version in the request matches the current
     * version for the Card.
     */
    public function getVersion(): ?int
    {
        return $this->version;
    }

/**
     * Sets Version.
     * Current version number of the card. Increments with each card update. Requests to update an
     * existing Card object will be rejected unless the version in the request matches the current
     * version for the Card.
     *
     * @maps version
     */
    public function setVersion(?int $version): void
    {
        $this->version = $version;
    }

/**
     * Returns Card Co Brand.
     * Indicates the brand for a co-branded card.
     */
    public function getCardCoBrand(): ?string
    {
        return $this->cardCoBrand;
    }

/**
     * Sets Card Co Brand.
     * Indicates the brand for a co-branded card.
     *
     * @maps card_co_brand
     */
    public function setCardCoBrand(?string $cardCoBrand): void
    {
        $this->cardCoBrand = $cardCoBrand;
    }

/**
     * Encode this object to JSON
     *
     * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields
     *        are set. (default: false)
     *
     * @return array|stdClass
     */
    #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1)
    public function jsonSerialize(bool $asArrayWhenEmpty = false)
    {
        $json = [];
        if (isset($this->id)) {
            $json['id']              = $this->id;
        }
        if (isset($this->cardBrand)) {
            $json['card_brand']      = $this->cardBrand;
        }
        if (isset($this->last4)) {
            $json['last_4']          = $this->last4;
        }
        if (!empty($this->expMonth)) {
            $json['exp_month']       = $this->expMonth['value'];
        }
        if (!empty($this->expYear)) {
            $json['exp_year']        = $this->expYear['value'];
        }
        if (!empty($this->cardholderName)) {
            $json['cardholder_name'] = $this->cardholderName['value'];
        }
        if (isset($this->billingAddress)) {
            $json['billing_address'] = $this->billingAddress;
        }
        if (isset($this->fingerprint)) {
            $json['fingerprint']     = $this->fingerprint;
        }
        if (!empty($this->customerId)) {
            $json['customer_id']     = $this->customerId['value'];
        }
        if (isset($this->merchantId)) {
            $json['merchant_id']     = $this->merchantId;
        }
        if (!empty($this->referenceId)) {
            $json['reference_id']    = $this->referenceId['value'];
        }
        if (isset($this->enabled)) {
            $json['enabled']         = $this->enabled;
        }
        if (isset($this->cardType)) {
            $json['card_type']       = $this->cardType;
        }
        if (isset($this->prepaidType)) {
            $json['prepaid_type']    = $this->prepaidType;
        }
        if (isset($this->bin)) {
            $json['bin']             = $this->bin;
        }
        if (isset($this->version)) {
            $json['version']         = $this->version;
        }
        if (isset($this->cardCoBrand)) {
            $json['card_co_brand']   = $this->cardCoBrand;
        }
        $json = array_filter($json, function ($val) {
            return $val !== null;
        });

return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json;
    }
}

Back