docusign_esign 3.0.0 → 3.1.0.pre.rc1

data/lib/docusign_esign/models/notary_result.rb

@@ -0,0 +1,199 @@
+=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 NotaryResult
+    # 
+    attr_accessor :jurisdictions
+
+    attr_accessor :notary
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'jurisdictions' => :'jurisdictions',
+        :'notary' => :'notary'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'jurisdictions' => :'Array<Jurisdiction>',
+        :'notary' => :'Notary'
+      }
+    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?(:'jurisdictions')
+        if (value = attributes[:'jurisdictions']).is_a?(Array)
+          self.jurisdictions = value
+        end
+      end
+
+      if attributes.has_key?(:'notary')
+        self.notary = attributes[:'notary']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return 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?
+      return 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 &&
+          jurisdictions == o.jurisdictions &&
+          notary == o.notary
+    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
+      [jurisdictions, notary].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 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/note.rb

@@ -14,6 +14,11 @@ require 'date'
 module DocuSign_eSign
 
   class Note
+    # 
+    attr_accessor :anchor_allow_white_space_in_characters
+
+    attr_accessor :anchor_allow_white_space_in_characters_metadata
+
     # When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.
     attr_accessor :anchor_case_sensitive
 
@@ -158,6 +163,8 @@ module DocuSign_eSign
 
     attr_accessor :shared_metadata
 
+    attr_accessor :smart_contract_information
+
     # 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
 
@@ -232,6 +239,8 @@ module DocuSign_eSign
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'anchor_allow_white_space_in_characters' => :'anchorAllowWhiteSpaceInCharacters',
+        :'anchor_allow_white_space_in_characters_metadata' => :'anchorAllowWhiteSpaceInCharactersMetadata',
         :'anchor_case_sensitive' => :'anchorCaseSensitive',
         :'anchor_case_sensitive_metadata' => :'anchorCaseSensitiveMetadata',
         :'anchor_horizontal_alignment' => :'anchorHorizontalAlignment',
@@ -290,6 +299,7 @@ module DocuSign_eSign
         :'recipient_id_metadata' => :'recipientIdMetadata',
         :'shared' => :'shared',
         :'shared_metadata' => :'sharedMetadata',
+        :'smart_contract_information' => :'smartContractInformation',
         :'status' => :'status',
         :'status_metadata' => :'statusMetadata',
         :'tab_group_labels' => :'tabGroupLabels',
@@ -324,6 +334,8 @@ module DocuSign_eSign
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'anchor_allow_white_space_in_characters' => :'String',
+        :'anchor_allow_white_space_in_characters_metadata' => :'PropertyMetadata',
         :'anchor_case_sensitive' => :'String',
         :'anchor_case_sensitive_metadata' => :'PropertyMetadata',
         :'anchor_horizontal_alignment' => :'String',
@@ -382,6 +394,7 @@ module DocuSign_eSign
         :'recipient_id_metadata' => :'PropertyMetadata',
         :'shared' => :'String',
         :'shared_metadata' => :'PropertyMetadata',
+        :'smart_contract_information' => :'SmartContractInformation',
         :'status' => :'String',
         :'status_metadata' => :'PropertyMetadata',
         :'tab_group_labels' => :'Array<String>',
@@ -421,6 +434,14 @@ 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?(:'anchorAllowWhiteSpaceInCharacters')
+        self.anchor_allow_white_space_in_characters = attributes[:'anchorAllowWhiteSpaceInCharacters']
+      end
+
+      if attributes.has_key?(:'anchorAllowWhiteSpaceInCharactersMetadata')
+        self.anchor_allow_white_space_in_characters_metadata = attributes[:'anchorAllowWhiteSpaceInCharactersMetadata']
+      end
+
       if attributes.has_key?(:'anchorCaseSensitive')
         self.anchor_case_sensitive = attributes[:'anchorCaseSensitive']
       end
@@ -653,6 +674,10 @@ module DocuSign_eSign
         self.shared_metadata = attributes[:'sharedMetadata']
       end
 
+      if attributes.has_key?(:'smartContractInformation')
+        self.smart_contract_information = attributes[:'smartContractInformation']
+      end
+
       if attributes.has_key?(:'status')
         self.status = attributes[:'status']
       end
