dropbox-sign 1.0.0 → 1.1.0

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

@@ -0,0 +1,263 @@
+=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
+  # This class extends `TemplateResponseDocumentStaticFieldBase`
+  class TemplateResponseDocumentStaticFieldText < TemplateResponseDocumentStaticFieldBase
+    # The type of this static field. See [field types](/api/reference/constants/#field-types).  * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
+    # @return [String]
+    attr_accessor :type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'type' => :'type'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about, including the ones defined in its parent(s)
+    def self.acceptable_attributes
+      attribute_map.values.concat(superclass.acceptable_attributes)
+    end
+
+    # Returns attribute map of this model + parent
+    def self.merged_attributes
+      self.superclass.attribute_map.merge(self.attribute_map)
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'type' => :'String'
+      }
+    end
+
+    # Attribute type mapping of this model + parent
+    def self.merged_types
+      self.superclass.openapi_types.merge(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.superclass.openapi_nullable.merge(self.openapi_nullable)
+    end
+
+    # Attempt to instantiate and hydrate a new instance of this class
+    # @param [Object] data Data to be converted
+    # @return [TemplateResponseDocumentStaticFieldText]
+    def self.init(data)
+      return ApiClient.default.convert_to_type(
+        data,
+        "TemplateResponseDocumentStaticFieldText"
+      ) || TemplateResponseDocumentStaticFieldText.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::TemplateResponseDocumentStaticFieldText` 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::TemplateResponseDocumentStaticFieldText`. 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
+      }
+
+      # call parent's initialize
+      super(attributes)
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = 'text'
+      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 = super
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      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 @type.nil?
+      true && super
+    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 &&
+          type == o.type && super(o)
+    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
+      [type].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)
+      super(attributes)
+      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 = super
+      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/template_response_field_avg_text_length.rb

@@ -23,7 +23,7 @@ module Dropbox::Sign
     # @return [Integer]
     attr_accessor :num_lines
 
-    # Number of character per line.
+    # Number of characters per line.
     # @return [Integer]
     attr_accessor :num_chars_per_line
 

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

@@ -80,7 +80,7 @@ module Dropbox::Sign
     # @return [Array<SubFormFieldRule>]
     attr_accessor :form_field_rules
 
-    # The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: <a href=\"/docs/openapi/form-fields-per-document\" target=\"_blank\">Using Form Fields per Document</a>.)  **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.  * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
+    # The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)  **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.  * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
     # @return [Array<SubFormFieldsPerDocumentBase>]
     attr_accessor :form_fields_per_document
 

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

@@ -61,7 +61,7 @@ module Dropbox::Sign
     # @return [Array<SubFormFieldRule>]
     attr_accessor :form_field_rules
 
-    # The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: <a href=\"/docs/openapi/form-fields-per-document\" target=\"_blank\">Using Form Fields per Document</a>.)  **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.  * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
+    # The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)  **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.  * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
     # @return [Array<SubFormFieldsPerDocumentBase>]
     attr_accessor :form_fields_per_document
 

data/lib/dropbox-sign/version.rb

@@ -14,5 +14,5 @@ module Dropbox
 end
 
 module Dropbox::Sign
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/dropbox-sign.rb

@@ -127,14 +127,13 @@ require 'dropbox-sign/models/template_response'
 require 'dropbox-sign/models/template_response_account'
 require 'dropbox-sign/models/template_response_account_quota'
 require 'dropbox-sign/models/template_response_cc_role'
-require 'dropbox-sign/models/template_response_custom_field'
 require 'dropbox-sign/models/template_response_document'
-require 'dropbox-sign/models/template_response_document_custom_field'
+require 'dropbox-sign/models/template_response_document_custom_field_base'
 require 'dropbox-sign/models/template_response_document_field_group'
-require 'dropbox-sign/models/template_response_document_form_field'
-require 'dropbox-sign/models/template_response_document_static_field'
+require 'dropbox-sign/models/template_response_document_field_group_rule'
+require 'dropbox-sign/models/template_response_document_form_field_base'
+require 'dropbox-sign/models/template_response_document_static_field_base'
 require 'dropbox-sign/models/template_response_field_avg_text_length'
-require 'dropbox-sign/models/template_response_named_form_field'
 require 'dropbox-sign/models/template_response_signer_role'
 require 'dropbox-sign/models/template_update_files_request'
 require 'dropbox-sign/models/template_update_files_response'
@@ -167,6 +166,24 @@ require 'dropbox-sign/models/sub_form_fields_per_document_radio'
 require 'dropbox-sign/models/sub_form_fields_per_document_signature'
 require 'dropbox-sign/models/sub_form_fields_per_document_text'
 require 'dropbox-sign/models/sub_form_fields_per_document_text_merge'
+require 'dropbox-sign/models/template_response_document_custom_field_checkbox'
+require 'dropbox-sign/models/template_response_document_custom_field_text'
+require 'dropbox-sign/models/template_response_document_form_field_checkbox'
+require 'dropbox-sign/models/template_response_document_form_field_date_signed'
+require 'dropbox-sign/models/template_response_document_form_field_dropdown'
+require 'dropbox-sign/models/template_response_document_form_field_hyperlink'
+require 'dropbox-sign/models/template_response_document_form_field_initials'
+require 'dropbox-sign/models/template_response_document_form_field_radio'
+require 'dropbox-sign/models/template_response_document_form_field_signature'
+require 'dropbox-sign/models/template_response_document_form_field_text'
+require 'dropbox-sign/models/template_response_document_static_field_checkbox'
+require 'dropbox-sign/models/template_response_document_static_field_date_signed'
+require 'dropbox-sign/models/template_response_document_static_field_dropdown'
+require 'dropbox-sign/models/template_response_document_static_field_hyperlink'
+require 'dropbox-sign/models/template_response_document_static_field_initials'
+require 'dropbox-sign/models/template_response_document_static_field_radio'
+require 'dropbox-sign/models/template_response_document_static_field_signature'
+require 'dropbox-sign/models/template_response_document_static_field_text'
 
 # APIs
 require 'dropbox-sign/api/account_api'

data/openapi-config.yaml

@@ -9,7 +9,7 @@ additionalProperties:
   gemName: dropbox-sign
   gemRequiredRubyVersion: '>= 2.7'
   moduleName: "Dropbox::Sign"
-  gemVersion: 1.0.0
+  gemVersion: 1.1.0
   sortModelPropertiesByRequiredFlag: true
   legacyDiscriminatorBehavior: true
   gitUserId: hellosign
@@ -18,6 +18,9 @@ files:
   event_callback_helper.mustache:
     templateType: SupportingFiles
     destinationFilename: lib/dropbox-sign/event_callback_helper.rb
+  VERSION-root.mustache:
+    templateType: SupportingFiles
+    destinationFilename: VERSION
 globalProperties:
   apiTests: false
   modelTests: false