Class: Dropbox::Sign::TemplateResponseDocument

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TemplateResponseDocument

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/dropbox-sign/models/template_response_document.rb', line 107

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::TemplateResponseDocument` 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::TemplateResponseDocument`. 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?(:'name')
    self.name = attributes[:'name']
  end

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

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

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

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

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

Instance Attribute Details

#custom_fields ⇒ Array<TemplateResponseDocumentCustomFieldBase>

An array of Form Field objects containing the name and type of each named field.

Returns:



39
40
41
 
# File 'lib/dropbox-sign/models/template_response_document.rb', line 39

def custom_fields
  @custom_fields
end

#field_groups ⇒ Array<TemplateResponseDocumentFieldGroup>

An array of Form Field Group objects.

Returns:



31
32
33
 
# File 'lib/dropbox-sign/models/template_response_document.rb', line 31

def field_groups
  @field_groups
end

#form_fields ⇒ Array<TemplateResponseDocumentFormFieldBase>

An array of Form Field objects containing the name and type of each named field.

Returns:



35
36
37
 
# File 'lib/dropbox-sign/models/template_response_document.rb', line 35

def form_fields
  @form_fields
end

#index ⇒ Integer

Document ordering, the lowest index is displayed first and the highest last (0-based indexing).

Returns:

  • (Integer) 


27
28
29
 
# File 'lib/dropbox-sign/models/template_response_document.rb', line 27

def index
  @index
end

#name ⇒ String

Name of the associated file.

Returns:

  • (String) 


23
24
25
 
# File 'lib/dropbox-sign/models/template_response_document.rb', line 23

def name
  @name
end

#static_fields ⇒ Array<TemplateResponseDocumentStaticFieldBase>

An array describing static overlay fields. NOTE: Only available for certain subscriptions.

Returns:



43
44
45
 
# File 'lib/dropbox-sign/models/template_response_document.rb', line 43

def static_fields
  @static_fields
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



58
59
60
 
# File 'lib/dropbox-sign/models/template_response_document.rb', line 58

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
 
# File 'lib/dropbox-sign/models/template_response_document.rb', line 46

def self.attribute_map
  {
    :'name' => :'name',
    :'index' => :'index',
    :'field_groups' => :'field_groups',
    :'form_fields' => :'form_fields',
    :'custom_fields' => :'custom_fields',
    :'static_fields' => :'static_fields'
  }
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



194
195
196
 
# File 'lib/dropbox-sign/models/template_response_document.rb', line 194

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

.init(data) ⇒ TemplateResponseDocument

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



98
99
100
101
102
103
 
# File 'lib/dropbox-sign/models/template_response_document.rb', line 98

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



81
82
83
 
# File 'lib/dropbox-sign/models/template_response_document.rb', line 81

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



91
92
93
 
# File 'lib/dropbox-sign/models/template_response_document.rb', line 91

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



86
87
88
 
# File 'lib/dropbox-sign/models/template_response_document.rb', line 86

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
 
# File 'lib/dropbox-sign/models/template_response_document.rb', line 63

def self.openapi_types
  {
    :'name' => :'String',
    :'index' => :'Integer',
    :'field_groups' => :'Array<TemplateResponseDocumentFieldGroup>',
    :'form_fields' => :'Array<TemplateResponseDocumentFormFieldBase>',
    :'custom_fields' => :'Array<TemplateResponseDocumentCustomFieldBase>',
    :'static_fields' => :'Array<TemplateResponseDocumentStaticFieldBase>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



168
169
170
171
172
173
174
175
176
177
 
# File 'lib/dropbox-sign/models/template_response_document.rb', line 168

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      index == o.index &&
      field_groups == o.field_groups &&
      form_fields == o.form_fields &&
      custom_fields == o.custom_fields &&
      static_fields == o.static_fields
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



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
255
256
257
258
259
260
 
# File 'lib/dropbox-sign/models/template_response_document.rb', line 224

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



295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/dropbox-sign/models/template_response_document.rb', line 295

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



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/dropbox-sign/models/template_response_document.rb', line 201

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



187
188
189
 
# File 'lib/dropbox-sign/models/template_response_document.rb', line 187

def hash
  [name, index, field_groups, form_fields, custom_fields, static_fields].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



155
156
157
158
 
# File 'lib/dropbox-sign/models/template_response_document.rb', line 155

def list_invalid_properties
  invalid_properties = Array.new
  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



270
271
272
 
# File 'lib/dropbox-sign/models/template_response_document.rb', line 270

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



276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/dropbox-sign/models/template_response_document.rb', line 276

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



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

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



162
163
164
 
# File 'lib/dropbox-sign/models/template_response_document.rb', line 162

def valid?
  true
end