Class: Dropbox::Sign::SubCustomField

Inherits:
Object
  • Object
show all
Defined in:
lib/dropbox-sign/models/sub_custom_field.rb

Overview

When used together with merge fields, ‘custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubCustomField

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/dropbox-sign/models/sub_custom_field.rb', line 101

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::SubCustomField` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  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::SubCustomField`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'editor')
    self.editor = attributes[:'editor']
  end

  if attributes.key?(:'required')
    self.required = attributes[:'required']
  else
    self.required = false
  end

  if attributes.key?(:'value')
    self.value = attributes[:'value']
  end
end

Instance Attribute Details

#editor ⇒ String

Used to create editable merge fields. When the value matches a role passed in with ‘signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`. NOTE: Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won’t be editable.

Returns:

  • (String) 


28
29
30
 
# File 'lib/dropbox-sign/models/sub_custom_field.rb', line 28

def editor
  @editor
end

#name ⇒ String

The name of a custom field. When working with pre-filled data, the custom field’s name must have a matching merge field name or the field will remain empty on the document during signing.

Returns:

  • (String) 


24
25
26
 
# File 'lib/dropbox-sign/models/sub_custom_field.rb', line 24

def name
  @name
end

#required ⇒ Boolean

Used to set an editable merge field when working with pre-filled data. When ‘true`, the custom field must specify a signer role in `editor`.

Returns:

  • (Boolean) 


32
33
34
 
# File 'lib/dropbox-sign/models/sub_custom_field.rb', line 32

def required
  @required
end

#value ⇒ String

The string that resolves (aka "pre-fills") to the merge field on the final document(s) used for signing.

Returns:

  • (String) 


36
37
38
 
# File 'lib/dropbox-sign/models/sub_custom_field.rb', line 36

def value
  @value
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



49
50
51
 
# File 'lib/dropbox-sign/models/sub_custom_field.rb', line 49

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



54
55
56
 
# File 'lib/dropbox-sign/models/sub_custom_field.rb', line 54

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



39
40
41
42
43
44
45
46
 
# File 'lib/dropbox-sign/models/sub_custom_field.rb', line 39

def self.attribute_map
  {
    :'name' => :'name',
    :'editor' => :'editor',
    :'required' => :'required',
    :'value' => :'value'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



188
189
190
 
# File 'lib/dropbox-sign/models/sub_custom_field.rb', line 188

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.init(data) ⇒ SubCustomField

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



92
93
94
95
96
97
 
# File 'lib/dropbox-sign/models/sub_custom_field.rb', line 92

def self.init(data)
  ApiClient.default.convert_to_type(
    data,
    "SubCustomField"
  ) || SubCustomField.new
end

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



75
76
77
 
# File 'lib/dropbox-sign/models/sub_custom_field.rb', line 75

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

Returns list of attributes with nullable: true of this model + parent



85
86
87
 
# File 'lib/dropbox-sign/models/sub_custom_field.rb', line 85

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



80
81
82
 
# File 'lib/dropbox-sign/models/sub_custom_field.rb', line 80

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



69
70
71
72
 
# File 'lib/dropbox-sign/models/sub_custom_field.rb', line 69

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
 
# File 'lib/dropbox-sign/models/sub_custom_field.rb', line 59

def self.openapi_types
  {
    :'name' => :'String',
    :'editor' => :'String',
    :'required' => :'Boolean',
    :'value' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



164
165
166
167
168
169
170
171
 
# File 'lib/dropbox-sign/models/sub_custom_field.rb', line 164

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      editor == o.editor &&
      required == o.required &&
      value == o.value
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/dropbox-sign/models/sub_custom_field.rb', line 218

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 :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
    klass = Dropbox::Sign.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value, include_nil = true) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/dropbox-sign/models/sub_custom_field.rb', line 289

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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/dropbox-sign/models/sub_custom_field.rb', line 195

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


175
176
177
 
# File 'lib/dropbox-sign/models/sub_custom_field.rb', line 175

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



181
182
183
 
# File 'lib/dropbox-sign/models/sub_custom_field.rb', line 181

def hash
  [name, editor, required, value].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



136
137
138
139
140
141
142
143
 
# File 'lib/dropbox-sign/models/sub_custom_field.rb', line 136

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



264
265
266
 
# File 'lib/dropbox-sign/models/sub_custom_field.rb', line 264

def to_body
  to_hash
end

#to_hash(include_nil = true) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/dropbox-sign/models/sub_custom_field.rb', line 270

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



258
259
260
 
# File 'lib/dropbox-sign/models/sub_custom_field.rb', line 258

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



147
148
149
150
 
# File 'lib/dropbox-sign/models/sub_custom_field.rb', line 147

def valid?
  return false if @name.nil?
  true
end