Documentation

PowerFormSendersResponse
in package
implements ModelInterface, ArrayAccess

PowerFormSendersResponse Class Doc Comment

Tags
category

Class

description

This object includes information about the users who have sent PowerForms.

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
getEndPosition()  : int|null
Gets end_position
getModelName()  : string
The original name of the model.
getNextUri()  : string|null
Gets next_uri
getPowerFormSenders()  : array<string|int, UserInfo>
Gets power_form_senders
getPreviousUri()  : string|null
Gets previous_uri
getResultSetSize()  : int|null
Gets result_set_size
getStartPosition()  : int|null
Gets start_position
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTotalSetSize()  : int|null
Gets total_set_size
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.
setEndPosition()  : $this
Sets end_position
setNextUri()  : $this
Sets next_uri
setPowerFormSenders()  : $this
Sets power_form_senders
setPreviousUri()  : $this
Sets previous_uri
setResultSetSize()  : $this
Sets result_set_size
setStartPosition()  : $this
Sets start_position
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTotalSetSize()  : $this
Sets total_set_size
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 = ['end_position' => 'endPosition', 'next_uri' => 'nextUri', 'power_form_senders' => 'powerFormSenders', 'previous_uri' => 'previousUri', 'result_set_size' => 'resultSetSize', 'start_position' => 'startPosition', 'total_set_size' => 'totalSetSize']

$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 = ['end_position' => 'getEndPosition', 'next_uri' => 'getNextUri', 'power_form_senders' => 'getPowerFormSenders', 'previous_uri' => 'getPreviousUri', 'result_set_size' => 'getResultSetSize', 'start_position' => 'getStartPosition', 'total_set_size' => 'getTotalSetSize']

$setters

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

protected static array<string|int, string> $setters = ['end_position' => 'setEndPosition', 'next_uri' => 'setNextUri', 'power_form_senders' => 'setPowerFormSenders', 'previous_uri' => 'setPreviousUri', 'result_set_size' => 'setResultSetSize', 'start_position' => 'setStartPosition', 'total_set_size' => 'setTotalSetSize']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['end_position' => 'int32', 'next_uri' => null, 'power_form_senders' => null, 'previous_uri' => null, 'result_set_size' => 'int32', 'start_position' => 'int32', 'total_set_size' => 'int32']

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'powerFormSendersResponse'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['end_position' => '?int', 'next_uri' => '?string', 'power_form_senders' => '\\DocuSign\\eSign\\Model\\UserInfo[]', 'previous_uri' => '?string', 'result_set_size' => '?int', 'start_position' => '?int', 'total_set_size' => '?int']

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

getResultSetSize()

Gets result_set_size

public getResultSetSize() : int|null
Return values
int|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> —

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 —

setEndPosition()

Sets end_position

public setEndPosition(int|null $end_position) : $this
Parameters
$end_position : int|null

The last position in the result set.

Return values
$this —

setNextUri()

Sets next_uri

public setNextUri(string|null $next_uri) : $this
Parameters
$next_uri : string|null

The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null.

Return values
$this —

setPowerFormSenders()

Sets power_form_senders

public setPowerFormSenders(array<string|int, UserInfo> $power_form_senders) : $this
Parameters
$power_form_senders : array<string|int, UserInfo>
Return values
$this —

setPreviousUri()

Sets previous_uri

public setPreviousUri(string|null $previous_uri) : $this
Parameters
$previous_uri : string|null

The postal code for the billing address.

Return values
$this —

setResultSetSize()

Sets result_set_size

public setResultSetSize(int|null $result_set_size) : $this
Parameters
$result_set_size : int|null

The number of results returned in this response.

Return values
$this —

setStartPosition()

Sets start_position

public setStartPosition(int|null $start_position) : $this
Parameters
$start_position : int|null

Starting position of the current result set.

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

setTotalSetSize()

Sets total_set_size

public setTotalSetSize(int|null $total_set_size) : $this
Parameters
$total_set_size : int|null

The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response.

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