docusign-esign
Version:
Docusign Node.js API client.
101 lines (86 loc) • 5.99 kB
JavaScript
/**
* Docusign eSignature REST API
* The Docusign eSignature 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/AddressInformationInput', 'model/DobInformationInput', 'model/Ssn4InformationInput', 'model/Ssn9InformationInput'], factory);
} else if (typeof module === 'object' && module.exports) {
// CommonJS-like environments that support module.exports, like Node.
module.exports = factory(require('../ApiClient'), require('./AddressInformationInput'), require('./DobInformationInput'), require('./Ssn4InformationInput'), require('./Ssn9InformationInput'));
} else {
// Browser globals (root is window)
if (!root.Docusign) {
root.Docusign = {};
}
root.Docusign.IdCheckInformationInput = factory(root.Docusign.ApiClient, root.Docusign.AddressInformationInput, root.Docusign.DobInformationInput, root.Docusign.Ssn4InformationInput, root.Docusign.Ssn9InformationInput);
}
}(this, function(ApiClient, AddressInformationInput, DobInformationInput, Ssn4InformationInput, Ssn9InformationInput) {
'use strict';
/**
* The IdCheckInformationInput model module.
* @module model/IdCheckInformationInput
*/
/**
* Constructs a new <code>IdCheckInformationInput</code>.
* A complex element that contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: * addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: * dateOfBirth: Specifies the recipient's date, month and year of birth. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of: * ssn4: Specifies the last four digits of the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: * ssn9: Specifies the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
* @alias module:model/IdCheckInformationInput
* @class
*/
var exports = function() {
var _this = this;
};
/**
* Constructs a <code>IdCheckInformationInput</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/IdCheckInformationInput} obj Optional instance to populate.
* @return {module:model/IdCheckInformationInput} The populated <code>IdCheckInformationInput</code> instance.
*/
exports.constructFromObject = function(data, obj) {
if (data) {
obj = obj || new exports();
if (data.hasOwnProperty('addressInformationInput')) {
obj['addressInformationInput'] = AddressInformationInput.constructFromObject(data['addressInformationInput']);
}
if (data.hasOwnProperty('dobInformationInput')) {
obj['dobInformationInput'] = DobInformationInput.constructFromObject(data['dobInformationInput']);
}
if (data.hasOwnProperty('ssn4InformationInput')) {
obj['ssn4InformationInput'] = Ssn4InformationInput.constructFromObject(data['ssn4InformationInput']);
}
if (data.hasOwnProperty('ssn9InformationInput')) {
obj['ssn9InformationInput'] = Ssn9InformationInput.constructFromObject(data['ssn9InformationInput']);
}
}
return obj;
}
/**
* An object that specifies recipient address information and how it is displayed.
* @member {module:model/AddressInformationInput} addressInformationInput
*/
exports.prototype['addressInformationInput'] = undefined;
/**
* An object that specifies recipient date of birth information and how it is displayed.
* @member {module:model/DobInformationInput} dobInformationInput
*/
exports.prototype['dobInformationInput'] = undefined;
/**
* An object that specifies the last four digits of the recipient's Social Security Number (SSN).
* @member {module:model/Ssn4InformationInput} ssn4InformationInput
*/
exports.prototype['ssn4InformationInput'] = undefined;
/**
* An object that specifies the recipient's Social Security Number (SSN) information. Note that ssn9 information cannot be returned in a response.
* @member {module:model/Ssn9InformationInput} ssn9InformationInput
*/
exports.prototype['ssn9InformationInput'] = undefined;
return exports;
}));