docusign_esign 3.18.0 → 3.20.0

data/lib/docusign_esign/models/access_code_format.rb

@@ -12,30 +12,36 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Object specifying the format of the string provided to a recipient in order to access an envelope.
   class AccessCodeFormat
     # 
     attr_accessor :format_required
 
+    # Metadata indicating whether the `formatRequired` property is editable.
     attr_accessor :format_required_metadata
 
     # 
     attr_accessor :letter_required
 
+    # Metadata indicating whether the `letterRequired` property is editable.
     attr_accessor :letter_required_metadata
 
     # 
     attr_accessor :minimum_length
 
+    # Metadata indicating whether the `minimumLength` property is editable.
     attr_accessor :minimum_length_metadata
 
     # 
     attr_accessor :number_required
 
+    # Metadata indicating whether the `numberRequired` property is editable.
     attr_accessor :number_required_metadata
 
     # 
     attr_accessor :special_character_required
 
+    # Metadata indicating whether the `specialCharacterRequired` property is editable.
     attr_accessor :special_character_required_metadata
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_esign/models/account_billing_plan.rb

@@ -32,6 +32,7 @@ module DocuSign_eSign
     # Specifies the ISO currency code for the account.
     attr_accessor :currency_code
 
+    # 
     attr_accessor :downgrade_plan_information
 
     # When set to **true**, then customer support is provided as part of the account plan.

data/lib/docusign_esign/models/account_billing_plan_response.rb

@@ -14,28 +14,37 @@ require 'date'
 module DocuSign_eSign
   # Defines an account billing plan response object.
   class AccountBillingPlanResponse
+    # The billing address for the account.
     attr_accessor :billing_address
 
     # When set to **true**, the credit card address information is the same as that returned as the billing address. If false, then the billing address is considered a billing contact address, and the credit card address can be different.
     attr_accessor :billing_address_is_credit_card_address
 
+    # An object that contains details about the billing plan.
     attr_accessor :billing_plan
 
+    # A complex type that has information about the credit card used to pay for this account.
     attr_accessor :credit_card_information
 
+    # Information about the bank that processes direct debits for the payment plan.
     attr_accessor :direct_debit_processor_information
 
+    # 
     attr_accessor :downgrade_plan_information
 
+    # 
     attr_accessor :downgrade_request_information
 
+    # 
     attr_accessor :entity_information
 
     # 
     attr_accessor :payment_method
 
+    # Information about the entity that processes payments for the billing plan.
     attr_accessor :payment_processor_information
 
+    # A complex type that contains properties for entering referral and discount information.
     attr_accessor :referral_information
 
     # 

data/lib/docusign_esign/models/account_identity_verification_step.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Information about a specific step in an Identity Verification workflow.
   class AccountIdentityVerificationStep
     # 
     attr_accessor :name

data/lib/docusign_esign/models/account_identity_verification_workflow.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Specifies an Identity Verification workflow.
   class AccountIdentityVerificationWorkflow
     # 
     attr_accessor :default_description
@@ -22,6 +23,7 @@ module DocuSign_eSign
     # 
     attr_accessor :input_options
 
+    # The signature provider associated with the Identity Verification workflow.
     attr_accessor :signature_provider
 
     # 
@@ -30,6 +32,9 @@ module DocuSign_eSign
     # 
     attr_accessor :workflow_id
 
+    # 
+    attr_accessor :workflow_label
+
     # 
     attr_accessor :workflow_resource_key
 
@@ -42,6 +47,7 @@ module DocuSign_eSign
         :'signature_provider' => :'signatureProvider',
         :'steps' => :'steps',
         :'workflow_id' => :'workflowId',
+        :'workflow_label' => :'workflowLabel',
         :'workflow_resource_key' => :'workflowResourceKey'
       }
     end
@@ -55,6 +61,7 @@ module DocuSign_eSign
         :'signature_provider' => :'AccountSignatureProvider',
         :'steps' => :'Array<AccountIdentityVerificationStep>',
         :'workflow_id' => :'String',
+        :'workflow_label' => :'String',
         :'workflow_resource_key' => :'String'
       }
     end
@@ -95,6 +102,10 @@ module DocuSign_eSign
         self.workflow_id = attributes[:'workflowId']
       end
 
+      if attributes.has_key?(:'workflowLabel')
+        self.workflow_label = attributes[:'workflowLabel']
+      end
+
       if attributes.has_key?(:'workflowResourceKey')
         self.workflow_resource_key = attributes[:'workflowResourceKey']
       end
@@ -124,6 +135,7 @@ module DocuSign_eSign
           signature_provider == o.signature_provider &&
           steps == o.steps &&
           workflow_id == o.workflow_id &&
+          workflow_label == o.workflow_label &&
           workflow_resource_key == o.workflow_resource_key
     end
 
