docusign_esign 3.15.0 → 3.16.0

data/lib/docusign_esign/models/envelope_delay_rule.rb

@@ -0,0 +1,194 @@
+=begin
+#DocuSign REST API
+
+#The DocuSign 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
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module DocuSign_eSign
+  class EnvelopeDelayRule
+    # 
+    attr_accessor :delay
+
+    # 
+    attr_accessor :resume_date
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'delay' => :'delay',
+        :'resume_date' => :'resumeDate'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'delay' => :'String',
+        :'resume_date' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'delay')
+        self.delay = attributes[:'delay']
+      end
+
+      if attributes.has_key?(:'resumeDate')
+        self.resume_date = attributes[:'resumeDate']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          delay == o.delay &&
+          resume_date == o.resume_date
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [delay, resume_date].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = DocuSign_eSign.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/docusign_esign/models/linked_external_primary_account.rb

@@ -25,6 +25,9 @@ module DocuSign_eSign
     # 
     attr_accessor :link_id
 
+    # 
+    attr_accessor :pdf_field_handling_option
+
     attr_accessor :recipient_auth_requirements
 
     # Indicates the envelope status. Valid values are:  * sent - The envelope is sent to the recipients.  * created - The envelope is saved as a draft and can be modified and sent later.
@@ -40,6 +43,7 @@ module DocuSign_eSign
         :'configuration_id' => :'configurationId',
         :'email' => :'email',
         :'link_id' => :'linkId',
+        :'pdf_field_handling_option' => :'pdfFieldHandlingOption',
         :'recipient_auth_requirements' => :'recipientAuthRequirements',
         :'status' => :'status',
         :'user_id' => :'userId'
@@ -53,6 +57,7 @@ module DocuSign_eSign
         :'configuration_id' => :'String',
         :'email' => :'String',
         :'link_id' => :'String',
+        :'pdf_field_handling_option' => :'String',
         :'recipient_auth_requirements' => :'ExternalPrimaryAccountRecipientAuthRequirements',
         :'status' => :'String',
         :'user_id' => :'String'
@@ -83,6 +88,10 @@ module DocuSign_eSign
         self.link_id = attributes[:'linkId']
       end
 
+      if attributes.has_key?(:'pdfFieldHandlingOption')
+        self.pdf_field_handling_option = attributes[:'pdfFieldHandlingOption']
+      end
+
       if attributes.has_key?(:'recipientAuthRequirements')
         self.recipient_auth_requirements = attributes[:'recipientAuthRequirements']
       end
@@ -118,6 +127,7 @@ module DocuSign_eSign
           configuration_id == o.configuration_id &&
           email == o.email &&
           link_id == o.link_id &&
+          pdf_field_handling_option == o.pdf_field_handling_option &&
           recipient_auth_requirements == o.recipient_auth_requirements &&
           status == o.status &&
           user_id == o.user_id
@@ -132,7 +142,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [account_name, configuration_id, email, link_id, recipient_auth_requirements, status, user_id].hash
+      [account_name, configuration_id, email, link_id, pdf_field_handling_option, recipient_auth_requirements, status, user_id].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/prefill_tabs.rb

@@ -16,6 +16,15 @@ module DocuSign_eSign
     # Specifies a tag on the document in a location where the recipient can select an option.
     attr_accessor :checkbox_tabs
 
+    # Specifies a tab on the document where you want the recipient to enter a date. Date tabs are single-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained.   If you need a particular date format enforced, DocuSign recommends using a Text tab with a Validation Pattern and Validation Message to enforce the format.
+    attr_accessor :date_tabs
+
+    # Specifies a tag on the document where you want the recipient to enter an email. Email tags are single-line fields that accept any characters. The system checks that a valid email format (i.e. xxx@yyy.zzz) is entered in the tag. It uses the same parameters as a Text tab, with the validation message and pattern set for email information.  When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.
+    attr_accessor :email_tabs
+
+    # Specifies a tag on the document where you want the recipient to enter a number. It uses the same parameters as a Text tab, with the validation message and pattern set for number information.  When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. 
+    attr_accessor :number_tabs
+
     # Specifies a tag on the document in a location where the recipient can select one option from a group of options using a radio button. The radio buttons do not have to be on the same page in a document.
     attr_accessor :radio_group_tabs
 
@@ -25,21 +34,32 @@ module DocuSign_eSign
     # 
     attr_accessor :sender_name_tabs
 
