docusign_esign 3.3.0.pre.rc → 3.5.0

data/lib/docusign_esign/models/conditional_recipient_rule_filter.rb

@@ -0,0 +1,235 @@
+=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 ConditionalRecipientRuleFilter
+    # 
+    attr_accessor :operator
+
+    # Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
+    attr_accessor :recipient_id
+
+    # 
+    attr_accessor :scope
+
+    # The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].     
+    attr_accessor :tab_id
+
+    # The label string associated with the tab.
+    attr_accessor :tab_label
+
+    # Specifies the value of the tab. 
+    attr_accessor :value
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'operator' => :'operator',
+        :'recipient_id' => :'recipientId',
+        :'scope' => :'scope',
+        :'tab_id' => :'tabId',
+        :'tab_label' => :'tabLabel',
+        :'value' => :'value'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'operator' => :'String',
+        :'recipient_id' => :'String',
+        :'scope' => :'String',
+        :'tab_id' => :'String',
+        :'tab_label' => :'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?(:'operator')
+        self.operator = attributes[:'operator']
+      end
+
+      if attributes.has_key?(:'recipientId')
+        self.recipient_id = attributes[:'recipientId']
+      end
+
+      if attributes.has_key?(:'scope')
+        self.scope = attributes[:'scope']
+      end
+
+      if attributes.has_key?(:'tabId')
+        self.tab_id = attributes[:'tabId']
+      end
+
+      if attributes.has_key?(:'tabLabel')
+        self.tab_label = attributes[:'tabLabel']
+      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 &&
+          operator == o.operator &&
+          recipient_id == o.recipient_id &&
+          scope == o.scope &&
+          tab_id == o.tab_id &&
+          tab_label == o.tab_label &&
+          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
+      [operator, recipient_id, scope, tab_id, tab_label, 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/e_note_configuration.rb

@@ -14,6 +14,9 @@ require 'date'
 
 module DocuSign_eSign
   class ENoteConfiguration
+    # 
+    attr_accessor :api_key
+
     # 
     attr_accessor :connect_configured
 
@@ -32,6 +35,7 @@ module DocuSign_eSign
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'api_key' => :'apiKey',
         :'connect_configured' => :'connectConfigured',
         :'e_note_configured' => :'eNoteConfigured',
         :'organization' => :'organization',
@@ -43,6 +47,7 @@ module DocuSign_eSign
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'api_key' => :'String',
         :'connect_configured' => :'String',
         :'e_note_configured' => :'String',
         :'organization' => :'String',
@@ -59,6 +64,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?(:'apiKey')
+        self.api_key = attributes[:'apiKey']
+      end
+
       if attributes.has_key?(:'connectConfigured')
         self.connect_configured = attributes[:'connectConfigured']
       end
@@ -98,6 +107,7 @@ module DocuSign_eSign
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          api_key == o.api_key &&
           connect_configured == o.connect_configured &&
           e_note_configured == o.e_note_configured &&
           organization == o.organization &&
@@ -114,7 +124,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [connect_configured, e_note_configured, organization, password, user_name].hash
+      [api_key, connect_configured, e_note_configured, organization, password, user_name].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/envelope.rb

@@ -231,6 +231,8 @@ module DocuSign_eSign
     # The reason the envelope or template was voided.
     attr_accessor :voided_reason
 
+    attr_accessor :workflow
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -308,7 +310,8 @@ module DocuSign_eSign
         :'transaction_id' => :'transactionId',
         :'use_disclosure' => :'useDisclosure',
         :'voided_date_time' => :'voidedDateTime',
-        :'voided_reason' => :'voidedReason'
+        :'voided_reason' => :'voidedReason',
+        :'workflow' => :'workflow'
       }
     end
 
@@ -389,7 +392,8 @@ module DocuSign_eSign
         :'transaction_id' => :'String',
         :'use_disclosure' => :'String',
         :'voided_date_time' => :'String',
-        :'voided_reason' => :'String'
+        :'voided_reason' => :'String',
+        :'workflow' => :'Workflow'
       }
     end
 
