Documentation

PhoneNumberReleaseProjection
in package
implements ModelInterface, ArrayAccess, JsonSerializable

PhoneNumberReleaseProjection Class Doc Comment

Tags
category

Class

description

Released phone number projection

author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

\ArrayAccess<string, mixed>

Interfaces, Classes, Traits and Enums

ModelInterface
Interface abstracting model access.
ArrayAccess
JsonSerializable

Table of Contents

DISCRIMINATOR  = null
PHONE_COUNTRY_AU  = 'AU'
PHONE_COUNTRY_CA  = 'CA'
PHONE_COUNTRY_CH  = 'CH'
PHONE_COUNTRY_EE  = 'EE'
PHONE_COUNTRY_FI  = 'FI'
PHONE_COUNTRY_GB  = 'GB'
PHONE_COUNTRY_HK  = 'HK'
PHONE_COUNTRY_IL  = 'IL'
PHONE_COUNTRY_NL  = 'NL'
PHONE_COUNTRY_PL  = 'PL'
PHONE_COUNTRY_PT  = 'PT'
PHONE_COUNTRY_SE  = 'SE'
PHONE_COUNTRY_US  = 'US'
PLAN_CURRENCY_AUD  = 'AUD'
PLAN_CURRENCY_CAD  = 'CAD'
PLAN_CURRENCY_CHF  = 'CHF'
PLAN_CURRENCY_CNY  = 'CNY'
PLAN_CURRENCY_EUR  = 'EUR'
PLAN_CURRENCY_GBP  = 'GBP'
PLAN_CURRENCY_INR  = 'INR'
PLAN_CURRENCY_JPY  = 'JPY'
PLAN_CURRENCY_NZD  = 'NZD'
PLAN_CURRENCY_USD  = 'USD'
SUBSCRIPTION_SCHEDULE_MONTHLY  = 'MONTHLY'
SUBSCRIPTION_SCHEDULE_YEARLY  = 'YEARLY'
$attributeMap  : array<string|int, string>
Array of attributes where the key is the local name, and the value is the original name
$container  : array<string|int, mixed>
Associative array for storing property values
$getters  : array<string|int, string>
Array of attributes to getter functions (for serialization of requests)
$openAPIFormats  : array<string|int, string>
Array of property to format mappings. Used for (de)serialization
$openAPIModelName  : string
The original name of the model.
$openAPINullables  : array<string|int, mixed>
Array of nullable properties. Used for (de)serialization
$openAPINullablesSetToNull  : array<string|int, mixed>
If a nullable field gets set to null, insert it here
$openAPITypes  : array<string|int, string>
Array of property to type mappings. Used for (de)serialization
$setters  : array<string|int, string>
Array of attributes to setter functions (for deserialization of responses)
__construct()  : mixed
Constructor
__toString()  : string
Gets the string presentation of the object
attributeMap()  : array<string|int, mixed>
Array of attributes where the key is the local name, and the value is the original name
getCreatedAt()  : DateTime
Gets created_at
getId()  : string
Gets id
getModelName()  : string
The original name of the model.
getName()  : string|null
Gets name
getPhoneCountry()  : string
Gets phone_country
getPhoneCountryAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getPhoneNumber()  : string|null
Gets phone_number
getPlanCurrency()  : string|null
Gets plan_currency
getPlanCurrencyAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getSubscriptionSchedule()  : string|null
Gets subscription_schedule
getSubscriptionScheduleAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUserId()  : string
Gets user_id
isNullable()  : bool
Checks if a property is nullable
isNullableSetToNull()  : bool
Checks if a nullable property is set to null.
jsonSerialize()  : mixed
Serializes the object to a value that can be serialized natively by json_encode().
listInvalidProperties()  : array<string|int, mixed>
Show all the invalid properties with reasons.
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed|null
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
openAPIFormats()  : array<string|int, mixed>
Array of property to format mappings. Used for (de)serialization
openAPITypes()  : array<string|int, mixed>
Array of property to type mappings. Used for (de)serialization
setCreatedAt()  : self
Sets created_at
setId()  : self
Sets id
setName()  : self
Sets name
setPhoneCountry()  : self
Sets phone_country
setPhoneNumber()  : self
Sets phone_number
setPlanCurrency()  : self
Sets plan_currency
setSubscriptionSchedule()  : self
Sets subscription_schedule
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUserId()  : self
Sets user_id
toHeaderValue()  : string
Gets a header-safe presentation of the object
valid()  : bool
Validate all the properties in the model return true if all passed
openAPINullables()  : array<string|int, mixed>
Array of nullable properties
getOpenAPINullablesSetToNull()  : array<string|int, bool>
Array of nullable field names deliberately set to null
setIfExists()  : void
Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
setOpenAPINullablesSetToNull()  : void
Setter - Array of nullable field names deliberately set to null

Constants

Properties

$attributeMap

Array of attributes where the key is the local name, and the value is the original name

protected static array<string|int, string> $attributeMap = ['name' => 'name', 'id' => 'id', 'user_id' => 'userId', 'subscription_schedule' => 'subscriptionSchedule', 'plan_currency' => 'planCurrency', 'phone_country' => 'phoneCountry', 'phone_number' => 'phoneNumber', 'created_at' => 'createdAt']

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['name' => 'getName', 'id' => 'getId', 'user_id' => 'getUserId', 'subscription_schedule' => 'getSubscriptionSchedule', 'plan_currency' => 'getPlanCurrency', 'phone_country' => 'getPhoneCountry', 'phone_number' => 'getPhoneNumber', 'created_at' => 'getCreatedAt']

$openAPIFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $openAPIFormats = ['name' => null, 'id' => 'uuid', 'user_id' => 'uuid', 'subscription_schedule' => null, 'plan_currency' => null, 'phone_country' => null, 'phone_number' => null, 'created_at' => 'date-time']
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'PhoneNumberReleaseProjection'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['name' => true, 'id' => false, 'user_id' => false, 'subscription_schedule' => true, 'plan_currency' => true, 'phone_country' => false, 'phone_number' => true, 'created_at' => false]

$openAPINullablesSetToNull

If a nullable field gets set to null, insert it here

protected array<string|int, mixed> $openAPINullablesSetToNull = []

$openAPITypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $openAPITypes = ['name' => 'string', 'id' => 'string', 'user_id' => 'string', 'subscription_schedule' => 'string', 'plan_currency' => 'string', 'phone_country' => 'string', 'phone_number' => 'string', 'created_at' => '\\DateTime']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['name' => 'setName', 'id' => 'setId', 'user_id' => 'setUserId', 'subscription_schedule' => 'setSubscriptionSchedule', 'plan_currency' => 'setPlanCurrency', 'phone_country' => 'setPhoneCountry', 'phone_number' => 'setPhoneNumber', 'created_at' => 'setCreatedAt']

Methods

__construct()

Constructor

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

Associated array of property values initializing the model

Return values
mixed —

attributeMap()

Array of attributes where the key is the local name, and the value is the original name

public static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getPhoneCountryAllowableValues()

Gets allowable values of the enum

public getPhoneCountryAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getPlanCurrencyAllowableValues()

Gets allowable values of the enum

public getPlanCurrencyAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getSubscriptionSchedule()

Gets subscription_schedule

public getSubscriptionSchedule() : string|null
Return values
string|null —

getSubscriptionScheduleAllowableValues()

Gets allowable values of the enum

public getSubscriptionScheduleAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getters()

Array of attributes to getter functions (for serialization of requests)

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

isNullable()

Checks if a property is nullable

public static isNullable(string $property) : bool
Parameters
$property : string
Return values
bool —

isNullableSetToNull()

Checks if a nullable property is set to null.

public isNullableSetToNull(string $property) : bool
Parameters
$property : string
Return values
bool —

listInvalidProperties()

Show all the invalid properties with reasons.

public listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —

invalid properties with reasons

offsetExists()

Returns true if offset exists. False otherwise.

public offsetExists(int $offset) : bool
Parameters
$offset : int

Offset

Return values
bool —

offsetGet()

Gets offset.

public offsetGet(int $offset) : mixed|null
Parameters
$offset : int

Offset

Return values
mixed|null —

offsetSet()

Sets value based on offset.

public offsetSet(int|null $offset, mixed $value) : void
Parameters
$offset : int|null

Offset

$value : mixed

Value to be set

Return values
void —

offsetUnset()

Unsets offset.

public offsetUnset(int $offset) : void
Parameters
$offset : int

Offset

Return values
void —

openAPIFormats()

Array of property to format mappings. Used for (de)serialization

public static openAPIFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —

openAPITypes()

Array of property to type mappings. Used for (de)serialization

public static openAPITypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —

setCreatedAt()

Sets created_at

public setCreatedAt(DateTime $created_at) : self
Parameters
$created_at : DateTime

created_at

Return values
self —

setName()

Sets name

public setName(string|null $name) : self
Parameters
$name : string|null

name

Return values
self —

setPhoneCountry()

Sets phone_country

public setPhoneCountry(string $phone_country) : self
Parameters
$phone_country : string

phone_country

Return values
self —

setPhoneNumber()

Sets phone_number

public setPhoneNumber(string|null $phone_number) : self
Parameters
$phone_number : string|null

phone_number

Return values
self —

setPlanCurrency()

Sets plan_currency

public setPlanCurrency(string|null $plan_currency) : self
Parameters
$plan_currency : string|null

plan_currency

Return values
self —

setSubscriptionSchedule()

Sets subscription_schedule

public setSubscriptionSchedule(string|null $subscription_schedule) : self
Parameters
$subscription_schedule : string|null

subscription_schedule

Return values
self —

setters()

Array of attributes to setter functions (for deserialization of responses)

public static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

setUserId()

Sets user_id

public setUserId(string $user_id) : self
Parameters
$user_id : string

user_id

Return values
self —

valid()

Validate all the properties in the model return true if all passed

public valid() : bool
Return values
bool —

True if all properties are valid

openAPINullables()

Array of nullable properties

protected static openAPINullables() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getOpenAPINullablesSetToNull()

Array of nullable field names deliberately set to null

private getOpenAPINullablesSetToNull() : array<string|int, bool>
Return values
array<string|int, bool> —

setIfExists()

Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array

private setIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void
Parameters
$variableName : string
$fields : array<string|int, mixed>
$defaultValue : mixed
Return values
void —

setOpenAPINullablesSetToNull()

Setter - Array of nullable field names deliberately set to null

private setOpenAPINullablesSetToNull(array<string|int, bool> $openAPINullablesSetToNull) : void
Parameters
$openAPINullablesSetToNull : array<string|int, bool>
Return values
void —

Search results