Documentation

LocalePolicy
in package
implements ModelInterface, ArrayAccess

LocalePolicy Class Doc Comment

Tags
category

Class

author

Swagger Codegen team apihelp@docusign.com

license

The Docusign PHP Client SDK is licensed under the MIT License.

link
https://github.com/swagger-api/swagger-codegen

Interfaces, Classes, Traits and Enums

ModelInterface
Interface abstracting model access.
ArrayAccess

Table of Contents

DISCRIMINATOR  = null
$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)
$setters  : array<string|int, string>
Array of attributes to setter functions (for deserialization of responses)
$swaggerFormats  : array<string|int, string>
Array of property to format mappings. Used for (de)serialization
$swaggerModelName  : string
The original name of the model.
$swaggerTypes  : array<string|int, string>
Array of property to type mappings. Used for (de)serialization
__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
getAddressFormat()  : string|null
Gets address_format
getAddressFormatMetadata()  : SettingsMetadata
Gets address_format_metadata
getAllowRegion()  : string|null
Gets allow_region
getCalendarType()  : string|null
Gets calendar_type
getCalendarTypeMetadata()  : SettingsMetadata
Gets calendar_type_metadata
getCultureName()  : string|null
Gets culture_name
getCultureNameMetadata()  : SettingsMetadata
Gets culture_name_metadata
getCurrencyCode()  : string|null
Gets currency_code
getCurrencyCodeMetadata()  : SettingsMetadata
Gets currency_code_metadata
getCurrencyNegativeFormat()  : string|null
Gets currency_negative_format
getCurrencyNegativeFormatMetadata()  : SettingsMetadata
Gets currency_negative_format_metadata
getCurrencyPositiveFormat()  : string|null
Gets currency_positive_format
getCurrencyPositiveFormatMetadata()  : SettingsMetadata
Gets currency_positive_format_metadata
getCustomDateFormat()  : string|null
Gets custom_date_format
getCustomSignDateFormat()  : string|null
Gets custom_sign_date_format
getCustomSignTimeFormat()  : string|null
Gets custom_sign_time_format
getCustomTimeFormat()  : string|null
Gets custom_time_format
getDateFormat()  : string|null
Gets date_format
getDateFormatMetadata()  : SettingsMetadata
Gets date_format_metadata
getEffectiveAddressFormat()  : string|null
Gets effective_address_format
getEffectiveCalendarType()  : string|null
Gets effective_calendar_type
getEffectiveCurrencyCode()  : string|null
Gets effective_currency_code
getEffectiveCurrencyNegativeFormat()  : string|null
Gets effective_currency_negative_format
getEffectiveCurrencyPositiveFormat()  : string|null
Gets effective_currency_positive_format
getEffectiveCustomDateFormat()  : string|null
Gets effective_custom_date_format
getEffectiveCustomTimeFormat()  : string|null
Gets effective_custom_time_format
getEffectiveDateFormat()  : string|null
Gets effective_date_format
getEffectiveInitialFormat()  : string|null
Gets effective_initial_format
getEffectiveNameFormat()  : string|null
Gets effective_name_format
getEffectiveTimeFormat()  : string|null
Gets effective_time_format
getEffectiveTimeZone()  : string|null
Gets effective_time_zone
getInitialFormat()  : string|null
Gets initial_format
getInitialFormatMetadata()  : SettingsMetadata
Gets initial_format_metadata
getModelName()  : string
The original name of the model.
getNameFormat()  : string|null
Gets name_format
getNameFormatMetadata()  : SettingsMetadata
Gets name_format_metadata
getSignDateFormat()  : string|null
Gets sign_date_format
getSignDateFormatMetadata()  : SettingsMetadata
Gets sign_date_format_metadata
getSignTimeFormat()  : string|null
Gets sign_time_format
getSignTimeFormatMetadata()  : SettingsMetadata
Gets sign_time_format_metadata
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTimeFormat()  : string|null
Gets time_format
getTimeFormatMetadata()  : SettingsMetadata
Gets time_format_metadata
getTimeZone()  : string|null
Gets time_zone
getTimeZoneMetadata()  : SettingsMetadata
Gets time_zone_metadata
listInvalidProperties()  : array<string|int, mixed>
Show all the invalid properties with reasons.
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
setAddressFormat()  : $this
Sets address_format
setAddressFormatMetadata()  : $this
Sets address_format_metadata
setAllowRegion()  : $this
Sets allow_region
setCalendarType()  : $this
Sets calendar_type
setCalendarTypeMetadata()  : $this
Sets calendar_type_metadata
setCultureName()  : $this
Sets culture_name
setCultureNameMetadata()  : $this
Sets culture_name_metadata
setCurrencyCode()  : $this
Sets currency_code
setCurrencyCodeMetadata()  : $this
Sets currency_code_metadata
setCurrencyNegativeFormat()  : $this
Sets currency_negative_format
setCurrencyNegativeFormatMetadata()  : $this
Sets currency_negative_format_metadata
setCurrencyPositiveFormat()  : $this
Sets currency_positive_format
setCurrencyPositiveFormatMetadata()  : $this
Sets currency_positive_format_metadata
setCustomDateFormat()  : $this
Sets custom_date_format
setCustomSignDateFormat()  : $this
Sets custom_sign_date_format
setCustomSignTimeFormat()  : $this
Sets custom_sign_time_format
setCustomTimeFormat()  : $this
Sets custom_time_format
setDateFormat()  : $this
Sets date_format
setDateFormatMetadata()  : $this
Sets date_format_metadata
setEffectiveAddressFormat()  : $this
Sets effective_address_format
setEffectiveCalendarType()  : $this
Sets effective_calendar_type
setEffectiveCurrencyCode()  : $this
Sets effective_currency_code
setEffectiveCurrencyNegativeFormat()  : $this
Sets effective_currency_negative_format
setEffectiveCurrencyPositiveFormat()  : $this
Sets effective_currency_positive_format
setEffectiveCustomDateFormat()  : $this
Sets effective_custom_date_format
setEffectiveCustomTimeFormat()  : $this
Sets effective_custom_time_format
setEffectiveDateFormat()  : $this
Sets effective_date_format
setEffectiveInitialFormat()  : $this
Sets effective_initial_format
setEffectiveNameFormat()  : $this
Sets effective_name_format
setEffectiveTimeFormat()  : $this
Sets effective_time_format
setEffectiveTimeZone()  : $this
Sets effective_time_zone
setInitialFormat()  : $this
Sets initial_format
setInitialFormatMetadata()  : $this
Sets initial_format_metadata
setNameFormat()  : $this
Sets name_format
setNameFormatMetadata()  : $this
Sets name_format_metadata
setSignDateFormat()  : $this
Sets sign_date_format
setSignDateFormatMetadata()  : $this
Sets sign_date_format_metadata
setSignTimeFormat()  : $this
Sets sign_time_format
setSignTimeFormatMetadata()  : $this
Sets sign_time_format_metadata
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTimeFormat()  : $this
Sets time_format
setTimeFormatMetadata()  : $this
Sets time_format_metadata
setTimeZone()  : $this
Sets time_zone
setTimeZoneMetadata()  : $this
Sets time_zone_metadata
swaggerFormats()  : array<string|int, mixed>
Array of property to format mappings. Used for (de)serialization
swaggerTypes()  : array<string|int, mixed>
Array of property to type mappings. Used for (de)serialization
valid()  : bool
Validate all the properties in the model return true if all passed

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 = ['address_format' => 'addressFormat', 'address_format_metadata' => 'addressFormatMetadata', 'allow_region' => 'allowRegion', 'calendar_type' => 'calendarType', 'calendar_type_metadata' => 'calendarTypeMetadata', 'culture_name' => 'cultureName', 'culture_name_metadata' => 'cultureNameMetadata', 'currency_code' => 'currencyCode', 'currency_code_metadata' => 'currencyCodeMetadata', 'currency_negative_format' => 'currencyNegativeFormat', 'currency_negative_format_metadata' => 'currencyNegativeFormatMetadata', 'currency_positive_format' => 'currencyPositiveFormat', 'currency_positive_format_metadata' => 'currencyPositiveFormatMetadata', 'custom_date_format' => 'customDateFormat', 'custom_sign_date_format' => 'customSignDateFormat', 'custom_sign_time_format' => 'customSignTimeFormat', 'custom_time_format' => 'customTimeFormat', 'date_format' => 'dateFormat', 'date_format_metadata' => 'dateFormatMetadata', 'effective_address_format' => 'effectiveAddressFormat', 'effective_calendar_type' => 'effectiveCalendarType', 'effective_currency_code' => 'effectiveCurrencyCode', 'effective_currency_negative_format' => 'effectiveCurrencyNegativeFormat', 'effective_currency_positive_format' => 'effectiveCurrencyPositiveFormat', 'effective_custom_date_format' => 'effectiveCustomDateFormat', 'effective_custom_time_format' => 'effectiveCustomTimeFormat', 'effective_date_format' => 'effectiveDateFormat', 'effective_initial_format' => 'effectiveInitialFormat', 'effective_name_format' => 'effectiveNameFormat', 'effective_time_format' => 'effectiveTimeFormat', 'effective_time_zone' => 'effectiveTimeZone', 'initial_format' => 'initialFormat', 'initial_format_metadata' => 'initialFormatMetadata', 'name_format' => 'nameFormat', 'name_format_metadata' => 'nameFormatMetadata', 'sign_date_format' => 'signDateFormat', 'sign_date_format_metadata' => 'signDateFormatMetadata', 'sign_time_format' => 'signTimeFormat', 'sign_time_format_metadata' => 'signTimeFormatMetadata', 'time_format' => 'timeFormat', 'time_format_metadata' => 'timeFormatMetadata', 'time_zone' => 'timeZone', 'time_zone_metadata' => 'timeZoneMetadata']

