Class: BrevoRuby::FileData

Inherits:
Object
  • Object
show all
Defined in:
lib/brevo-ruby/models/file_data.rb

Overview

File data that is uploaded

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FileData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/brevo-ruby/models/file_data.rb', line 67

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

  if attributes.has_key?(:'authorId')
    self.author_id = attributes[:'authorId']
  end

  if attributes.has_key?(:'contactId')
    self.contact_id = attributes[:'contactId']
  end

  if attributes.has_key?(:'dealId')
    self.deal_id = attributes[:'dealId']
  end

  if attributes.has_key?(:'companyId')
    self.company_id = attributes[:'companyId']
  end

  if attributes.has_key?(:'size')
    self.size = attributes[:'size']
  end

  if attributes.has_key?(:'createdAt')
    self.created_at = attributes[:'createdAt']
  end
end

Instance Attribute Details

#author_id ⇒ Object

Account id of user which created the file



22
23
24
 
# File 'lib/brevo-ruby/models/file_data.rb', line 22

def author_id
  @author_id
end

#company_id ⇒ Object

Company id linked to a file



31
32
33
 
# File 'lib/brevo-ruby/models/file_data.rb', line 31

def company_id
  @company_id
end

#contact_id ⇒ Object

Contact id of contact on which file is uploaded



25
26
27
 
# File 'lib/brevo-ruby/models/file_data.rb', line 25

def contact_id
  @contact_id
end

#created_at ⇒ Object

File created date/time



37
38
39
 
# File 'lib/brevo-ruby/models/file_data.rb', line 37

def created_at
  @created_at
end

#deal_id ⇒ Object

Deal id linked to a file



28
29
30
 
# File 'lib/brevo-ruby/models/file_data.rb', line 28

def deal_id
  @deal_id
end

#name ⇒ Object

Name of uploaded file



19
20
21
 
# File 'lib/brevo-ruby/models/file_data.rb', line 19

def name
  @name
end

#size ⇒ Object

Size of file in bytes



34
35
36
 
# File 'lib/brevo-ruby/models/file_data.rb', line 34

def size
  @size
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/brevo-ruby/models/file_data.rb', line 40

def self.attribute_map
  {
    :'name' => :'name',
    :'author_id' => :'authorId',
    :'contact_id' => :'contactId',
    :'deal_id' => :'dealId',
    :'company_id' => :'companyId',
    :'size' => :'size',
    :'created_at' => :'createdAt'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/brevo-ruby/models/file_data.rb', line 53

def self.swagger_types
  {
    :'name' => :'String',
    :'author_id' => :'String',
    :'contact_id' => :'Integer',
    :'deal_id' => :'String',
    :'company_id' => :'String',
    :'size' => :'Integer',
    :'created_at' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/brevo-ruby/models/file_data.rb', line 117

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      author_id == o.author_id &&
      contact_id == o.contact_id &&
      deal_id == o.deal_id &&
      company_id == o.company_id &&
      size == o.size &&
      created_at == o.created_at
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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/brevo-ruby/models/file_data.rb', line 165

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = BrevoRuby.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ 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



231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/brevo-ruby/models/file_data.rb', line 231

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  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



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/brevo-ruby/models/file_data.rb', line 144

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


131
132
133
 
# File 'lib/brevo-ruby/models/file_data.rb', line 131

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



137
138
139
 
# File 'lib/brevo-ruby/models/file_data.rb', line 137

def hash
  [name, author_id, contact_id, deal_id, company_id, size, created_at].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



104
105
106
107
 
# File 'lib/brevo-ruby/models/file_data.rb', line 104

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



211
212
213
 
# File 'lib/brevo-ruby/models/file_data.rb', line 211

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



217
218
219
220
221
222
223
224
225
 
# File 'lib/brevo-ruby/models/file_data.rb', line 217

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



205
206
207
 
# File 'lib/brevo-ruby/models/file_data.rb', line 205

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



111
112
113
 
# File 'lib/brevo-ruby/models/file_data.rb', line 111

def valid?
  true
end