@@ -706,6 +710,10 @@ module DocuSign_eSign
       if attributes.has_key?(:'voidedReason')
         self.voided_reason = attributes[:'voidedReason']
       end
+
+      if attributes.has_key?(:'workflow')
+        self.workflow = attributes[:'workflow']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -800,7 +808,8 @@ module DocuSign_eSign
           transaction_id == o.transaction_id &&
           use_disclosure == o.use_disclosure &&
           voided_date_time == o.voided_date_time &&
-          voided_reason == o.voided_reason
+          voided_reason == o.voided_reason &&
+          workflow == o.workflow
     end
 
     # @see the `==` method
@@ -812,7 +821,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [access_control_list_base64, allow_comments, allow_markup, allow_reassign, allow_view_history, any_signer, asynchronous, attachments_uri, authoritative_copy, authoritative_copy_default, auto_navigation, brand_id, brand_lock, certificate_uri, completed_date_time, copy_recipient_data, created_date_time, custom_fields, custom_fields_uri, declined_date_time, deleted_date_time, delivered_date_time, disable_responsive_document, documents_combined_uri, documents_uri, email_blurb, email_settings, email_subject, enable_wet_sign, enforce_signer_visibility, envelope_attachments, envelope_documents, envelope_id, envelope_id_stamping, envelope_location, envelope_metadata, envelope_uri, expire_after, expire_date_time, expire_enabled, external_envelope_id, folders, has_comments, has_form_data_changed, has_wav_file, holder, initial_sent_date_time, is21_cfr_part11, is_dynamic_envelope, is_signature_provider_envelope, last_modified_date_time, location, lock_information, message_lock, notification, notification_uri, power_form, purge_completed_date, purge_request_date, purge_state, recipients, recipients_lock, recipients_uri, sender, sent_date_time, signer_can_sign_on_mobile, signing_location, status, status_changed_date_time, status_date_time, templates_uri, transaction_id, use_disclosure, voided_date_time, voided_reason].hash
+      [access_control_list_base64, allow_comments, allow_markup, allow_reassign, allow_view_history, any_signer, asynchronous, attachments_uri, authoritative_copy, authoritative_copy_default, auto_navigation, brand_id, brand_lock, certificate_uri, completed_date_time, copy_recipient_data, created_date_time, custom_fields, custom_fields_uri, declined_date_time, deleted_date_time, delivered_date_time, disable_responsive_document, documents_combined_uri, documents_uri, email_blurb, email_settings, email_subject, enable_wet_sign, enforce_signer_visibility, envelope_attachments, envelope_documents, envelope_id, envelope_id_stamping, envelope_location, envelope_metadata, envelope_uri, expire_after, expire_date_time, expire_enabled, external_envelope_id, folders, has_comments, has_form_data_changed, has_wav_file, holder, initial_sent_date_time, is21_cfr_part11, is_dynamic_envelope, is_signature_provider_envelope, last_modified_date_time, location, lock_information, message_lock, notification, notification_uri, power_form, purge_completed_date, purge_request_date, purge_state, recipients, recipients_lock, recipients_uri, sender, sent_date_time, signer_can_sign_on_mobile, signing_location, status, status_changed_date_time, status_date_time, templates_uri, transaction_id, use_disclosure, voided_date_time, voided_reason, workflow].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/envelope_definition.rb

@@ -260,6 +260,8 @@ module DocuSign_eSign
     # The reason the envelope or template was voided.
     attr_accessor :voided_reason
 
+    attr_accessor :workflow
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -347,7 +349,8 @@ module DocuSign_eSign
         :'transaction_id' => :'transactionId',
         :'use_disclosure' => :'useDisclosure',
         :'voided_date_time' => :'voidedDateTime',
-        :'voided_reason' => :'voidedReason'
+        :'voided_reason' => :'voidedReason',
+        :'workflow' => :'workflow'
       }
     end
 
@@ -438,7 +441,8 @@ module DocuSign_eSign
         :'transaction_id' => :'String',
         :'use_disclosure' => :'String',
         :'voided_date_time' => :'String',
-        :'voided_reason' => :'String'
+        :'voided_reason' => :'String',
+        :'workflow' => :'Workflow'
       }
     end
 
