docusign_esign 3.18.0 → 3.20.0

data/lib/docusign_esign/models/user_account_management_granular_information.rb

@@ -12,55 +12,66 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Describes which account management capabilities a user has.
   class UserAccountManagementGranularInformation
     # 
     attr_accessor :can_manage_account_security_settings
 
+    # 
     attr_accessor :can_manage_account_security_settings_metadata
 
     # 
     attr_accessor :can_manage_account_settings
 
+    # 
     attr_accessor :can_manage_account_settings_metadata
 
     # 
     attr_accessor :can_manage_admins
 
+    # Metadata that indicates whether the `canManageAdmins` property is editable. 
     attr_accessor :can_manage_admins_metadata
 
     # 
     attr_accessor :can_manage_connect
 
+    # 
     attr_accessor :can_manage_connect_metadata
 
     # 
     attr_accessor :can_manage_document_retention
 
+    # 
     attr_accessor :can_manage_document_retention_metadata
 
     # 
     attr_accessor :can_manage_envelope_transfer
 
+    # 
     attr_accessor :can_manage_envelope_transfer_metadata
 
     # 
     attr_accessor :can_manage_groups_but_not_users
 
+    # 
     attr_accessor :can_manage_groups_but_not_users_metadata
 
     # 
     attr_accessor :can_manage_reporting
 
+    # 
     attr_accessor :can_manage_reporting_metadata
 
     # 
     attr_accessor :can_manage_sharing
 
+    # Metadata that indicates whether the `canManageSharing` property is editable. 
     attr_accessor :can_manage_sharing_metadata
 
     # 
     attr_accessor :can_manage_signing_groups
 
+    # 
     attr_accessor :can_manage_signing_groups_metadata
 
     # 
@@ -71,6 +82,7 @@ module DocuSign_eSign
     # 
     attr_accessor :can_manage_users
 
+    # Metadata that indicates whether the `canManageUsers` property is editable. 
     attr_accessor :can_manage_users_metadata
 
     # 

data/lib/docusign_esign/models/user_info.rb

@@ -25,6 +25,7 @@ module DocuSign_eSign
     # 
     attr_accessor :email
 
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # 

data/lib/docusign_esign/models/user_information.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # User information.
   class UserInformation
     # The activation code the new user must enter when activating their account.
     attr_accessor :activation_access_code
@@ -40,11 +41,13 @@ module DocuSign_eSign
     # Specifies whether the user is enabled for updates from DocuSign Connect. Valid values: true or false.
     attr_accessor :enable_connect_for_user
 
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # The user's first name.  Maximum Length: 50 characters.
     attr_accessor :first_name
 
+    # A complex element containing up to four Question/Answer pairs for forgotten password information.
     attr_accessor :forgotten_password_info
 
     # A list of the group information for groups to add the user to. Group information can be found by calling [ML:GET group information]. The only required parameter is groupId.   The parameters are:  * groupId - The DocuSign group ID for the group. * groupName - The name of the group * permissionProfileId - The ID of the permission profile associated with the group. * groupType - The group type. 
@@ -53,6 +56,7 @@ module DocuSign_eSign
     # 
     attr_accessor :has_remote_notary
 
+    # Specifies the email for the signing host. It is a Required element for In Person Signers recipient Type.  Maximum Length: 100 characters.
     attr_accessor :home_address
 
     # Contains the URI for an endpoint that you can use to retrieve the initials image.
@@ -130,6 +134,7 @@ module DocuSign_eSign
     # 
     attr_accessor :user_profile_last_modified_date
 
+    # The collection of settings representing the actions a user can perform. See [userSettingsInformation](/docs/esign-rest-api/reference/users/users/get/#userSettingsInformation) for available settings.
     attr_accessor :user_settings
 
     # 
@@ -138,6 +143,7 @@ module DocuSign_eSign
     # 
     attr_accessor :user_type
 
+    # 
     attr_accessor :work_address
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_esign/models/user_information_list.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Contains a list of account users.
   class UserInformationList
     # The last position in the result set. 
     attr_accessor :end_position

data/lib/docusign_esign/models/user_password_information.rb

@@ -19,6 +19,7 @@ module DocuSign_eSign
     # The user's email address for the associated account.
     attr_accessor :email
 
+    # A complex element containing up to four Question/Answer pairs for forgotten password information.
     attr_accessor :forgotten_password_info
 
     # The user's new password.

data/lib/docusign_esign/models/user_password_rules.rb

@@ -12,7 +12,9 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Contains details about the password rules for a user.
   class UserPasswordRules
+    # Contains details about the password rules for the user.
     attr_accessor :password_rules
 
     # 