+    # Specifies a tag on the document where you want the recipient to enter a Social Security Number (SSN). A SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information.  When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.
+    attr_accessor :ssn_tabs
+
     # 
     attr_accessor :tab_groups
 
     # Specifies a that that is an adaptable field that allows the recipient to enter different text information.  When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.
     attr_accessor :text_tabs
 
+    # Specifies a tag on the document where you want the recipient to enter a ZIP code. The ZIP code can be a five numbers or the ZIP+4 format with nine numbers. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information.  When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.
+    attr_accessor :zip_tabs
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'checkbox_tabs' => :'checkboxTabs',
+        :'date_tabs' => :'dateTabs',
+        :'email_tabs' => :'emailTabs',
+        :'number_tabs' => :'numberTabs',
         :'radio_group_tabs' => :'radioGroupTabs',
         :'sender_company_tabs' => :'senderCompanyTabs',
         :'sender_name_tabs' => :'senderNameTabs',
+        :'ssn_tabs' => :'ssnTabs',
         :'tab_groups' => :'tabGroups',
-        :'text_tabs' => :'textTabs'
+        :'text_tabs' => :'textTabs',
+        :'zip_tabs' => :'zipTabs'
       }
     end
 
@@ -47,11 +67,16 @@ module DocuSign_eSign
     def self.swagger_types
       {
         :'checkbox_tabs' => :'Array<Checkbox>',
+        :'date_tabs' => :'Array<DocuSign_eSign::Date>',
+        :'email_tabs' => :'Array<Email>',
+        :'number_tabs' => :'Array<Number>',
         :'radio_group_tabs' => :'Array<RadioGroup>',
         :'sender_company_tabs' => :'Array<SenderCompany>',
         :'sender_name_tabs' => :'Array<SenderName>',
+        :'ssn_tabs' => :'Array<Ssn>',
         :'tab_groups' => :'Array<TabGroup>',
-        :'text_tabs' => :'Array<Text>'
+        :'text_tabs' => :'Array<Text>',
+        :'zip_tabs' => :'Array<Zip>'
       }
     end
 
@@ -69,6 +94,24 @@ module DocuSign_eSign
         end
       end
 
+      if attributes.has_key?(:'dateTabs')
+        if (value = attributes[:'dateTabs']).is_a?(Array)
+          self.date_tabs = value
+        end
+      end
+
+      if attributes.has_key?(:'emailTabs')
+        if (value = attributes[:'emailTabs']).is_a?(Array)
+          self.email_tabs = value
+        end
+      end
+
+      if attributes.has_key?(:'numberTabs')
+        if (value = attributes[:'numberTabs']).is_a?(Array)
+          self.number_tabs = value
+        end
+      end
+
       if attributes.has_key?(:'radioGroupTabs')
         if (value = attributes[:'radioGroupTabs']).is_a?(Array)
           self.radio_group_tabs = value
@@ -87,6 +130,12 @@ module DocuSign_eSign
         end
       end
 
+      if attributes.has_key?(:'ssnTabs')
+        if (value = attributes[:'ssnTabs']).is_a?(Array)
+          self.ssn_tabs = value
+        end
+      end
+
       if attributes.has_key?(:'tabGroups')
         if (value = attributes[:'tabGroups']).is_a?(Array)
           self.tab_groups = value
@@ -98,6 +147,12 @@ module DocuSign_eSign
           self.text_tabs = value
         end
       end
+
+      if attributes.has_key?(:'zipTabs')
+        if (value = attributes[:'zipTabs']).is_a?(Array)
+          self.zip_tabs = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -119,11 +174,16 @@ module DocuSign_eSign
       return true if self.equal?(o)
       self.class == o.class &&
           checkbox_tabs == o.checkbox_tabs &&
+          date_tabs == o.date_tabs &&
+          email_tabs == o.email_tabs &&
+          number_tabs == o.number_tabs &&
           radio_group_tabs == o.radio_group_tabs &&
           sender_company_tabs == o.sender_company_tabs &&
           sender_name_tabs == o.sender_name_tabs &&
+          ssn_tabs == o.ssn_tabs &&
           tab_groups == o.tab_groups &&
-          text_tabs == o.text_tabs
+          text_tabs == o.text_tabs &&
+          zip_tabs == o.zip_tabs
     end
 
     # @see the `==` method
@@ -135,7 +195,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [checkbox_tabs, radio_group_tabs, sender_company_tabs, sender_name_tabs, tab_groups, text_tabs].hash
+      [checkbox_tabs, date_tabs, email_tabs, number_tabs, radio_group_tabs, sender_company_tabs, sender_name_tabs, ssn_tabs, tab_groups, text_tabs, zip_tabs].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/scheduled_sending.rb

