files.com 1.0.247 → 1.0.249

package/lib/models/Bundle.js

@@ -31,201 +31,240 @@ var Bundle = /*#__PURE__*/(0, _createClass2.default)(function Bundle() {
   (0, _defineProperty2.default)(this, "isLoaded", function () {
     return !!_this.attributes.id;
   });
+  // string # Bundle code.  This code forms the end part of the Public URL.
   (0, _defineProperty2.default)(this, "getCode", function () {
     return _this.attributes.code;
   });
   (0, _defineProperty2.default)(this, "setCode", function (value) {
     _this.attributes.code = value;
   });
+  // string # Public URL of Share Link
   (0, _defineProperty2.default)(this, "getUrl", function () {
     return _this.attributes.url;
   });
   (0, _defineProperty2.default)(this, "setUrl", function (value) {
     _this.attributes.url = value;
   });
+  // string # Public description
   (0, _defineProperty2.default)(this, "getDescription", function () {
     return _this.attributes.description;
   });
   (0, _defineProperty2.default)(this, "setDescription", function (value) {
     _this.attributes.description = value;
   });
+  // boolean # Is this bundle password protected?
   (0, _defineProperty2.default)(this, "getPasswordProtected", function () {
     return _this.attributes.password_protected;
   });
   (0, _defineProperty2.default)(this, "setPasswordProtected", function (value) {
     _this.attributes.password_protected = value;
   });
+  // string # Permissions that apply to Folders in this Share Link.
   (0, _defineProperty2.default)(this, "getPermissions", function () {
     return _this.attributes.permissions;
   });
   (0, _defineProperty2.default)(this, "setPermissions", function (value) {
     _this.attributes.permissions = value;
   });
+  // boolean # Restrict users to previewing files only?
   (0, _defineProperty2.default)(this, "getPreviewOnly", function () {
     return _this.attributes.preview_only;
   });
   (0, _defineProperty2.default)(this, "setPreviewOnly", function (value) {
     _this.attributes.preview_only = value;
   });
+  // boolean # Show a registration page that captures the downloader's name and email address?
   (0, _defineProperty2.default)(this, "getRequireRegistration", function () {
     return _this.attributes.require_registration;
   });
   (0, _defineProperty2.default)(this, "setRequireRegistration", function (value) {
     _this.attributes.require_registration = value;
   });
+  // boolean # Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
   (0, _defineProperty2.default)(this, "getRequireShareRecipient", function () {
     return _this.attributes.require_share_recipient;
   });
   (0, _defineProperty2.default)(this, "setRequireShareRecipient", function (value) {
     _this.attributes.require_share_recipient = value;
   });
+  // string # Legal text that must be agreed to prior to accessing Bundle.
   (0, _defineProperty2.default)(this, "getClickwrapBody", function () {
     return _this.attributes.clickwrap_body;
   });
   (0, _defineProperty2.default)(this, "setClickwrapBody", function (value) {
     _this.attributes.clickwrap_body = value;
   });
+  // FormFieldSet # Custom Form to use
   (0, _defineProperty2.default)(this, "getFormFieldSet", function () {
     return _this.attributes.form_field_set;
   });
   (0, _defineProperty2.default)(this, "setFormFieldSet", function (value) {
     _this.attributes.form_field_set = value;
   });
+  // boolean # BundleRegistrations can be saved without providing name?
   (0, _defineProperty2.default)(this, "getSkipName", function () {
     return _this.attributes.skip_name;
   });
   (0, _defineProperty2.default)(this, "setSkipName", function (value) {
     _this.attributes.skip_name = value;
   });
+  // boolean # BundleRegistrations can be saved without providing email?
   (0, _defineProperty2.default)(this, "getSkipEmail", function () {
     return _this.attributes.skip_email;
   });
   (0, _defineProperty2.default)(this, "setSkipEmail", function (value) {
     _this.attributes.skip_email = value;
   });
+  // boolean # BundleRegistrations can be saved without providing company?
   (0, _defineProperty2.default)(this, "getSkipCompany", function () {
     return _this.attributes.skip_company;
   });
   (0, _defineProperty2.default)(this, "setSkipCompany", function (value) {
     _this.attributes.skip_company = value;
   });
+  // int64 # Bundle ID
   (0, _defineProperty2.default)(this, "getId", function () {
     return _this.attributes.id;
   });
   (0, _defineProperty2.default)(this, "setId", function (value) {
     _this.attributes.id = value;
   });
+  // date-time # Bundle created at date/time
   (0, _defineProperty2.default)(this, "getCreatedAt", function () {
     return _this.attributes.created_at;
   });
+  // boolean # Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
   (0, _defineProperty2.default)(this, "getDontSeparateSubmissionsByFolder", function () {
     return _this.attributes.dont_separate_submissions_by_folder;
   });
   (0, _defineProperty2.default)(this, "setDontSeparateSubmissionsByFolder", function (value) {
     _this.attributes.dont_separate_submissions_by_folder = value;
   });
+  // date-time # Bundle expiration date/time
   (0, _defineProperty2.default)(this, "getExpiresAt", function () {
     return _this.attributes.expires_at;
   });
   (0, _defineProperty2.default)(this, "setExpiresAt", function (value) {
     _this.attributes.expires_at = value;
   });
+  // int64 # Maximum number of times bundle can be accessed
   (0, _defineProperty2.default)(this, "getMaxUses", function () {
     return _this.attributes.max_uses;
   });
   (0, _defineProperty2.default)(this, "setMaxUses", function (value) {
     _this.attributes.max_uses = value;
   });
+  // string # Bundle internal note
   (0, _defineProperty2.default)(this, "getNote", function () {
     return _this.attributes.note;
   });
   (0, _defineProperty2.default)(this, "setNote", function (value) {
     _this.attributes.note = value;
   });
+  // string # Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, and any custom form data.
   (0, _defineProperty2.default)(this, "getPathTemplate", function () {
     return _this.attributes.path_template;
   });
   (0, _defineProperty2.default)(this, "setPathTemplate", function (value) {
     _this.attributes.path_template = value;
   });
+  // boolean # Send delivery receipt to the uploader. Note: For writable share only
   (0, _defineProperty2.default)(this, "getSendEmailReceiptToUploader", function () {
     return _this.attributes.send_email_receipt_to_uploader;
   });
   (0, _defineProperty2.default)(this, "setSendEmailReceiptToUploader", function (value) {
     _this.attributes.send_email_receipt_to_uploader = value;
   });
+  // int64 # Bundle creator user ID
   (0, _defineProperty2.default)(this, "getUserId", function () {
     return _this.attributes.user_id;
   });
   (0, _defineProperty2.default)(this, "setUserId", function (value) {
     _this.attributes.user_id = value;
   });
+  // string # Bundle creator username
   (0, _defineProperty2.default)(this, "getUsername", function () {
     return _this.attributes.username;
   });
   (0, _defineProperty2.default)(this, "setUsername", function (value) {
     _this.attributes.username = value;
   });
+  // int64 # ID of the clickwrap to use with this bundle.
   (0, _defineProperty2.default)(this, "getClickwrapId", function () {
     return _this.attributes.clickwrap_id;
   });
   (0, _defineProperty2.default)(this, "setClickwrapId", function (value) {
     _this.attributes.clickwrap_id = value;
   });
+  // int64 # ID of the associated inbox, if available.
   (0, _defineProperty2.default)(this, "getInboxId", function () {
     return _this.attributes.inbox_id;
   });
   (0, _defineProperty2.default)(this, "setInboxId", function (value) {
     _this.attributes.inbox_id = value;
   });
+  // Image # Preview watermark image applied to all bundle items.
   (0, _defineProperty2.default)(this, "getWatermarkAttachment", function () {
     return _this.attributes.watermark_attachment;
   });
   (0, _defineProperty2.default)(this, "setWatermarkAttachment", function (value) {
     _this.attributes.watermark_attachment = value;
   });
+  // object # Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
   (0, _defineProperty2.default)(this, "getWatermarkValue", function () {
     return _this.attributes.watermark_value;
   });
   (0, _defineProperty2.default)(this, "setWatermarkValue", function (value) {
     _this.attributes.watermark_value = value;
   });
+  // boolean # Does this bundle have an associated inbox?
   (0, _defineProperty2.default)(this, "getHasInbox", function () {
     return _this.attributes.has_inbox;
   });
   (0, _defineProperty2.default)(this, "setHasInbox", function (value) {
     _this.attributes.has_inbox = value;
   });
+  // array # A list of paths in this bundle
   (0, _defineProperty2.default)(this, "getPaths", function () {
     return _this.attributes.paths;
   });
   (0, _defineProperty2.default)(this, "setPaths", function (value) {
     _this.attributes.paths = value;
   });
+  // string # Password for this bundle.
   (0, _defineProperty2.default)(this, "getPassword", function () {
     return _this.attributes.password;
   });
   (0, _defineProperty2.default)(this, "setPassword", function (value) {
     _this.attributes.password = value;
   });
+  // int64 # Id of Form Field Set to use with this bundle
   (0, _defineProperty2.default)(this, "getFormFieldSetId", function () {
     return _this.attributes.form_field_set_id;
   });
   (0, _defineProperty2.default)(this, "setFormFieldSetId", function (value) {
     _this.attributes.form_field_set_id = value;
   });
+  // file # Preview watermark image applied to all bundle items.
   (0, _defineProperty2.default)(this, "getWatermarkAttachmentFile", function () {
     return _this.attributes.watermark_attachment_file;
   });
   (0, _defineProperty2.default)(this, "setWatermarkAttachmentFile", function (value) {
     _this.attributes.watermark_attachment_file = value;
   });
+  // boolean # If true, will delete the file stored in watermark_attachment
   (0, _defineProperty2.default)(this, "getWatermarkAttachmentDelete", function () {
     return _this.attributes.watermark_attachment_delete;
   });
   (0, _defineProperty2.default)(this, "setWatermarkAttachmentDelete", function (value) {
     _this.attributes.watermark_attachment_delete = value;
   });
+  // Send email(s) with a link to bundle
+  //
+  // Parameters:
+  //   to - array(string) - A list of email addresses to share this bundle with. Required unless `recipients` is used.
+  //   note - string - Note to include in email.
+  //   recipients - array(object) - A list of recipients to share this bundle with. Required unless `to` is used.
   (0, _defineProperty2.default)(this, "share", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
     var params,
       response,
@@ -296,6 +335,29 @@ var Bundle = /*#__PURE__*/(0, _createClass2.default)(function Bundle() {
       }
     }, _callee);
   })));
