FileMaster

Edit File: Merchant.php

<?php

declare(strict_types=1);

namespace Square\Models;

use stdClass;

/**
 * Represents a business that sells with Square.
 */
class Merchant implements \JsonSerializable
{
    /**
     * @var string|null
     */
    private $id;

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

/**
     * @var string
     */
    private $country;

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

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

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

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

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

/**
     * @param string $country
     */
    public function __construct(string $country)
    {
        $this->country = $country;
    }

/**
     * Returns Id.
     * The Square-issued ID of the merchant.
     */
    public function getId(): ?string
    {
        return $this->id;
    }

/**
     * Sets Id.
     * The Square-issued ID of the merchant.
     *
     * @maps id
     */
    public function setId(?string $id): void
    {
        $this->id = $id;
    }

/**
     * Returns Business Name.
     * The name of the merchant's overall business.
     */
    public function getBusinessName(): ?string
    {
        if (count($this->businessName) == 0) {
            return null;
        }
        return $this->businessName['value'];
    }

/**
     * Sets Business Name.
     * The name of the merchant's overall business.
     *
     * @maps business_name
     */
    public function setBusinessName(?string $businessName): void
    {
        $this->businessName['value'] = $businessName;
    }

/**
     * Unsets Business Name.
     * The name of the merchant's overall business.
     */
    public function unsetBusinessName(): void
    {
        $this->businessName = [];
    }

/**
     * Returns Country.
     * Indicates the country associated with another entity, such as a business.
     * Values are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).
     */
    public function getCountry(): string
    {
        return $this->country;
    }

/**
     * Sets Country.
     * Indicates the country associated with another entity, such as a business.
     * Values are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).
     *
     * @required
     * @maps country
     */
    public function setCountry(string $country): void
    {
        $this->country = $country;
    }

/**
     * Returns Language Code.
     * The code indicating the [language preferences](https://developer.squareup.com/docs/build-
     * basics/general-considerations/language-preferences) of the merchant, in [BCP 47 format](https:
     * //tools.ietf.org/html/bcp47#appendix-A). For example, `en-US` or `fr-CA`.
     */
    public function getLanguageCode(): ?string
    {
        if (count($this->languageCode) == 0) {
            return null;
        }
        return $this->languageCode['value'];
    }

/**
     * Sets Language Code.
     * The code indicating the [language preferences](https://developer.squareup.com/docs/build-
     * basics/general-considerations/language-preferences) of the merchant, in [BCP 47 format](https:
     * //tools.ietf.org/html/bcp47#appendix-A). For example, `en-US` or `fr-CA`.
     *
     * @maps language_code
     */
    public function setLanguageCode(?string $languageCode): void
    {
        $this->languageCode['value'] = $languageCode;
    }

/**
     * Unsets Language Code.
     * The code indicating the [language preferences](https://developer.squareup.com/docs/build-
     * basics/general-considerations/language-preferences) of the merchant, in [BCP 47 format](https:
     * //tools.ietf.org/html/bcp47#appendix-A). For example, `en-US` or `fr-CA`.
     */
    public function unsetLanguageCode(): void
    {
        $this->languageCode = [];
    }

/**
     * Returns Currency.
     * Indicates the associated currency for an amount of money. Values correspond
     * to [ISO 4217](https://wikipedia.org/wiki/ISO_4217).
     */
    public function getCurrency(): ?string
    {
        return $this->currency;
    }

/**
     * Sets Currency.
     * Indicates the associated currency for an amount of money. Values correspond
     * to [ISO 4217](https://wikipedia.org/wiki/ISO_4217).
     *
     * @maps currency
     */
    public function setCurrency(?string $currency): void
    {
        $this->currency = $currency;
    }

/**
     * Returns Status.
     */
    public function getStatus(): ?string
    {
        return $this->status;
    }

/**
     * Sets Status.
     *
     * @maps status
     */
    public function setStatus(?string $status): void
    {
        $this->status = $status;
    }

/**
     * Returns Main Location Id.
     * The ID of the [main `Location`](https://developer.squareup.com/docs/locations-api#about-the-main-
     * location) for this merchant.
     */
    public function getMainLocationId(): ?string
    {
        if (count($this->mainLocationId) == 0) {
            return null;
        }
        return $this->mainLocationId['value'];
    }

/**
     * Sets Main Location Id.
     * The ID of the [main `Location`](https://developer.squareup.com/docs/locations-api#about-the-main-
     * location) for this merchant.
     *
     * @maps main_location_id
     */
    public function setMainLocationId(?string $mainLocationId): void
    {
        $this->mainLocationId['value'] = $mainLocationId;
    }

/**
     * Unsets Main Location Id.
     * The ID of the [main `Location`](https://developer.squareup.com/docs/locations-api#about-the-main-
     * location) for this merchant.
     */
    public function unsetMainLocationId(): void
    {
        $this->mainLocationId = [];
    }

/**
     * Returns Created At.
     * The time when the merchant was created, in RFC 3339 format.
     * For more information, see [Working with Dates](https://developer.squareup.com/docs/build-
     * basics/working-with-dates).
     */
    public function getCreatedAt(): ?string
    {
        return $this->createdAt;
    }

/**
     * Sets Created At.
     * The time when the merchant was created, in RFC 3339 format.
     * For more information, see [Working with Dates](https://developer.squareup.com/docs/build-
     * basics/working-with-dates).
     *
     * @maps created_at
     */
    public function setCreatedAt(?string $createdAt): void
    {
        $this->createdAt = $createdAt;
    }

/**
     * 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 (!empty($this->businessName)) {
            $json['business_name']    = $this->businessName['value'];
        }
        $json['country']              = $this->country;
        if (!empty($this->languageCode)) {
            $json['language_code']    = $this->languageCode['value'];
        }
        if (isset($this->currency)) {
            $json['currency']         = $this->currency;
        }
        if (isset($this->status)) {
            $json['status']           = $this->status;
        }
        if (!empty($this->mainLocationId)) {
            $json['main_location_id'] = $this->mainLocationId['value'];
        }
        if (isset($this->createdAt)) {
            $json['created_at']       = $this->createdAt;
        }
        $json = array_filter($json, function ($val) {
            return $val !== null;
        });

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

Back