docusign_esign 1.0.2 → 2.0.0

data/lib/docusign_esign/models/smart_section_display_settings.rb

@@ -0,0 +1,287 @@
+=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
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module DocuSign_eSign
+
+  class SmartSectionDisplaySettings
+    # 
+    attr_accessor :cell_style
+
+    attr_accessor :collapsible_settings
+
+    # 
+    attr_accessor :display
+
+    # 
+    attr_accessor :display_label
+
+    # 
+    attr_accessor :display_order
+
+    # 
+    attr_accessor :display_page_number
+
+    # 
+    attr_accessor :hide_label_when_opened
+
+    # 
+    attr_accessor :inline_outer_style
+
+    # 
+    attr_accessor :label_when_opened
+
+    # 
+    attr_accessor :scroll_to_top_when_opened
+
+    # 
+    attr_accessor :table_style
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'cell_style' => :'cellStyle',
+        :'collapsible_settings' => :'collapsibleSettings',
+        :'display' => :'display',
+        :'display_label' => :'displayLabel',
+        :'display_order' => :'displayOrder',
+        :'display_page_number' => :'displayPageNumber',
+        :'hide_label_when_opened' => :'hideLabelWhenOpened',
+        :'inline_outer_style' => :'inlineOuterStyle',
+        :'label_when_opened' => :'labelWhenOpened',
+        :'scroll_to_top_when_opened' => :'scrollToTopWhenOpened',
+        :'table_style' => :'tableStyle'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'cell_style' => :'String',
+        :'collapsible_settings' => :'SmartSectionCollapsibleDisplaySettings',
+        :'display' => :'String',
+        :'display_label' => :'String',
+        :'display_order' => :'Integer',
+        :'display_page_number' => :'Integer',
+        :'hide_label_when_opened' => :'BOOLEAN',
+        :'inline_outer_style' => :'String',
+        :'label_when_opened' => :'String',
+        :'scroll_to_top_when_opened' => :'BOOLEAN',
+        :'table_style' => :'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?(:'cellStyle')
+        self.cell_style = attributes[:'cellStyle']
+      end
+
+      if attributes.has_key?(:'collapsibleSettings')
+        self.collapsible_settings = attributes[:'collapsibleSettings']
+      end
+
+      if attributes.has_key?(:'display')
+        self.display = attributes[:'display']
+      end
+
+      if attributes.has_key?(:'displayLabel')
+        self.display_label = attributes[:'displayLabel']
+      end
+
+      if attributes.has_key?(:'displayOrder')
+        self.display_order = attributes[:'displayOrder']
+      end
+
+      if attributes.has_key?(:'displayPageNumber')
+        self.display_page_number = attributes[:'displayPageNumber']
+      end
+
+      if attributes.has_key?(:'hideLabelWhenOpened')
+        self.hide_label_when_opened = attributes[:'hideLabelWhenOpened']
+      end
+
+      if attributes.has_key?(:'inlineOuterStyle')
+        self.inline_outer_style = attributes[:'inlineOuterStyle']
+      end
+
+      if attributes.has_key?(:'labelWhenOpened')
+        self.label_when_opened = attributes[:'labelWhenOpened']
+      end
+
+      if attributes.has_key?(:'scrollToTopWhenOpened')
+        self.scroll_to_top_when_opened = attributes[:'scrollToTopWhenOpened']
+      end
+
+      if attributes.has_key?(:'tableStyle')
+        self.table_style = attributes[:'tableStyle']
+      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 &&
+          cell_style == o.cell_style &&
+          collapsible_settings == o.collapsible_settings &&
+          display == o.display &&
+          display_label == o.display_label &&
+          display_order == o.display_order &&
+          display_page_number == o.display_page_number &&
+          hide_label_when_opened == o.hide_label_when_opened &&
+          inline_outer_style == o.inline_outer_style &&
+          label_when_opened == o.label_when_opened &&
+          scroll_to_top_when_opened == o.scroll_to_top_when_opened &&
+          table_style == o.table_style
+    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
+      [cell_style, collapsible_settings, display, display_label, display_order, display_page_number, hide_label_when_opened, inline_outer_style, label_when_opened, scroll_to_top_when_opened, table_style].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/ssn.rb

@@ -32,10 +32,10 @@ module DocuSign_eSign
     # Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
     attr_accessor :anchor_units
 
-    # Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
+    # Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
     attr_accessor :anchor_x_offset
 
-    # Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
+    # Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
     attr_accessor :anchor_y_offset
 
     # When set to **true**, the information in the tab is bold.
@@ -111,6 +111,9 @@ module DocuSign_eSign
     # 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
 
+    # 
+    attr_accessor :tab_group_labels
+
     # The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].     
     attr_accessor :tab_id
 
