Documentation

PermissionProfile
in package
implements ModelInterface, ArrayAccess

PermissionProfile Class Doc Comment

Tags
category

Class

description

This object defines the account permissions for a profile that you can apply to a group of users.

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
getModelName()  : string
The original name of the model.
getModifiedByUsername()  : string|null
Gets modified_by_username
getModifiedDateTime()  : string|null
Gets modified_date_time
getPermissionProfileId()  : string|null
Gets permission_profile_id
getPermissionProfileName()  : string|null
Gets permission_profile_name
getSettings()  : AccountRoleSettings
Gets settings
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUserCount()  : string|null
Gets user_count
getUsers()  : array<string|int, UserInformation>
Gets users
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.
setModifiedByUsername()  : $this
Sets modified_by_username
setModifiedDateTime()  : $this
Sets modified_date_time
setPermissionProfileId()  : $this
Sets permission_profile_id
setPermissionProfileName()  : $this
Sets permission_profile_name
setSettings()  : $this
Sets settings
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUserCount()  : $this
Sets user_count
setUsers()  : $this
Sets users
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 = ['modified_by_username' => 'modifiedByUsername', 'modified_date_time' => 'modifiedDateTime', 'permission_profile_id' => 'permissionProfileId', 'permission_profile_name' => 'permissionProfileName', 'settings' => 'settings', 'user_count' => 'userCount', 'users' => 'users']

$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 = ['modified_by_username' => 'getModifiedByUsername', 'modified_date_time' => 'getModifiedDateTime', 'permission_profile_id' => 'getPermissionProfileId', 'permission_profile_name' => 'getPermissionProfileName', 'settings' => 'getSettings', 'user_count' => 'getUserCount', 'users' => 'getUsers']

$setters

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

protected static array<string|int, string> $setters = ['modified_by_username' => 'setModifiedByUsername', 'modified_date_time' => 'setModifiedDateTime', 'permission_profile_id' => 'setPermissionProfileId', 'permission_profile_name' => 'setPermissionProfileName', 'settings' => 'setSettings', 'user_count' => 'setUserCount', 'users' => 'setUsers']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['modified_by_username' => null, 'modified_date_time' => null, 'permission_profile_id' => null, 'permission_profile_name' => null, 'settings' => null, 'user_count' => null, 'users' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'permissionProfile'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['modified_by_username' => '?string', 'modified_date_time' => '?string', 'permission_profile_id' => '?string', 'permission_profile_name' => '?string', 'settings' => '\\DocuSign\\eSign\\Model\\AccountRoleSettings', 'user_count' => '?string', 'users' => '\\DocuSign\\eSign\\Model\\UserInformation[]']

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>

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getModifiedByUsername()

Gets modified_by_username

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

getModifiedDateTime()

Gets modified_date_time

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

getPermissionProfileId()

Gets permission_profile_id

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

getPermissionProfileName()

Gets permission_profile_name

public getPermissionProfileName() : 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>

getUserCount()

Gets user_count

public getUserCount() : 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

setModifiedByUsername()

Sets modified_by_username

public setModifiedByUsername(string|null $modified_by_username) : $this
Parameters
$modified_by_username : string|null
Return values
$this

setModifiedDateTime()

Sets modified_date_time

public setModifiedDateTime(string|null $modified_date_time) : $this
Parameters
$modified_date_time : string|null
Return values
$this

setPermissionProfileId()

Sets permission_profile_id

public setPermissionProfileId(string|null $permission_profile_id) : $this
Parameters
$permission_profile_id : string|null
Return values
$this

setPermissionProfileName()

Sets permission_profile_name

public setPermissionProfileName(string|null $permission_profile_name) : $this
Parameters
$permission_profile_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>

setUserCount()

Sets user_count

public setUserCount(string|null $user_count) : $this
Parameters
$user_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

Search results