Documentation

BulkSendingListSummary
in package
implements ModelInterface, ArrayAccess

BulkSendingListSummary Class Doc Comment

Tags
category

Class

description

This object contains basic information about a bulk send list.

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
getBulkSendListId()  : string|null
Gets bulk_send_list_id
getCreatedByUser()  : string|null
Gets created_by_user
getCreatedDate()  : string|null
Gets created_date
getModelName()  : string
The original name of the model.
getName()  : string|null
Gets name
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
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.
setBulkSendListId()  : $this
Sets bulk_send_list_id
setCreatedByUser()  : $this
Sets created_by_user
setCreatedDate()  : $this
Sets created_date
setName()  : $this
Sets name
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
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 = ['bulk_send_list_id' => 'bulkSendListId', 'created_by_user' => 'createdByUser', 'created_date' => 'createdDate', 'name' => 'name']

$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 = ['bulk_send_list_id' => 'getBulkSendListId', 'created_by_user' => 'getCreatedByUser', 'created_date' => 'getCreatedDate', 'name' => 'getName']

$setters

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

protected static array<string|int, string> $setters = ['bulk_send_list_id' => 'setBulkSendListId', 'created_by_user' => 'setCreatedByUser', 'created_date' => 'setCreatedDate', 'name' => 'setName']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['bulk_send_list_id' => null, 'created_by_user' => null, 'created_date' => null, 'name' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'bulkSendingListSummary'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['bulk_send_list_id' => '?string', 'created_by_user' => '?string', 'created_date' => '?string', 'name' => '?string']

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>

getBulkSendListId()

Gets bulk_send_list_id

public getBulkSendListId() : string|null
Return values
string|null

getCreatedByUser()

Gets created_by_user

public getCreatedByUser() : string|null
Return values
string|null

getCreatedDate()

Gets created_date

public getCreatedDate() : string|null
Return values
string|null

getModelName()

The original name of the model.

public getModelName() : string
Return values
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>

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

setBulkSendListId()

Sets bulk_send_list_id

public setBulkSendListId(string|null $bulk_send_list_id) : $this
Parameters
$bulk_send_list_id : string|null
Return values
$this

setCreatedByUser()

Sets created_by_user

public setCreatedByUser(string|null $created_by_user) : $this
Parameters
$created_by_user : string|null
Return values
$this

setCreatedDate()

Sets created_date

public setCreatedDate(string|null $created_date) : $this
Parameters
$created_date : string|null
Return values
$this

setName()

Sets name

public setName(string|null $name) : $this
Parameters
$name : string|null
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>

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