@@ -136,7 +148,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [default_description, default_name, input_options, signature_provider, steps, workflow_id, workflow_resource_key].hash
+      [default_description, default_name, input_options, signature_provider, steps, workflow_id, workflow_label, workflow_resource_key].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/account_information.rb

@@ -20,6 +20,7 @@ module DocuSign_eSign
     # The name of the current account.
     attr_accessor :account_name
 
+    # The list of account settings accountsettings that determine the features available for the account. Note that some features are determined by the plan used to create the account and cannot be overridden.  
     attr_accessor :account_settings
 
     # When set to **true**, the transaction rooms feature exposed through the Workspaces API is enabled.

data/lib/docusign_esign/models/account_notification.rb

@@ -12,9 +12,12 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # A complex element that specifies notifications (expirations and reminders) for the envelope.
   class AccountNotification
+    # A complex element that specifies the expiration settings for the envelope.
     attr_accessor :expirations
 
+    # A complex element that specifies reminder settings for the envelope.
     attr_accessor :reminders
 
     # 

data/lib/docusign_esign/models/account_password_questions_required.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Information about the number of password questions required (0 to 4) to confirm a user's identity when a user needs to reset their password.
   class AccountPasswordQuestionsRequired
     # 
     attr_accessor :maximum_questions

data/lib/docusign_esign/models/account_password_rules.rb

@@ -19,26 +19,31 @@ module DocuSign_eSign
     # 
     attr_accessor :expire_password_days
 
+    # Metadata that indicates whether the `expirePasswordDays` property is editable. 
     attr_accessor :expire_password_days_metadata
 
     # 
     attr_accessor :lockout_duration_minutes
 
+    # Metadata that indicates whether the `lockoutDurationMinutes` property is editable. 
     attr_accessor :lockout_duration_minutes_metadata
 
     # 
     attr_accessor :lockout_duration_type
 
+    # Metadata that indicates whether the `lockoutDurationType` property is editable. 
     attr_accessor :lockout_duration_type_metadata
 
     # 
     attr_accessor :minimum_password_age_days
 
+    # Metadata that indicates whether the `minimumPasswordAgeDays` property is editable. 
     attr_accessor :minimum_password_age_days_metadata
 
     # 
     attr_accessor :minimum_password_length
 
+    # Metadata that indicates whether the `minimumPasswordLength` property is editable. 
     attr_accessor :minimum_password_length_metadata
 
     # 
@@ -59,11 +64,13 @@ module DocuSign_eSign
     # 
     attr_accessor :password_strength_type
 
+    # Metadata that indicates whether the `passwordStrengthType` property is editable. 
     attr_accessor :password_strength_type_metadata
 
     # 
     attr_accessor :questions_required
 
+    # Metadata that indicates whether the `questionsRequired` property is editable. 
     attr_accessor :questions_required_metadata
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_esign/models/account_role_settings.rb

@@ -12,135 +12,162 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This object defines account permissions for users who are associated with the account permission profile. 
   class AccountRoleSettings
     # 
     attr_accessor :allow_account_management
 
+    # Metadata that indicates whether the `allowAccountManagement` property is editable. 
     attr_accessor :allow_account_management_metadata
 
     # 
     attr_accessor :allow_api_access
 
+    # Metadata that indicates whether the `allowApiAccess` property is editable. 
     attr_accessor :allow_api_access_metadata
 
     # 
     attr_accessor :allow_api_access_to_account
 
+    # Metadata that indicates whether the `allowApiAccessToAccount` property is editable. 
     attr_accessor :allow_api_access_to_account_metadata
 
     # 
     attr_accessor :allow_api_sending_on_behalf_of_others
 
+    # Metadata that indicates whether the `allowApiSendingOnBehalfOfOthers` property is editable. 
     attr_accessor :allow_api_sending_on_behalf_of_others_metadata
 
     # 
     attr_accessor :allow_api_sequential_signing
 
+    # Metadata that indicates whether the `allowApiSequentialSigning` property is editable. 
     attr_accessor :allow_api_sequential_signing_metadata
 
     # 
     attr_accessor :allow_auto_tagging
 
+    # Metadata that indicates whether the `allowAutoTagging` property is editable.
     attr_accessor :allow_auto_tagging_metadata
 
     # 
     attr_accessor :allow_bulk_sending
 
+    # Metadata that indicates whether the `allowBulkSending` property is editable. 
     attr_accessor :allow_bulk_sending_metadata
 
     # 
     attr_accessor :allow_docu_sign_desktop_client
 
+    # Metadata that indicates whether the `allowDocuSignDesktopClient` property is editable. 
     attr_accessor :allow_docu_sign_desktop_client_metadata
 
     # 
     attr_accessor :allowed_address_book_access
 
+    # Metadata that indicates whether the `allowedAddressBookAccess` property is editable. 
     attr_accessor :allowed_address_book_access_metadata
 
     # 
     attr_accessor :allowed_clickwraps_access
 
