dropbox-sign 1.2.0 → 1.4.0

data/lib/dropbox-sign/models/signature_request_edit_with_template_request.rb

@@ -0,0 +1,509 @@
+=begin
+#Dropbox Sign API
+
+#Dropbox Sign v3 API
+
+The version of the OpenAPI document: 3.0.0
+Contact: apisupport@hellosign.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.3.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Dropbox
+end
+
+module Dropbox::Sign
+  class SignatureRequestEditWithTemplateRequest
+    # Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.
+    # @return [Array<String>]
+    attr_accessor :template_ids
+
+    # Add Signers to your Templated-based Signature Request.
+    # @return [Array<SubSignatureRequestTemplateSigner>]
+    attr_accessor :signers
+
+    # Allows signers to decline to sign a document if `true`. Defaults to `false`.
+    # @return [Boolean]
+    attr_accessor :allow_decline
+
+    # Add CC email recipients. Required when a CC role exists for the Template.
+    # @return [Array<SubCC>]
+    attr_accessor :ccs
+
+    # Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app.
+    # @return [String]
+    attr_accessor :client_id
+
+    # An array defining values and options for custom fields. Required when a custom field exists in the Template.
+    # @return [Array<SubCustomField>]
+    attr_accessor :custom_fields
+
+    # Use `files[]` to indicate the uploaded file(s) to send for signature.  This endpoint requires either **files** or **file_urls[]**, but not both.
+    # @return [Array<File>]
+    attr_accessor :files
+
+    # Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.  This endpoint requires either **files** or **file_urls[]**, but not both.
+    # @return [Array<String>]
+    attr_accessor :file_urls
+
+    # Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br> **Note**: QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer.
+    # @return [Boolean]
+    attr_accessor :is_qualified_signature
+
+    # Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
+    # @return [Boolean]
+    attr_accessor :is_eid
+
+    # The custom message in the email that will be sent to the signers.
+    # @return [String]
+    attr_accessor :message
+
+    # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.  Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
+    # @return [Hash<String, Object>]
+    attr_accessor :metadata
+
+    # @return [SubSigningOptions]
+    attr_accessor :signing_options
+
+    # The URL you want signers redirected to after they successfully sign.
+    # @return [String]
+    attr_accessor :signing_redirect_url
+
+    # The subject in the email that will be sent to the signers.
+    # @return [String]
+    attr_accessor :subject
+
+    # Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
+    # @return [Boolean]
+    attr_accessor :test_mode
+
+    # The title you want to assign to the SignatureRequest.
+    # @return [String]
+    attr_accessor :title
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'template_ids' => :'template_ids',
+        :'signers' => :'signers',
+        :'allow_decline' => :'allow_decline',
+        :'ccs' => :'ccs',
+        :'client_id' => :'client_id',
+        :'custom_fields' => :'custom_fields',
+        :'files' => :'files',
+        :'file_urls' => :'file_urls',
+        :'is_qualified_signature' => :'is_qualified_signature',
+        :'is_eid' => :'is_eid',
+        :'message' => :'message',
+        :'metadata' => :'metadata',
+        :'signing_options' => :'signing_options',
+        :'signing_redirect_url' => :'signing_redirect_url',
+        :'subject' => :'subject',
+        :'test_mode' => :'test_mode',
+        :'title' => :'title'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Returns attribute map of this model + parent
+    def self.merged_attributes
+      self.attribute_map
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'template_ids' => :'Array<String>',
+        :'signers' => :'Array<SubSignatureRequestTemplateSigner>',
+        :'allow_decline' => :'Boolean',
+        :'ccs' => :'Array<SubCC>',
+        :'client_id' => :'String',
+        :'custom_fields' => :'Array<SubCustomField>',
+        :'files' => :'Array<File>',
+        :'file_urls' => :'Array<String>',
+        :'is_qualified_signature' => :'Boolean',
+        :'is_eid' => :'Boolean',
+        :'message' => :'String',
+        :'metadata' => :'Hash<String, Object>',
+        :'signing_options' => :'SubSigningOptions',
+        :'signing_redirect_url' => :'String',
+        :'subject' => :'String',
+        :'test_mode' => :'Boolean',
+        :'title' => :'String'
+      }
+    end
+
+    # Attribute type mapping of this model + parent
+    def self.merged_types
+      self.openapi_types
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Returns list of attributes with nullable: true of this model + parent
+    def self.merged_nullable
+      self.openapi_nullable
+    end
+
+    # Attempt to instantiate and hydrate a new instance of this class
+    # @param [Object] data Data to be converted
+    # @return [SignatureRequestEditWithTemplateRequest]
+    def self.init(data)
+      return ApiClient.default.convert_to_type(
+        data,
+        "SignatureRequestEditWithTemplateRequest"
+      ) || SignatureRequestEditWithTemplateRequest.new
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::SignatureRequestEditWithTemplateRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.merged_attributes.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestEditWithTemplateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'template_ids')
+        if (value = attributes[:'template_ids']).is_a?(Array)
+          self.template_ids = value
+        end
+      end
+
+      if attributes.key?(:'signers')
+        if (value = attributes[:'signers']).is_a?(Array)
+          self.signers = value
+        end
+      end
+
+      if attributes.key?(:'allow_decline')
+        self.allow_decline = attributes[:'allow_decline']
+      else
+        self.allow_decline = false
+      end
+
+      if attributes.key?(:'ccs')
+        if (value = attributes[:'ccs']).is_a?(Array)
+          self.ccs = value
+        end
+      end
+
+      if attributes.key?(:'client_id')
+        self.client_id = attributes[:'client_id']
+      end
+
+      if attributes.key?(:'custom_fields')
+        if (value = attributes[:'custom_fields']).is_a?(Array)
+          self.custom_fields = value
+        end
+      end
+
+      if attributes.key?(:'files')
+        if (value = attributes[:'files']).is_a?(Array)
+          self.files = value
+        end
+      end
+
+      if attributes.key?(:'file_urls')
+        if (value = attributes[:'file_urls']).is_a?(Array)
+          self.file_urls = value
+        end
+      end
+
+      if attributes.key?(:'is_qualified_signature')
+        self.is_qualified_signature = attributes[:'is_qualified_signature']
+      else
+        self.is_qualified_signature = false
+      end
+
+      if attributes.key?(:'is_eid')
+        self.is_eid = attributes[:'is_eid']
+      else
+        self.is_eid = false
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      end
+
+      if attributes.key?(:'metadata')
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
+        end
+      end
+
+      if attributes.key?(:'signing_options')
+        self.signing_options = attributes[:'signing_options']
+      end
+
+      if attributes.key?(:'signing_redirect_url')
+        self.signing_redirect_url = attributes[:'signing_redirect_url']
+      end
+
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
+      end
+
+      if attributes.key?(:'test_mode')
+        self.test_mode = attributes[:'test_mode']
+      else
+        self.test_mode = false
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      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
+      if @template_ids.nil?
+        invalid_properties.push('invalid value for "template_ids", template_ids cannot be nil.')
+      end
+
+      if @signers.nil?
+        invalid_properties.push('invalid value for "signers", signers cannot be nil.')
+      end
+
+      if !@message.nil? && @message.to_s.length > 5000
+        invalid_properties.push('invalid value for "message", the character length must be smaller than or equal to 5000.')
+      end
+
+      if !@subject.nil? && @subject.to_s.length > 255
+        invalid_properties.push('invalid value for "subject", the character length must be smaller than or equal to 255.')
+      end
+
+      if !@title.nil? && @title.to_s.length > 255
+        invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 255.')
+      end
+
+      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 false if @template_ids.nil?
+      return false if @signers.nil?
+      return false if !@message.nil? && @message.to_s.length > 5000
+      return false if !@subject.nil? && @subject.to_s.length > 255
+      return false if !@title.nil? && @title.to_s.length > 255
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] message Value to be assigned
+    def message=(message)
+      if !message.nil? && message.to_s.length > 5000
+        fail ArgumentError, 'invalid value for "message", the character length must be smaller than or equal to 5000.'
+      end
+
+      @message = message
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] metadata Value to be assigned
+    def metadata=(metadata)
+      @metadata = metadata
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] subject Value to be assigned
+    def subject=(subject)
+      if !subject.nil? && subject.to_s.length > 255
+        fail ArgumentError, 'invalid value for "subject", the character length must be smaller than or equal to 255.'
+      end
+
+      @subject = subject
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] title Value to be assigned
+    def title=(title)
+      if !title.nil? && title.to_s.length > 255
+        fail ArgumentError, 'invalid value for "title", the character length must be smaller than or equal to 255.'
+      end
+
+      @title = title
+    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 &&
+          template_ids == o.template_ids &&
+          signers == o.signers &&
+          allow_decline == o.allow_decline &&
+          ccs == o.ccs &&
+          client_id == o.client_id &&
+          custom_fields == o.custom_fields &&
+          files == o.files &&
+          file_urls == o.file_urls &&
+          is_qualified_signature == o.is_qualified_signature &&
+          is_eid == o.is_eid &&
+          message == o.message &&
+          metadata == o.metadata &&
+          signing_options == o.signing_options &&
+          signing_redirect_url == o.signing_redirect_url &&
+          subject == o.subject &&
+          test_mode == o.test_mode &&
+          title == o.title
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [template_ids, signers, allow_decline, ccs, client_id, custom_fields, files, file_urls, is_qualified_signature, is_eid, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    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)
+      attribute_map = self.class.merged_attributes
+
+      self.class.merged_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[attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]]))
+        end
+      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 :Time
+        Time.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 :File
+        value
+      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
+        # models (e.g. Pet)
+        klass = Dropbox::Sign.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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(include_nil = true)
+      hash = {}
+      self.class.merged_attributes.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          next unless include_nil
+          is_nullable = self.class.merged_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value, include_nil)
+      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, include_nil = true)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v, include_nil) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v, include_nil) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash(include_nil)
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/dropbox-sign/models/signature_request_response.rb