$container

Associative array for storing property values

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

$getters

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

protected static array<string|int, string> $getters = ['address_format' => 'getAddressFormat', 'address_format_metadata' => 'getAddressFormatMetadata', 'allow_region' => 'getAllowRegion', 'calendar_type' => 'getCalendarType', 'calendar_type_metadata' => 'getCalendarTypeMetadata', 'culture_name' => 'getCultureName', 'culture_name_metadata' => 'getCultureNameMetadata', 'currency_code' => 'getCurrencyCode', 'currency_code_metadata' => 'getCurrencyCodeMetadata', 'currency_negative_format' => 'getCurrencyNegativeFormat', 'currency_negative_format_metadata' => 'getCurrencyNegativeFormatMetadata', 'currency_positive_format' => 'getCurrencyPositiveFormat', 'currency_positive_format_metadata' => 'getCurrencyPositiveFormatMetadata', 'custom_date_format' => 'getCustomDateFormat', 'custom_sign_date_format' => 'getCustomSignDateFormat', 'custom_sign_time_format' => 'getCustomSignTimeFormat', 'custom_time_format' => 'getCustomTimeFormat', 'date_format' => 'getDateFormat', 'date_format_metadata' => 'getDateFormatMetadata', 'effective_address_format' => 'getEffectiveAddressFormat', 'effective_calendar_type' => 'getEffectiveCalendarType', 'effective_currency_code' => 'getEffectiveCurrencyCode', 'effective_currency_negative_format' => 'getEffectiveCurrencyNegativeFormat', 'effective_currency_positive_format' => 'getEffectiveCurrencyPositiveFormat', 'effective_custom_date_format' => 'getEffectiveCustomDateFormat', 'effective_custom_time_format' => 'getEffectiveCustomTimeFormat', 'effective_date_format' => 'getEffectiveDateFormat', 'effective_initial_format' => 'getEffectiveInitialFormat', 'effective_name_format' => 'getEffectiveNameFormat', 'effective_time_format' => 'getEffectiveTimeFormat', 'effective_time_zone' => 'getEffectiveTimeZone', 'initial_format' => 'getInitialFormat', 'initial_format_metadata' => 'getInitialFormatMetadata', 'name_format' => 'getNameFormat', 'name_format_metadata' => 'getNameFormatMetadata', 'sign_date_format' => 'getSignDateFormat', 'sign_date_format_metadata' => 'getSignDateFormatMetadata', 'sign_time_format' => 'getSignTimeFormat', 'sign_time_format_metadata' => 'getSignTimeFormatMetadata', 'time_format' => 'getTimeFormat', 'time_format_metadata' => 'getTimeFormatMetadata', 'time_zone' => 'getTimeZone', 'time_zone_metadata' => 'getTimeZoneMetadata']

