/**
* DocuSign REST API
* The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
*
* OpenAPI spec version: v2.1
* Contact: devcenter@docusign.com
*
* NOTE: This class is auto generated. Do not edit the class manually and submit a new issue instead.
*
*/
(function(root, factory) {
if (typeof define === 'function' && define.amd) {
// AMD. Register as an anonymous module.
define(['ApiClient', 'model/ErrorDetails', 'model/PropertyMetadata'], factory);
} else if (typeof module === 'object' && module.exports) {
// CommonJS-like environments that support module.exports, like Node.
module.exports = factory(require('../ApiClient'), require('./ErrorDetails'), require('./PropertyMetadata'));
} else {
// Browser globals (root is window)
if (!root.Docusign) {
root.Docusign = {};
}
root.Docusign.Radio = factory(root.Docusign.ApiClient, root.Docusign.ErrorDetails, root.Docusign.PropertyMetadata);
}
}(this, function(ApiClient, ErrorDetails, PropertyMetadata) {
'use strict';
/**
* The Radio model module.
* @module model/Radio
*/
/**
* Constructs a new <code>Radio</code>.
* One of the selectable radio buttons in the `radios` property of a [`radioGroup`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) tab.
* @alias module:model/Radio
* @class
*/
var exports = function() {
var _this = this;
};
/**
* Constructs a <code>Radio</code> from a plain JavaScript object, optionally creating a new instance.
* Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
* @param {Object} data The plain JavaScript object bearing properties of interest.
* @param {module:model/Radio} obj Optional instance to populate.
* @return {module:model/Radio} The populated <code>Radio</code> instance.
*/
exports.constructFromObject = function(data, obj) {
if (data) {
obj = obj || new exports();
if (data.hasOwnProperty('anchorAllowWhiteSpaceInCharacters')) {
obj['anchorAllowWhiteSpaceInCharacters'] = ApiClient.convertToType(data['anchorAllowWhiteSpaceInCharacters'], 'String');
}
if (data.hasOwnProperty('anchorAllowWhiteSpaceInCharactersMetadata')) {
obj['anchorAllowWhiteSpaceInCharactersMetadata'] = PropertyMetadata.constructFromObject(data['anchorAllowWhiteSpaceInCharactersMetadata']);
}
if (data.hasOwnProperty('anchorCaseSensitive')) {
obj['anchorCaseSensitive'] = ApiClient.convertToType(data['anchorCaseSensitive'], 'String');
}
if (data.hasOwnProperty('anchorCaseSensitiveMetadata')) {
obj['anchorCaseSensitiveMetadata'] = PropertyMetadata.constructFromObject(data['anchorCaseSensitiveMetadata']);
}
if (data.hasOwnProperty('anchorHorizontalAlignment')) {
obj['anchorHorizontalAlignment'] = ApiClient.convertToType(data['anchorHorizontalAlignment'], 'String');
}
if (data.hasOwnProperty('anchorHorizontalAlignmentMetadata')) {
obj['anchorHorizontalAlignmentMetadata'] = PropertyMetadata.constructFromObject(data['anchorHorizontalAlignmentMetadata']);
}
if (data.hasOwnProperty('anchorIgnoreIfNotPresent')) {
obj['anchorIgnoreIfNotPresent'] = ApiClient.convertToType(data['anchorIgnoreIfNotPresent'], 'String');
}
if (data.hasOwnProperty('anchorIgnoreIfNotPresentMetadata')) {
obj['anchorIgnoreIfNotPresentMetadata'] = PropertyMetadata.constructFromObject(data['anchorIgnoreIfNotPresentMetadata']);
}
if (data.hasOwnProperty('anchorMatchWholeWord')) {
obj['anchorMatchWholeWord'] = ApiClient.convertToType(data['anchorMatchWholeWord'], 'String');
}
if (data.hasOwnProperty('anchorMatchWholeWordMetadata')) {
obj['anchorMatchWholeWordMetadata'] = PropertyMetadata.constructFromObject(data['anchorMatchWholeWordMetadata']);
}
if (data.hasOwnProperty('anchorString')) {
obj['anchorString'] = ApiClient.convertToType(data['anchorString'], 'String');
}
if (data.hasOwnProperty('anchorStringMetadata')) {
obj['anchorStringMetadata'] = PropertyMetadata.constructFromObject(data['anchorStringMetadata']);
}
if (data.hasOwnProperty('anchorTabProcessorVersion')) {
obj['anchorTabProcessorVersion'] = ApiClient.convertToType(data['anchorTabProcessorVersion'], 'String');
}
if (data.hasOwnProperty('anchorTabProcessorVersionMetadata')) {
obj['anchorTabProcessorVersionMetadata'] = PropertyMetadata.constructFromObject(data['anchorTabProcessorVersionMetadata']);
}
if (data.hasOwnProperty('anchorUnits')) {
obj['anchorUnits'] = ApiClient.convertToType(data['anchorUnits'], 'String');
}
if (data.hasOwnProperty('anchorUnitsMetadata')) {
obj['anchorUnitsMetadata'] = PropertyMetadata.constructFromObject(data['anchorUnitsMetadata']);
}
if (data.hasOwnProperty('anchorXOffset')) {
obj['anchorXOffset'] = ApiClient.convertToType(data['anchorXOffset'], 'String');
}
if (data.hasOwnProperty('anchorXOffsetMetadata')) {
obj['anchorXOffsetMetadata'] = PropertyMetadata.constructFromObject(data['anchorXOffsetMetadata']);
}
if (data.hasOwnProperty('anchorYOffset')) {
obj['anchorYOffset'] = ApiClient.convertToType(data['anchorYOffset'], 'String');
}
if (data.hasOwnProperty('anchorYOffsetMetadata')) {
obj['anchorYOffsetMetadata'] = PropertyMetadata.constructFromObject(data['anchorYOffsetMetadata']);
}
if (data.hasOwnProperty('bold')) {
obj['bold'] = ApiClient.convertToType(data['bold'], 'String');
}
if (data.hasOwnProperty('boldMetadata')) {
obj['boldMetadata'] = PropertyMetadata.constructFromObject(data['boldMetadata']);
}
if (data.hasOwnProperty('caption')) {
obj['caption'] = ApiClient.convertToType(data['caption'], 'String');
}
if (data.hasOwnProperty('captionMetadata')) {
obj['captionMetadata'] = PropertyMetadata.constructFromObject(data['captionMetadata']);
}
if (data.hasOwnProperty('errorDetails')) {
obj['errorDetails'] = ErrorDetails.constructFromObject(data['errorDetails']);
}
if (data.hasOwnProperty('font')) {
obj['font'] = ApiClient.convertToType(data['font'], 'String');
}
if (data.hasOwnProperty('fontColor')) {
obj['fontColor'] = ApiClient.convertToType(data['fontColor'], 'String');
}
if (data.hasOwnProperty('fontColorMetadata')) {
obj['fontColorMetadata'] = PropertyMetadata.constructFromObject(data['fontColorMetadata']);
}
if (data.hasOwnProperty('fontMetadata')) {
obj['fontMetadata'] = PropertyMetadata.constructFromObject(data['fontMetadata']);
}
if (data.hasOwnProperty('fontSize')) {
obj['fontSize'] = ApiClient.convertToType(data['fontSize'], 'String');
}
if (data.hasOwnProperty('fontSizeMetadata')) {
obj['fontSizeMetadata'] = PropertyMetadata.constructFromObject(data['fontSizeMetadata']);
}
if (data.hasOwnProperty('italic')) {
obj['italic'] = ApiClient.convertToType(data['italic'], 'String');
}
if (data.hasOwnProperty('italicMetadata')) {
obj['italicMetadata'] = PropertyMetadata.constructFromObject(data['italicMetadata']);
}
if (data.hasOwnProperty('locked')) {
obj['locked'] = ApiClient.convertToType(data['locked'], 'String');
}
if (data.hasOwnProperty('lockedMetadata')) {
obj['lockedMetadata'] = PropertyMetadata.constructFromObject(data['lockedMetadata']);
}
if (data.hasOwnProperty('mergeFieldXml')) {
obj['mergeFieldXml'] = ApiClient.convertToType(data['mergeFieldXml'], 'String');
}
if (data.hasOwnProperty('pageNumber')) {
obj['pageNumber'] = ApiClient.convertToType(data['pageNumber'], 'String');
}
if (data.hasOwnProperty('pageNumberMetadata')) {
obj['pageNumberMetadata'] = PropertyMetadata.constructFromObject(data['pageNumberMetadata']);
}
if (data.hasOwnProperty('required')) {
obj['required'] = ApiClient.convertToType(data['required'], 'String');
}
if (data.hasOwnProperty('requiredMetadata')) {
obj['requiredMetadata'] = PropertyMetadata.constructFromObject(data['requiredMetadata']);
}
if (data.hasOwnProperty('selected')) {
obj['selected'] = ApiClient.convertToType(data['selected'], 'String');
}
if (data.hasOwnProperty('selectedMetadata')) {
obj['selectedMetadata'] = PropertyMetadata.constructFromObject(data['selectedMetadata']);
}
if (data.hasOwnProperty('status')) {
obj['status'] = ApiClient.convertToType(data['status'], 'String');
}
if (data.hasOwnProperty('statusMetadata')) {
obj['statusMetadata'] = PropertyMetadata.constructFromObject(data['statusMetadata']);
}
if (data.hasOwnProperty('tabId')) {
obj['tabId'] = ApiClient.convertToType(data['tabId'], 'String');
}
if (data.hasOwnProperty('tabIdMetadata')) {
obj['tabIdMetadata'] = PropertyMetadata.constructFromObject(data['tabIdMetadata']);
}
if (data.hasOwnProperty('tabOrder')) {
obj['tabOrder'] = ApiClient.convertToType(data['tabOrder'], 'String');
}
if (data.hasOwnProperty('tabOrderMetadata')) {
obj['tabOrderMetadata'] = PropertyMetadata.constructFromObject(data['tabOrderMetadata']);
}
if (data.hasOwnProperty('underline')) {
obj['underline'] = ApiClient.convertToType(data['underline'], 'String');
}
if (data.hasOwnProperty('underlineMetadata')) {
obj['underlineMetadata'] = PropertyMetadata.constructFromObject(data['underlineMetadata']);
}
if (data.hasOwnProperty('value')) {
obj['value'] = ApiClient.convertToType(data['value'], 'String');
}
if (data.hasOwnProperty('valueMetadata')) {
obj['valueMetadata'] = PropertyMetadata.constructFromObject(data['valueMetadata']);
}
if (data.hasOwnProperty('xPosition')) {
obj['xPosition'] = ApiClient.convertToType(data['xPosition'], 'String');
}
if (data.hasOwnProperty('xPositionMetadata')) {
obj['xPositionMetadata'] = PropertyMetadata.constructFromObject(data['xPositionMetadata']);
}
if (data.hasOwnProperty('yPosition')) {
obj['yPosition'] = ApiClient.convertToType(data['yPosition'], 'String');
}
if (data.hasOwnProperty('yPositionMetadata')) {
obj['yPositionMetadata'] = PropertyMetadata.constructFromObject(data['yPositionMetadata']);
}
}
return obj;
}
/**
*
* @member {String} anchorAllowWhiteSpaceInCharacters
*/
exports.prototype['anchorAllowWhiteSpaceInCharacters'] = undefined;
/**
* Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable.
* @member {module:model/PropertyMetadata} anchorAllowWhiteSpaceInCharactersMetadata
*/
exports.prototype['anchorAllowWhiteSpaceInCharactersMetadata'] = undefined;
/**
* When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.
* @member {String} anchorCaseSensitive
*/
exports.prototype['anchorCaseSensitive'] = undefined;
/**
* Metadata that indicates whether the `anchorCaseSensitive` property is editable.
* @member {module:model/PropertyMetadata} anchorCaseSensitiveMetadata
*/
exports.prototype['anchorCaseSensitiveMetadata'] = undefined;
/**
* Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.
* @member {String} anchorHorizontalAlignment
*/
exports.prototype['anchorHorizontalAlignment'] = undefined;
/**
* Metadata that indicates whether the `anchorHorizontalAlignment` property is editable.
* @member {module:model/PropertyMetadata} anchorHorizontalAlignmentMetadata
*/
exports.prototype['anchorHorizontalAlignmentMetadata'] = undefined;
/**
* When set to **true**, this tab is ignored if anchorString is not found in the document.
* @member {String} anchorIgnoreIfNotPresent
*/
exports.prototype['anchorIgnoreIfNotPresent'] = undefined;
/**
* Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable.
* @member {module:model/PropertyMetadata} anchorIgnoreIfNotPresentMetadata
*/
exports.prototype['anchorIgnoreIfNotPresentMetadata'] = undefined;
/**
* When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.
* @member {String} anchorMatchWholeWord
*/
exports.prototype['anchorMatchWholeWord'] = undefined;
/**
* Metadata that indicates whether the `anchorMatchWholeWord` property is editable.
* @member {module:model/PropertyMetadata} anchorMatchWholeWordMetadata
*/
exports.prototype['anchorMatchWholeWordMetadata'] = undefined;
/**
* Anchor text information for a radio button.
* @member {String} anchorString
*/
exports.prototype['anchorString'] = undefined;
/**
* Metadata that indicates whether the `anchorString` property is editable.
* @member {module:model/PropertyMetadata} anchorStringMetadata
*/
exports.prototype['anchorStringMetadata'] = undefined;
/**
*
* @member {String} anchorTabProcessorVersion
*/
exports.prototype['anchorTabProcessorVersion'] = undefined;
/**
* Reserved for DocuSign.
* @member {module:model/PropertyMetadata} anchorTabProcessorVersionMetadata
*/
exports.prototype['anchorTabProcessorVersionMetadata'] = undefined;
/**
* Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
* @member {String} anchorUnits
*/
exports.prototype['anchorUnits'] = undefined;
/**
* Metadata that indicates whether the `anchorUnits` property is editable.
* @member {module:model/PropertyMetadata} anchorUnitsMetadata
*/
exports.prototype['anchorUnitsMetadata'] = undefined;
/**
* Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
* @member {String} anchorXOffset
*/
exports.prototype['anchorXOffset'] = undefined;
/**
* Metadata that indicates whether the `anchorXOffset` property is editable.
* @member {module:model/PropertyMetadata} anchorXOffsetMetadata
*/
exports.prototype['anchorXOffsetMetadata'] = undefined;
/**
* Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
* @member {String} anchorYOffset
*/
exports.prototype['anchorYOffset'] = undefined;
/**
* Metadata that indicates whether the `anchorYOffset` property is editable.
* @member {module:model/PropertyMetadata} anchorYOffsetMetadata
*/
exports.prototype['anchorYOffsetMetadata'] = undefined;
/**
* When set to **true**, the information in the tab is bold.
* @member {String} bold
*/
exports.prototype['bold'] = undefined;
/**
* Metadata that indicates whether the `bold` property is editable.
* @member {module:model/PropertyMetadata} boldMetadata
*/
exports.prototype['boldMetadata'] = undefined;
/**
*
* @member {String} caption
*/
exports.prototype['caption'] = undefined;
/**
*
* @member {module:model/PropertyMetadata} captionMetadata
*/
exports.prototype['captionMetadata'] = undefined;
/**
* Array or errors.
* @member {module:model/ErrorDetails} errorDetails
*/
exports.prototype['errorDetails'] = undefined;
/**
* The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.
* @member {String} font
*/
exports.prototype['font'] = undefined;
/**
* The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.
* @member {String} fontColor
*/
exports.prototype['fontColor'] = undefined;
/**
* Metadata that indicates whether the `fontColor` property is editable.
* @member {module:model/PropertyMetadata} fontColorMetadata
*/
exports.prototype['fontColorMetadata'] = undefined;
/**
* Metadata that indicates whether the `font` property is editable.
* @member {module:model/PropertyMetadata} fontMetadata
*/
exports.prototype['fontMetadata'] = undefined;
/**
* The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72.
* @member {String} fontSize
*/
exports.prototype['fontSize'] = undefined;
/**
* Metadata that indicates whether the `fontSize` property is editable.
* @member {module:model/PropertyMetadata} fontSizeMetadata
*/
exports.prototype['fontSizeMetadata'] = undefined;
/**
* When set to **true**, the information in the tab is italic.
* @member {String} italic
*/
exports.prototype['italic'] = undefined;
/**
* Metadata that indicates whether the `italic` property is editable.
* @member {module:model/PropertyMetadata} italicMetadata
*/
exports.prototype['italicMetadata'] = undefined;
/**
* When set to **true**, the signer cannot change the data of the custom tab.
* @member {String} locked
*/
exports.prototype['locked'] = undefined;
/**
* Metadata that indicates whether the `locked` property is editable.
* @member {module:model/PropertyMetadata} lockedMetadata
*/
exports.prototype['lockedMetadata'] = undefined;
/**
*
* @member {String} mergeFieldXml
*/
exports.prototype['mergeFieldXml'] = undefined;
/**
* Specifies the page number on which the tab is located.
* @member {String} pageNumber
*/
exports.prototype['pageNumber'] = undefined;
/**
* Metadata that indicates whether the `pageNumber` property is editable.
* @member {module:model/PropertyMetadata} pageNumberMetadata
*/
exports.prototype['pageNumberMetadata'] = undefined;
/**
* When set to **true**, the signer is required to fill out this tab
* @member {String} required
*/
exports.prototype['required'] = undefined;
/**
* Metadata that indicates whether the `required` property is editable.
* @member {module:model/PropertyMetadata} requiredMetadata
*/
exports.prototype['requiredMetadata'] = undefined;
/**
* When set to **true**, the radio button is selected.
* @member {String} selected
*/
exports.prototype['selected'] = undefined;
/**
* Metadata that indicates whether the `selected` property is editable.
* @member {module:model/PropertyMetadata} selectedMetadata
*/
exports.prototype['selectedMetadata'] = undefined;
/**
* Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
* @member {String} status
*/
exports.prototype['status'] = undefined;
/**
* Metadata that indicates whether the `status` property is editable.
* @member {module:model/PropertyMetadata} statusMetadata
*/
exports.prototype['statusMetadata'] = undefined;
/**
* The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
* @member {String} tabId
*/
exports.prototype['tabId'] = undefined;
/**
* Metadata that indicates whether the `tabId` property is editable.
* @member {module:model/PropertyMetadata} tabIdMetadata
*/
exports.prototype['tabIdMetadata'] = undefined;
/**
*
* @member {String} tabOrder
*/
exports.prototype['tabOrder'] = undefined;
/**
* Metadata that indicates whether the `tabOrder` property is editable.
* @member {module:model/PropertyMetadata} tabOrderMetadata
*/
exports.prototype['tabOrderMetadata'] = undefined;
/**
* When set to **true**, the information in the tab is underlined.
* @member {String} underline
*/
exports.prototype['underline'] = undefined;
/**
* Metadata that indicates whether the `underline` property is editable.
* @member {module:model/PropertyMetadata} underlineMetadata
*/
exports.prototype['underlineMetadata'] = undefined;
/**
* Specifies the value of the tab.
* @member {String} value
*/
exports.prototype['value'] = undefined;
/**
* Metadata that indicates whether the `value` property is editable.
* @member {module:model/PropertyMetadata} valueMetadata
*/
exports.prototype['valueMetadata'] = undefined;
/**
* This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
* @member {String} xPosition
*/
exports.prototype['xPosition'] = undefined;
/**
* Metadata that indicates whether the `xPosition` property is editable.
* @member {module:model/PropertyMetadata} xPositionMetadata
*/
exports.prototype['xPositionMetadata'] = undefined;
/**
* This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
* @member {String} yPosition
*/
exports.prototype['yPosition'] = undefined;
/**
* Metadata that indicates whether the `yPosition` property is editable.
* @member {module:model/PropertyMetadata} yPositionMetadata
*/
exports.prototype['yPositionMetadata'] = undefined;
return exports;
}));