@@ -91,6 +91,10 @@ module Dropbox::Sign
     # @return [String, nil]
     attr_accessor :signing_redirect_url
 
+    # The path where the completed document can be downloaded
+    # @return [String, nil]
+    attr_accessor :final_copy_uri
+
     # Templates IDs used in this SignatureRequest (if any).
     # @return [Array<String>, nil]
     attr_accessor :template_ids
@@ -111,6 +115,10 @@ module Dropbox::Sign
     # @return [Array<SignatureRequestResponseSignatures>]
     attr_accessor :signatures
 
+    # The ID of the Bulk Send job which sent the signature request, if applicable.
+    # @return [String, nil]
+    attr_accessor :bulk_send_job_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -132,11 +140,13 @@ module Dropbox::Sign
         :'details_url' => :'details_url',
         :'cc_email_addresses' => :'cc_email_addresses',
         :'signing_redirect_url' => :'signing_redirect_url',
+        :'final_copy_uri' => :'final_copy_uri',
         :'template_ids' => :'template_ids',
         :'custom_fields' => :'custom_fields',
         :'attachments' => :'attachments',
         :'response_data' => :'response_data',
-        :'signatures' => :'signatures'
+        :'signatures' => :'signatures',
+        :'bulk_send_job_id' => :'bulk_send_job_id'
       }
     end
 
