Documentation

ReferralInformation
in package
implements ModelInterface, ArrayAccess

ReferralInformation Class Doc Comment

Tags
category

Class

description

A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry ###### Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only.

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
getAdvertisementId()  : string|null
Gets advertisement_id
getEnableSupport()  : string|null
Gets enable_support
getExternalOrgId()  : string|null
Gets external_org_id
getGroupMemberId()  : string|null
Gets group_member_id
getIdType()  : string|null
Gets id_type
getIncludedSeats()  : string|null
Gets included_seats
getIndustry()  : string|null
Gets industry
getModelName()  : string
The original name of the model.
getPlanStartMonth()  : string|null
Gets plan_start_month
getPromoCode()  : string|null
Gets promo_code
getPublisherId()  : string|null
Gets publisher_id
getReferralCode()  : string|null
Gets referral_code
getReferrerName()  : string|null
Gets referrer_name
getSaleDiscountAmount()  : string|null
Gets sale_discount_amount
getSaleDiscountFixedAmount()  : string|null
Gets sale_discount_fixed_amount
getSaleDiscountPercent()  : string|null
Gets sale_discount_percent
getSaleDiscountPeriods()  : string|null
Gets sale_discount_periods
getSaleDiscountSeatPriceOverride()  : string|null
Gets sale_discount_seat_price_override
getShopperId()  : string|null
Gets shopper_id
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.
setAdvertisementId()  : $this
Sets advertisement_id
setEnableSupport()  : $this
Sets enable_support
setExternalOrgId()  : $this
Sets external_org_id
setGroupMemberId()  : $this
Sets group_member_id
setIdType()  : $this
Sets id_type
setIncludedSeats()  : $this
Sets included_seats
setIndustry()  : $this
Sets industry
setPlanStartMonth()  : $this
Sets plan_start_month
setPromoCode()  : $this
Sets promo_code
setPublisherId()  : $this
Sets publisher_id
setReferralCode()  : $this
Sets referral_code
setReferrerName()  : $this
Sets referrer_name
setSaleDiscountAmount()  : $this
Sets sale_discount_amount
setSaleDiscountFixedAmount()  : $this
Sets sale_discount_fixed_amount
setSaleDiscountPercent()  : $this
Sets sale_discount_percent
setSaleDiscountPeriods()  : $this
Sets sale_discount_periods
setSaleDiscountSeatPriceOverride()  : $this
Sets sale_discount_seat_price_override
setShopperId()  : $this
Sets shopper_id
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 = ['advertisement_id' => 'advertisementId', 'enable_support' => 'enableSupport', 'external_org_id' => 'externalOrgId', 'group_member_id' => 'groupMemberId', 'id_type' => 'idType', 'included_seats' => 'includedSeats', 'industry' => 'industry', 'plan_start_month' => 'planStartMonth', 'promo_code' => 'promoCode', 'publisher_id' => 'publisherId', 'referral_code' => 'referralCode', 'referrer_name' => 'referrerName', 'sale_discount_amount' => 'saleDiscountAmount', 'sale_discount_fixed_amount' => 'saleDiscountFixedAmount', 'sale_discount_percent' => 'saleDiscountPercent', 'sale_discount_periods' => 'saleDiscountPeriods', 'sale_discount_seat_price_override' => 'saleDiscountSeatPriceOverride', 'shopper_id' => 'shopperId']

$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 = ['advertisement_id' => 'getAdvertisementId', 'enable_support' => 'getEnableSupport', 'external_org_id' => 'getExternalOrgId', 'group_member_id' => 'getGroupMemberId', 'id_type' => 'getIdType', 'included_seats' => 'getIncludedSeats', 'industry' => 'getIndustry', 'plan_start_month' => 'getPlanStartMonth', 'promo_code' => 'getPromoCode', 'publisher_id' => 'getPublisherId', 'referral_code' => 'getReferralCode', 'referrer_name' => 'getReferrerName', 'sale_discount_amount' => 'getSaleDiscountAmount', 'sale_discount_fixed_amount' => 'getSaleDiscountFixedAmount', 'sale_discount_percent' => 'getSaleDiscountPercent', 'sale_discount_periods' => 'getSaleDiscountPeriods', 'sale_discount_seat_price_override' => 'getSaleDiscountSeatPriceOverride', 'shopper_id' => 'getShopperId']

