Documentation

ConnectUserObject
in package
implements ModelInterface, ArrayAccess

ConnectUserObject 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
getConfigurationtype()  : string|null
Gets configurationtype
getConnectId()  : string|null
Gets connect_id
getEnabled()  : string|null
Gets enabled
getHasAccess()  : string|null
Gets has_access
getModelName()  : string
The original name of the model.
getSenderSearchableItems()  : array<string|int, ?string>
Gets sender_searchable_items
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.
setConfigurationtype()  : $this
Sets configurationtype
setConnectId()  : $this
Sets connect_id
setEnabled()  : $this
Sets enabled
setHasAccess()  : $this
Sets has_access
setSenderSearchableItems()  : $this
Sets sender_searchable_items
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 = ['configurationtype' => 'configurationtype', 'connect_id' => 'connectId', 'enabled' => 'enabled', 'has_access' => 'hasAccess', 'sender_searchable_items' => 'senderSearchableItems']

$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 = ['configurationtype' => 'getConfigurationtype', 'connect_id' => 'getConnectId', 'enabled' => 'getEnabled', 'has_access' => 'getHasAccess', 'sender_searchable_items' => 'getSenderSearchableItems']

$setters

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

protected static array<string|int, string> $setters = ['configurationtype' => 'setConfigurationtype', 'connect_id' => 'setConnectId', 'enabled' => 'setEnabled', 'has_access' => 'setHasAccess', 'sender_searchable_items' => 'setSenderSearchableItems']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['configurationtype' => null, 'connect_id' => null, 'enabled' => null, 'has_access' => null, 'sender_searchable_items' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'connectUserObject'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['configurationtype' => '?string', 'connect_id' => '?string', 'enabled' => '?string', 'has_access' => '?string', 'sender_searchable_items' => '?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>

getConfigurationtype()

Gets configurationtype

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

getConnectId()

Gets connect_id

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

getEnabled()

Gets enabled

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

getHasAccess()

Gets has_access

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getSenderSearchableItems()

Gets sender_searchable_items

public getSenderSearchableItems() : array<string|int, ?string>
Return values
array<string|int, ?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

setConfigurationtype()

Sets configurationtype

public setConfigurationtype(string|null $configurationtype) : $this
Parameters
$configurationtype : string|null

If merge field's are being used, specifies the type of the merge field. The only supported value is salesforce.

Return values
$this

setConnectId()

Sets connect_id

public setConnectId(string|null $connect_id) : $this
Parameters
$connect_id : string|null
Return values
$this

setEnabled()

Sets enabled

public setEnabled(string|null $enabled) : $this
Parameters
$enabled : string|null
Return values
$this

setHasAccess()

Sets has_access

public setHasAccess(string|null $has_access) : $this
Parameters
$has_access : string|null
Return values
$this

setSenderSearchableItems()

Sets sender_searchable_items

public setSenderSearchableItems(array<string|int, ?string> $sender_searchable_items) : $this
Parameters
$sender_searchable_items : array<string|int, ?string>
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