model/EnvelopePurgeConfiguration.js

  1. /**
  2.  * Docusign eSignature REST API
  3.  * The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
  4.  *
  5.  * OpenAPI spec version: v2.1
  6.  * Contact: devcenter@docusign.com
  7.  *
  8.  * NOTE: This class is auto generated. Do not edit the class manually and submit a new issue instead.
  9.  *
  10.  */
  12. (function(root, factory) {
  13.   if (typeof define === 'function' && define.amd) {
  14.     // AMD. Register as an anonymous module.
  15.     define(['ApiClient'], factory);
  16.   } else if (typeof module === 'object' && module.exports) {
  17.     // CommonJS-like environments that support module.exports, like Node.
  18.     module.exports = factory(require('../ApiClient'));
  19.   } else {
  20.     // Browser globals (root is window)
  21.     if (!root.Docusign) {
  22.       root.Docusign = {};
  23.     }
  24.     root.Docusign.EnvelopePurgeConfiguration = factory(root.Docusign.ApiClient);
  25.   }
  26. }(this, function(ApiClient) {
  27.   'use strict';
  30.   /**
  31.    * The EnvelopePurgeConfiguration model module.
  32.    * @module model/EnvelopePurgeConfiguration
  33.    */
  35.   /**
  36.    * Constructs a new <code>EnvelopePurgeConfiguration</code>.
  37.    * Contains information about the current envelope purge configuration for an account, which enables account administrators to purge documents from completed and voided envelopes after a set number of days (`retentionDays`). 
  38.    * @alias module:model/EnvelopePurgeConfiguration
  39.    * @class
  40.    */
  41.   var exports = function() {
  42.     var _this = this;
  45.   };
  47.   /**
  48.    * Constructs a <code>EnvelopePurgeConfiguration</code> from a plain JavaScript object, optionally creating a new instance.
  49.    * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
  50.    * @param {Object} data The plain JavaScript object bearing properties of interest.
  51.    * @param {module:model/EnvelopePurgeConfiguration} obj Optional instance to populate.
  52.    * @return {module:model/EnvelopePurgeConfiguration} The populated <code>EnvelopePurgeConfiguration</code> instance.
  53.    */
  54.   exports.constructFromObject = function(data, obj) {
  55.     if (data) {
  56.       obj = obj || new exports();
  58.       if (data.hasOwnProperty('purgeEnvelopes')) {
  59.         obj['purgeEnvelopes'] = ApiClient.convertToType(data['purgeEnvelopes'], 'String');
  60.       }
  61.       if (data.hasOwnProperty('redactPII')) {
  62.         obj['redactPII'] = ApiClient.convertToType(data['redactPII'], 'String');
  63.       }
  64.       if (data.hasOwnProperty('removeTabsAndEnvelopeAttachments')) {
  65.         obj['removeTabsAndEnvelopeAttachments'] = ApiClient.convertToType(data['removeTabsAndEnvelopeAttachments'], 'String');
  66.       }
  67.       if (data.hasOwnProperty('retentionDays')) {
  68.         obj['retentionDays'] = ApiClient.convertToType(data['retentionDays'], 'String');
  69.       }
  70.     }
  71.     return obj;
  72.   }
  74.   /**
  75.    * 
  76.    * @member {String} purgeEnvelopes
  77.    */
  78.   exports.prototype['purgeEnvelopes'] = undefined;
  79.   /**
  80.    * 
  81.    * @member {String} redactPII
  82.    */
  83.   exports.prototype['redactPII'] = undefined;
  84.   /**
  85.    * 
  86.    * @member {String} removeTabsAndEnvelopeAttachments
  87.    */
  88.   exports.prototype['removeTabsAndEnvelopeAttachments'] = undefined;
  89.   /**
  90.    * 
  91.    * @member {String} retentionDays
  92.    */
  93.   exports.prototype['retentionDays'] = undefined;
  97.   return exports;
  98. }));