$setters

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

protected static array<string|int, string> $setters = ['address_format' => 'setAddressFormat', 'address_format_metadata' => 'setAddressFormatMetadata', 'allow_region' => 'setAllowRegion', 'calendar_type' => 'setCalendarType', 'calendar_type_metadata' => 'setCalendarTypeMetadata', 'culture_name' => 'setCultureName', 'culture_name_metadata' => 'setCultureNameMetadata', 'currency_code' => 'setCurrencyCode', 'currency_code_metadata' => 'setCurrencyCodeMetadata', 'currency_negative_format' => 'setCurrencyNegativeFormat', 'currency_negative_format_metadata' => 'setCurrencyNegativeFormatMetadata', 'currency_positive_format' => 'setCurrencyPositiveFormat', 'currency_positive_format_metadata' => 'setCurrencyPositiveFormatMetadata', 'custom_date_format' => 'setCustomDateFormat', 'custom_sign_date_format' => 'setCustomSignDateFormat', 'custom_sign_time_format' => 'setCustomSignTimeFormat', 'custom_time_format' => 'setCustomTimeFormat', 'date_format' => 'setDateFormat', 'date_format_metadata' => 'setDateFormatMetadata', 'effective_address_format' => 'setEffectiveAddressFormat', 'effective_calendar_type' => 'setEffectiveCalendarType', 'effective_currency_code' => 'setEffectiveCurrencyCode', 'effective_currency_negative_format' => 'setEffectiveCurrencyNegativeFormat', 'effective_currency_positive_format' => 'setEffectiveCurrencyPositiveFormat', 'effective_custom_date_format' => 'setEffectiveCustomDateFormat', 'effective_custom_time_format' => 'setEffectiveCustomTimeFormat', 'effective_date_format' => 'setEffectiveDateFormat', 'effective_initial_format' => 'setEffectiveInitialFormat', 'effective_name_format' => 'setEffectiveNameFormat', 'effective_time_format' => 'setEffectiveTimeFormat', 'effective_time_zone' => 'setEffectiveTimeZone', 'initial_format' => 'setInitialFormat', 'initial_format_metadata' => 'setInitialFormatMetadata', 'name_format' => 'setNameFormat', 'name_format_metadata' => 'setNameFormatMetadata', 'sign_date_format' => 'setSignDateFormat', 'sign_date_format_metadata' => 'setSignDateFormatMetadata', 'sign_time_format' => 'setSignTimeFormat', 'sign_time_format_metadata' => 'setSignTimeFormatMetadata', 'time_format' => 'setTimeFormat', 'time_format_metadata' => 'setTimeFormatMetadata', 'time_zone' => 'setTimeZone', 'time_zone_metadata' => 'setTimeZoneMetadata']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['address_format' => null, 'address_format_metadata' => null, 'allow_region' => null, 'calendar_type' => null, 'calendar_type_metadata' => null, 'culture_name' => null, 'culture_name_metadata' => null, 'currency_code' => null, 'currency_code_metadata' => null, 'currency_negative_format' => null, 'currency_negative_format_metadata' => null, 'currency_positive_format' => null, 'currency_positive_format_metadata' => null, 'custom_date_format' => null, 'custom_sign_date_format' => null, 'custom_sign_time_format' => null, 'custom_time_format' => null, 'date_format' => null, 'date_format_metadata' => null, 'effective_address_format' => null, 'effective_calendar_type' => null, 'effective_currency_code' => null, 'effective_currency_negative_format' => null, 'effective_currency_positive_format' => null, 'effective_custom_date_format' => null, 'effective_custom_time_format' => null, 'effective_date_format' => null, 'effective_initial_format' => null, 'effective_name_format' => null, 'effective_time_format' => null, 'effective_time_zone' => null, 'initial_format' => null, 'initial_format_metadata' => null, 'name_format' => null, 'name_format_metadata' => null, 'sign_date_format' => null, 'sign_date_format_metadata' => null, 'sign_time_format' => null, 'sign_time_format_metadata' => null, 'time_format' => null, 'time_format_metadata' => null, 'time_zone' => null, 'time_zone_metadata' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'localePolicy'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['address_format' => '?string', 'address_format_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'allow_region' => '?string', 'calendar_type' => '?string', 'calendar_type_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'culture_name' => '?string', 'culture_name_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'currency_code' => '?string', 'currency_code_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'currency_negative_format' => '?string', 'currency_negative_format_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'currency_positive_format' => '?string', 'currency_positive_format_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'custom_date_format' => '?string', 'custom_sign_date_format' => '?string', 'custom_sign_time_format' => '?string', 'custom_time_format' => '?string', 'date_format' => '?string', 'date_format_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'effective_address_format' => '?string', 'effective_calendar_type' => '?string', 'effective_currency_code' => '?string', 'effective_currency_negative_format' => '?string', 'effective_currency_positive_format' => '?string', 'effective_custom_date_format' => '?string', 'effective_custom_time_format' => '?string', 'effective_date_format' => '?string', 'effective_initial_format' => '?string', 'effective_name_format' => '?string', 'effective_time_format' => '?string', 'effective_time_zone' => '?string', 'initial_format' => '?string', 'initial_format_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'name_format' => '?string', 'name_format_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'sign_date_format' => '?string', 'sign_date_format_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'sign_time_format' => '?string', 'sign_time_format_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'time_format' => '?string', 'time_format_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'time_zone' => '?string', 'time_zone_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata']

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 —

__toString()

Gets the string presentation of the object

public __toString() : string
Return values
string —

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> —

getAddressFormat()

Gets address_format

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

getAllowRegion()

Gets allow_region

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

getCalendarType()

Gets calendar_type

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

getCultureName()

Gets culture_name

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

getCurrencyCode()

Gets currency_code

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

getCurrencyNegativeFormat()

Gets currency_negative_format

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

getCurrencyPositiveFormat()

Gets currency_positive_format

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

getCustomDateFormat()

Gets custom_date_format

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

getCustomSignDateFormat()

Gets custom_sign_date_format

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

getCustomSignTimeFormat()

Gets custom_sign_time_format

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

getCustomTimeFormat()

Gets custom_time_format

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

getDateFormat()

Gets date_format

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

getEffectiveAddressFormat()

Gets effective_address_format

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

getEffectiveCalendarType()

Gets effective_calendar_type

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

getEffectiveCurrencyCode()

Gets effective_currency_code

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

getEffectiveCurrencyNegativeFormat()

Gets effective_currency_negative_format

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

getEffectiveCurrencyPositiveFormat()

Gets effective_currency_positive_format

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

getEffectiveCustomDateFormat()

Gets effective_custom_date_format

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

getEffectiveCustomTimeFormat()

Gets effective_custom_time_format

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

getEffectiveDateFormat()

Gets effective_date_format

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

getEffectiveInitialFormat()

Gets effective_initial_format

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

getEffectiveNameFormat()

Gets effective_name_format

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

getEffectiveTimeFormat()

Gets effective_time_format

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

getEffectiveTimeZone()

Gets effective_time_zone

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

getInitialFormat()

Gets initial_format

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getNameFormat()

Gets name_format

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

getSignDateFormat()

Gets sign_date_format

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

getSignTimeFormat()

Gets sign_time_format

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

getters()

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

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

getTimeFormat()

Gets time_format

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

getTimeZone()

Gets time_zone

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

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
Parameters
$offset : int

Offset

Return values
mixed —

offsetSet()

Sets value based on offset.

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

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 —

setAddressFormat()

Sets address_format

public setAddressFormat(string|null $address_format) : $this
Parameters
$address_format : string|null
Return values
$this —

setAddressFormatMetadata()

Sets address_format_metadata

public setAddressFormatMetadata(SettingsMetadata $address_format_metadata) : $this
Parameters
$address_format_metadata : SettingsMetadata
Return values
$this —

setAllowRegion()

Sets allow_region

public setAllowRegion(string|null $allow_region) : $this
Parameters
$allow_region : string|null
Return values
$this —

setCalendarType()

Sets calendar_type

public setCalendarType(string|null $calendar_type) : $this
Parameters
$calendar_type : string|null
Return values
$this —

setCultureName()

Sets culture_name

public setCultureName(string|null $culture_name) : $this
Parameters
$culture_name : string|null
Return values
$this —

setCurrencyCode()

Sets currency_code

public setCurrencyCode(string|null $currency_code) : $this
Parameters
$currency_code : string|null
Return values
$this —

setCurrencyCodeMetadata()

Sets currency_code_metadata

public setCurrencyCodeMetadata(SettingsMetadata $currency_code_metadata) : $this
Parameters
$currency_code_metadata : SettingsMetadata

Metadata that indicates whether the currencyCode property is editable.

Return values
$this —

setCurrencyNegativeFormat()

Sets currency_negative_format

public setCurrencyNegativeFormat(string|null $currency_negative_format) : $this
Parameters
$currency_negative_format : string|null
Return values
$this —

setCurrencyNegativeFormatMetadata()

Sets currency_negative_format_metadata

public setCurrencyNegativeFormatMetadata(SettingsMetadata $currency_negative_format_metadata) : $this
Parameters
$currency_negative_format_metadata : SettingsMetadata
Return values
$this —

setCurrencyPositiveFormat()

Sets currency_positive_format

public setCurrencyPositiveFormat(string|null $currency_positive_format) : $this
Parameters
$currency_positive_format : string|null
Return values
$this —

setCurrencyPositiveFormatMetadata()

Sets currency_positive_format_metadata

public setCurrencyPositiveFormatMetadata(SettingsMetadata $currency_positive_format_metadata) : $this
Parameters
$currency_positive_format_metadata : SettingsMetadata
Return values
$this —

setCustomDateFormat()

Sets custom_date_format

public setCustomDateFormat(string|null $custom_date_format) : $this
Parameters
$custom_date_format : string|null
Return values
$this —

setCustomSignDateFormat()

Sets custom_sign_date_format

public setCustomSignDateFormat(string|null $custom_sign_date_format) : $this
Parameters
$custom_sign_date_format : string|null
Return values
$this —

setCustomSignTimeFormat()

Sets custom_sign_time_format

public setCustomSignTimeFormat(string|null $custom_sign_time_format) : $this
Parameters
$custom_sign_time_format : string|null
Return values
$this —

setCustomTimeFormat()

Sets custom_time_format

public setCustomTimeFormat(string|null $custom_time_format) : $this
Parameters
$custom_time_format : string|null
Return values
$this —

setDateFormat()

Sets date_format

public setDateFormat(string|null $date_format) : $this
Parameters
$date_format : string|null
Return values
$this —

setEffectiveAddressFormat()

Sets effective_address_format

public setEffectiveAddressFormat(string|null $effective_address_format) : $this
Parameters
$effective_address_format : string|null
Return values
$this —

setEffectiveCalendarType()

Sets effective_calendar_type

public setEffectiveCalendarType(string|null $effective_calendar_type) : $this
Parameters
$effective_calendar_type : string|null
Return values
$this —

setEffectiveCurrencyCode()

Sets effective_currency_code

public setEffectiveCurrencyCode(string|null $effective_currency_code) : $this
Parameters
$effective_currency_code : string|null
Return values
$this —

setEffectiveCurrencyNegativeFormat()

Sets effective_currency_negative_format

public setEffectiveCurrencyNegativeFormat(string|null $effective_currency_negative_format) : $this
Parameters
$effective_currency_negative_format : string|null
Return values
$this —

setEffectiveCurrencyPositiveFormat()

Sets effective_currency_positive_format

public setEffectiveCurrencyPositiveFormat(string|null $effective_currency_positive_format) : $this
Parameters
$effective_currency_positive_format : string|null
Return values
$this —

setEffectiveCustomDateFormat()

Sets effective_custom_date_format

public setEffectiveCustomDateFormat(string|null $effective_custom_date_format) : $this
Parameters
$effective_custom_date_format : string|null
Return values
$this —

setEffectiveCustomTimeFormat()

Sets effective_custom_time_format

public setEffectiveCustomTimeFormat(string|null $effective_custom_time_format) : $this
Parameters
$effective_custom_time_format : string|null
Return values
$this —

setEffectiveDateFormat()

Sets effective_date_format

public setEffectiveDateFormat(string|null $effective_date_format) : $this
Parameters
$effective_date_format : string|null
Return values
$this —

setEffectiveInitialFormat()

Sets effective_initial_format

public setEffectiveInitialFormat(string|null $effective_initial_format) : $this
Parameters
$effective_initial_format : string|null
Return values
$this —

setEffectiveNameFormat()

Sets effective_name_format

public setEffectiveNameFormat(string|null $effective_name_format) : $this
Parameters
$effective_name_format : string|null
Return values
$this —

setEffectiveTimeFormat()

Sets effective_time_format

public setEffectiveTimeFormat(string|null $effective_time_format) : $this
Parameters
$effective_time_format : string|null
Return values
$this —

setEffectiveTimeZone()

Sets effective_time_zone

public setEffectiveTimeZone(string|null $effective_time_zone) : $this
Parameters
$effective_time_zone : string|null
Return values
$this —

setInitialFormat()

Sets initial_format

public setInitialFormat(string|null $initial_format) : $this
Parameters
$initial_format : string|null
Return values
$this —

setInitialFormatMetadata()

Sets initial_format_metadata

public setInitialFormatMetadata(SettingsMetadata $initial_format_metadata) : $this
Parameters
$initial_format_metadata : SettingsMetadata
Return values
$this —

setNameFormat()

Sets name_format

public setNameFormat(string|null $name_format) : $this
Parameters
$name_format : string|null
Return values
$this —

setSignDateFormat()

Sets sign_date_format

public setSignDateFormat(string|null $sign_date_format) : $this
Parameters
$sign_date_format : string|null
Return values
$this —

setSignDateFormatMetadata()

Sets sign_date_format_metadata

public setSignDateFormatMetadata(SettingsMetadata $sign_date_format_metadata) : $this
Parameters
$sign_date_format_metadata : SettingsMetadata

Metadata that indicates whether the signDateFormat property is editable.

Return values
$this —

setSignTimeFormat()

Sets sign_time_format

public setSignTimeFormat(string|null $sign_time_format) : $this
Parameters
$sign_time_format : string|null
Return values
$this —

setSignTimeFormatMetadata()

Sets sign_time_format_metadata

public setSignTimeFormatMetadata(SettingsMetadata $sign_time_format_metadata) : $this
Parameters
$sign_time_format_metadata : SettingsMetadata

Metadata that indicates whether the signTimeFormat property is editable.

Return values
$this —

setters()

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

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

setTimeFormat()

Sets time_format

public setTimeFormat(string|null $time_format) : $this
Parameters
$time_format : string|null
Return values
$this —

setTimeZone()

Sets time_zone

public setTimeZone(string|null $time_zone) : $this
Parameters
$time_zone : string|null
Return values
$this —

swaggerFormats()

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

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

swaggerTypes()

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

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

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

Search results