Properties
extends AbstractApiObject
in package
Properties class
Tags
Table of Contents
- $id : id
- $required : required
- $amount : amount
- $bank_account_holder : bank_account_holder
- $bank_account_number : bank_account_number
- $bank_code : bank_code
- $bank_name : bank_name
- $currency : currency
- $date : date
- $date_of_birth : date_of_birth
- $email : email
- $first_name : first_name
- $handling : handling
- Used for dhl_endorsement. By choosing the handling option abandon, your parcel will not be returned to you, but rather auctioned off or destroyed by the recipient countrys' postal company. You will not be charged with a return fee for this option. When using the option return_immediately, the shipment will be returned to you and you will be charged for returning it.
- $id_number : id_number
- ID number from the document
- $id_type : id_type
- Type of ID document that should be used for verifying a Hermes recipient
- $language : language
- Language the customer should be notified in (ISO-639-1 format)
- $last_name : last_name
- $message : message
- $minimum_age : minimum_age
- $name : name
- $phone : phone
- $properties : properties
- $reference1 : reference1
- Text that should be displayed as the reason for transfer
- $regulation_class : regulation_class
- Key that identifies the hazardous goods regulation class
- $sms : sms
- $time_of_day_earliest : time_of_day_earliest
- $time_of_day_latest : time_of_day_latest
- __construct() : void
- Properties constructor.
- get_amount() : float
- Getter method for amount.
- get_bank_account_holder() : string
- Getter method for bank_account_holder.
- get_bank_account_number() : string
- Getter method for bank_account_number.
- get_bank_code() : string
- Getter method for bank_code.
- get_bank_name() : string
- Getter method for bank_name.
- get_currency() : string
- Getter method for currency.
- get_date() : string
- Getter method for date.
- get_date_of_birth() : string
- Getter method for date_of_birth.
- get_email() : string
- Getter method for email.
- get_first_name() : string
- Getter method for first_name.
- get_handling() : string
- Getter method for handling.
- get_id() : string|null
- Getter method for id.
- get_id_number() : string
- Getter method for id_number.
- get_id_type() : string
- Getter method for id_type.
- get_language() : string
- Getter method for language.
- get_last_name() : string
- Getter method for last_name.
- get_message() : string
- Getter method for message.
- get_minimum_age() : string
- Getter method for minimum_age.
- get_name() : string
- Getter method for name.
- get_phone() : string
- Getter method for phone.
- get_properties() : array<string|int, mixed>
- Getter method for properties.
- get_reference1() : string
- Getter method for reference1.
- get_regulation_class() : string
- Getter method for regulation_class.
- get_required_fields() : array<string|int, mixed>
- Getter method for id.
- get_sms() : string
- Getter method for sms.
- get_time_of_day_earliest() : string
- Getter method for time_of_day_earliest.
- get_time_of_day_latest() : string
- Getter method for time_of_day_latest.
- set_amount() : void
- Setter method for amount.
- set_bank_account_holder() : void
- Setter method for bank_account_holder.
- set_bank_account_number() : void
- Setter method for bank_account_number.
- set_bank_code() : void
- Setter method for bank_code.
- set_bank_name() : void
- Setter method for bank_name.
- set_currency() : void
- Setter method for currency.
- set_date() : void
- Setter method for date.
- set_date_of_birth() : void
- Setter method for date_of_birth.
- set_email() : void
- Setter method for email.
- set_first_name() : void
- Setter method for first_name.
- set_handling() : void
- Setter method for handling.
- set_id() : void
- Setter method for id.
- set_id_number() : void
- Setter method for id_number.
- set_id_type() : void
- Setter method for id_type.
- set_language() : void
- Setter method for language.
- set_last_name() : void
- Setter method for last_name.
- set_message() : void
- Setter method for message.
- set_minimum_age() : void
- Setter method for minimum_age.
- set_name() : void
- Setter method for name.
- set_phone() : void
- Setter method for phone.
- set_properties() : void
- Setter method for properties.
- set_reference1() : void
- Setter method for reference1.
- set_regulation_class() : void
- Setter method for regulation_class.
- set_sms() : void
- Setter method for sms.
- set_time_of_day_earliest() : void
- Setter method for time_of_day_earliest.
- set_time_of_day_latest() : void
- Setter method for time_of_day_latest.
- to_array() : array<string|int, mixed>
- Getter method for parameter array.
- to_string() : string
- Getter method for string representation.
- get_other_fields() : array<string|int, mixed>
- Getter method for other fields.
Properties
$id
protected
id
$id
$required
protected
required
$required
$amount
private
amount
$amount
$bank_account_holder
private
bank_account_holder
$bank_account_holder
$bank_account_number
private
bank_account_number
$bank_account_number
$bank_code
private
bank_code
$bank_code
$bank_name
private
bank_name
$bank_name
$currency
private
currency
$currency
$date
private
date
$date
$date_of_birth
private
date_of_birth
$date_of_birth
private
email
$email
$first_name
private
first_name
$first_name
$handling
Used for dhl_endorsement. By choosing the handling option abandon, your parcel will not be returned to you, but rather auctioned off or destroyed by the recipient countrys' postal company. You will not be charged with a return fee for this option. When using the option return_immediately, the shipment will be returned to you and you will be charged for returning it.
private
handling
$handling
$id_number
ID number from the document
private
id_number
$id_number
$id_type
Type of ID document that should be used for verifying a Hermes recipient
private
id_type
$id_type
$language
Language the customer should be notified in (ISO-639-1 format)
private
language
$language
$last_name
private
last_name
$last_name
$message
private
message
$message
$minimum_age
private
minimum_age
$minimum_age
$name
private
name
$name
$phone
private
phone
$phone
$properties
private
properties
$properties
$reference1
Text that should be displayed as the reason for transfer
private
reference1
$reference1
$regulation_class
Key that identifies the hazardous goods regulation class
private
regulation_class
$regulation_class
$sms
private
sms
$sms
$time_of_day_earliest
private
time_of_day_earliest
$time_of_day_earliest
$time_of_day_latest
private
time_of_day_latest
$time_of_day_latest
Methods
__construct()
Properties constructor.
public
__construct() : void
Return values
void —get_amount()
Getter method for amount.
public
get_amount() : float
Return values
float —The amount.
get_bank_account_holder()
Getter method for bank_account_holder.
public
get_bank_account_holder() : string
Return values
string —The bank_account_holder.
get_bank_account_number()
Getter method for bank_account_number.
public
get_bank_account_number() : string
Return values
string —The bank_account_number.
get_bank_code()
Getter method for bank_code.
public
get_bank_code() : string
Return values
string —The bank_code.
get_bank_name()
Getter method for bank_name.
public
get_bank_name() : string
Return values
string —The bank_name.
get_currency()
Getter method for currency.
public
get_currency() : string
Return values
string —The currency.
get_date()
Getter method for date.
public
get_date() : string
Return values
string —The date.
get_date_of_birth()
Getter method for date_of_birth.
public
get_date_of_birth() : string
Return values
string —The date_of_birth.
get_email()
Getter method for email.
public
get_email() : string
Return values
string —The email.
get_first_name()
Getter method for first_name.
public
get_first_name() : string
Return values
string —The first_name.
get_handling()
Getter method for handling.
public
get_handling() : string
Return values
string —The handling.
get_id()
Getter method for id.
public
get_id() : string|null
Return values
string|null —The id.
get_id_number()
Getter method for id_number.
public
get_id_number() : string
Return values
string —The id_number.
get_id_type()
Getter method for id_type.
public
get_id_type() : string
Return values
string —The id_type.
get_language()
Getter method for language.
public
get_language() : string
Return values
string —The language.
get_last_name()
Getter method for last_name.
public
get_last_name() : string
Return values
string —The last_name.
get_message()
Getter method for message.
public
get_message() : string
Return values
string —The message.
get_minimum_age()
Getter method for minimum_age.
public
get_minimum_age() : string
Return values
string —The minimum_age.
get_name()
Getter method for name.
public
get_name() : string
Return values
string —The name.
get_phone()
Getter method for phone.
public
get_phone() : string
Return values
string —The phone.
get_properties()
Getter method for properties.
public
get_properties() : array<string|int, mixed>
Return values
array<string|int, mixed> —The properties.
get_reference1()
Getter method for reference1.
public
get_reference1() : string
Return values
string —The reference1.
get_regulation_class()
Getter method for regulation_class.
public
get_regulation_class() : string
Return values
string —The regulation_class.
get_required_fields()
Getter method for id.
public
get_required_fields() : array<string|int, mixed>
Return values
array<string|int, mixed> —The id.
get_sms()
Getter method for sms.
public
get_sms() : string
Return values
string —The sms.
get_time_of_day_earliest()
Getter method for time_of_day_earliest.
public
get_time_of_day_earliest() : string
Return values
string —The time_of_day_earliest.
get_time_of_day_latest()
Getter method for time_of_day_latest.
public
get_time_of_day_latest() : string
Return values
string —The time_of_day_latest.
set_amount()
Setter method for amount.
public
set_amount(float $amount) : void
Parameters
- $amount : float
-
The amount to set.
Return values
void —set_bank_account_holder()
Setter method for bank_account_holder.
public
set_bank_account_holder(string $bank_account_holder) : void
Parameters
- $bank_account_holder : string
-
The bank_account_holder to set.
Return values
void —set_bank_account_number()
Setter method for bank_account_number.
public
set_bank_account_number(string $bank_account_number) : void
Parameters
- $bank_account_number : string
-
The bank_account_number to set.
Return values
void —set_bank_code()
Setter method for bank_code.
public
set_bank_code(string $bank_code) : void
Parameters
- $bank_code : string
-
The bank_code to set.
Return values
void —set_bank_name()
Setter method for bank_name.
public
set_bank_name(string $bank_name) : void
Parameters
- $bank_name : string
-
The bank_name to set.
Return values
void —set_currency()
Setter method for currency.
public
set_currency(string $currency) : void
Parameters
- $currency : string
-
The currency to set.
Return values
void —set_date()
Setter method for date.
public
set_date(string $date) : void
Parameters
- $date : string
-
The date to set.
Return values
void —set_date_of_birth()
Setter method for date_of_birth.
public
set_date_of_birth(string $date_of_birth) : void
Parameters
- $date_of_birth : string
-
The date_of_birth to set.
Return values
void —set_email()
Setter method for email.
public
set_email(string $email) : void
Parameters
- $email : string
-
The email to set.
Return values
void —set_first_name()
Setter method for first_name.
public
set_first_name(string $first_name) : void
Parameters
- $first_name : string
-
The first_name to set.
Return values
void —set_handling()
Setter method for handling.
public
set_handling(string $handling) : void
Parameters
- $handling : string
-
The handling to set.
Tags
Return values
void —set_id()
Setter method for id.
public
set_id(string $id) : void
Parameters
- $id : string
-
The id to set.
Return values
void —set_id_number()
Setter method for id_number.
public
set_id_number(string $id_number) : void
Parameters
- $id_number : string
-
The id_number to set.
Return values
void —set_id_type()
Setter method for id_type.
public
set_id_type(string $id_type) : void
Parameters
- $id_type : string
-
The id_type to set.
Tags
Return values
void —set_language()
Setter method for language.
public
set_language(string $language) : void
Parameters
- $language : string
-
The language to set.
Return values
void —set_last_name()
Setter method for last_name.
public
set_last_name(string $last_name) : void
Parameters
- $last_name : string
-
The last_name to set.
Return values
void —set_message()
Setter method for message.
public
set_message(string $message) : void
Parameters
- $message : string
-
The message to set.
Return values
void —set_minimum_age()
Setter method for minimum_age.
public
set_minimum_age(string $minimum_age) : void
Parameters
- $minimum_age : string
-
The minimum_age to set.
Return values
void —set_name()
Setter method for name.
public
set_name(string $name) : void
Parameters
- $name : string
-
The name to set.
Return values
void —set_phone()
Setter method for phone.
public
set_phone(string $phone) : void
Parameters
- $phone : string
-
The phone to set.
Return values
void —set_properties()
Setter method for properties.
public
set_properties(array<string|int, mixed> $properties) : void
Parameters
- $properties : array<string|int, mixed>
-
The properties to set.
Return values
void —set_reference1()
Setter method for reference1.
public
set_reference1(string $reference1) : void
Parameters
- $reference1 : string
-
The reference1 to set.
Return values
void —set_regulation_class()
Setter method for regulation_class.
public
set_regulation_class(string $regulation_class) : void
Parameters
- $regulation_class : string
-
The regulation_class to set.
Tags
Return values
void —set_sms()
Setter method for sms.
public
set_sms(string $sms) : void
Parameters
- $sms : string
-
The sms to set.
Return values
void —set_time_of_day_earliest()
Setter method for time_of_day_earliest.
public
set_time_of_day_earliest(string $time_of_day_earliest) : void
Parameters
- $time_of_day_earliest : string
-
The time_of_day_earliest to set.
Return values
void —set_time_of_day_latest()
Setter method for time_of_day_latest.
public
set_time_of_day_latest(string $time_of_day_latest) : void
Parameters
- $time_of_day_latest : string
-
The time_of_day_latest to set.
Return values
void —to_array()
Getter method for parameter array.
public
to_array() : array<string|int, mixed>
Return values
array<string|int, mixed> —The class object as array.
to_string()
Getter method for string representation.
public
to_string() : string
Return values
string —The object as string representation.
get_other_fields()
Getter method for other fields.
private
get_other_fields() : array<string|int, mixed>
Return values
array<string|int, mixed> —The other fields.