shipcloud PHP Client

DropOffPoint extends AbstractApiObject
in package

DropOffPoint class

Tags
category

Class

author

Daniel Muenter info@msltns.com

version
0.0.1
since
0.0.1
license

GPL 3 This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 3, as published by the Free Software Foundation. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

Table of Contents

$id  : id
$required  : required
$drop_off_point_id  : string
Identifier for where the shipment should be dropped off.
$type  : string
The type of the dropoff location.
__construct()  : void
DropOffPoint constructor.
get_drop_off_point_id()  : string
Getter method for drop off point id.
get_id()  : string|null
Getter method for id.
get_required_fields()  : array<string|int, mixed>
Getter method for id.
get_type()  : string
Getter method for type.
set_drop_off_point_id()  : void
Setter method for drop off point id.
set_id()  : void
Setter method for id.
set_type()  : void
Setter method for type.
to_array()  : array<string|int, mixed>
Getter method for parameter array.
to_string()  : string
Getter method for string representation.

Properties

$drop_off_point_id

Identifier for where the shipment should be dropped off.

private string $drop_off_point_id

Methods

__construct()

DropOffPoint constructor.

public __construct([string $type = DropOffPointType::PARCEL_SHOP ][, string $drop_off_point_id = null ]) : void
Parameters
$type : string = DropOffPointType::PARCEL_SHOP
$drop_off_point_id : string = null
Tags
see
DropOffPointType
throws
ApiException
Return values
void —

get_drop_off_point_id()

Getter method for drop off point id.

public get_drop_off_point_id() : string
Return values
string —

The drop off point id.

get_id()

Getter method for id.

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

The id.

get_required_fields()

Getter method for id.

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

The id.

get_type()

Getter method for type.

public get_type() : string
Return values
string —

The type.

set_drop_off_point_id()

Setter method for drop off point id.

public set_drop_off_point_id(string $id) : void
Parameters
$id : string

The drop off point id to set.

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 —

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.

Search results