data/lib/docusign_esign/models/user_profile.rb

@@ -13,6 +13,7 @@ require 'date'
 
 module DocuSign_eSign
   class UserProfile
+    # The user's address.
     attr_accessor :address
 
     # These properties cannot be modified in the PUT.   Indicates the authentication methods used by the user.
@@ -39,8 +40,10 @@ module DocuSign_eSign
     # 
     attr_accessor :title
 
+    # A complex element consisting of:   - `lastSentDateTime`: The date and time the user last sent an envelope.  - `lastSignedDateTime`: The date and time the user last signed an envelope. - `sentCount`: The number of envelopes the user has sent. - `signedCount`: The number of envelopes the user has signed.  
     attr_accessor :usage_history
 
+    # 
     attr_accessor :user_details
 
     # 

data/lib/docusign_esign/models/user_settings_information.rb

@@ -12,12 +12,15 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Properties that configure the settings for a user. Some elements of this object have a `metadata` property, which includes the following: - `rights`: The calling users permissions to edit this setting (can be `editable` or `read_only`) - `uiHint`: Internally used to build UIs (can be `available` or `hidden`) - `options`: The values supported for this setting (not all settings have this element)
   class UserSettingsInformation
+    # Describes which account management capabilities a user has.
     attr_accessor :account_management_granular
 
     # 
     attr_accessor :admin_only
 
+    # Reserved for DocuSign.
     attr_accessor :admin_only_metadata
 
     # 
@@ -26,31 +29,37 @@ module DocuSign_eSign
     # 
     attr_accessor :allow_envelope_transfer_to
 
+    # Reserved for DocuSign.
     attr_accessor :allow_envelope_transfer_to_metadata
 
     # 
     attr_accessor :allow_eseal_recipients
 
+    # Metadata about the `allowEsealRecipientsMetadata` property.
     attr_accessor :allow_eseal_recipients_metadata
 
     # 
     attr_accessor :allow_power_forms_admin_to_access_all_power_form_envelope
 
+    # Metadata about the `allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata` property.
     attr_accessor :allow_power_forms_admin_to_access_all_power_form_envelope_metadata
 
     # 
     attr_accessor :allow_recipient_language_selection
 
+    # Metadata for allowRecipientLanguageSelection.
     attr_accessor :allow_recipient_language_selection_metadata
 
     # 
     attr_accessor :allow_send_on_behalf_of
 
+    # Metadata for allowSendOnBehalfOf.
     attr_accessor :allow_send_on_behalf_of_metadata
 
     # 
     attr_accessor :allow_supplemental_documents
 
+    # Metadata that indicates whether the `allowSupplementalDocuments` property is editable.
     attr_accessor :allow_supplemental_documents_metadata
 
     # 
@@ -59,91 +68,109 @@ module DocuSign_eSign
     # 
     attr_accessor :api_account_wide_access
 
+    # Metadata for apiAccountWideAccess.
     attr_accessor :api_account_wide_access_metadata
 
     # 
     attr_accessor :api_can_export_ac
 
+    # Metadata about the `apiCanExportACMetadata` property.
     attr_accessor :api_can_export_ac_metadata
 
     # 
     attr_accessor :bulk_send
 
+    # Metadata that indicates whether the `bulkSend` property is editable. 
     attr_accessor :bulk_send_metadata
 
     # 
     attr_accessor :can_charge_account
 
+    # Reserved for DocuSign.
     attr_accessor :can_charge_account_metadata
 
     # 
     attr_accessor :can_edit_shared_addressbook
 
+    # Metadata about the `canEditSharedAddressbookMetadata` property.
     attr_accessor :can_edit_shared_addressbook_metadata
 
     # 
     attr_accessor :can_lock_envelopes
 
+    # Metadata about the `canLockEnvelopes` property.
     attr_accessor :can_lock_envelopes_metadata
 
     # 
     attr_accessor :can_manage_account
 
+    # Metadata about the `canManageAccountMetadata` property.
     attr_accessor :can_manage_account_metadata
 
     # 
     attr_accessor :can_manage_distributor
 
+    # Metadata about the `canManageDistributor` property.
     attr_accessor :can_manage_distributor_metadata
 
     # 
     attr_accessor :can_manage_templates
 
+    # Metadata about the `canManageTemplates` property.
     attr_accessor :can_manage_templates_metadata
 
     # 
     attr_accessor :can_send_api_requests
 
+    # Metadata about the `canSendAPIRequests` property.
     attr_accessor :can_send_api_requests_metadata
 
     # 
     attr_accessor :can_send_envelope
 