@@ -787,6 +812,8 @@ module DocuSign_eSign
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          anchor_allow_white_space_in_characters == o.anchor_allow_white_space_in_characters &&
+          anchor_allow_white_space_in_characters_metadata == o.anchor_allow_white_space_in_characters_metadata &&
           anchor_case_sensitive == o.anchor_case_sensitive &&
           anchor_case_sensitive_metadata == o.anchor_case_sensitive_metadata &&
           anchor_horizontal_alignment == o.anchor_horizontal_alignment &&
@@ -845,6 +872,7 @@ module DocuSign_eSign
           recipient_id_metadata == o.recipient_id_metadata &&
           shared == o.shared &&
           shared_metadata == o.shared_metadata &&
+          smart_contract_information == o.smart_contract_information &&
           status == o.status &&
           status_metadata == o.status_metadata &&
           tab_group_labels == o.tab_group_labels &&
@@ -884,7 +912,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [anchor_case_sensitive, anchor_case_sensitive_metadata, anchor_horizontal_alignment, anchor_horizontal_alignment_metadata, anchor_ignore_if_not_present, anchor_ignore_if_not_present_metadata, anchor_match_whole_word, anchor_match_whole_word_metadata, anchor_string, anchor_string_metadata, anchor_tab_processor_version, anchor_tab_processor_version_metadata, anchor_units, anchor_units_metadata, anchor_x_offset, anchor_x_offset_metadata, anchor_y_offset, anchor_y_offset_metadata, bold, bold_metadata, conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, custom_tab_id, custom_tab_id_metadata, document_id, document_id_metadata, error_details, font, font_color, font_color_metadata, font_metadata, font_size, font_size_metadata, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, height, height_metadata, italic, italic_metadata, locale_policy, merge_field, merge_field_xml, name, name_metadata, page_number, page_number_metadata, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, shared, shared_metadata, status, status_metadata, tab_group_labels, tab_group_labels_metadata, tab_id, tab_id_metadata, tab_label, tab_label_metadata, tab_order, tab_order_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tool_tip_metadata, underline, underline_metadata, value, value_metadata, width, width_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
+      [anchor_allow_white_space_in_characters, anchor_allow_white_space_in_characters_metadata, anchor_case_sensitive, anchor_case_sensitive_metadata, anchor_horizontal_alignment, anchor_horizontal_alignment_metadata, anchor_ignore_if_not_present, anchor_ignore_if_not_present_metadata, anchor_match_whole_word, anchor_match_whole_word_metadata, anchor_string, anchor_string_metadata, anchor_tab_processor_version, anchor_tab_processor_version_metadata, anchor_units, anchor_units_metadata, anchor_x_offset, anchor_x_offset_metadata, anchor_y_offset, anchor_y_offset_metadata, bold, bold_metadata, conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, custom_tab_id, custom_tab_id_metadata, document_id, document_id_metadata, error_details, font, font_color, font_color_metadata, font_metadata, font_size, font_size_metadata, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, height, height_metadata, italic, italic_metadata, locale_policy, merge_field, merge_field_xml, name, name_metadata, page_number, page_number_metadata, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, shared, shared_metadata, smart_contract_information, status, status_metadata, tab_group_labels, tab_group_labels_metadata, tab_id, tab_id_metadata, tab_label, tab_label_metadata, tab_order, tab_order_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tool_tip_metadata, underline, underline_metadata, value, value_metadata, width, width_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/number.rb

@@ -14,6 +14,11 @@ require 'date'
 module DocuSign_eSign
 
   class Number
+    # 
+    attr_accessor :anchor_allow_white_space_in_characters
+
+    attr_accessor :anchor_allow_white_space_in_characters_metadata
+
     # When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.
     attr_accessor :anchor_case_sensitive
 
@@ -213,6 +218,8 @@ module DocuSign_eSign
 
     attr_accessor :shared_metadata
 
+    attr_accessor :smart_contract_information
+
     # 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
 
@@ -297,6 +304,8 @@ module DocuSign_eSign
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'anchor_allow_white_space_in_characters' => :'anchorAllowWhiteSpaceInCharacters',
+        :'anchor_allow_white_space_in_characters_metadata' => :'anchorAllowWhiteSpaceInCharactersMetadata',
         :'anchor_case_sensitive' => :'anchorCaseSensitive',
         :'anchor_case_sensitive_metadata' => :'anchorCaseSensitiveMetadata',
         :'anchor_horizontal_alignment' => :'anchorHorizontalAlignment',
@@ -377,6 +386,7 @@ module DocuSign_eSign
         :'sender_required_metadata' => :'senderRequiredMetadata',
         :'shared' => :'shared',
         :'shared_metadata' => :'sharedMetadata',
+        :'smart_contract_information' => :'smartContractInformation',
         :'status' => :'status',
         :'status_metadata' => :'statusMetadata',
         :'tab_group_labels' => :'tabGroupLabels',
@@ -415,6 +425,8 @@ module DocuSign_eSign
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'anchor_allow_white_space_in_characters' => :'String',
+        :'anchor_allow_white_space_in_characters_metadata' => :'PropertyMetadata',
         :'anchor_case_sensitive' => :'String',
         :'anchor_case_sensitive_metadata' => :'PropertyMetadata',
         :'anchor_horizontal_alignment' => :'String',
@@ -495,6 +507,7 @@ module DocuSign_eSign
         :'sender_required_metadata' => :'PropertyMetadata',
         :'shared' => :'String',
         :'shared_metadata' => :'PropertyMetadata',
+        :'smart_contract_information' => :'SmartContractInformation',
         :'status' => :'String',
         :'status_metadata' => :'PropertyMetadata',
         :'tab_group_labels' => :'Array<String>',
@@ -538,6 +551,14 @@ 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?(:'anchorAllowWhiteSpaceInCharacters')
+        self.anchor_allow_white_space_in_characters = attributes[:'anchorAllowWhiteSpaceInCharacters']
+      end
+
+      if attributes.has_key?(:'anchorAllowWhiteSpaceInCharactersMetadata')
+        self.anchor_allow_white_space_in_characters_metadata = attributes[:'anchorAllowWhiteSpaceInCharactersMetadata']
+      end
+
       if attributes.has_key?(:'anchorCaseSensitive')
         self.anchor_case_sensitive = attributes[:'anchorCaseSensitive']
       end
@@ -858,6 +879,10 @@ module DocuSign_eSign
         self.shared_metadata = attributes[:'sharedMetadata']
       end
 
+      if attributes.has_key?(:'smartContractInformation')
+        self.smart_contract_information = attributes[:'smartContractInformation']
+      end
+
       if attributes.has_key?(:'status')
         self.status = attributes[:'status']
       end
@@ -1008,6 +1033,8 @@ module DocuSign_eSign
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          anchor_allow_white_space_in_characters == o.anchor_allow_white_space_in_characters &&
+          anchor_allow_white_space_in_characters_metadata == o.anchor_allow_white_space_in_characters_metadata &&
           anchor_case_sensitive == o.anchor_case_sensitive &&
           anchor_case_sensitive_metadata == o.anchor_case_sensitive_metadata &&
           anchor_horizontal_alignment == o.anchor_horizontal_alignment &&
@@ -1088,6 +1115,7 @@ module DocuSign_eSign
           sender_required_metadata == o.sender_required_metadata &&
           shared == o.shared &&
           shared_metadata == o.shared_metadata &&
+          smart_contract_information == o.smart_contract_information &&
           status == o.status &&
           status_metadata == o.status_metadata &&
           tab_group_labels == o.tab_group_labels &&
@@ -1131,7 +1159,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [anchor_case_sensitive, anchor_case_sensitive_metadata, anchor_horizontal_alignment, anchor_horizontal_alignment_metadata, anchor_ignore_if_not_present, anchor_ignore_if_not_present_metadata, anchor_match_whole_word, anchor_match_whole_word_metadata, anchor_string, anchor_string_metadata, anchor_tab_processor_version, anchor_tab_processor_version_metadata, anchor_units, anchor_units_metadata, anchor_x_offset, anchor_x_offset_metadata, anchor_y_offset, anchor_y_offset_metadata, bold, bold_metadata, conceal_value_on_document, conceal_value_on_document_metadata, conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, custom_tab_id, custom_tab_id_metadata, disable_auto_size, disable_auto_size_metadata, document_id, document_id_metadata, error_details, font, font_color, font_color_metadata, font_metadata, font_size, font_size_metadata, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, formula, formula_metadata, height, height_metadata, is_payment_amount, is_payment_amount_metadata, italic, italic_metadata, locale_policy, locked, locked_metadata, max_length, max_length_metadata, merge_field, merge_field_xml, name, name_metadata, original_value, original_value_metadata, page_number, page_number_metadata, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, require_all, require_all_metadata, required, required_metadata, require_initial_on_shared_change, require_initial_on_shared_change_metadata, sender_required, sender_required_metadata, shared, shared_metadata, status, status_metadata, tab_group_labels, tab_group_labels_metadata, tab_id, tab_id_metadata, tab_label, tab_label_metadata, tab_order, tab_order_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tool_tip_metadata, underline, underline_metadata, validation_message, validation_message_metadata, validation_pattern, validation_pattern_metadata, value, value_metadata, width, width_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
+      [anchor_allow_white_space_in_characters, anchor_allow_white_space_in_characters_metadata, anchor_case_sensitive, anchor_case_sensitive_metadata, anchor_horizontal_alignment, anchor_horizontal_alignment_metadata, anchor_ignore_if_not_present, anchor_ignore_if_not_present_metadata, anchor_match_whole_word, anchor_match_whole_word_metadata, anchor_string, anchor_string_metadata, anchor_tab_processor_version, anchor_tab_processor_version_metadata, anchor_units, anchor_units_metadata, anchor_x_offset, anchor_x_offset_metadata, anchor_y_offset, anchor_y_offset_metadata, bold, bold_metadata, conceal_value_on_document, conceal_value_on_document_metadata, conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, custom_tab_id, custom_tab_id_metadata, disable_auto_size, disable_auto_size_metadata, document_id, document_id_metadata, error_details, font, font_color, font_color_metadata, font_metadata, font_size, font_size_metadata, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, formula, formula_metadata, height, height_metadata, is_payment_amount, is_payment_amount_metadata, italic, italic_metadata, locale_policy, locked, locked_metadata, max_length, max_length_metadata, merge_field, merge_field_xml, name, name_metadata, original_value, original_value_metadata, page_number, page_number_metadata, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, require_all, require_all_metadata, required, required_metadata, require_initial_on_shared_change, require_initial_on_shared_change_metadata, sender_required, sender_required_metadata, shared, shared_metadata, smart_contract_information, status, status_metadata, tab_group_labels, tab_group_labels_metadata, tab_id, tab_id_metadata, tab_label, tab_label_metadata, tab_order, tab_order_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tool_tip_metadata, underline, underline_metadata, validation_message, validation_message_metadata, validation_pattern, validation_pattern_metadata, value, value_metadata, width, width_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/ocr_request.rb

@@ -0,0 +1,238 @@
+=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 OcrRequest
+    # 
+    attr_accessor :ocr_language
+
+    # 
+    attr_accessor :page_selection
+
+    # 
+    attr_accessor :set_page_orientation
+
+    # 
+    attr_accessor :show_frames
+
+    # 
+    attr_accessor :show_text
+
+    # 
+    attr_accessor :skip_pages_having_existing_extractable_text
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'ocr_language' => :'ocrLanguage',
+        :'page_selection' => :'pageSelection',
+        :'set_page_orientation' => :'setPageOrientation',
+        :'show_frames' => :'showFrames',
+        :'show_text' => :'showText',
+        :'skip_pages_having_existing_extractable_text' => :'skipPagesHavingExistingExtractableText'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'ocr_language' => :'String',
+        :'page_selection' => :'String',
+        :'set_page_orientation' => :'String',
+        :'show_frames' => :'String',
+        :'show_text' => :'String',
+        :'skip_pages_having_existing_extractable_text' => :'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?(:'ocrLanguage')
+        self.ocr_language = attributes[:'ocrLanguage']
+      end
+
+      if attributes.has_key?(:'pageSelection')
+        self.page_selection = attributes[:'pageSelection']
+      end
+
+      if attributes.has_key?(:'setPageOrientation')
+        self.set_page_orientation = attributes[:'setPageOrientation']
+      end
+
+      if attributes.has_key?(:'showFrames')
+        self.show_frames = attributes[:'showFrames']
+      end
+
+      if attributes.has_key?(:'showText')
+        self.show_text = attributes[:'showText']
+      end
+
+      if attributes.has_key?(:'skipPagesHavingExistingExtractableText')
+        self.skip_pages_having_existing_extractable_text = attributes[:'skipPagesHavingExistingExtractableText']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return 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?
+      return 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 &&
+          ocr_language == o.ocr_language &&
+          page_selection == o.page_selection &&
+          set_page_orientation == o.set_page_orientation &&
+          show_frames == o.show_frames &&
+          show_text == o.show_text &&
+          skip_pages_having_existing_extractable_text == o.skip_pages_having_existing_extractable_text
+    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
+      [ocr_language, page_selection, set_page_orientation, show_frames, show_text, skip_pages_having_existing_extractable_text].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 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