Documentation

UserAccountManagementGranularInformation
in package
implements ModelInterface, ArrayAccess

UserAccountManagementGranularInformation Class Doc Comment

Tags
category

Class

description

Describes which account management capabilities a user has.

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
getCanManageAccountSecuritySettings()  : string|null
Gets can_manage_account_security_settings
getCanManageAccountSecuritySettingsMetadata()  : SettingsMetadata
Gets can_manage_account_security_settings_metadata
getCanManageAccountSettings()  : string|null
Gets can_manage_account_settings
getCanManageAccountSettingsMetadata()  : SettingsMetadata
Gets can_manage_account_settings_metadata
getCanManageAdmins()  : string|null
Gets can_manage_admins
getCanManageAdminsMetadata()  : SettingsMetadata
Gets can_manage_admins_metadata
getCanManageConnect()  : string|null
Gets can_manage_connect
getCanManageConnectMetadata()  : SettingsMetadata
Gets can_manage_connect_metadata
getCanManageDocumentRetention()  : string|null
Gets can_manage_document_retention
getCanManageDocumentRetentionMetadata()  : SettingsMetadata
Gets can_manage_document_retention_metadata
getCanManageEnvelopeTransfer()  : string|null
Gets can_manage_envelope_transfer
getCanManageEnvelopeTransferMetadata()  : SettingsMetadata
Gets can_manage_envelope_transfer_metadata
getCanManageGroupsButNotUsers()  : string|null
Gets can_manage_groups_but_not_users
getCanManageGroupsButNotUsersMetadata()  : SettingsMetadata
Gets can_manage_groups_but_not_users_metadata
getCanManageJointAgreements()  : string|null
Gets can_manage_joint_agreements
getCanManageJointAgreementsMetadata()  : SettingsMetadata
Gets can_manage_joint_agreements_metadata
getCanManageReporting()  : string|null
Gets can_manage_reporting
getCanManageReportingMetadata()  : SettingsMetadata
Gets can_manage_reporting_metadata
getCanManageSharing()  : string|null
Gets can_manage_sharing
getCanManageSharingMetadata()  : SettingsMetadata
Gets can_manage_sharing_metadata
getCanManageSigningGroups()  : string|null
Gets can_manage_signing_groups
getCanManageSigningGroupsMetadata()  : SettingsMetadata
Gets can_manage_signing_groups_metadata
getCanManageStamps()  : string|null
Gets can_manage_stamps
getCanManageStampsMetadata()  : SettingsMetadata
Gets can_manage_stamps_metadata
getCanManageUsers()  : string|null
Gets can_manage_users
getCanManageUsersMetadata()  : SettingsMetadata
Gets can_manage_users_metadata
getCanViewUsers()  : string|null
Gets can_view_users
getModelName()  : string
The original name of the model.
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.
setCanManageAccountSecuritySettings()  : $this
Sets can_manage_account_security_settings
setCanManageAccountSecuritySettingsMetadata()  : $this
Sets can_manage_account_security_settings_metadata
setCanManageAccountSettings()  : $this
Sets can_manage_account_settings
setCanManageAccountSettingsMetadata()  : $this
Sets can_manage_account_settings_metadata
setCanManageAdmins()  : $this
Sets can_manage_admins
setCanManageAdminsMetadata()  : $this
Sets can_manage_admins_metadata
setCanManageConnect()  : $this
Sets can_manage_connect
setCanManageConnectMetadata()  : $this
Sets can_manage_connect_metadata
setCanManageDocumentRetention()  : $this
Sets can_manage_document_retention
setCanManageDocumentRetentionMetadata()  : $this
Sets can_manage_document_retention_metadata
setCanManageEnvelopeTransfer()  : $this
Sets can_manage_envelope_transfer
setCanManageEnvelopeTransferMetadata()  : $this
Sets can_manage_envelope_transfer_metadata
setCanManageGroupsButNotUsers()  : $this
Sets can_manage_groups_but_not_users
setCanManageGroupsButNotUsersMetadata()  : $this
Sets can_manage_groups_but_not_users_metadata
setCanManageJointAgreements()  : $this
Sets can_manage_joint_agreements
setCanManageJointAgreementsMetadata()  : $this
Sets can_manage_joint_agreements_metadata
setCanManageReporting()  : $this
Sets can_manage_reporting
setCanManageReportingMetadata()  : $this
Sets can_manage_reporting_metadata
setCanManageSharing()  : $this
Sets can_manage_sharing
setCanManageSharingMetadata()  : $this
Sets can_manage_sharing_metadata
setCanManageSigningGroups()  : $this
Sets can_manage_signing_groups
setCanManageSigningGroupsMetadata()  : $this
Sets can_manage_signing_groups_metadata
setCanManageStamps()  : $this
Sets can_manage_stamps
setCanManageStampsMetadata()  : $this
Sets can_manage_stamps_metadata
setCanManageUsers()  : $this
Sets can_manage_users
setCanManageUsersMetadata()  : $this
Sets can_manage_users_metadata
setCanViewUsers()  : $this
Sets can_view_users
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 = ['can_manage_account_security_settings' => 'canManageAccountSecuritySettings', 'can_manage_account_security_settings_metadata' => 'canManageAccountSecuritySettingsMetadata', 'can_manage_account_settings' => 'canManageAccountSettings', 'can_manage_account_settings_metadata' => 'canManageAccountSettingsMetadata', 'can_manage_admins' => 'canManageAdmins', 'can_manage_admins_metadata' => 'canManageAdminsMetadata', 'can_manage_connect' => 'canManageConnect', 'can_manage_connect_metadata' => 'canManageConnectMetadata', 'can_manage_document_retention' => 'canManageDocumentRetention', 'can_manage_document_retention_metadata' => 'canManageDocumentRetentionMetadata', 'can_manage_envelope_transfer' => 'canManageEnvelopeTransfer', 'can_manage_envelope_transfer_metadata' => 'canManageEnvelopeTransferMetadata', 'can_manage_groups_but_not_users' => 'canManageGroupsButNotUsers', 'can_manage_groups_but_not_users_metadata' => 'canManageGroupsButNotUsersMetadata', 'can_manage_joint_agreements' => 'canManageJointAgreements', 'can_manage_joint_agreements_metadata' => 'canManageJointAgreementsMetadata', 'can_manage_reporting' => 'canManageReporting', 'can_manage_reporting_metadata' => 'canManageReportingMetadata', 'can_manage_sharing' => 'canManageSharing', 'can_manage_sharing_metadata' => 'canManageSharingMetadata', 'can_manage_signing_groups' => 'canManageSigningGroups', 'can_manage_signing_groups_metadata' => 'canManageSigningGroupsMetadata', 'can_manage_stamps' => 'canManageStamps', 'can_manage_stamps_metadata' => 'canManageStampsMetadata', 'can_manage_users' => 'canManageUsers', 'can_manage_users_metadata' => 'canManageUsersMetadata', 'can_view_users' => 'canViewUsers']

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['can_manage_account_security_settings' => 'getCanManageAccountSecuritySettings', 'can_manage_account_security_settings_metadata' => 'getCanManageAccountSecuritySettingsMetadata', 'can_manage_account_settings' => 'getCanManageAccountSettings', 'can_manage_account_settings_metadata' => 'getCanManageAccountSettingsMetadata', 'can_manage_admins' => 'getCanManageAdmins', 'can_manage_admins_metadata' => 'getCanManageAdminsMetadata', 'can_manage_connect' => 'getCanManageConnect', 'can_manage_connect_metadata' => 'getCanManageConnectMetadata', 'can_manage_document_retention' => 'getCanManageDocumentRetention', 'can_manage_document_retention_metadata' => 'getCanManageDocumentRetentionMetadata', 'can_manage_envelope_transfer' => 'getCanManageEnvelopeTransfer', 'can_manage_envelope_transfer_metadata' => 'getCanManageEnvelopeTransferMetadata', 'can_manage_groups_but_not_users' => 'getCanManageGroupsButNotUsers', 'can_manage_groups_but_not_users_metadata' => 'getCanManageGroupsButNotUsersMetadata', 'can_manage_joint_agreements' => 'getCanManageJointAgreements', 'can_manage_joint_agreements_metadata' => 'getCanManageJointAgreementsMetadata', 'can_manage_reporting' => 'getCanManageReporting', 'can_manage_reporting_metadata' => 'getCanManageReportingMetadata', 'can_manage_sharing' => 'getCanManageSharing', 'can_manage_sharing_metadata' => 'getCanManageSharingMetadata', 'can_manage_signing_groups' => 'getCanManageSigningGroups', 'can_manage_signing_groups_metadata' => 'getCanManageSigningGroupsMetadata', 'can_manage_stamps' => 'getCanManageStamps', 'can_manage_stamps_metadata' => 'getCanManageStampsMetadata', 'can_manage_users' => 'getCanManageUsers', 'can_manage_users_metadata' => 'getCanManageUsersMetadata', 'can_view_users' => 'getCanViewUsers']