+    # Metadata about the `canSendEnvelope` property.
     attr_accessor :can_send_envelope_metadata
 
     # 
     attr_accessor :can_send_envelopes_via_sms
 
+    # 
     attr_accessor :can_send_envelopes_via_sms_metadata
 
     # 
     attr_accessor :can_sign_envelope
 
+    # Metadata about the `canSignEnvelope` property.
     attr_accessor :can_sign_envelope_metadata
 
     # 
     attr_accessor :can_use_scratchpad
 
+    # Metadata about the `canUseScratchpad` property.
     attr_accessor :can_use_scratchpad_metadata
 
     # 
     attr_accessor :can_use_smart_contracts
 
+    # Reserved for DocuSign.
     attr_accessor :can_use_smart_contracts_metadata
 
     # 
     attr_accessor :disable_document_upload
 
+    # Metadata that indicates whether the `disableDocumentUpload` property is editable. 
     attr_accessor :disable_document_upload_metadata
 
     # 
     attr_accessor :disable_other_actions
 
+    # Metadata that indicates whether the `disableOtherActions` property is editable. 
     attr_accessor :disable_other_actions_metadata
 
     # 
     attr_accessor :enable_ds_pro
 
+    # Metadata that indicates whether the `enableDSPro` property is editable. 
     attr_accessor :enable_ds_pro_metadata
 
     # 
@@ -154,31 +181,37 @@ module DocuSign_eSign
     # 
     attr_accessor :enable_sequential_signing_api
 
+    # Metadata that indicates whether the `enableSequentialSigningAPI` property is editable. 
     attr_accessor :enable_sequential_signing_api_metadata
 
     # 
     attr_accessor :enable_sequential_signing_ui
 
+    # Metadata that indicates whether the `enableSequentialSigningUI` property is editable. 
     attr_accessor :enable_sequential_signing_ui_metadata
 
     # 
     attr_accessor :enable_signer_attachments
 
+    # Metadata that indicates whether the `enableSignerAttachments` property is editable. 
     attr_accessor :enable_signer_attachments_metadata
 
     # 
     attr_accessor :enable_sign_on_paper_override
 
+    # Metadata that indicates whether the `enableSignOnPaperOverride` property is editable. 
     attr_accessor :enable_sign_on_paper_override_metadata
 
     # 
     attr_accessor :enable_transaction_point
 
+    # Reserved for DocuSign.
     attr_accessor :enable_transaction_point_metadata
 
     # 
     attr_accessor :enable_vaulting
 
+    # Metadata that indicates whether the `enableVaulting` property is editable. 
     attr_accessor :enable_vaulting_metadata
 
     # 
@@ -187,43 +220,52 @@ module DocuSign_eSign
     # 
     attr_accessor :locale
 
+    # Metadata about the `locale` property.
     attr_accessor :locale_metadata
 
+    # Reserved for DocuSign.
     attr_accessor :locale_policy
 
     # 
     attr_accessor :manage_clickwraps_mode
 
+    # Metadata about the `manageClickwrapsMode` property.
     attr_accessor :manage_clickwraps_mode_metadata
 
     # 
     attr_accessor :modified_by
 
+    # Metadata about the `modifiedBy` property.
     attr_accessor :modified_by_metadata
 
     # 
     attr_accessor :modified_date
 
+    # Metadata about the `modifiedDate` property.
     attr_accessor :modified_date_metadata
 
     # 
     attr_accessor :modified_page
 
+    # Metadata about the `modifiedPage` property.
     attr_accessor :modified_page_metadata
 
     # 
     attr_accessor :new_send_ui
 
+    # Metadata about the `newSendUI` property.
     attr_accessor :new_send_ui_metadata
 
     # 
     attr_accessor :power_form_mode
 
+    # Metadata about the `powerFormMode` property.
     attr_accessor :power_form_mode_metadata
 
     # 
     attr_accessor :recipient_viewed_notification
 
+    # Metadata about the `recipientViewedNotification` property.
     attr_accessor :recipient_viewed_notification_metadata
 
     # 
@@ -232,10 +274,13 @@ module DocuSign_eSign
     # 
     attr_accessor :self_signed_recipient_email_document
 
+    # Metadata that indicates whether the `selfSignedRecipientEmailDocument` property is editable. 
     attr_accessor :self_signed_recipient_email_document_metadata
 
+    #   An array of email notifications that sets the email the user receives when they are a sender. When the specific email notification is set to true, the user will receive those types of email notifications from DocuSign.   The user inherits the default account sender email notification settings when the user is created. The email notifications are:  * envelopeComplete * changedSigner  * senderEnvelopeDeclined  * withdrawnConsent  * recipientViewed  * deliveryFailed   
     attr_accessor :sender_email_notifications
 