$setters

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

protected static array<string|int, string> $setters = ['advertisement_id' => 'setAdvertisementId', 'enable_support' => 'setEnableSupport', 'external_org_id' => 'setExternalOrgId', 'group_member_id' => 'setGroupMemberId', 'id_type' => 'setIdType', 'included_seats' => 'setIncludedSeats', 'industry' => 'setIndustry', 'plan_start_month' => 'setPlanStartMonth', 'promo_code' => 'setPromoCode', 'publisher_id' => 'setPublisherId', 'referral_code' => 'setReferralCode', 'referrer_name' => 'setReferrerName', 'sale_discount_amount' => 'setSaleDiscountAmount', 'sale_discount_fixed_amount' => 'setSaleDiscountFixedAmount', 'sale_discount_percent' => 'setSaleDiscountPercent', 'sale_discount_periods' => 'setSaleDiscountPeriods', 'sale_discount_seat_price_override' => 'setSaleDiscountSeatPriceOverride', 'shopper_id' => 'setShopperId']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['advertisement_id' => null, 'enable_support' => null, 'external_org_id' => null, 'group_member_id' => null, 'id_type' => null, 'included_seats' => null, 'industry' => null, 'plan_start_month' => null, 'promo_code' => null, 'publisher_id' => null, 'referral_code' => null, 'referrer_name' => null, 'sale_discount_amount' => null, 'sale_discount_fixed_amount' => null, 'sale_discount_percent' => null, 'sale_discount_periods' => null, 'sale_discount_seat_price_override' => null, 'shopper_id' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'referralInformation'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['advertisement_id' => '?string', 'enable_support' => '?string', 'external_org_id' => '?string', 'group_member_id' => '?string', 'id_type' => '?string', 'included_seats' => '?string', 'industry' => '?string', 'plan_start_month' => '?string', 'promo_code' => '?string', 'publisher_id' => '?string', 'referral_code' => '?string', 'referrer_name' => '?string', 'sale_discount_amount' => '?string', 'sale_discount_fixed_amount' => '?string', 'sale_discount_percent' => '?string', 'sale_discount_periods' => '?string', 'sale_discount_seat_price_override' => '?string', 'shopper_id' => '?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> —

getAdvertisementId()

Gets advertisement_id

public getAdvertisementId() : string|null
Return values
string|null —

getEnableSupport()

Gets enable_support

public getEnableSupport() : string|null
Return values
string|null —

getExternalOrgId()

Gets external_org_id

public getExternalOrgId() : string|null
Return values
string|null —

getGroupMemberId()

Gets group_member_id

public getGroupMemberId() : string|null
Return values
string|null —

getIdType()

Gets id_type

public getIdType() : string|null
Return values
string|null —

getIncludedSeats()

Gets included_seats

public getIncludedSeats() : string|null
Return values
string|null —

getIndustry()

Gets industry

public getIndustry() : string|null
Return values
string|null —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getPlanStartMonth()

Gets plan_start_month

public getPlanStartMonth() : string|null
Return values
string|null —

getPromoCode()

Gets promo_code

public getPromoCode() : string|null
Return values
string|null —

getPublisherId()

Gets publisher_id

public getPublisherId() : string|null
Return values
string|null —

getReferralCode()

Gets referral_code

public getReferralCode() : string|null
Return values
string|null —

getReferrerName()

Gets referrer_name

public getReferrerName() : string|null
Return values
string|null —

getSaleDiscountAmount()

Gets sale_discount_amount

public getSaleDiscountAmount() : string|null
Return values
string|null —

getSaleDiscountFixedAmount()

Gets sale_discount_fixed_amount

public getSaleDiscountFixedAmount() : string|null
Return values
string|null —

getSaleDiscountPercent()

Gets sale_discount_percent

public getSaleDiscountPercent() : string|null
Return values
string|null —

getSaleDiscountPeriods()

Gets sale_discount_periods

public getSaleDiscountPeriods() : string|null
Return values
string|null —

getSaleDiscountSeatPriceOverride()

Gets sale_discount_seat_price_override

public getSaleDiscountSeatPriceOverride() : string|null
Return values
string|null —

getShopperId()

Gets shopper_id

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

setAdvertisementId()

Sets advertisement_id

public setAdvertisementId(string|null $advertisement_id) : $this
Parameters
$advertisement_id : string|null

A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry. ###### Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only.

Return values
$this —

setEnableSupport()

Sets enable_support

public setEnableSupport(string|null $enable_support) : $this
Parameters
$enable_support : string|null

When set to true, then customer support is provided as part of the account plan.

Return values
$this —

setExternalOrgId()

Sets external_org_id

public setExternalOrgId(string|null $external_org_id) : $this
Parameters
$external_org_id : string|null
Return values
$this —

setGroupMemberId()

Sets group_member_id

public setGroupMemberId(string|null $group_member_id) : $this
Parameters
$group_member_id : string|null
Return values
$this —

setIdType()

Sets id_type

public setIdType(string|null $id_type) : $this
Parameters
$id_type : string|null
Return values
$this —

setIncludedSeats()

Sets included_seats

public setIncludedSeats(string|null $included_seats) : $this
Parameters
$included_seats : string|null

The number of seats (users) included.

Return values
$this —

setIndustry()

Sets industry

public setIndustry(string|null $industry) : $this
Parameters
$industry : string|null
Return values
$this —

setPlanStartMonth()

Sets plan_start_month

public setPlanStartMonth(string|null $plan_start_month) : $this
Parameters
$plan_start_month : string|null
Return values
$this —

setPromoCode()

Sets promo_code

public setPromoCode(string|null $promo_code) : $this
Parameters
$promo_code : string|null
Return values
$this —

setPublisherId()

Sets publisher_id

public setPublisherId(string|null $publisher_id) : $this
Parameters
$publisher_id : string|null
Return values
$this —

setReferralCode()

Sets referral_code

public setReferralCode(string|null $referral_code) : $this
Parameters
$referral_code : string|null
Return values
$this —

setReferrerName()

Sets referrer_name

public setReferrerName(string|null $referrer_name) : $this
Parameters
$referrer_name : string|null
Return values
$this —

setSaleDiscountAmount()

Sets sale_discount_amount

public setSaleDiscountAmount(string|null $sale_discount_amount) : $this
Parameters
$sale_discount_amount : string|null

Reserved for DocuSign use only.

Return values
$this —

setSaleDiscountFixedAmount()

Sets sale_discount_fixed_amount

public setSaleDiscountFixedAmount(string|null $sale_discount_fixed_amount) : $this
Parameters
$sale_discount_fixed_amount : string|null

Reserved for DocuSign use only.

Return values
$this —

setSaleDiscountPercent()

Sets sale_discount_percent

public setSaleDiscountPercent(string|null $sale_discount_percent) : $this
Parameters
$sale_discount_percent : string|null

Reserved for DocuSign use only.

Return values
$this —

setSaleDiscountPeriods()

Sets sale_discount_periods

public setSaleDiscountPeriods(string|null $sale_discount_periods) : $this
Parameters
$sale_discount_periods : string|null

Reserved for DocuSign use only.

Return values
$this —

setSaleDiscountSeatPriceOverride()

Sets sale_discount_seat_price_override

public setSaleDiscountSeatPriceOverride(string|null $sale_discount_seat_price_override) : $this
Parameters
$sale_discount_seat_price_override : string|null

Reserved for DocuSign use only.

Return values
$this —

setShopperId()

Sets shopper_id

public setShopperId(string|null $shopper_id) : $this
Parameters
$shopper_id : 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> —

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