+  // Parameters:
+  //   paths - array(string) - A list of paths to include in this bundle.
+  //   password - string - Password for this bundle.
+  //   form_field_set_id - int64 - Id of Form Field Set to use with this bundle
+  //   clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
+  //   code - string - Bundle code.  This code forms the end part of the Public URL.
+  //   description - string - Public description
+  //   dont_separate_submissions_by_folder - boolean - Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
+  //   expires_at - string - Bundle expiration date/time
+  //   inbox_id - int64 - ID of the associated inbox, if available.
+  //   max_uses - int64 - Maximum number of times bundle can be accessed
+  //   note - string - Bundle internal note
+  //   path_template - string - Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, and any custom form data.
+  //   permissions - string - Permissions that apply to Folders in this Share Link.
+  //   preview_only - boolean - Restrict users to previewing files only?
+  //   require_registration - boolean - Show a registration page that captures the downloader's name and email address?
+  //   require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
+  //   send_email_receipt_to_uploader - boolean - Send delivery receipt to the uploader. Note: For writable share only
+  //   skip_company - boolean - BundleRegistrations can be saved without providing company?
+  //   skip_email - boolean - BundleRegistrations can be saved without providing email?
+  //   skip_name - boolean - BundleRegistrations can be saved without providing name?
+  //   watermark_attachment_delete - boolean - If true, will delete the file stored in watermark_attachment
+  //   watermark_attachment_file - file - Preview watermark image applied to all bundle items.
   (0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
     var params,
       response,
@@ -498,6 +560,17 @@ var Bundle = /*#__PURE__*/(0, _createClass2.default)(function Bundle() {
   });
   this.options = _objectSpread({}, options);
 });
