Package com.docusign.esign.model

Class ReferralInformation

  • public class ReferralInformation
extends java.lang.Object
    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..

    • Constructor Detail

      • ReferralInformation

        public ReferralInformation()

    • Method Detail

      • advertisementId

        public ReferralInformation advertisementId​(java.lang.String advertisementId)
        advertisementId.
        Returns:
        ReferralInformation

      • getAdvertisementId

        public java.lang.String getAdvertisementId()
        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. .
        Returns:
        advertisementId

      • setAdvertisementId

        public void setAdvertisementId​(java.lang.String advertisementId)
        setAdvertisementId.

      • enableSupport

        public ReferralInformation enableSupport​(java.lang.String enableSupport)
        enableSupport.
        Returns:
        ReferralInformation

      • getEnableSupport

        public java.lang.String getEnableSupport()
        When set to **true**, then customer support is provided as part of the account plan..
        Returns:
        enableSupport

      • setEnableSupport

        public void setEnableSupport​(java.lang.String enableSupport)
        setEnableSupport.

      • externalOrgId

        public ReferralInformation externalOrgId​(java.lang.String externalOrgId)
        externalOrgId.
        Returns:
        ReferralInformation

      • getExternalOrgId

        public java.lang.String getExternalOrgId()
        .
        Returns:
        externalOrgId

      • setExternalOrgId

        public void setExternalOrgId​(java.lang.String externalOrgId)
        setExternalOrgId.

      • groupMemberId

        public ReferralInformation groupMemberId​(java.lang.String groupMemberId)
        groupMemberId.
        Returns:
        ReferralInformation

      • getGroupMemberId

        public java.lang.String getGroupMemberId()
        .
        Returns:
        groupMemberId

      • setGroupMemberId

        public void setGroupMemberId​(java.lang.String groupMemberId)
        setGroupMemberId.

      • idType

        public ReferralInformation idType​(java.lang.String idType)
        idType.
        Returns:
        ReferralInformation

      • getIdType

        public java.lang.String getIdType()
        .
        Returns:
        idType

      • setIdType

        public void setIdType​(java.lang.String idType)
        setIdType.

      • includedSeats

        public ReferralInformation includedSeats​(java.lang.String includedSeats)
        includedSeats.
        Returns:
        ReferralInformation

      • getIncludedSeats

        public java.lang.String getIncludedSeats()
        The number of seats (users) included..
        Returns:
        includedSeats

      • setIncludedSeats

        public void setIncludedSeats​(java.lang.String includedSeats)
        setIncludedSeats.

      • industry

        public ReferralInformation industry​(java.lang.String industry)
        industry.
        Returns:
        ReferralInformation

      • getIndustry

        public java.lang.String getIndustry()
        .
        Returns:
        industry

      • setIndustry

        public void setIndustry​(java.lang.String industry)
        setIndustry.

      • planStartMonth

        public ReferralInformation planStartMonth​(java.lang.String planStartMonth)
        planStartMonth.
        Returns:
        ReferralInformation

      • getPlanStartMonth

        public java.lang.String getPlanStartMonth()
        .
        Returns:
        planStartMonth

      • setPlanStartMonth

        public void setPlanStartMonth​(java.lang.String planStartMonth)
        setPlanStartMonth.

      • promoCode

        public ReferralInformation promoCode​(java.lang.String promoCode)
        promoCode.
        Returns:
        ReferralInformation

      • getPromoCode

        public java.lang.String getPromoCode()
        .
        Returns:
        promoCode

      • setPromoCode

        public void setPromoCode​(java.lang.String promoCode)
        setPromoCode.

      • publisherId

        public ReferralInformation publisherId​(java.lang.String publisherId)
        publisherId.
        Returns:
        ReferralInformation

      • getPublisherId

        public java.lang.String getPublisherId()
        .
        Returns:
        publisherId

      • setPublisherId

        public void setPublisherId​(java.lang.String publisherId)
        setPublisherId.

      • referralCode

        public ReferralInformation referralCode​(java.lang.String referralCode)
        referralCode.
        Returns:
        ReferralInformation

      • getReferralCode

        public java.lang.String getReferralCode()
        .
        Returns:
        referralCode

      • setReferralCode

        public void setReferralCode​(java.lang.String referralCode)
        setReferralCode.

      • referrerName

        public ReferralInformation referrerName​(java.lang.String referrerName)
        referrerName.
        Returns:
        ReferralInformation

      • getReferrerName

        public java.lang.String getReferrerName()
        .
        Returns:
        referrerName

      • setReferrerName

        public void setReferrerName​(java.lang.String referrerName)
        setReferrerName.

      • saleDiscountAmount

        public ReferralInformation saleDiscountAmount​(java.lang.String saleDiscountAmount)
        saleDiscountAmount.
        Returns:
        ReferralInformation

      • getSaleDiscountAmount

        public java.lang.String getSaleDiscountAmount()
        Reserved for DocuSign use only..
        Returns:
        saleDiscountAmount

      • setSaleDiscountAmount

        public void setSaleDiscountAmount​(java.lang.String saleDiscountAmount)
        setSaleDiscountAmount.

      • saleDiscountFixedAmount

        public ReferralInformation saleDiscountFixedAmount​(java.lang.String saleDiscountFixedAmount)
        saleDiscountFixedAmount.
        Returns:
        ReferralInformation

      • getSaleDiscountFixedAmount

        public java.lang.String getSaleDiscountFixedAmount()
        Reserved for DocuSign use only..
        Returns:
        saleDiscountFixedAmount

      • setSaleDiscountFixedAmount

        public void setSaleDiscountFixedAmount​(java.lang.String saleDiscountFixedAmount)
        setSaleDiscountFixedAmount.

      • saleDiscountPercent

        public ReferralInformation saleDiscountPercent​(java.lang.String saleDiscountPercent)
        saleDiscountPercent.
        Returns:
        ReferralInformation

      • getSaleDiscountPercent

        public java.lang.String getSaleDiscountPercent()
        Reserved for DocuSign use only..
        Returns:
        saleDiscountPercent

      • setSaleDiscountPercent

        public void setSaleDiscountPercent​(java.lang.String saleDiscountPercent)
        setSaleDiscountPercent.

      • saleDiscountPeriods

        public ReferralInformation saleDiscountPeriods​(java.lang.String saleDiscountPeriods)
        saleDiscountPeriods.
        Returns:
        ReferralInformation

      • getSaleDiscountPeriods

        public java.lang.String getSaleDiscountPeriods()
        Reserved for DocuSign use only..
        Returns:
        saleDiscountPeriods

      • setSaleDiscountPeriods

        public void setSaleDiscountPeriods​(java.lang.String saleDiscountPeriods)
        setSaleDiscountPeriods.

      • saleDiscountSeatPriceOverride

        public ReferralInformation saleDiscountSeatPriceOverride​(java.lang.String saleDiscountSeatPriceOverride)
        saleDiscountSeatPriceOverride.
        Returns:
        ReferralInformation

      • getSaleDiscountSeatPriceOverride

        public java.lang.String getSaleDiscountSeatPriceOverride()
        Reserved for DocuSign use only..
        Returns:
        saleDiscountSeatPriceOverride

      • setSaleDiscountSeatPriceOverride

        public void setSaleDiscountSeatPriceOverride​(java.lang.String saleDiscountSeatPriceOverride)
        setSaleDiscountSeatPriceOverride.

      • shopperId

        public ReferralInformation shopperId​(java.lang.String shopperId)
        shopperId.
        Returns:
        ReferralInformation

      • getShopperId

        public java.lang.String getShopperId()
        .
        Returns:
        shopperId

      • setShopperId

        public void setShopperId​(java.lang.String shopperId)
        setShopperId.

      • equals

        public boolean equals​(java.lang.Object o)
        Compares objects.
        Overrides:
        equals in class java.lang.Object
        Returns:
        true or false depending on comparison result.

      • hashCode

        public int hashCode()
        Returns the HashCode.
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Converts the given object to string.
        Overrides:
        toString in class java.lang.Object