+    # 
     attr_accessor :allowed_clickwraps_access_metadata
 
     # 
     attr_accessor :allowed_template_access
 
+    # Metadata that indicates whether the `allowedTemplateAccess` property is editable. 
     attr_accessor :allowed_template_access_metadata
 
     # 
     attr_accessor :allowed_to_be_envelope_transfer_recipient
 
+    # Metadata that indicates whether the `allowedToBeEnvelopeTransferRecipient` property is editable. 
     attr_accessor :allowed_to_be_envelope_transfer_recipient_metadata
 
     # 
     attr_accessor :allow_envelope_sending
 
+    # Metadata that indicates whether the `allowEnvelopeSending` property is editable. 
     attr_accessor :allow_envelope_sending_metadata
 
     # 
     attr_accessor :allow_e_seal_recipients
 
+    # Metadata that indicates whether the `allowESealRecipients` property is editable.
     attr_accessor :allow_e_seal_recipients_metadata
 
     # 
     attr_accessor :allow_power_forms_admin_to_access_all_power_form_envelopes
 
+    # Metadata that indicates whether the `allowPowerFormsAdminToAccessAllPowerFormEnvelopes` property is editable.
     attr_accessor :allow_power_forms_admin_to_access_all_power_form_envelopes_metadata
 
     # 
     attr_accessor :allow_senders_to_set_recipient_email_language
 
+    # Metadata that indicates whether the `allowSendersToSetRecipientEmailLanguage` property is editable. 
     attr_accessor :allow_senders_to_set_recipient_email_language_metadata
 
     # 
     attr_accessor :allow_signer_attachments
 
+    # Metadata that indicates whether the `allowSignerAttachments` property is editable. 
     attr_accessor :allow_signer_attachments_metadata
 
     # 
     attr_accessor :allow_supplemental_documents
 
+    # Metadata that indicates whether the `allowSupplementalDocuments` property is editable.
     attr_accessor :allow_supplemental_documents_metadata
 
     # 
     attr_accessor :allow_tagging_in_send_and_correct
 
+    # Metadata that indicates whether the `allowTaggingInSendAndCorrect` property is editable. 
     attr_accessor :allow_tagging_in_send_and_correct_metadata
 
     # 
     attr_accessor :allow_vaulting
 
+    # Reserved for DocuSign.
     attr_accessor :allow_vaulting_metadata
 
     # 
     attr_accessor :allow_wet_signing_override
 
+    # Metadata that indicates whether the `allowWetSigningOverride` property is editable. 
     attr_accessor :allow_wet_signing_override_metadata
 
     # 
     attr_accessor :can_create_workspaces
 
+    # Reserved for DocuSign.
     attr_accessor :can_create_workspaces_metadata
 
     # 
     attr_accessor :can_send_envelopes_via_sms
 
+    # 
     attr_accessor :can_send_envelopes_via_sms_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_api_request_logging
 
+    # Metadata that indicates whether the `enableApiRequestLogging` property is editable. 
     attr_accessor :enable_api_request_logging_metadata
 
     # 
@@ -151,58 +178,70 @@ module DocuSign_eSign
     # 
     attr_accessor :enable_recipient_viewing_notifications
 
+    # Metadata that indicates whether the `enableRecipientViewingNotifications` property is editable. 
     attr_accessor :enable_recipient_viewing_notifications_metadata
 
     # 
     attr_accessor :enable_sequential_signing_interface
 
+    # Metadata that indicates whether the `enableSequentialSigningInterface` property is editable. 
     attr_accessor :enable_sequential_signing_interface_metadata
 
     # 
     attr_accessor :enable_transaction_point_integration
 
+    # Reserved for DocuSign.
     attr_accessor :enable_transaction_point_integration_metadata
 
     # 
     attr_accessor :power_form_role
 
+    # Metadata that indicates whether the `powerFormRole` property is editable. 
     attr_accessor :power_form_role_metadata
 
     # 
     attr_accessor :receive_completed_self_signed_documents_as_email_links
 
+    # Metadata that indicates whether the `receiveCompletedSelfSignedDocumentsAsEmailLinks` property is editable. 
     attr_accessor :receive_completed_self_signed_documents_as_email_links_metadata
 
+    # Reserved for DocuSign.
     attr_accessor :signing_ui_version_metadata
 
     # 
     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 :use_new_docu_sign_experience_interface
 
+    # Reserved for DocuSign.
     attr_accessor :use_new_docu_sign_experience_interface_metadata
 
     # 
     attr_accessor :use_new_sending_interface
 
+    # Reserved for DocuSign.
     attr_accessor :use_new_sending_interface_metadata
 
     # 
     attr_accessor :vaulting_mode
 
+    # Reserved for DocuSign.
     attr_accessor :vaulting_mode_metadata
 
     #