docusign_esign 2.1.0 → 2.2.0.pre.rc1

data/lib/docusign_esign/models/account_ui_settings.rb

@@ -0,0 +1,330 @@
+=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 AccountUISettings
+    # 
+    attr_accessor :enable_easy_sign_can_use_multi_template_apply
+
+    attr_accessor :enable_easy_sign_can_use_multi_template_apply_metadata
+
+    # 
+    attr_accessor :enable_easy_sign_template_upload
+
+    attr_accessor :enable_easy_sign_template_upload_metadata
+
+    # 
+    attr_accessor :hide_send_an_envelope
+
+    attr_accessor :hide_send_an_envelope_metadata
+
+    # 
+    attr_accessor :hide_use_a_template
+
+    # 
+    attr_accessor :hide_use_a_template_in_prepare
+
+    attr_accessor :hide_use_a_template_in_prepare_metadata
+
+    attr_accessor :hide_use_a_template_metadata
+
+    # 
+    attr_accessor :order_based_recipient_id_generation
+
+    attr_accessor :order_based_recipient_id_generation_metadata
+
+    # 
+    attr_accessor :remove_envelope_forwarding
+
+    attr_accessor :remove_envelope_forwarding_metadata
+
+    # 
+    attr_accessor :should_redact_access_code
+
+    attr_accessor :should_redact_access_code_metadata
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'enable_easy_sign_can_use_multi_template_apply' => :'enableEasySignCanUseMultiTemplateApply',
+        :'enable_easy_sign_can_use_multi_template_apply_metadata' => :'enableEasySignCanUseMultiTemplateApplyMetadata',
+        :'enable_easy_sign_template_upload' => :'enableEasySignTemplateUpload',
+        :'enable_easy_sign_template_upload_metadata' => :'enableEasySignTemplateUploadMetadata',
+        :'hide_send_an_envelope' => :'hideSendAnEnvelope',
+        :'hide_send_an_envelope_metadata' => :'hideSendAnEnvelopeMetadata',
+        :'hide_use_a_template' => :'hideUseATemplate',
+        :'hide_use_a_template_in_prepare' => :'hideUseATemplateInPrepare',
+        :'hide_use_a_template_in_prepare_metadata' => :'hideUseATemplateInPrepareMetadata',
+        :'hide_use_a_template_metadata' => :'hideUseATemplateMetadata',
+        :'order_based_recipient_id_generation' => :'orderBasedRecipientIdGeneration',
+        :'order_based_recipient_id_generation_metadata' => :'orderBasedRecipientIdGenerationMetadata',
+        :'remove_envelope_forwarding' => :'removeEnvelopeForwarding',
+        :'remove_envelope_forwarding_metadata' => :'removeEnvelopeForwardingMetadata',
+        :'should_redact_access_code' => :'shouldRedactAccessCode',
+        :'should_redact_access_code_metadata' => :'shouldRedactAccessCodeMetadata'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'enable_easy_sign_can_use_multi_template_apply' => :'String',
+        :'enable_easy_sign_can_use_multi_template_apply_metadata' => :'SettingsMetadata',
+        :'enable_easy_sign_template_upload' => :'String',
+        :'enable_easy_sign_template_upload_metadata' => :'SettingsMetadata',
+        :'hide_send_an_envelope' => :'String',
+        :'hide_send_an_envelope_metadata' => :'SettingsMetadata',
+        :'hide_use_a_template' => :'String',
+        :'hide_use_a_template_in_prepare' => :'String',
+        :'hide_use_a_template_in_prepare_metadata' => :'SettingsMetadata',
+        :'hide_use_a_template_metadata' => :'SettingsMetadata',
+        :'order_based_recipient_id_generation' => :'String',
+        :'order_based_recipient_id_generation_metadata' => :'SettingsMetadata',
+        :'remove_envelope_forwarding' => :'String',
+        :'remove_envelope_forwarding_metadata' => :'SettingsMetadata',
+        :'should_redact_access_code' => :'String',
+        :'should_redact_access_code_metadata' => :'SettingsMetadata'
+      }
+    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?(:'enableEasySignCanUseMultiTemplateApply')
+        self.enable_easy_sign_can_use_multi_template_apply = attributes[:'enableEasySignCanUseMultiTemplateApply']
+      end
+
+      if attributes.has_key?(:'enableEasySignCanUseMultiTemplateApplyMetadata')
+        self.enable_easy_sign_can_use_multi_template_apply_metadata = attributes[:'enableEasySignCanUseMultiTemplateApplyMetadata']
+      end
+
+      if attributes.has_key?(:'enableEasySignTemplateUpload')
+        self.enable_easy_sign_template_upload = attributes[:'enableEasySignTemplateUpload']
+      end
+
+      if attributes.has_key?(:'enableEasySignTemplateUploadMetadata')
+        self.enable_easy_sign_template_upload_metadata = attributes[:'enableEasySignTemplateUploadMetadata']
+      end
+
+      if attributes.has_key?(:'hideSendAnEnvelope')
+        self.hide_send_an_envelope = attributes[:'hideSendAnEnvelope']
+      end
+
+      if attributes.has_key?(:'hideSendAnEnvelopeMetadata')
+        self.hide_send_an_envelope_metadata = attributes[:'hideSendAnEnvelopeMetadata']
+      end
+
+      if attributes.has_key?(:'hideUseATemplate')
+        self.hide_use_a_template = attributes[:'hideUseATemplate']
+      end
+
+      if attributes.has_key?(:'hideUseATemplateInPrepare')
+        self.hide_use_a_template_in_prepare = attributes[:'hideUseATemplateInPrepare']
+      end
+
+      if attributes.has_key?(:'hideUseATemplateInPrepareMetadata')
+        self.hide_use_a_template_in_prepare_metadata = attributes[:'hideUseATemplateInPrepareMetadata']
+      end
+
+      if attributes.has_key?(:'hideUseATemplateMetadata')
+        self.hide_use_a_template_metadata = attributes[:'hideUseATemplateMetadata']
+      end
+
+      if attributes.has_key?(:'orderBasedRecipientIdGeneration')
+        self.order_based_recipient_id_generation = attributes[:'orderBasedRecipientIdGeneration']
+      end
+
+      if attributes.has_key?(:'orderBasedRecipientIdGenerationMetadata')
+        self.order_based_recipient_id_generation_metadata = attributes[:'orderBasedRecipientIdGenerationMetadata']
+      end
+
+      if attributes.has_key?(:'removeEnvelopeForwarding')
+        self.remove_envelope_forwarding = attributes[:'removeEnvelopeForwarding']
+      end
+
+      if attributes.has_key?(:'removeEnvelopeForwardingMetadata')
+        self.remove_envelope_forwarding_metadata = attributes[:'removeEnvelopeForwardingMetadata']
+      end
+
+      if attributes.has_key?(:'shouldRedactAccessCode')
+        self.should_redact_access_code = attributes[:'shouldRedactAccessCode']
+      end
+
+      if attributes.has_key?(:'shouldRedactAccessCodeMetadata')
+        self.should_redact_access_code_metadata = attributes[:'shouldRedactAccessCodeMetadata']
+      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 &&
+          enable_easy_sign_can_use_multi_template_apply == o.enable_easy_sign_can_use_multi_template_apply &&
+          enable_easy_sign_can_use_multi_template_apply_metadata == o.enable_easy_sign_can_use_multi_template_apply_metadata &&
+          enable_easy_sign_template_upload == o.enable_easy_sign_template_upload &&
+          enable_easy_sign_template_upload_metadata == o.enable_easy_sign_template_upload_metadata &&
+          hide_send_an_envelope == o.hide_send_an_envelope &&
+          hide_send_an_envelope_metadata == o.hide_send_an_envelope_metadata &&
+          hide_use_a_template == o.hide_use_a_template &&
+          hide_use_a_template_in_prepare == o.hide_use_a_template_in_prepare &&
+          hide_use_a_template_in_prepare_metadata == o.hide_use_a_template_in_prepare_metadata &&
+          hide_use_a_template_metadata == o.hide_use_a_template_metadata &&
+          order_based_recipient_id_generation == o.order_based_recipient_id_generation &&
+          order_based_recipient_id_generation_metadata == o.order_based_recipient_id_generation_metadata &&
+          remove_envelope_forwarding == o.remove_envelope_forwarding &&
+          remove_envelope_forwarding_metadata == o.remove_envelope_forwarding_metadata &&
+          should_redact_access_code == o.should_redact_access_code &&
+          should_redact_access_code_metadata == o.should_redact_access_code_metadata
+    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
+      [enable_easy_sign_can_use_multi_template_apply, enable_easy_sign_can_use_multi_template_apply_metadata, enable_easy_sign_template_upload, enable_easy_sign_template_upload_metadata, hide_send_an_envelope, hide_send_an_envelope_metadata, hide_use_a_template, hide_use_a_template_in_prepare, hide_use_a_template_in_prepare_metadata, hide_use_a_template_metadata, order_based_recipient_id_generation, order_based_recipient_id_generation_metadata, remove_envelope_forwarding, remove_envelope_forwarding_metadata, should_redact_access_code, should_redact_access_code_metadata].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/bcc_email_archive.rb

