Group
in package
implements
ModelInterface, ArrayAccess
Group Class Doc Comment
Tags
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
- getAccessType() : string|null
- Gets access_type
- getDsGroupId() : string|null
- Gets ds_group_id
- getErrorDetails() : ErrorDetails
- Gets error_details
- getGroupId() : string|null
- Gets group_id
- getGroupName() : string|null
- Gets group_name
- getGroupType() : string|null
- Gets group_type
- getLastModifiedOn() : string|null
- Gets last_modified_on
- getModelName() : string
- The original name of the model.
- getPermissionProfileId() : string|null
- Gets permission_profile_id
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getUsers() : array<string|int, UserInfo>
- Gets users
- getUsersCount() : string|null
- Gets users_count
- 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.
- setAccessType() : $this
- Sets access_type
- setDsGroupId() : $this
- Sets ds_group_id
- setErrorDetails() : $this
- Sets error_details
- setGroupId() : $this
- Sets group_id
- setGroupName() : $this
- Sets group_name
- setGroupType() : $this
- Sets group_type
- setLastModifiedOn() : $this
- Sets last_modified_on
- setPermissionProfileId() : $this
- Sets permission_profile_id
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setUsers() : $this
- Sets users
- setUsersCount() : $this
- Sets users_count
- 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
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
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
= ['access_type' => 'accessType', 'ds_group_id' => 'dsGroupId', 'error_details' => 'errorDetails', 'group_id' => 'groupId', 'group_name' => 'groupName', 'group_type' => 'groupType', 'last_modified_on' => 'lastModifiedOn', 'permission_profile_id' => 'permissionProfileId', 'users' => 'users', 'users_count' => 'usersCount']
$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
= ['access_type' => 'getAccessType', 'ds_group_id' => 'getDsGroupId', 'error_details' => 'getErrorDetails', 'group_id' => 'getGroupId', 'group_name' => 'getGroupName', 'group_type' => 'getGroupType', 'last_modified_on' => 'getLastModifiedOn', 'permission_profile_id' => 'getPermissionProfileId', 'users' => 'getUsers', 'users_count' => 'getUsersCount']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['access_type' => 'setAccessType', 'ds_group_id' => 'setDsGroupId', 'error_details' => 'setErrorDetails', 'group_id' => 'setGroupId', 'group_name' => 'setGroupName', 'group_type' => 'setGroupType', 'last_modified_on' => 'setLastModifiedOn', 'permission_profile_id' => 'setPermissionProfileId', 'users' => 'setUsers', 'users_count' => 'setUsersCount']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['access_type' => null, 'ds_group_id' => null, 'error_details' => null, 'group_id' => null, 'group_name' => null, 'group_type' => null, 'last_modified_on' => null, 'permission_profile_id' => null, 'users' => null, 'users_count' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'group'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['access_type' => '?string', 'ds_group_id' => '?string', 'error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'group_id' => '?string', 'group_name' => '?string', 'group_type' => '?string', 'last_modified_on' => '?string', 'permission_profile_id' => '?string', 'users' => '\\DocuSign\\eSign\\Model\\UserInfo[]', 'users_count' => '?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> —getAccessType()
Gets access_type
public
getAccessType() : string|null
Return values
string|null —getDsGroupId()
Gets ds_group_id
public
getDsGroupId() : string|null
Return values
string|null —getErrorDetails()
Gets error_details
public
getErrorDetails() : ErrorDetails
Return values
ErrorDetails —getGroupId()
Gets group_id
public
getGroupId() : string|null
Return values
string|null —getGroupName()
Gets group_name
public
getGroupName() : string|null
Return values
string|null —getGroupType()
Gets group_type
public
getGroupType() : string|null
Return values
string|null —getLastModifiedOn()
Gets last_modified_on
public
getLastModifiedOn() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPermissionProfileId()
Gets permission_profile_id
public
getPermissionProfileId() : string|null
Return values
string|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> —getUsers()
Gets users
public
getUsers() : array<string|int, UserInfo>
Return values
array<string|int, UserInfo> —getUsersCount()
Gets users_count
public
getUsersCount() : string|null
Return values
string|null —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 —setAccessType()
Sets access_type
public
setAccessType(string|null $access_type) : $this
Parameters
- $access_type : string|null
Return values
$this —setDsGroupId()
Sets ds_group_id
public
setDsGroupId(string|null $ds_group_id) : $this
Parameters
- $ds_group_id : string|null
Return values
$this —setErrorDetails()
Sets error_details
public
setErrorDetails(ErrorDetails $error_details) : $this
Parameters
- $error_details : ErrorDetails
-
Array or errors.
Return values
$this —setGroupId()
Sets group_id
public
setGroupId(string|null $group_id) : $this
Parameters
- $group_id : string|null
-
The DocuSign group ID for the group.
Return values
$this —setGroupName()
Sets group_name
public
setGroupName(string|null $group_name) : $this
Parameters
- $group_name : string|null
-
The name of the group.
Return values
$this —setGroupType()
Sets group_type
public
setGroupType(string|null $group_type) : $this
Parameters
- $group_type : string|null
-
The group type.
Return values
$this —setLastModifiedOn()
Sets last_modified_on
public
setLastModifiedOn(string|null $last_modified_on) : $this
Parameters
- $last_modified_on : string|null
Return values
$this —setPermissionProfileId()
Sets permission_profile_id
public
setPermissionProfileId(string|null $permission_profile_id) : $this
Parameters
- $permission_profile_id : string|null
-
The ID of the permission profile associated with the group.
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> —setUsers()
Sets users
public
setUsers(array<string|int, UserInfo> $users) : $this
Parameters
- $users : array<string|int, UserInfo>
Return values
$this —setUsersCount()
Sets users_count
public
setUsersCount(string|null $users_count) : $this
Parameters
- $users_count : string|null
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