+    # An array of email notifications that specifies the email the user receives when they are a recipient. When the specific email notification is set to true, the user receives those types of email notifications from DocuSign. The user inherits the default account email notification settings when the user is created. 
     attr_accessor :signer_email_notifications
 
     # 
@@ -244,81 +289,97 @@ module DocuSign_eSign
     # 
     attr_accessor :supplemental_documents_must_accept
 
+    # Metadata that indicates whether the `supplementalDocumentsMustAccept` property is editable. 
     attr_accessor :supplemental_documents_must_accept_metadata
 
     # 
     attr_accessor :supplemental_documents_must_read
 
+    # Metadata that indicates whether the `supplementalDocumentsMustRead` property is editable. 
     attr_accessor :supplemental_documents_must_read_metadata
 
     # 
     attr_accessor :supplemental_documents_must_view
 
+    # Metadata that indicates whether the `supplementalDocumentsMustView` property is editable. 
     attr_accessor :supplemental_documents_must_view_metadata
 
     # 
     attr_accessor :template_active_creation
 
+    # Metadata about the `templateActiveCreation` property.
     attr_accessor :template_active_creation_metadata
 
     # 
     attr_accessor :template_apply_notify
 
+    # Metadata about the `templateApplyNotify` property.
     attr_accessor :template_apply_notify_metadata
 
     # 
     attr_accessor :template_auto_matching
 
+    # Metadata about the `templateAutoMatching` property.
     attr_accessor :template_auto_matching_metadata
 
     # 
     attr_accessor :template_matching_sensitivity
 
+    # Metadata about the `tempalteMatchingSensitivity` property.
     attr_accessor :template_matching_sensitivity_metadata
 
     # 
     attr_accessor :template_page_level_matching
 
+    # Metadata about the `templatePageLevelMatching` property.
     attr_accessor :template_page_level_matching_metadata
 
     # 
     attr_accessor :timezone_dst
 
+    # Metadata about the `timezoneDST` property.
     attr_accessor :timezone_dst_metadata
 
     # 
     attr_accessor :timezone_mask
 
+    # Metadata about the `timezoneMask` property.
     attr_accessor :timezone_mask_metadata
 
     # 
     attr_accessor :timezone_offset
 
+    # Metadata about the `timezoneOffset` property.
     attr_accessor :timezone_offset_metadata
 
     # 
     attr_accessor :timezone_sending_pref
 
+    # Reserved for DocuSign.
     attr_accessor :timezone_sending_pref_metadata
 
     # 
     attr_accessor :timezone_signing_pref
 
+    # Reserved for DocuSign.
     attr_accessor :timezone_signing_pref_metadata
 
     # 
     attr_accessor :transaction_point_site_name_url
 
+    # Reserved for DocuSign.
     attr_accessor :transaction_point_site_name_url_metadata
 
     # 
     attr_accessor :transaction_point_user_name
 
+    # Reserved for DocuSign.
     attr_accessor :transaction_point_user_name_metadata
 
     # 
     attr_accessor :vaulting_mode
 
+    # Metadata about the `vaultingMode` property.
     attr_accessor :vaulting_mode_metadata
 
     # 

data/lib/docusign_esign/models/user_shared_item.rb

@@ -12,12 +12,15 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Information about a shared item.
   class UserSharedItem
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # When set to **true**, this custom tab is shared.
     attr_accessor :shared
 
+    # The user whose sharing information is being requested.
     attr_accessor :user
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_esign/models/user_signature.rb

@@ -22,11 +22,13 @@ module DocuSign_eSign
     # 
     attr_accessor :custom_field
 
+    # Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.  This property contains the following information about the central rectangle:  - `DateAreaX`: The X axis position of the top-left corner. - `DateAreaY`: The Y axis position of the top-left corner. - `DateAreaWidth`: The width of the rectangle. - `DateAreaHeight`: The height of the rectangle.
     attr_accessor :date_stamp_properties
 
     # 
     attr_accessor :disallow_user_resize_stamp
 
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # 

data/lib/docusign_esign/models/user_signature_definition.rb

@@ -13,6 +13,7 @@ require 'date'
 
 module DocuSign_eSign
   class UserSignatureDefinition
+    # Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.  This property contains the following information about the central rectangle:  - `DateAreaX`: The X axis position of the top-left corner. - `DateAreaY`: The Y axis position of the top-left corner. - `DateAreaWidth`: The width of the rectangle. - `DateAreaHeight`: The height of the rectangle.
     attr_accessor :date_stamp_properties
 
     #