FeatureSet
in package
implements
ModelInterface, ArrayAccess
FeatureSet 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
- getCurrencyFeatureSetPrices() : array<string|int, CurrencyFeatureSetPrice>
- Gets currency_feature_set_prices
- getEnvelopeFee() : string|null
- Gets envelope_fee
- getFeatureSetId() : string|null
- Gets feature_set_id
- getFixedFee() : string|null
- Gets fixed_fee
- getIs21CfrPart11() : string|null
- Gets is21_cfr_part11
- getIsActive() : string|null
- Gets is_active
- getIsEnabled() : string|null
- Gets is_enabled
- getModelName() : string
- The original name of the model.
- getName() : string|null
- Gets name
- getSeatFee() : string|null
- Gets seat_fee
- 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.
- setCurrencyFeatureSetPrices() : $this
- Sets currency_feature_set_prices
- setEnvelopeFee() : $this
- Sets envelope_fee
- setFeatureSetId() : $this
- Sets feature_set_id
- setFixedFee() : $this
- Sets fixed_fee
- setIs21CfrPart11() : $this
- Sets is21_cfr_part11
- setIsActive() : $this
- Sets is_active
- setIsEnabled() : $this
- Sets is_enabled
- setName() : $this
- Sets name
- setSeatFee() : $this
- Sets seat_fee
- 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
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
= ['currency_feature_set_prices' => 'currencyFeatureSetPrices', 'envelope_fee' => 'envelopeFee', 'feature_set_id' => 'featureSetId', 'fixed_fee' => 'fixedFee', 'is21_cfr_part11' => 'is21CFRPart11', 'is_active' => 'isActive', 'is_enabled' => 'isEnabled', 'name' => 'name', 'seat_fee' => 'seatFee']
$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
= ['currency_feature_set_prices' => 'getCurrencyFeatureSetPrices', 'envelope_fee' => 'getEnvelopeFee', 'feature_set_id' => 'getFeatureSetId', 'fixed_fee' => 'getFixedFee', 'is21_cfr_part11' => 'getIs21CfrPart11', 'is_active' => 'getIsActive', 'is_enabled' => 'getIsEnabled', 'name' => 'getName', 'seat_fee' => 'getSeatFee']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['currency_feature_set_prices' => 'setCurrencyFeatureSetPrices', 'envelope_fee' => 'setEnvelopeFee', 'feature_set_id' => 'setFeatureSetId', 'fixed_fee' => 'setFixedFee', 'is21_cfr_part11' => 'setIs21CfrPart11', 'is_active' => 'setIsActive', 'is_enabled' => 'setIsEnabled', 'name' => 'setName', 'seat_fee' => 'setSeatFee']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['currency_feature_set_prices' => null, 'envelope_fee' => null, 'feature_set_id' => null, 'fixed_fee' => null, 'is21_cfr_part11' => null, 'is_active' => null, 'is_enabled' => null, 'name' => null, 'seat_fee' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'featureSet'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['currency_feature_set_prices' => '\\DocuSign\\eSign\\Model\\CurrencyFeatureSetPrice[]', 'envelope_fee' => '?string', 'feature_set_id' => '?string', 'fixed_fee' => '?string', 'is21_cfr_part11' => '?string', 'is_active' => '?string', 'is_enabled' => '?string', 'name' => '?string', 'seat_fee' => '?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> —getCurrencyFeatureSetPrices()
Gets currency_feature_set_prices
public
getCurrencyFeatureSetPrices() : array<string|int, CurrencyFeatureSetPrice>
Return values
array<string|int, CurrencyFeatureSetPrice> —getEnvelopeFee()
Gets envelope_fee
public
getEnvelopeFee() : string|null
Return values
string|null —getFeatureSetId()
Gets feature_set_id
public
getFeatureSetId() : string|null
Return values
string|null —getFixedFee()
Gets fixed_fee
public
getFixedFee() : string|null
Return values
string|null —getIs21CfrPart11()
Gets is21_cfr_part11
public
getIs21CfrPart11() : string|null
Return values
string|null —getIsActive()
Gets is_active
public
getIsActive() : string|null
Return values
string|null —getIsEnabled()
Gets is_enabled
public
getIsEnabled() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getName()
Gets name
public
getName() : string|null
Return values
string|null —getSeatFee()
Gets seat_fee
public
getSeatFee() : 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
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 —setCurrencyFeatureSetPrices()
Sets currency_feature_set_prices
public
setCurrencyFeatureSetPrices(array<string|int, CurrencyFeatureSetPrice> $currency_feature_set_prices) : $this
Parameters
- $currency_feature_set_prices : array<string|int, CurrencyFeatureSetPrice>
-
A complex type that contains alternate currency values that are configured for this plan feature set.
Return values
$this —setEnvelopeFee()
Sets envelope_fee
public
setEnvelopeFee(string|null $envelope_fee) : $this
Parameters
- $envelope_fee : string|null
Return values
$this —setFeatureSetId()
Sets feature_set_id
public
setFeatureSetId(string|null $feature_set_id) : $this
Parameters
- $feature_set_id : string|null
-
A unique ID for the feature set.
Return values
$this —setFixedFee()
Sets fixed_fee
public
setFixedFee(string|null $fixed_fee) : $this
Parameters
- $fixed_fee : string|null
Return values
$this —setIs21CfrPart11()
Sets is21_cfr_part11
public
setIs21CfrPart11(string|null $is21_cfr_part11) : $this
Parameters
- $is21_cfr_part11 : string|null
-
When set to true, indicates that this module is enabled on the account.
Return values
$this —setIsActive()
Sets is_active
public
setIsActive(string|null $is_active) : $this
Parameters
- $is_active : string|null
Return values
$this —setIsEnabled()
Sets is_enabled
public
setIsEnabled(string|null $is_enabled) : $this
Parameters
- $is_enabled : string|null
-
Specifies whether the feature set is actively enabled as part of the plan.
Return values
$this —setName()
Sets name
public
setName(string|null $name) : $this
Parameters
- $name : string|null
Return values
$this —setSeatFee()
Sets seat_fee
public
setSeatFee(string|null $seat_fee) : $this
Parameters
- $seat_fee : string|null
-
An incremental seat cost for seat-based plans. Only valid when isEnabled for the feature set is set to true.
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