@@ -805,6 +809,10 @@ module DocuSign_eSign
       if attributes.has_key?(:'voidedReason')
         self.voided_reason = attributes[:'voidedReason']
       end
+
+      if attributes.has_key?(:'workflow')
+        self.workflow = attributes[:'workflow']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -909,7 +917,8 @@ module DocuSign_eSign
           transaction_id == o.transaction_id &&
           use_disclosure == o.use_disclosure &&
           voided_date_time == o.voided_date_time &&
-          voided_reason == o.voided_reason
+          voided_reason == o.voided_reason &&
+          workflow == o.workflow
     end
 
     # @see the `==` method
@@ -921,7 +930,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [access_control_list_base64, accessibility, allow_comments, allow_markup, allow_reassign, allow_recipient_recursion, allow_view_history, any_signer, asynchronous, attachments, attachments_uri, authoritative_copy, authoritative_copy_default, auto_navigation, brand_id, brand_lock, certificate_uri, completed_date_time, composite_templates, copy_recipient_data, created_date_time, custom_fields, custom_fields_uri, declined_date_time, deleted_date_time, delivered_date_time, disable_responsive_document, documents, documents_combined_uri, documents_uri, email_blurb, email_settings, email_subject, enable_wet_sign, enforce_signer_visibility, envelope_attachments, envelope_documents, envelope_id, envelope_id_stamping, envelope_location, envelope_metadata, envelope_uri, event_notification, event_notifications, expire_after, expire_date_time, expire_enabled, external_envelope_id, folders, has_comments, has_form_data_changed, has_wav_file, holder, initial_sent_date_time, is21_cfr_part11, is_dynamic_envelope, is_signature_provider_envelope, last_modified_date_time, location, lock_information, message_lock, notification, notification_uri, password, power_form, purge_completed_date, purge_request_date, purge_state, recipients, recipients_lock, recipients_uri, sender, sent_date_time, signer_can_sign_on_mobile, signing_location, status, status_changed_date_time, status_date_time, template_id, template_roles, templates_uri, transaction_id, use_disclosure, voided_date_time, voided_reason].hash
+      [access_control_list_base64, accessibility, allow_comments, allow_markup, allow_reassign, allow_recipient_recursion, allow_view_history, any_signer, asynchronous, attachments, attachments_uri, authoritative_copy, authoritative_copy_default, auto_navigation, brand_id, brand_lock, certificate_uri, completed_date_time, composite_templates, copy_recipient_data, created_date_time, custom_fields, custom_fields_uri, declined_date_time, deleted_date_time, delivered_date_time, disable_responsive_document, documents, documents_combined_uri, documents_uri, email_blurb, email_settings, email_subject, enable_wet_sign, enforce_signer_visibility, envelope_attachments, envelope_documents, envelope_id, envelope_id_stamping, envelope_location, envelope_metadata, envelope_uri, event_notification, event_notifications, expire_after, expire_date_time, expire_enabled, external_envelope_id, folders, has_comments, has_form_data_changed, has_wav_file, holder, initial_sent_date_time, is21_cfr_part11, is_dynamic_envelope, is_signature_provider_envelope, last_modified_date_time, location, lock_information, message_lock, notification, notification_uri, password, power_form, purge_completed_date, purge_request_date, purge_state, recipients, recipients_lock, recipients_uri, sender, sent_date_time, signer_can_sign_on_mobile, signing_location, status, status_changed_date_time, status_date_time, template_id, template_roles, templates_uri, transaction_id, use_disclosure, voided_date_time, voided_reason, workflow].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/envelope_template.rb

@@ -295,6 +295,8 @@ module DocuSign_eSign
     # The reason the envelope or template was voided.
     attr_accessor :voided_reason
 
+    attr_accessor :workflow
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -394,7 +396,8 @@ module DocuSign_eSign
         :'uri' => :'uri',
         :'use_disclosure' => :'useDisclosure',
         :'voided_date_time' => :'voidedDateTime',
-        :'voided_reason' => :'voidedReason'
+        :'voided_reason' => :'voidedReason',
+        :'workflow' => :'workflow'
       }
     end
 