@@ -171,11 +181,13 @@ module Dropbox::Sign
         :'details_url' => :'String',
         :'cc_email_addresses' => :'Array<String>',
         :'signing_redirect_url' => :'String',
+        :'final_copy_uri' => :'String',
         :'template_ids' => :'Array<String>',
         :'custom_fields' => :'Array<SignatureRequestResponseCustomFieldBase>',
         :'attachments' => :'Array<SignatureRequestResponseAttachment>',
         :'response_data' => :'Array<SignatureRequestResponseDataBase>',
-        :'signatures' => :'Array<SignatureRequestResponseSignatures>'
+        :'signatures' => :'Array<SignatureRequestResponseSignatures>',
+        :'bulk_send_job_id' => :'String'
       }
     end
 
@@ -192,10 +204,12 @@ module Dropbox::Sign
         :'message',
         :'signing_url',
         :'signing_redirect_url',
+        :'final_copy_uri',
         :'template_ids',
         :'custom_fields',
         :'attachments',
         :'response_data',
+        :'bulk_send_job_id'
       ])
     end
 
@@ -305,6 +319,10 @@ module Dropbox::Sign
         self.signing_redirect_url = attributes[:'signing_redirect_url']
       end
 
+      if attributes.key?(:'final_copy_uri')
+        self.final_copy_uri = attributes[:'final_copy_uri']
+      end
+
       if attributes.key?(:'template_ids')
         if (value = attributes[:'template_ids']).is_a?(Array)
           self.template_ids = value