+// Parameters:
+//   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+//   cursor - string - Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+//   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+//   sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `created_at` and `code`.
+//   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
+//   filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
+//   filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `created_at`.
+//   filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
+//   filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
+//   filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `created_at`.
 (0, _defineProperty2.default)(Bundle, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4() {
   var _response$data;
   var params,
@@ -545,6 +618,8 @@ var Bundle = /*#__PURE__*/(0, _createClass2.default)(function Bundle() {
   var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   return Bundle.list(params, options);
 });
+// Parameters:
+//   id (required) - int64 - Bundle ID.
 (0, _defineProperty2.default)(Bundle, "find", /*#__PURE__*/function () {
   var _ref7 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5(id) {
     var params,
@@ -595,6 +670,29 @@ var Bundle = /*#__PURE__*/(0, _createClass2.default)(function Bundle() {
   var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
   return Bundle.find(id, params, options);
 });
+// Parameters:
+//   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+//   paths (required) - array(string) - A list of paths to include in this bundle.
+//   password - string - Password for this bundle.
+//   form_field_set_id - int64 - Id of Form Field Set to use with this bundle
+//   dont_separate_submissions_by_folder - boolean - Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
+//   expires_at - string - Bundle expiration date/time
+//   max_uses - int64 - Maximum number of times bundle can be accessed
+//   description - string - Public description
+//   note - string - Bundle internal note
+//   code - string - Bundle code.  This code forms the end part of the Public URL.
+//   path_template - string - Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, and any custom form data.
+//   permissions - string - Permissions that apply to Folders in this Share Link.
+//   preview_only - boolean - Restrict users to previewing files only?
+//   require_registration - boolean - Show a registration page that captures the downloader's name and email address?
+//   clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
+//   inbox_id - int64 - ID of the associated inbox, if available.
+//   require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
+//   send_email_receipt_to_uploader - boolean - Send delivery receipt to the uploader. Note: For writable share only
+//   skip_email - boolean - BundleRegistrations can be saved without providing email?
+//   skip_name - boolean - BundleRegistrations can be saved without providing name?
+//   skip_company - boolean - BundleRegistrations can be saved without providing company?
+//   watermark_attachment_file - file - Preview watermark image applied to all bundle items.
 (0, _defineProperty2.default)(Bundle, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee6() {
   var params,
     options,

package/lib/models/BundleDownload.js

@@ -31,15 +31,19 @@ var BundleDownload = /*#__PURE__*/(0, _createClass2.default)(function BundleDown
   (0, _defineProperty2.default)(this, "isLoaded", function () {
     return !!_this.attributes.id;
   });
+  // BundleRegistration
   (0, _defineProperty2.default)(this, "getBundleRegistration", function () {
     return _this.attributes.bundle_registration;
   });
+  // string # Download method (file or full_zip)
   (0, _defineProperty2.default)(this, "getDownloadMethod", function () {
     return _this.attributes.download_method;
   });
+  // string # Download path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
   (0, _defineProperty2.default)(this, "getPath", function () {
     return _this.attributes.path;
   });
+  // date-time # Download date/time
   (0, _defineProperty2.default)(this, "getCreatedAt", function () {
     return _this.attributes.created_at;
   });
@@ -56,6 +60,18 @@ var BundleDownload = /*#__PURE__*/(0, _createClass2.default)(function BundleDown
   });
   this.options = _objectSpread({}, options);
 });
+// Parameters:
+//   cursor - string - Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+//   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+//   sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `created_at`.
+//   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
+//   filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
+//   filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `created_at`.
+//   filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
+//   filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
+//   filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `created_at`.
+//   bundle_id - int64 - Bundle ID
+//   bundle_registration_id - int64 - BundleRegistration ID
 (0, _defineProperty2.default)(BundleDownload, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
   var _response$data;
   var params,

package/lib/models/BundleNotification.js

@@ -31,36 +31,44 @@ var BundleNotification = /*#__PURE__*/(0, _createClass2.default)(function Bundle
   (0, _defineProperty2.default)(this, "isLoaded", function () {
     return !!_this.attributes.id;
   });
+  // int64 # Bundle ID to notify on
   (0, _defineProperty2.default)(this, "getBundleId", function () {
     return _this.attributes.bundle_id;
   });
   (0, _defineProperty2.default)(this, "setBundleId", function (value) {
     _this.attributes.bundle_id = value;
   });
+  // int64 # Bundle Notification ID
   (0, _defineProperty2.default)(this, "getId", function () {
     return _this.attributes.id;
   });
   (0, _defineProperty2.default)(this, "setId", function (value) {
     _this.attributes.id = value;
   });
+  // boolean # Triggers bundle notification when a registration action occurs for it.
   (0, _defineProperty2.default)(this, "getNotifyOnRegistration", function () {
     return _this.attributes.notify_on_registration;
   });
   (0, _defineProperty2.default)(this, "setNotifyOnRegistration", function (value) {
     _this.attributes.notify_on_registration = value;
   });
+  // boolean # Triggers bundle notification when a upload action occurs for it.
   (0, _defineProperty2.default)(this, "getNotifyOnUpload", function () {
     return _this.attributes.notify_on_upload;
   });
   (0, _defineProperty2.default)(this, "setNotifyOnUpload", function (value) {
     _this.attributes.notify_on_upload = value;
   });
+  // int64 # The id of the user to notify.
   (0, _defineProperty2.default)(this, "getUserId", function () {
     return _this.attributes.user_id;
   });
   (0, _defineProperty2.default)(this, "setUserId", function (value) {
     _this.attributes.user_id = value;
   });
+  // Parameters:
+  //   notify_on_registration - boolean - Triggers bundle notification when a registration action occurs for it.
+  //   notify_on_upload - boolean - Triggers bundle notification when a upload action occurs for it.
   (0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
     var params,
       response,
@@ -191,6 +199,11 @@ var BundleNotification = /*#__PURE__*/(0, _createClass2.default)(function Bundle
   });
   this.options = _objectSpread({}, options);
 });
+// Parameters:
+//   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+//   cursor - string - Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+//   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+//   bundle_id - int64 - Bundle ID to notify on
 (0, _defineProperty2.default)(BundleNotification, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
   var _response$data;
   var params,
@@ -244,6 +257,8 @@ var BundleNotification = /*#__PURE__*/(0, _createClass2.default)(function Bundle
   var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   return BundleNotification.list(params, options);
 });
+// Parameters:
+//   id (required) - int64 - Bundle Notification ID.
 (0, _defineProperty2.default)(BundleNotification, "find", /*#__PURE__*/function () {
   var _ref6 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(id) {
     var params,
@@ -294,6 +309,11 @@ var BundleNotification = /*#__PURE__*/(0, _createClass2.default)(function Bundle
   var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
   return BundleNotification.find(id, params, options);
 });
+// Parameters:
+//   user_id - int64 - The id of the user to notify.
+//   notify_on_registration - boolean - Triggers bundle notification when a registration action occurs for it.
+//   notify_on_upload - boolean - Triggers bundle notification when a upload action occurs for it.
+//   bundle_id (required) - int64 - Bundle ID to notify on
 (0, _defineProperty2.default)(BundleNotification, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5() {
   var params,
     options,

package/lib/models/BundleRecipient.js

@@ -31,48 +31,56 @@ var BundleRecipient = /*#__PURE__*/(0, _createClass2.default)(function BundleRec
   (0, _defineProperty2.default)(this, "isLoaded", function () {
     return !!_this.attributes.id;
   });
+  // string # The recipient's company.
   (0, _defineProperty2.default)(this, "getCompany", function () {
     return _this.attributes.company;
   });
   (0, _defineProperty2.default)(this, "setCompany", function (value) {
     _this.attributes.company = value;
   });
+  // string # The recipient's name.
   (0, _defineProperty2.default)(this, "getName", function () {
     return _this.attributes.name;
   });
   (0, _defineProperty2.default)(this, "setName", function (value) {
     _this.attributes.name = value;
   });
+  // string # A note sent to the recipient with the bundle.
   (0, _defineProperty2.default)(this, "getNote", function () {
     return _this.attributes.note;
   });
   (0, _defineProperty2.default)(this, "setNote", function (value) {
     _this.attributes.note = value;
   });
+  // string # The recipient's email address.
   (0, _defineProperty2.default)(this, "getRecipient", function () {
     return _this.attributes.recipient;
   });
   (0, _defineProperty2.default)(this, "setRecipient", function (value) {
     _this.attributes.recipient = value;
   });
+  // date-time # When the Bundle was shared with this recipient.
   (0, _defineProperty2.default)(this, "getSentAt", function () {
     return _this.attributes.sent_at;
   });
   (0, _defineProperty2.default)(this, "setSentAt", function (value) {
     _this.attributes.sent_at = value;
   });
+  // int64 # User ID.  Provide a value of `0` to operate the current session's user.
   (0, _defineProperty2.default)(this, "getUserId", function () {
     return _this.attributes.user_id;
   });
   (0, _defineProperty2.default)(this, "setUserId", function (value) {
     _this.attributes.user_id = value;
   });
+  // int64 # Bundle to share.
   (0, _defineProperty2.default)(this, "getBundleId", function () {
     return _this.attributes.bundle_id;
   });
   (0, _defineProperty2.default)(this, "setBundleId", function (value) {
     _this.attributes.bundle_id = value;
   });
+  // boolean # Set to true to share the link with the recipient upon creation.
   (0, _defineProperty2.default)(this, "getShareAfterCreate", function () {
     return _this.attributes.share_after_create;
   });
@@ -101,6 +109,18 @@ var BundleRecipient = /*#__PURE__*/(0, _createClass2.default)(function BundleRec
   });
   this.options = _objectSpread({}, options);
 });
+// Parameters:
+//   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+//   cursor - string - Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+//   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+//   sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `has_registrations`.
+//   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
+//   filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `has_registrations`.
+//   filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `has_registrations`.
+//   filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
+//   filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `has_registrations`.
+//   filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `has_registrations`.
+//   bundle_id (required) - int64 - List recipients for the bundle with this ID.
 (0, _defineProperty2.default)(BundleRecipient, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
   var _response$data;
   var params,
@@ -160,6 +180,14 @@ var BundleRecipient = /*#__PURE__*/(0, _createClass2.default)(function BundleRec
   var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   return BundleRecipient.list(params, options);
 });
+// Parameters:
+//   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+//   bundle_id (required) - int64 - Bundle to share.
+//   recipient (required) - string - Email addresses to share this bundle with.
+//   name - string - Name of recipient.
+//   company - string - Company of recipient.
+//   note - string - Note to include in email.
+//   share_after_create - boolean - Set to true to share the link with the recipient upon creation.
 (0, _defineProperty2.default)(BundleRecipient, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
   var params,
     options,

package/lib/models/BundleRegistration.js

@@ -31,42 +31,55 @@ var BundleRegistration = /*#__PURE__*/(0, _createClass2.default)(function Bundle
   (0, _defineProperty2.default)(this, "isLoaded", function () {
     return !!_this.attributes.id;
   });
+  // string # Registration cookie code
   (0, _defineProperty2.default)(this, "getCode", function () {
     return _this.attributes.code;
   });
+  // string # Registrant name
   (0, _defineProperty2.default)(this, "getName", function () {
     return _this.attributes.name;
   });
+  // string # Registrant company name
   (0, _defineProperty2.default)(this, "getCompany", function () {
     return _this.attributes.company;
   });
+  // string # Registrant email address
   (0, _defineProperty2.default)(this, "getEmail", function () {
     return _this.attributes.email;
   });
+  // string # Registrant IP Address
   (0, _defineProperty2.default)(this, "getIp", function () {
     return _this.attributes.ip;
   });
+  // string # InboxRegistration cookie code, if there is an associated InboxRegistration
   (0, _defineProperty2.default)(this, "getInboxCode", function () {
     return _this.attributes.inbox_code;
   });
+  // string # Clickwrap text that was shown to the registrant
   (0, _defineProperty2.default)(this, "getClickwrapBody", function () {
     return _this.attributes.clickwrap_body;
   });
+  // int64 # Id of associated form field set
   (0, _defineProperty2.default)(this, "getFormFieldSetId", function () {
     return _this.attributes.form_field_set_id;
   });
+  // object # Data for form field set with form field ids as keys and user data as values
   (0, _defineProperty2.default)(this, "getFormFieldData", function () {
     return _this.attributes.form_field_data;
   });
+  // string # Bundle URL code
   (0, _defineProperty2.default)(this, "getBundleCode", function () {
     return _this.attributes.bundle_code;
   });
+  // int64 # Id of associated bundle
   (0, _defineProperty2.default)(this, "getBundleId", function () {
     return _this.attributes.bundle_id;
   });
+  // int64 # Id of associated bundle recipient
   (0, _defineProperty2.default)(this, "getBundleRecipientId", function () {
     return _this.attributes.bundle_recipient_id;
   });
+  // date-time # Registration creation date/time
   (0, _defineProperty2.default)(this, "getCreatedAt", function () {
     return _this.attributes.created_at;
   });
@@ -83,6 +96,11 @@ var BundleRegistration = /*#__PURE__*/(0, _createClass2.default)(function Bundle
   });
   this.options = _objectSpread({}, options);
 });
+// Parameters:
+//   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+//   cursor - string - Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+//   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+//   bundle_id - int64 - ID of the associated Bundle
 (0, _defineProperty2.default)(BundleRegistration, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
   var _response$data;
   var params,