Class: Dropbox::Sign::TemplateListResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TemplateListResponse

Initializes the object



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/dropbox-sign/models/template_list_response.rb', line 88

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

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

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

Instance Attribute Details

#list_info ⇒ ListInfoResponse 



26
27
28
 
# File 'lib/dropbox-sign/models/template_list_response.rb', line 26

def list_info
  @list_info
end

#templates ⇒ Array<TemplateResponse>

List of templates that the API caller has access to.



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

def templates
  @templates
end

#warnings ⇒ Array<WarningResponse>

A list of warnings.



30
31
32
 
# File 'lib/dropbox-sign/models/template_list_response.rb', line 30

def warnings
  @warnings
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



42
43
44
 
# File 'lib/dropbox-sign/models/template_list_response.rb', line 42

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
 
# File 'lib/dropbox-sign/models/template_list_response.rb', line 33

def self.attribute_map
  {
    :'templates' => :'templates',
    :'list_info' => :'list_info',
    :'warnings' => :'warnings'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



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

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

.init(data) ⇒ TemplateListResponse

Attempt to instantiate and hydrate a new instance of this class



79
80
81
82
83
84
 
# File 'lib/dropbox-sign/models/template_list_response.rb', line 79

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



47
48
49
 
# File 'lib/dropbox-sign/models/template_list_response.rb', line 47

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



72
73
74
 
# File 'lib/dropbox-sign/models/template_list_response.rb', line 72

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



61
62
63
 
# File 'lib/dropbox-sign/models/template_list_response.rb', line 61

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



66
67
68
69
 
# File 'lib/dropbox-sign/models/template_list_response.rb', line 66

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

.openapi_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
 
# File 'lib/dropbox-sign/models/template_list_response.rb', line 52

def self.openapi_types
  {
    :'templates' => :'Array<TemplateResponse>',
    :'list_info' => :'ListInfoResponse',
    :'warnings' => :'Array<WarningResponse>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



133
134
135
136
137
138
139
 
# File 'lib/dropbox-sign/models/template_list_response.rb', line 133

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      templates == o.templates &&
      list_info == o.list_info &&
      warnings == o.warnings
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/dropbox-sign/models/template_list_response.rb', line 186

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

#_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



260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/dropbox-sign/models/template_list_response.rb', line 260

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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/dropbox-sign/models/template_list_response.rb', line 163

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

See Also:

  • `==` method


143
144
145
 
# File 'lib/dropbox-sign/models/template_list_response.rb', line 143

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



149
150
151
 
# File 'lib/dropbox-sign/models/template_list_response.rb', line 149

def hash
  [templates, list_info, warnings].hash
end

#list_invalid_properties ⇒ Object

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



120
121
122
123
 
# File 'lib/dropbox-sign/models/template_list_response.rb', line 120

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



235
236
237
 
# File 'lib/dropbox-sign/models/template_list_response.rb', line 235

def to_body
  to_hash
end

#to_hash(include_nil = true) ⇒ Hash

Returns the object in the form of hash



241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/dropbox-sign/models/template_list_response.rb', line 241

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



229
230
231
 
# File 'lib/dropbox-sign/models/template_list_response.rb', line 229

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



127
128
129
 
# File 'lib/dropbox-sign/models/template_list_response.rb', line 127

def valid?
  true
end