@@ -0,0 +1,276 @@
+=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 BccEmailArchive
+    # The account ID associated with the envelope.
+    attr_accessor :account_id
+
+    # 
+    attr_accessor :bcc_email_archive_id
+
+    # 
+    attr_accessor :created
+
+    attr_accessor :created_by
+
+    # 
+    attr_accessor :email
+
+    # 
+    attr_accessor :email_notification_id
+
+    # 
+    attr_accessor :modified
+
+    attr_accessor :modified_by
+
+    # 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 :uri
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'account_id' => :'accountId',
+        :'bcc_email_archive_id' => :'bccEmailArchiveId',
+        :'created' => :'created',
+        :'created_by' => :'createdBy',
+        :'email' => :'email',
+        :'email_notification_id' => :'emailNotificationId',
+        :'modified' => :'modified',
+        :'modified_by' => :'modifiedBy',
+        :'status' => :'status',
+        :'uri' => :'uri'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'account_id' => :'String',
+        :'bcc_email_archive_id' => :'String',
+        :'created' => :'String',
+        :'created_by' => :'UserInfo',
+        :'email' => :'String',
+        :'email_notification_id' => :'String',
+        :'modified' => :'String',
+        :'modified_by' => :'UserInfo',
+        :'status' => :'String',
+        :'uri' => :'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?(:'accountId')
+        self.account_id = attributes[:'accountId']
+      end
+
+      if attributes.has_key?(:'bccEmailArchiveId')
+        self.bcc_email_archive_id = attributes[:'bccEmailArchiveId']
+      end
+
+      if attributes.has_key?(:'created')
+        self.created = attributes[:'created']
+      end
+
+      if attributes.has_key?(:'createdBy')
+        self.created_by = attributes[:'createdBy']
+      end
+
+      if attributes.has_key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.has_key?(:'emailNotificationId')
+        self.email_notification_id = attributes[:'emailNotificationId']
+      end
+
+      if attributes.has_key?(:'modified')
+        self.modified = attributes[:'modified']
+      end
+
+      if attributes.has_key?(:'modifiedBy')
+        self.modified_by = attributes[:'modifiedBy']
+      end
+
+      if attributes.has_key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.has_key?(:'uri')
+        self.uri = attributes[:'uri']
+      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 &&
+          account_id == o.account_id &&
+          bcc_email_archive_id == o.bcc_email_archive_id &&
+          created == o.created &&
+          created_by == o.created_by &&
+          email == o.email &&
+          email_notification_id == o.email_notification_id &&
+          modified == o.modified &&
+          modified_by == o.modified_by &&
+          status == o.status &&
+          uri == o.uri
+    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
+      [account_id, bcc_email_archive_id, created, created_by, email, email_notification_id, modified, modified_by, status, uri].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