docusign_esign 3.4.0 → 3.5.0.rc1

data/lib/docusign_esign/models/report_in_product_save_response.rb

@@ -0,0 +1,185 @@
+=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
+Swagger Codegen version: 2.4.13-SNAPSHOT
+
+=end
+
+require 'date'
+
+module DocuSign_eSign
+  class ReportInProductSaveResponse
+    # 
+    attr_accessor :report_customized_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'report_customized_id' => :'reportCustomizedId'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'report_customized_id' => :'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?(:'reportCustomizedId')
+        self.report_customized_id = attributes[:'reportCustomizedId']
+      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 &&
+          report_customized_id == o.report_customized_id
+    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
+      [report_customized_id].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/report_in_product_sent_by_details.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
+Swagger Codegen version: 2.4.13-SNAPSHOT
+
+=end
+
+require 'date'
+
+module DocuSign_eSign
+  class ReportInProductSentByDetails
+    # A collection group objects containing information about the groups returned.
+    attr_accessor :groups
+
+    # 
+    attr_accessor :users
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'groups' => :'groups',
+        :'users' => :'users'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'groups' => :'Array<Group>',
+        :'users' => :'Array<UserInfo>'
+      }
+    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?(:'groups')
+        if (value = attributes[:'groups']).is_a?(Array)
+          self.groups = value
+        end
+      end
+
+      if attributes.has_key?(:'users')
+        if (value = attributes[:'users']).is_a?(Array)
+          self.users = value
+        end
+      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 &&
+          groups == o.groups &&
+          users == o.users
+    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
+      [groups, users].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/sender_email_notifications.rb

@@ -32,6 +32,9 @@ module DocuSign_eSign
     # When set to **true**, the user receives notification if the offline signing failed.
     attr_accessor :offline_signing_failed
 
+    # 
+    attr_accessor :powerform_responses_limit_notification_email
+
     # 
     attr_accessor :purge_documents
 
@@ -53,6 +56,7 @@ module DocuSign_eSign
         :'delivery_failed' => :'deliveryFailed',
         :'envelope_complete' => :'envelopeComplete',
         :'offline_signing_failed' => :'offlineSigningFailed',
+        :'powerform_responses_limit_notification_email' => :'powerformResponsesLimitNotificationEmail',
         :'purge_documents' => :'purgeDocuments',
         :'recipient_viewed' => :'recipientViewed',
         :'sender_envelope_declined' => :'senderEnvelopeDeclined',
@@ -69,6 +73,7 @@ module DocuSign_eSign
         :'delivery_failed' => :'String',
         :'envelope_complete' => :'String',
         :'offline_signing_failed' => :'String',
+        :'powerform_responses_limit_notification_email' => :'String',
         :'purge_documents' => :'String',
         :'recipient_viewed' => :'String',
         :'sender_envelope_declined' => :'String',
@@ -108,6 +113,10 @@ module DocuSign_eSign
         self.offline_signing_failed = attributes[:'offlineSigningFailed']
       end
 
+      if attributes.has_key?(:'powerformResponsesLimitNotificationEmail')
+        self.powerform_responses_limit_notification_email = attributes[:'powerformResponsesLimitNotificationEmail']
+      end
+
       if attributes.has_key?(:'purgeDocuments')
         self.purge_documents = attributes[:'purgeDocuments']
       end
@@ -149,6 +158,7 @@ module DocuSign_eSign
           delivery_failed == o.delivery_failed &&
           envelope_complete == o.envelope_complete &&
           offline_signing_failed == o.offline_signing_failed &&
+          powerform_responses_limit_notification_email == o.powerform_responses_limit_notification_email &&
           purge_documents == o.purge_documents &&
           recipient_viewed == o.recipient_viewed &&
           sender_envelope_declined == o.sender_envelope_declined &&
@@ -164,7 +174,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [changed_signer, comments_only_private_and_mention, comments_receive_all, delivery_failed, envelope_complete, offline_signing_failed, purge_documents, recipient_viewed, sender_envelope_declined, withdrawn_consent].hash
+      [changed_signer, comments_only_private_and_mention, comments_receive_all, delivery_failed, envelope_complete, offline_signing_failed, powerform_responses_limit_notification_email, purge_documents, recipient_viewed, sender_envelope_declined, withdrawn_consent].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/tab_metadata.rb