@@ -334,6 +352,10 @@ module Dropbox::Sign
           self.signatures = value
         end
       end
+
+      if attributes.key?(:'bulk_send_job_id')
+        self.bulk_send_job_id = attributes[:'bulk_send_job_id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -372,11 +394,13 @@ module Dropbox::Sign
           details_url == o.details_url &&
           cc_email_addresses == o.cc_email_addresses &&
           signing_redirect_url == o.signing_redirect_url &&
+          final_copy_uri == o.final_copy_uri &&
           template_ids == o.template_ids &&
           custom_fields == o.custom_fields &&
           attachments == o.attachments &&
           response_data == o.response_data &&
-          signatures == o.signatures
+          signatures == o.signatures &&
+          bulk_send_job_id == o.bulk_send_job_id
     end
 
     # @see the `==` method
@@ -388,7 +412,7 @@ module Dropbox::Sign
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [test_mode, signature_request_id, requester_email_address, title, original_title, subject, message, metadata, created_at, expires_at, is_complete, is_declined, has_error, files_url, signing_url, details_url, cc_email_addresses, signing_redirect_url, template_ids, custom_fields, attachments, response_data, signatures].hash
+      [test_mode, signature_request_id, requester_email_address, title, original_title, subject, message, metadata, created_at, expires_at, is_complete, is_declined, has_error, files_url, signing_url, details_url, cc_email_addresses, signing_redirect_url, final_copy_uri, template_ids, custom_fields, attachments, response_data, signatures, bulk_send_job_id].hash
     end
 
     # Builds the object from hash

data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb

@@ -137,6 +137,8 @@ module Dropbox::Sign
 
       if attributes.key?(:'font_size')
         self.font_size = attributes[:'font_size']
+      else
+        self.font_size = 12
       end
     end
 

data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb

@@ -159,6 +159,8 @@ module Dropbox::Sign
 
       if attributes.key?(:'font_size')
         self.font_size = attributes[:'font_size']
+      else
+        self.font_size = 12
       end
     end
 

data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb

@@ -157,6 +157,8 @@ module Dropbox::Sign
 
       if attributes.key?(:'font_size')
         self.font_size = attributes[:'font_size']
+      else
+        self.font_size = 12
       end
     end
 

data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb

@@ -215,6 +215,8 @@ module Dropbox::Sign
 
       if attributes.key?(:'font_size')
         self.font_size = attributes[:'font_size']
+      else
+        self.font_size = 12
       end
     end
 

data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb

@@ -137,6 +137,8 @@ module Dropbox::Sign
 
       if attributes.key?(:'font_size')
         self.font_size = attributes[:'font_size']
+      else
+        self.font_size = 12
       end
     end
 

data/lib/dropbox-sign/models/sub_signature_request_signer.rb

@@ -34,7 +34,7 @@ module Dropbox::Sign
     # @return [String]
     attr_accessor :pin
 
-    # An E.164 formatted phone number.  **Note**: Not available in test mode and requires a Standard plan or higher.
+    # An E.164 formatted phone number.  By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).  **Note**: Not available in test mode and requires a Standard plan or higher.
     # @return [String]
     attr_accessor :sms_phone_number
 

data/lib/dropbox-sign/models/sub_signature_request_template_signer.rb

@@ -34,7 +34,7 @@ module Dropbox::Sign
     # @return [String]
     attr_accessor :pin
 
-    # An E.164 formatted phone number.  **Note**: Not available in test mode and requires a Standard plan or higher.
+    # An E.164 formatted phone number.  By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).  **Note**: Not available in test mode and requires a Standard plan or higher.
     # @return [String]
     attr_accessor :sms_phone_number