Class: XeroRuby::Files::Association

Inherits:
Object
  • Object
show all
Defined in:
lib/xero-ruby/models/files/association.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Association

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
101
102
103
104
105
106
107
108
 
# File 'lib/xero-ruby/models/files/association.rb', line 68

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Files::Association` 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.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `XeroRuby::Files::Association`. 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?(:'send_with_object')
    self.send_with_object = attributes[:'send_with_object']
  end

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

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

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

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

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

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

Instance Attribute Details

#file_id ⇒ Object

The unique identifier of the file



29
30
31
 
# File 'lib/xero-ruby/models/files/association.rb', line 29

def file_id
  @file_id
end

#name ⇒ Object

The name of the associated file. Note- The Name element is only returned when using /Associations/ObjectId endpoint.



23
24
25
 
# File 'lib/xero-ruby/models/files/association.rb', line 23

def name
  @name
end

#object_group ⇒ Object

Returns the value of attribute object_group.



35
36
37
 
# File 'lib/xero-ruby/models/files/association.rb', line 35

def object_group
  @object_group
end

#object_id ⇒ Object

The identifier of the object that the file is being associated with (e.g. InvoiceID, BankTransactionID, ContactID)



32
33
34
 
# File 'lib/xero-ruby/models/files/association.rb', line 32

def object_id
  @object_id
end

#object_type ⇒ Object

Returns the value of attribute object_type.



38
39
40
 
# File 'lib/xero-ruby/models/files/association.rb', line 38

def object_type
  @object_type
end

#send_with_object ⇒ Object

Boolean flag to determines whether the file is sent with the document it is attached to on client facing communications. Note- The SendWithObject element is only returned when using /Associations/ObjectId endpoint.



20
21
22
 
# File 'lib/xero-ruby/models/files/association.rb', line 20

def send_with_object
  @send_with_object
end

#size ⇒ Object

The size of the associated file in bytes. Note- The Size element is only returned when using /Associations/ObjectId endpoint.



26
27
28
 
# File 'lib/xero-ruby/models/files/association.rb', line 26

def size
  @size
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/xero-ruby/models/files/association.rb', line 41

def self.attribute_map
  {
    :'send_with_object' => :'SendWithObject',
    :'name' => :'Name',
    :'size' => :'Size',
    :'file_id' => :'FileId',
    :'object_id' => :'ObjectId',
    :'object_group' => :'ObjectGroup',
    :'object_type' => :'ObjectType'
  }
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



152
153
154
 
# File 'lib/xero-ruby/models/files/association.rb', line 152

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

.openapi_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/xero-ruby/models/files/association.rb', line 54

def self.openapi_types
  {
    :'send_with_object' => :'Boolean',
    :'name' => :'String',
    :'size' => :'Integer',
    :'file_id' => :'String',
    :'object_id' => :'String',
    :'object_group' => :'ObjectGroup',
    :'object_type' => :'ObjectType'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/xero-ruby/models/files/association.rb', line 125

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      send_with_object == o.send_with_object &&
      name == o.name &&
      size == o.size &&
      file_id == o.file_id &&
      object_id == o.object_id &&
      object_group == o.object_group &&
      object_type == o.object_type
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



180
181
182
183
184
185
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
 
# File 'lib/xero-ruby/models/files/association.rb', line 180

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(parse_date(value))
  when :Date
    Date.parse(parse_date(value))
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BigDecimal
    BigDecimal(value.to_s)
  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
    XeroRuby::Files.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value, downcase: false) ⇒ 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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/xero-ruby/models/files/association.rb', line 253

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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/xero-ruby/models/files/association.rb', line 159

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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


139
140
141
 
# File 'lib/xero-ruby/models/files/association.rb', line 139

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



145
146
147
 
# File 'lib/xero-ruby/models/files/association.rb', line 145

def hash
  [send_with_object, name, size, file_id, object_id, object_group, object_type].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



112
113
114
115
 
# File 'lib/xero-ruby/models/files/association.rb', line 112

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object 



269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/xero-ruby/models/files/association.rb', line 269

def parse_date(datestring)
  if datestring.include?('Date')
    date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
    original, date, timezone = *date_pattern.match(datestring)
    date = (date.to_i / 1000)
    Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
  elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD
    Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').to_s
  else # handle date 'types' for small subset of payroll API's
    Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
  end
end

#to_attributes ⇒ Object

Returns the object in the form of hash with snake_case



245
246
247
 
# File 'lib/xero-ruby/models/files/association.rb', line 245

def to_attributes
  to_hash(downcase: true)
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



227
228
229
 
# File 'lib/xero-ruby/models/files/association.rb', line 227

def to_body
  to_hash
end

#to_hash(downcase: false) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



233
234
235
236
237
238
239
240
241
242
 
# File 'lib/xero-ruby/models/files/association.rb', line 233

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



221
222
223
 
# File 'lib/xero-ruby/models/files/association.rb', line 221

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



119
120
121
 
# File 'lib/xero-ruby/models/files/association.rb', line 119

def valid?
  true
end