Package com.hellosign.openapi.model
Class SubWhiteLabelingOptions
- java.lang.Object
-
- com.hellosign.openapi.model.SubWhiteLabelingOptions
-
@Generated("org.openapitools.codegen.languages.JavaClientCodegen") public class SubWhiteLabelingOptions extends java.lang.ObjectAn array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans) Take a look at our [white labeling guide](/api/reference/white-labeling/) to learn more.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classSubWhiteLabelingOptions.LegalVersionEnumGets or Sets legalVersion
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringJSON_PROPERTY_HEADER_BACKGROUND_COLORstatic java.lang.StringJSON_PROPERTY_LEGAL_VERSIONstatic java.lang.StringJSON_PROPERTY_LINK_COLORstatic java.lang.StringJSON_PROPERTY_PAGE_BACKGROUND_COLORstatic java.lang.StringJSON_PROPERTY_PRIMARY_BUTTON_COLORstatic java.lang.StringJSON_PROPERTY_PRIMARY_BUTTON_COLOR_HOVERstatic java.lang.StringJSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLORstatic java.lang.StringJSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR_HOVERstatic java.lang.StringJSON_PROPERTY_RESET_TO_DEFAULTstatic java.lang.StringJSON_PROPERTY_SECONDARY_BUTTON_COLORstatic java.lang.StringJSON_PROPERTY_SECONDARY_BUTTON_COLOR_HOVERstatic java.lang.StringJSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLORstatic java.lang.StringJSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR_HOVERstatic java.lang.StringJSON_PROPERTY_TEXT_COLOR1static java.lang.StringJSON_PROPERTY_TEXT_COLOR2
-
Constructor Summary
Constructors Constructor Description SubWhiteLabelingOptions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Map<java.lang.String,java.lang.Object>createFormData()booleanequals(java.lang.Object o)Return true if this SubWhiteLabelingOptions object is equal to o.java.lang.StringgetHeaderBackgroundColor()Get headerBackgroundColorSubWhiteLabelingOptions.LegalVersionEnumgetLegalVersion()Get legalVersionjava.lang.StringgetLinkColor()Get linkColorjava.lang.StringgetPageBackgroundColor()Get pageBackgroundColorjava.lang.StringgetPrimaryButtonColor()Get primaryButtonColorjava.lang.StringgetPrimaryButtonColorHover()Get primaryButtonColorHoverjava.lang.StringgetPrimaryButtonTextColor()Get primaryButtonTextColorjava.lang.StringgetPrimaryButtonTextColorHover()Get primaryButtonTextColorHoverjava.lang.BooleangetResetToDefault()Resets white labeling options to defaults.java.lang.StringgetSecondaryButtonColor()Get secondaryButtonColorjava.lang.StringgetSecondaryButtonColorHover()Get secondaryButtonColorHoverjava.lang.StringgetSecondaryButtonTextColor()Get secondaryButtonTextColorjava.lang.StringgetSecondaryButtonTextColorHover()Get secondaryButtonTextColorHoverjava.lang.StringgetTextColor1()Get textColor1java.lang.StringgetTextColor2()Get textColor2inthashCode()SubWhiteLabelingOptionsheaderBackgroundColor(java.lang.String headerBackgroundColor)SubWhiteLabelingOptionslegalVersion(SubWhiteLabelingOptions.LegalVersionEnum legalVersion)SubWhiteLabelingOptionslinkColor(java.lang.String linkColor)SubWhiteLabelingOptionspageBackgroundColor(java.lang.String pageBackgroundColor)SubWhiteLabelingOptionsprimaryButtonColor(java.lang.String primaryButtonColor)SubWhiteLabelingOptionsprimaryButtonColorHover(java.lang.String primaryButtonColorHover)SubWhiteLabelingOptionsprimaryButtonTextColor(java.lang.String primaryButtonTextColor)SubWhiteLabelingOptionsprimaryButtonTextColorHover(java.lang.String primaryButtonTextColorHover)SubWhiteLabelingOptionsresetToDefault(java.lang.Boolean resetToDefault)SubWhiteLabelingOptionssecondaryButtonColor(java.lang.String secondaryButtonColor)SubWhiteLabelingOptionssecondaryButtonColorHover(java.lang.String secondaryButtonColorHover)SubWhiteLabelingOptionssecondaryButtonTextColor(java.lang.String secondaryButtonTextColor)SubWhiteLabelingOptionssecondaryButtonTextColorHover(java.lang.String secondaryButtonTextColorHover)voidsetHeaderBackgroundColor(java.lang.String headerBackgroundColor)voidsetLegalVersion(SubWhiteLabelingOptions.LegalVersionEnum legalVersion)voidsetLinkColor(java.lang.String linkColor)voidsetPageBackgroundColor(java.lang.String pageBackgroundColor)voidsetPrimaryButtonColor(java.lang.String primaryButtonColor)voidsetPrimaryButtonColorHover(java.lang.String primaryButtonColorHover)voidsetPrimaryButtonTextColor(java.lang.String primaryButtonTextColor)voidsetPrimaryButtonTextColorHover(java.lang.String primaryButtonTextColorHover)voidsetResetToDefault(java.lang.Boolean resetToDefault)voidsetSecondaryButtonColor(java.lang.String secondaryButtonColor)voidsetSecondaryButtonColorHover(java.lang.String secondaryButtonColorHover)voidsetSecondaryButtonTextColor(java.lang.String secondaryButtonTextColor)voidsetSecondaryButtonTextColorHover(java.lang.String secondaryButtonTextColorHover)voidsetTextColor1(java.lang.String textColor1)voidsetTextColor2(java.lang.String textColor2)SubWhiteLabelingOptionstextColor1(java.lang.String textColor1)SubWhiteLabelingOptionstextColor2(java.lang.String textColor2)java.lang.StringtoString()
-
-
-
Field Detail
-
JSON_PROPERTY_HEADER_BACKGROUND_COLOR
public static final java.lang.String JSON_PROPERTY_HEADER_BACKGROUND_COLOR
- See Also:
- Constant Field Values
-
JSON_PROPERTY_LEGAL_VERSION
public static final java.lang.String JSON_PROPERTY_LEGAL_VERSION
- See Also:
- Constant Field Values
-
JSON_PROPERTY_LINK_COLOR
public static final java.lang.String JSON_PROPERTY_LINK_COLOR
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PAGE_BACKGROUND_COLOR
public static final java.lang.String JSON_PROPERTY_PAGE_BACKGROUND_COLOR
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PRIMARY_BUTTON_COLOR
public static final java.lang.String JSON_PROPERTY_PRIMARY_BUTTON_COLOR
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PRIMARY_BUTTON_COLOR_HOVER
public static final java.lang.String JSON_PROPERTY_PRIMARY_BUTTON_COLOR_HOVER
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR
public static final java.lang.String JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR_HOVER
public static final java.lang.String JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR_HOVER
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SECONDARY_BUTTON_COLOR
public static final java.lang.String JSON_PROPERTY_SECONDARY_BUTTON_COLOR
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SECONDARY_BUTTON_COLOR_HOVER
public static final java.lang.String JSON_PROPERTY_SECONDARY_BUTTON_COLOR_HOVER
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR
public static final java.lang.String JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR_HOVER
public static final java.lang.String JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR_HOVER
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TEXT_COLOR1
public static final java.lang.String JSON_PROPERTY_TEXT_COLOR1
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TEXT_COLOR2
public static final java.lang.String JSON_PROPERTY_TEXT_COLOR2
- See Also:
- Constant Field Values
-
JSON_PROPERTY_RESET_TO_DEFAULT
public static final java.lang.String JSON_PROPERTY_RESET_TO_DEFAULT
- See Also:
- Constant Field Values
-
-
Method Detail
-
headerBackgroundColor
public SubWhiteLabelingOptions headerBackgroundColor(java.lang.String headerBackgroundColor)
-
getHeaderBackgroundColor
@Nullable public java.lang.String getHeaderBackgroundColor()
Get headerBackgroundColor- Returns:
- headerBackgroundColor
-
setHeaderBackgroundColor
public void setHeaderBackgroundColor(java.lang.String headerBackgroundColor)
-
legalVersion
public SubWhiteLabelingOptions legalVersion(SubWhiteLabelingOptions.LegalVersionEnum legalVersion)
-
getLegalVersion
@Nullable public SubWhiteLabelingOptions.LegalVersionEnum getLegalVersion()
Get legalVersion- Returns:
- legalVersion
-
setLegalVersion
public void setLegalVersion(SubWhiteLabelingOptions.LegalVersionEnum legalVersion)
-
linkColor
public SubWhiteLabelingOptions linkColor(java.lang.String linkColor)
-
getLinkColor
@Nullable public java.lang.String getLinkColor()
Get linkColor- Returns:
- linkColor
-
setLinkColor
public void setLinkColor(java.lang.String linkColor)
-
pageBackgroundColor
public SubWhiteLabelingOptions pageBackgroundColor(java.lang.String pageBackgroundColor)
-
getPageBackgroundColor
@Nullable public java.lang.String getPageBackgroundColor()
Get pageBackgroundColor- Returns:
- pageBackgroundColor
-
setPageBackgroundColor
public void setPageBackgroundColor(java.lang.String pageBackgroundColor)
-
primaryButtonColor
public SubWhiteLabelingOptions primaryButtonColor(java.lang.String primaryButtonColor)
-
getPrimaryButtonColor
@Nullable public java.lang.String getPrimaryButtonColor()
Get primaryButtonColor- Returns:
- primaryButtonColor
-
setPrimaryButtonColor
public void setPrimaryButtonColor(java.lang.String primaryButtonColor)
-
primaryButtonColorHover
public SubWhiteLabelingOptions primaryButtonColorHover(java.lang.String primaryButtonColorHover)
-
getPrimaryButtonColorHover
@Nullable public java.lang.String getPrimaryButtonColorHover()
Get primaryButtonColorHover- Returns:
- primaryButtonColorHover
-
setPrimaryButtonColorHover
public void setPrimaryButtonColorHover(java.lang.String primaryButtonColorHover)
-
primaryButtonTextColor
public SubWhiteLabelingOptions primaryButtonTextColor(java.lang.String primaryButtonTextColor)
-
getPrimaryButtonTextColor
@Nullable public java.lang.String getPrimaryButtonTextColor()
Get primaryButtonTextColor- Returns:
- primaryButtonTextColor
-
setPrimaryButtonTextColor
public void setPrimaryButtonTextColor(java.lang.String primaryButtonTextColor)
-
primaryButtonTextColorHover
public SubWhiteLabelingOptions primaryButtonTextColorHover(java.lang.String primaryButtonTextColorHover)
-
getPrimaryButtonTextColorHover
@Nullable public java.lang.String getPrimaryButtonTextColorHover()
Get primaryButtonTextColorHover- Returns:
- primaryButtonTextColorHover
-
setPrimaryButtonTextColorHover
public void setPrimaryButtonTextColorHover(java.lang.String primaryButtonTextColorHover)
-
secondaryButtonColor
public SubWhiteLabelingOptions secondaryButtonColor(java.lang.String secondaryButtonColor)
-
getSecondaryButtonColor
@Nullable public java.lang.String getSecondaryButtonColor()
Get secondaryButtonColor- Returns:
- secondaryButtonColor
-
setSecondaryButtonColor
public void setSecondaryButtonColor(java.lang.String secondaryButtonColor)
-
secondaryButtonColorHover
public SubWhiteLabelingOptions secondaryButtonColorHover(java.lang.String secondaryButtonColorHover)
-
getSecondaryButtonColorHover
@Nullable public java.lang.String getSecondaryButtonColorHover()
Get secondaryButtonColorHover- Returns:
- secondaryButtonColorHover
-
setSecondaryButtonColorHover
public void setSecondaryButtonColorHover(java.lang.String secondaryButtonColorHover)
-
secondaryButtonTextColor
public SubWhiteLabelingOptions secondaryButtonTextColor(java.lang.String secondaryButtonTextColor)
-
getSecondaryButtonTextColor
@Nullable public java.lang.String getSecondaryButtonTextColor()
Get secondaryButtonTextColor- Returns:
- secondaryButtonTextColor
-
setSecondaryButtonTextColor
public void setSecondaryButtonTextColor(java.lang.String secondaryButtonTextColor)
-
secondaryButtonTextColorHover
public SubWhiteLabelingOptions secondaryButtonTextColorHover(java.lang.String secondaryButtonTextColorHover)
-
getSecondaryButtonTextColorHover
@Nullable public java.lang.String getSecondaryButtonTextColorHover()
Get secondaryButtonTextColorHover- Returns:
- secondaryButtonTextColorHover
-
setSecondaryButtonTextColorHover
public void setSecondaryButtonTextColorHover(java.lang.String secondaryButtonTextColorHover)
-
textColor1
public SubWhiteLabelingOptions textColor1(java.lang.String textColor1)
-
getTextColor1
@Nullable public java.lang.String getTextColor1()
Get textColor1- Returns:
- textColor1
-
setTextColor1
public void setTextColor1(java.lang.String textColor1)
-
textColor2
public SubWhiteLabelingOptions textColor2(java.lang.String textColor2)
-
getTextColor2
@Nullable public java.lang.String getTextColor2()
Get textColor2- Returns:
- textColor2
-
setTextColor2
public void setTextColor2(java.lang.String textColor2)
-
resetToDefault
public SubWhiteLabelingOptions resetToDefault(java.lang.Boolean resetToDefault)
-
getResetToDefault
@Nullable public java.lang.Boolean getResetToDefault()
Resets white labeling options to defaults. Only useful when updating an API App.- Returns:
- resetToDefault
-
setResetToDefault
public void setResetToDefault(java.lang.Boolean resetToDefault)
-
equals
public boolean equals(java.lang.Object o)
Return true if this SubWhiteLabelingOptions object is equal to o.- Overrides:
equalsin classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
createFormData
public java.util.Map<java.lang.String,java.lang.Object> createFormData() throws ApiException- Throws:
ApiException
-
-