docusign_esign 3.24.0 → 3.26.0

data/lib/docusign_esign/models/brand.rb

@@ -38,6 +38,9 @@ module DocuSign_eSign
     # Array or errors.
     attr_accessor :error_details
 
+    # 
+    attr_accessor :is_organization_brand
+
     # 
     attr_accessor :is_overriding_company_name
 
@@ -56,6 +59,9 @@ module DocuSign_eSign
     # The URIs for retrieving the logos that are associated with the brand.
     attr_accessor :logos
 
+    # 
+    attr_accessor :organization_brand_logo
+
     # An object containing the URLs for the four DocuSign master resource files that the brand uses for sending, signing, email messages, and captive (embedded) signing. You can modify the default email messages and formats in these file to customize the user experience.  **Note:** This object is returned only when the `resourceContentType` is `sending`, `signing`, `email`, or `signing_captive`.
     attr_accessor :resources
 
@@ -70,12 +76,14 @@ module DocuSign_eSign
         :'default_brand_language' => :'defaultBrandLanguage',
         :'email_content' => :'emailContent',
         :'error_details' => :'errorDetails',
+        :'is_organization_brand' => :'isOrganizationBrand',
         :'is_overriding_company_name' => :'isOverridingCompanyName',
         :'is_sending_default' => :'isSendingDefault',
         :'is_signing_default' => :'isSigningDefault',
         :'landing_pages' => :'landingPages',
         :'links' => :'links',
         :'logos' => :'logos',
+        :'organization_brand_logo' => :'organizationBrandLogo',
         :'resources' => :'resources'
       }
     end
@@ -91,12 +99,14 @@ module DocuSign_eSign
         :'default_brand_language' => :'String',
         :'email_content' => :'Array<BrandEmailContent>',
         :'error_details' => :'ErrorDetails',
+        :'is_organization_brand' => :'String',
         :'is_overriding_company_name' => :'BOOLEAN',
         :'is_sending_default' => :'BOOLEAN',
         :'is_signing_default' => :'BOOLEAN',
         :'landing_pages' => :'Array<NameValue>',
         :'links' => :'Array<BrandLink>',
         :'logos' => :'BrandLogos',
+        :'organization_brand_logo' => :'String',
         :'resources' => :'BrandResourceUrls'
       }
     end
@@ -147,6 +157,10 @@ module DocuSign_eSign
         self.error_details = attributes[:'errorDetails']
       end
 
+      if attributes.has_key?(:'isOrganizationBrand')
+        self.is_organization_brand = attributes[:'isOrganizationBrand']
+      end
+
       if attributes.has_key?(:'isOverridingCompanyName')
         self.is_overriding_company_name = attributes[:'isOverridingCompanyName']
       end
@@ -175,6 +189,10 @@ module DocuSign_eSign
         self.logos = attributes[:'logos']
       end
 
+      if attributes.has_key?(:'organizationBrandLogo')
+        self.organization_brand_logo = attributes[:'organizationBrandLogo']
+      end
+
       if attributes.has_key?(:'resources')
         self.resources = attributes[:'resources']
       end
@@ -206,12 +224,14 @@ module DocuSign_eSign
           default_brand_language == o.default_brand_language &&
           email_content == o.email_content &&
           error_details == o.error_details &&
+          is_organization_brand == o.is_organization_brand &&
           is_overriding_company_name == o.is_overriding_company_name &&
           is_sending_default == o.is_sending_default &&
           is_signing_default == o.is_signing_default &&
           landing_pages == o.landing_pages &&
           links == o.links &&
           logos == o.logos &&
+          organization_brand_logo == o.organization_brand_logo &&
           resources == o.resources
     end
 
@@ -224,7 +244,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [brand_company, brand_id, brand_languages, brand_name, colors, default_brand_language, email_content, error_details, is_overriding_company_name, is_sending_default, is_signing_default, landing_pages, links, logos, resources].hash
+      [brand_company, brand_id, brand_languages, brand_name, colors, default_brand_language, email_content, error_details, is_organization_brand, is_overriding_company_name, is_sending_default, is_signing_default, landing_pages, links, logos, organization_brand_logo, resources].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/doc_gen_form_field.rb

@@ -13,28 +13,44 @@ require 'date'
 
 module DocuSign_eSign
   class DocGenFormField
+    # 
+    attr_accessor :description
+
     # 
     attr_accessor :label
 
     # 
     attr_accessor :name
 
+    # 
+    attr_accessor :options
+
+    # 
+    attr_accessor :predefined_validation
+
     # When set to **true**, the signer is required to fill out this tab
     attr_accessor :required
 
     # 
     attr_accessor :type
 
+    # 
+    attr_accessor :validation
+
     # Specifies the value of the tab. 
     attr_accessor :value
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'description' => :'description',
         :'label' => :'label',
         :'name' => :'name',
+        :'options' => :'options',
+        :'predefined_validation' => :'predefinedValidation',
         :'required' => :'required',
         :'type' => :'type',
+        :'validation' => :'validation',
         :'value' => :'value'
       }
     end
@@ -42,10 +58,14 @@ module DocuSign_eSign
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'description' => :'String',
         :'label' => :'String',
         :'name' => :'String',
+        :'options' => :'Array<DocGenFormFieldOption>',
+        :'predefined_validation' => :'String',
         :'required' => :'String',
         :'type' => :'String',
+        :'validation' => :'DocGenFormFieldValidation',
         :'value' => :'String'
       }
     end
@@ -58,6 +78,10 @@ module DocuSign_eSign
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
+      if attributes.has_key?(:'description')
+        self.description = attributes[:'description']
+      end
+
       if attributes.has_key?(:'label')
         self.label = attributes[:'label']
       end