@@ -0,0 +1,206 @@
+=begin
+#DocuSign REST API
+
+#The DocuSign 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
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module DocuSign_eSign
+  class ScheduledSending
+    # 
+    attr_accessor :resume_date
+
+    # 
+    attr_accessor :rules
+
+    # Indicates the envelope status. Valid values are:  * sent - The envelope is sent to the recipients.  * created - The envelope is saved as a draft and can be modified and sent later.
+    attr_accessor :status
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'resume_date' => :'resumeDate',
+        :'rules' => :'rules',
+        :'status' => :'status'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'resume_date' => :'String',
+        :'rules' => :'Array<EnvelopeDelayRule>',
+        :'status' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'resumeDate')
+        self.resume_date = attributes[:'resumeDate']
+      end
+
+      if attributes.has_key?(:'rules')
+        if (value = attributes[:'rules']).is_a?(Array)
+          self.rules = value
+        end
+      end
+
+      if attributes.has_key?(:'status')
+        self.status = attributes[:'status']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          resume_date == o.resume_date &&
+          rules == o.rules &&
+          status == o.status
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [resume_date, rules, status].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = DocuSign_eSign.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/docusign_esign/models/user_information.rb

@@ -61,6 +61,9 @@ module DocuSign_eSign
     # Determines if the feature set is actively set as part of the plan.
     attr_accessor :is_admin
 
+    # 
+    attr_accessor :is_alternate_admin
+
     # 
     attr_accessor :is_nar_enabled
 
@@ -157,6 +160,7 @@ module DocuSign_eSign
         :'home_address' => :'homeAddress',
         :'initials_image_uri' => :'initialsImageUri',
         :'is_admin' => :'isAdmin',
+        :'is_alternate_admin' => :'isAlternateAdmin',
         :'is_nar_enabled' => :'isNAREnabled',
         :'job_title' => :'jobTitle',
         :'last_login' => :'lastLogin',
@@ -206,6 +210,7 @@ module DocuSign_eSign
         :'home_address' => :'AddressInformation',
         :'initials_image_uri' => :'String',
         :'is_admin' => :'String',
+        :'is_alternate_admin' => :'String',
         :'is_nar_enabled' => :'String',
         :'job_title' => :'String',
         :'last_login' => :'String',
@@ -317,6 +322,10 @@ module DocuSign_eSign
         self.is_admin = attributes[:'isAdmin']
       end
 
+      if attributes.has_key?(:'isAlternateAdmin')
+        self.is_alternate_admin = attributes[:'isAlternateAdmin']
+      end
+
       if attributes.has_key?(:'isNAREnabled')
         self.is_nar_enabled = attributes[:'isNAREnabled']
       end
@@ -457,6 +466,7 @@ module DocuSign_eSign
           home_address == o.home_address &&
           initials_image_uri == o.initials_image_uri &&
           is_admin == o.is_admin &&
+          is_alternate_admin == o.is_alternate_admin &&
           is_nar_enabled == o.is_nar_enabled &&
           job_title == o.job_title &&
           last_login == o.last_login &&
@@ -494,7 +504,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [activation_access_code, company, connect_configurations, country_code, created_date_time, custom_settings, default_account_id, email, enable_connect_for_user, error_details, first_name, forgotten_password_info, group_list, has_remote_notary, home_address, initials_image_uri, is_admin, is_nar_enabled, job_title, last_login, last_name, login_status, middle_name, password, password_expiration, permission_profile_id, permission_profile_name, profile_image_uri, send_activation_email, send_activation_on_invalid_login, signature_image_uri, subscribe, suffix_name, title, uri, user_added_to_account_date_time, user_id, user_name, user_profile_last_modified_date, user_settings, user_status, user_type, work_address].hash
+      [activation_access_code, company, connect_configurations, country_code, created_date_time, custom_settings, default_account_id, email, enable_connect_for_user, error_details, first_name, forgotten_password_info, group_list, has_remote_notary, home_address, initials_image_uri, is_admin, is_alternate_admin, is_nar_enabled, job_title, last_login, last_name, login_status, middle_name, password, password_expiration, permission_profile_id, permission_profile_name, profile_image_uri, send_activation_email, send_activation_on_invalid_login, signature_image_uri, subscribe, suffix_name, title, uri, user_added_to_account_date_time, user_id, user_name, user_profile_last_modified_date, user_settings, user_status, user_type, work_address].hash
     end
 
     # Builds the object from hash