@@ -126,13 +129,16 @@ module DocuSign_eSign
     # When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
     attr_accessor :template_required
 
+    # 
+    attr_accessor :tooltip
+
     # When set to **true**, the information in the tab is underlined.
     attr_accessor :underline
 
     # The message displayed if the custom tab fails input validation (either custom of embedded).
     attr_accessor :validation_message
 
-    # A regular expressionn used to validate input for the tab.
+    # A regular expression used to validate input for the tab.
     attr_accessor :validation_pattern
 
     # Specifies the value of the tab. 
@@ -184,11 +190,13 @@ module DocuSign_eSign
         :'sender_required' => :'senderRequired',
         :'shared' => :'shared',
         :'status' => :'status',
+        :'tab_group_labels' => :'tabGroupLabels',
         :'tab_id' => :'tabId',
         :'tab_label' => :'tabLabel',
         :'tab_order' => :'tabOrder',
         :'template_locked' => :'templateLocked',
         :'template_required' => :'templateRequired',
+        :'tooltip' => :'tooltip',
         :'underline' => :'underline',
         :'validation_message' => :'validationMessage',
         :'validation_pattern' => :'validationPattern',
@@ -235,11 +243,13 @@ module DocuSign_eSign
         :'sender_required' => :'String',
         :'shared' => :'String',
         :'status' => :'String',
+        :'tab_group_labels' => :'Array<String>',
         :'tab_id' => :'String',
         :'tab_label' => :'String',
         :'tab_order' => :'String',
         :'template_locked' => :'String',
         :'template_required' => :'String',
+        :'tooltip' => :'String',
         :'underline' => :'String',
         :'validation_message' => :'String',
         :'validation_pattern' => :'String',
@@ -390,6 +400,12 @@ module DocuSign_eSign
         self.status = attributes[:'status']
       end
 
+      if attributes.has_key?(:'tabGroupLabels')
+        if (value = attributes[:'tabGroupLabels']).is_a?(Array)
+          self.tab_group_labels = value
+        end
+      end
+
       if attributes.has_key?(:'tabId')
         self.tab_id = attributes[:'tabId']
       end
@@ -410,6 +426,10 @@ module DocuSign_eSign
         self.template_required = attributes[:'templateRequired']
       end
 
+      if attributes.has_key?(:'tooltip')
+        self.tooltip = attributes[:'tooltip']
+      end
+
       if attributes.has_key?(:'underline')
         self.underline = attributes[:'underline']
       end
@@ -491,11 +511,13 @@ module DocuSign_eSign
           sender_required == o.sender_required &&
           shared == o.shared &&
           status == o.status &&
+          tab_group_labels == o.tab_group_labels &&
           tab_id == o.tab_id &&
           tab_label == o.tab_label &&
           tab_order == o.tab_order &&
           template_locked == o.template_locked &&
           template_required == o.template_required &&
+          tooltip == o.tooltip &&
           underline == o.underline &&
           validation_message == o.validation_message &&
           validation_pattern == o.validation_pattern &&
@@ -514,7 +536,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [anchor_case_sensitive, anchor_horizontal_alignment, anchor_ignore_if_not_present, anchor_match_whole_word, anchor_string, anchor_units, anchor_x_offset, anchor_y_offset, bold, conceal_value_on_document, conditional_parent_label, conditional_parent_value, custom_tab_id, disable_auto_size, document_id, error_details, font, font_color, font_size, italic, locked, max_length, merge_field, name, original_value, page_number, recipient_id, require_all, required, require_initial_on_shared_change, sender_required, shared, status, tab_id, tab_label, tab_order, template_locked, template_required, underline, validation_message, validation_pattern, value, width, x_position, y_position].hash
+      [anchor_case_sensitive, anchor_horizontal_alignment, anchor_ignore_if_not_present, anchor_match_whole_word, anchor_string, anchor_units, anchor_x_offset, anchor_y_offset, bold, conceal_value_on_document, conditional_parent_label, conditional_parent_value, custom_tab_id, disable_auto_size, document_id, error_details, font, font_color, font_size, italic, locked, max_length, merge_field, name, original_value, page_number, recipient_id, require_all, required, require_initial_on_shared_change, sender_required, shared, status, tab_group_labels, tab_id, tab_label, tab_order, template_locked, template_required, tooltip, underline, validation_message, validation_pattern, value, width, x_position, y_position].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/supported_languages.rb

@@ -0,0 +1,190 @@
+=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
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module DocuSign_eSign
+
+  class SupportedLanguages
+    # 
+    attr_accessor :languages
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'languages' => :'languages'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'languages' => :'Array<NameValue>'
+      }
+    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?(:'languages')
+        if (value = attributes[:'languages']).is_a?(Array)
+          self.languages = value
+        end
+      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 &&
+          languages == o.languages
+    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
+      [languages].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