@@ -66,6 +90,16 @@ module DocuSign_eSign
         self.name = attributes[:'name']
       end
 
+      if attributes.has_key?(:'options')
+        if (value = attributes[:'options']).is_a?(Array)
+          self.options = value
+        end
+      end
+
+      if attributes.has_key?(:'predefinedValidation')
+        self.predefined_validation = attributes[:'predefinedValidation']
+      end
+
       if attributes.has_key?(:'required')
         self.required = attributes[:'required']
       end
@@ -74,6 +108,10 @@ module DocuSign_eSign
         self.type = attributes[:'type']
       end
 
+      if attributes.has_key?(:'validation')
+        self.validation = attributes[:'validation']
+      end
+
       if attributes.has_key?(:'value')
         self.value = attributes[:'value']
       end
@@ -97,10 +135,14 @@ module DocuSign_eSign
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          description == o.description &&
           label == o.label &&
           name == o.name &&
+          options == o.options &&
+          predefined_validation == o.predefined_validation &&
           required == o.required &&
           type == o.type &&
+          validation == o.validation &&
           value == o.value
     end
 
@@ -113,7 +155,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [label, name, required, type, value].hash
+      [description, label, name, options, predefined_validation, required, type, validation, value].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/doc_gen_form_field_option.rb

@@ -0,0 +1,214 @@
+=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 DocGenFormFieldOption
+    # 
+    attr_accessor :description
+
+    # 
+    attr_accessor :label
+
+    # 
+    attr_accessor :selected
+
+    # Specifies the value of the tab. 
+    attr_accessor :value
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'description' => :'description',
+        :'label' => :'label',
+        :'selected' => :'selected',
+        :'value' => :'value'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'description' => :'String',
+        :'label' => :'String',
+        :'selected' => :'String',
+        :'value' => :'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?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.has_key?(:'label')
+        self.label = attributes[:'label']
+      end
+
+      if attributes.has_key?(:'selected')
+        self.selected = attributes[:'selected']
+      end
+
+      if attributes.has_key?(:'value')
+        self.value = attributes[:'value']
+      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 &&
+          description == o.description &&
+          label == o.label &&
+          selected == o.selected &&
+          value == o.value
+    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
+      [description, label, selected, value].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/doc_gen_form_field_validation.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 DocGenFormFieldValidation
+    # 
+    attr_accessor :error_message
+
+    # 
+    attr_accessor :expression
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'error_message' => :'errorMessage',
+        :'expression' => :'expression'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'error_message' => :'String',
+        :'expression' => :'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?(:'errorMessage')
+        self.error_message = attributes[:'errorMessage']
+      end
+
+      if attributes.has_key?(:'expression')
+        self.expression = attributes[:'expression']
+      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 &&
+          error_message == o.error_message &&
+          expression == o.expression
+    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
+      [error_message, expression].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/document.rb

@@ -20,6 +20,9 @@ module DocuSign_eSign
     # 
     attr_accessor :assign_tabs_to_recipient_id
 
+    # Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.
+    attr_accessor :authoritative_copy
+
     # 
     attr_accessor :display
 
@@ -100,6 +103,7 @@ module DocuSign_eSign
       {
         :'apply_anchor_tabs' => :'applyAnchorTabs',
         :'assign_tabs_to_recipient_id' => :'assignTabsToRecipientId',
+        :'authoritative_copy' => :'authoritativeCopy',
         :'display' => :'display',
         :'doc_gen_form_fields' => :'docGenFormFields',
         :'document_base64' => :'documentBase64',
@@ -133,6 +137,7 @@ module DocuSign_eSign
       {
         :'apply_anchor_tabs' => :'String',
         :'assign_tabs_to_recipient_id' => :'String',
+        :'authoritative_copy' => :'BOOLEAN',
         :'display' => :'String',
         :'doc_gen_form_fields' => :'Array<DocGenFormField>',
         :'document_base64' => :'String',
@@ -177,6 +182,10 @@ module DocuSign_eSign
         self.assign_tabs_to_recipient_id = attributes[:'assignTabsToRecipientId']
       end
 
+      if attributes.has_key?(:'authoritativeCopy')
+        self.authoritative_copy = attributes[:'authoritativeCopy']
+      end
+
       if attributes.has_key?(:'display')
         self.display = attributes[:'display']
       end
@@ -304,6 +313,7 @@ module DocuSign_eSign
       self.class == o.class &&
           apply_anchor_tabs == o.apply_anchor_tabs &&
           assign_tabs_to_recipient_id == o.assign_tabs_to_recipient_id &&
+          authoritative_copy == o.authoritative_copy &&
           display == o.display &&
           doc_gen_form_fields == o.doc_gen_form_fields &&
           document_base64 == o.document_base64 &&
@@ -340,7 +350,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [apply_anchor_tabs, assign_tabs_to_recipient_id, display, doc_gen_form_fields, document_base64, document_fields, document_id, encrypted_with_key_manager, file_extension, file_format_hint, html_definition, include_in_download, is_doc_gen_document, match_boxes, name, order, pages, password, pdf_form_field_option, remote_url, signer_must_acknowledge, signer_must_acknowledge_use_account_default, tabs, template_locked, template_required, transform_pdf_fields, uri].hash
+      [apply_anchor_tabs, assign_tabs_to_recipient_id, authoritative_copy, display, doc_gen_form_fields, document_base64, document_fields, document_id, encrypted_with_key_manager, file_extension, file_format_hint, html_definition, include_in_download, is_doc_gen_document, match_boxes, name, order, pages, password, pdf_form_field_option, remote_url, signer_must_acknowledge, signer_must_acknowledge_use_account_default, tabs, template_locked, template_required, transform_pdf_fields, uri].hash
     end
 
     # Builds the object from hash