@@ -497,7 +500,8 @@ module DocuSign_eSign
         :'uri' => :'String',
         :'use_disclosure' => :'String',
         :'voided_date_time' => :'String',
-        :'voided_reason' => :'String'
+        :'voided_reason' => :'String',
+        :'workflow' => :'Workflow'
       }
     end
 
@@ -908,6 +912,10 @@ module DocuSign_eSign
       if attributes.has_key?(:'voidedReason')
         self.voided_reason = attributes[:'voidedReason']
       end
+
+      if attributes.has_key?(:'workflow')
+        self.workflow = attributes[:'workflow']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -1024,7 +1032,8 @@ module DocuSign_eSign
           uri == o.uri &&
           use_disclosure == o.use_disclosure &&
           voided_date_time == o.voided_date_time &&
-          voided_reason == o.voided_reason
+          voided_reason == o.voided_reason &&
+          workflow == o.workflow
     end
 
     # @see the `==` method
@@ -1036,7 +1045,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [access_control_list_base64, allow_comments, allow_markup, allow_reassign, allow_view_history, any_signer, asynchronous, attachments_uri, authoritative_copy, authoritative_copy_default, auto_match, auto_match_specified_by_user, auto_navigation, brand_id, brand_lock, certificate_uri, completed_date_time, copy_recipient_data, created, created_date_time, custom_fields, custom_fields_uri, declined_date_time, deleted_date_time, delivered_date_time, description, disable_responsive_document, documents, documents_combined_uri, documents_uri, email_blurb, email_settings, email_subject, enable_wet_sign, enforce_signer_visibility, envelope_attachments, envelope_documents, envelope_id, envelope_id_stamping, envelope_location, envelope_metadata, envelope_uri, expire_after, expire_date_time, expire_enabled, external_envelope_id, favorited_by_me, folder_id, folder_ids, folder_name, folders, has_comments, has_form_data_changed, has_wav_file, holder, initial_sent_date_time, is21_cfr_part11, is_dynamic_envelope, is_signature_provider_envelope, last_modified, last_modified_by, last_modified_date_time, last_used, location, lock_information, message_lock, name, new_password, notification, notification_uri, owner, page_count, password, password_protected, power_form, power_forms, purge_completed_date, purge_request_date, purge_state, recipients, recipients_lock, recipients_uri, sender, sent_date_time, shared, signer_can_sign_on_mobile, signing_location, status, status_changed_date_time, status_date_time, template_id, templates_uri, transaction_id, uri, use_disclosure, voided_date_time, voided_reason].hash
+      [access_control_list_base64, allow_comments, allow_markup, allow_reassign, allow_view_history, any_signer, asynchronous, attachments_uri, authoritative_copy, authoritative_copy_default, auto_match, auto_match_specified_by_user, auto_navigation, brand_id, brand_lock, certificate_uri, completed_date_time, copy_recipient_data, created, created_date_time, custom_fields, custom_fields_uri, declined_date_time, deleted_date_time, delivered_date_time, description, disable_responsive_document, documents, documents_combined_uri, documents_uri, email_blurb, email_settings, email_subject, enable_wet_sign, enforce_signer_visibility, envelope_attachments, envelope_documents, envelope_id, envelope_id_stamping, envelope_location, envelope_metadata, envelope_uri, expire_after, expire_date_time, expire_enabled, external_envelope_id, favorited_by_me, folder_id, folder_ids, folder_name, folders, has_comments, has_form_data_changed, has_wav_file, holder, initial_sent_date_time, is21_cfr_part11, is_dynamic_envelope, is_signature_provider_envelope, last_modified, last_modified_by, last_modified_date_time, last_used, location, lock_information, message_lock, name, new_password, notification, notification_uri, owner, page_count, password, password_protected, power_form, power_forms, purge_completed_date, purge_request_date, purge_state, recipients, recipients_lock, recipients_uri, sender, sent_date_time, shared, signer_can_sign_on_mobile, signing_location, status, status_changed_date_time, status_date_time, template_id, templates_uri, transaction_id, uri, use_disclosure, voided_date_time, voided_reason, workflow].hash
     end
 
     # Builds the object from hash