$setters

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

protected static array<string|int, string> $setters = ['can_manage_account_security_settings' => 'setCanManageAccountSecuritySettings', 'can_manage_account_security_settings_metadata' => 'setCanManageAccountSecuritySettingsMetadata', 'can_manage_account_settings' => 'setCanManageAccountSettings', 'can_manage_account_settings_metadata' => 'setCanManageAccountSettingsMetadata', 'can_manage_admins' => 'setCanManageAdmins', 'can_manage_admins_metadata' => 'setCanManageAdminsMetadata', 'can_manage_connect' => 'setCanManageConnect', 'can_manage_connect_metadata' => 'setCanManageConnectMetadata', 'can_manage_document_retention' => 'setCanManageDocumentRetention', 'can_manage_document_retention_metadata' => 'setCanManageDocumentRetentionMetadata', 'can_manage_envelope_transfer' => 'setCanManageEnvelopeTransfer', 'can_manage_envelope_transfer_metadata' => 'setCanManageEnvelopeTransferMetadata', 'can_manage_groups_but_not_users' => 'setCanManageGroupsButNotUsers', 'can_manage_groups_but_not_users_metadata' => 'setCanManageGroupsButNotUsersMetadata', 'can_manage_joint_agreements' => 'setCanManageJointAgreements', 'can_manage_joint_agreements_metadata' => 'setCanManageJointAgreementsMetadata', 'can_manage_reporting' => 'setCanManageReporting', 'can_manage_reporting_metadata' => 'setCanManageReportingMetadata', 'can_manage_sharing' => 'setCanManageSharing', 'can_manage_sharing_metadata' => 'setCanManageSharingMetadata', 'can_manage_signing_groups' => 'setCanManageSigningGroups', 'can_manage_signing_groups_metadata' => 'setCanManageSigningGroupsMetadata', 'can_manage_stamps' => 'setCanManageStamps', 'can_manage_stamps_metadata' => 'setCanManageStampsMetadata', 'can_manage_users' => 'setCanManageUsers', 'can_manage_users_metadata' => 'setCanManageUsersMetadata', 'can_view_users' => 'setCanViewUsers']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['can_manage_account_security_settings' => null, 'can_manage_account_security_settings_metadata' => null, 'can_manage_account_settings' => null, 'can_manage_account_settings_metadata' => null, 'can_manage_admins' => null, 'can_manage_admins_metadata' => null, 'can_manage_connect' => null, 'can_manage_connect_metadata' => null, 'can_manage_document_retention' => null, 'can_manage_document_retention_metadata' => null, 'can_manage_envelope_transfer' => null, 'can_manage_envelope_transfer_metadata' => null, 'can_manage_groups_but_not_users' => null, 'can_manage_groups_but_not_users_metadata' => null, 'can_manage_joint_agreements' => null, 'can_manage_joint_agreements_metadata' => null, 'can_manage_reporting' => null, 'can_manage_reporting_metadata' => null, 'can_manage_sharing' => null, 'can_manage_sharing_metadata' => null, 'can_manage_signing_groups' => null, 'can_manage_signing_groups_metadata' => null, 'can_manage_stamps' => null, 'can_manage_stamps_metadata' => null, 'can_manage_users' => null, 'can_manage_users_metadata' => null, 'can_view_users' => null]

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['can_manage_account_security_settings' => '?string', 'can_manage_account_security_settings_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'can_manage_account_settings' => '?string', 'can_manage_account_settings_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'can_manage_admins' => '?string', 'can_manage_admins_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'can_manage_connect' => '?string', 'can_manage_connect_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'can_manage_document_retention' => '?string', 'can_manage_document_retention_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'can_manage_envelope_transfer' => '?string', 'can_manage_envelope_transfer_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'can_manage_groups_but_not_users' => '?string', 'can_manage_groups_but_not_users_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'can_manage_joint_agreements' => '?string', 'can_manage_joint_agreements_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'can_manage_reporting' => '?string', 'can_manage_reporting_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'can_manage_sharing' => '?string', 'can_manage_sharing_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'can_manage_signing_groups' => '?string', 'can_manage_signing_groups_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'can_manage_stamps' => '?string', 'can_manage_stamps_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'can_manage_users' => '?string', 'can_manage_users_metadata' => '\\DocuSign\\eSign\\Model\\SettingsMetadata', 'can_view_users' => '?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

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>

getCanManageAccountSecuritySettings()

Gets can_manage_account_security_settings

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

listInvalidProperties()

Show all the invalid properties with reasons.

public listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed>

invalid properties with reasons

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

setCanManageAccountSecuritySettings()

Sets can_manage_account_security_settings

public setCanManageAccountSecuritySettings(string|null $can_manage_account_security_settings) : $this
Parameters
$can_manage_account_security_settings : string|null
Return values
$this

setCanManageAccountSettings()

Sets can_manage_account_settings

public setCanManageAccountSettings(string|null $can_manage_account_settings) : $this
Parameters
$can_manage_account_settings : string|null
Return values
$this

setCanManageAdmins()

Sets can_manage_admins

public setCanManageAdmins(string|null $can_manage_admins) : $this
Parameters
$can_manage_admins : string|null
Return values
$this

setCanManageConnect()

Sets can_manage_connect

public setCanManageConnect(string|null $can_manage_connect) : $this
Parameters
$can_manage_connect : string|null
Return values
$this

setCanManageDocumentRetention()

Sets can_manage_document_retention

public setCanManageDocumentRetention(string|null $can_manage_document_retention) : $this
Parameters
$can_manage_document_retention : string|null
Return values
$this

setCanManageEnvelopeTransfer()

Sets can_manage_envelope_transfer

public setCanManageEnvelopeTransfer(string|null $can_manage_envelope_transfer) : $this
Parameters
$can_manage_envelope_transfer : string|null
Return values
$this

setCanManageGroupsButNotUsers()

Sets can_manage_groups_but_not_users

public setCanManageGroupsButNotUsers(string|null $can_manage_groups_but_not_users) : $this
Parameters
$can_manage_groups_but_not_users : string|null
Return values
$this

setCanManageJointAgreements()

Sets can_manage_joint_agreements

public setCanManageJointAgreements(string|null $can_manage_joint_agreements) : $this
Parameters
$can_manage_joint_agreements : string|null
Return values
$this

setCanManageReporting()

Sets can_manage_reporting

public setCanManageReporting(string|null $can_manage_reporting) : $this
Parameters
$can_manage_reporting : string|null
Return values
$this

setCanManageSharing()

Sets can_manage_sharing

public setCanManageSharing(string|null $can_manage_sharing) : $this
Parameters
$can_manage_sharing : string|null
Return values
$this

setCanManageSigningGroups()

Sets can_manage_signing_groups

public setCanManageSigningGroups(string|null $can_manage_signing_groups) : $this
Parameters
$can_manage_signing_groups : string|null
Return values
$this

setCanManageStamps()

Sets can_manage_stamps

public setCanManageStamps(string|null $can_manage_stamps) : $this
Parameters
$can_manage_stamps : string|null
Return values
$this

setCanManageUsers()

Sets can_manage_users

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

Search results