@@ -115,9 +115,15 @@ module DocuSign_eSign
     # 
     attr_accessor :payment_item_name
 
+    # When set to **true** and shared is true, information must be entered in this field to complete the envelope. 
+    attr_accessor :require_all
+
     # When set to **true**, the signer is required to fill out this tab
     attr_accessor :required
 
+    # Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.
+    attr_accessor :require_initial_on_shared_change
+
     # 
     attr_accessor :scale_value
 
@@ -187,7 +193,9 @@ module DocuSign_eSign
         :'payment_item_code' => :'paymentItemCode',
         :'payment_item_description' => :'paymentItemDescription',
         :'payment_item_name' => :'paymentItemName',
+        :'require_all' => :'requireAll',
         :'required' => :'required',
+        :'require_initial_on_shared_change' => :'requireInitialOnSharedChange',
         :'scale_value' => :'scaleValue',
         :'selected' => :'selected',
         :'shared' => :'shared',
@@ -239,7 +247,9 @@ module DocuSign_eSign
         :'payment_item_code' => :'String',
         :'payment_item_description' => :'String',
         :'payment_item_name' => :'String',
+        :'require_all' => :'String',
         :'required' => :'String',
+        :'require_initial_on_shared_change' => :'String',
         :'scale_value' => :'String',
         :'selected' => :'String',
         :'shared' => :'String',
@@ -400,10 +410,18 @@ module DocuSign_eSign
         self.payment_item_name = attributes[:'paymentItemName']
       end
 
+      if attributes.has_key?(:'requireAll')
+        self.require_all = attributes[:'requireAll']
+      end
+
       if attributes.has_key?(:'required')
         self.required = attributes[:'required']
       end
 
+      if attributes.has_key?(:'requireInitialOnSharedChange')
+        self.require_initial_on_shared_change = attributes[:'requireInitialOnSharedChange']
+      end
+
       if attributes.has_key?(:'scaleValue')
         self.scale_value = attributes[:'scaleValue']
       end
@@ -501,7 +519,9 @@ module DocuSign_eSign
           payment_item_code == o.payment_item_code &&
           payment_item_description == o.payment_item_description &&
           payment_item_name == o.payment_item_name &&
+          require_all == o.require_all &&
           required == o.required &&
+          require_initial_on_shared_change == o.require_initial_on_shared_change &&
           scale_value == o.scale_value &&
           selected == o.selected &&
           shared == o.shared &&
@@ -524,7 +544,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [anchor, anchor_case_sensitive, anchor_horizontal_alignment, anchor_ignore_if_not_present, anchor_match_whole_word, anchor_units, anchor_x_offset, anchor_y_offset, bold, collaborative, conceal_value_on_document, created_by_display_name, created_by_user_id, custom_tab_id, disable_auto_size, editable, font, font_color, font_size, height, included_in_email, initial_value, italic, items, last_modified, last_modified_by_display_name, last_modified_by_user_id, locked, maximum_length, merge_field, name, payment_item_code, payment_item_description, payment_item_name, required, scale_value, selected, shared, stamp_type, stamp_type_metadata, tab_label, type, underline, validation_message, validation_pattern, width].hash
+      [anchor, anchor_case_sensitive, anchor_horizontal_alignment, anchor_ignore_if_not_present, anchor_match_whole_word, anchor_units, anchor_x_offset, anchor_y_offset, bold, collaborative, conceal_value_on_document, created_by_display_name, created_by_user_id, custom_tab_id, disable_auto_size, editable, font, font_color, font_size, height, included_in_email, initial_value, italic, items, last_modified, last_modified_by_display_name, last_modified_by_user_id, locked, maximum_length, merge_field, name, payment_item_code, payment_item_description, payment_item_name, require_all, required, require_initial_on_shared_change, scale_value, selected, shared, stamp_type, stamp_type_metadata, tab_label, type, underline, validation_message, validation_pattern, width].hash
     end
 
     # Builds the object from hash