Class: MergeAccountingClient::AccountingPeriod

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_accounting_client/models/accounting_period.rb

Overview

# The AccountingPeriod Object ### Description The ‘AccountingPeriod` object is used to define a period of time in which events occurred. ### Usage Example Common models like `Invoice` and `Transaction` will have `AccountingPeriod` objects which will denote when they occurred.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AccountingPeriod

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/merge_accounting_client/models/accounting_period.rb', line 80

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

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

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Object

Returns the value of attribute created_at.



32
33
34
 
# File 'lib/merge_accounting_client/models/accounting_period.rb', line 32

def created_at
  @created_at
end

#end_date ⇒ Object

End date of the period



23
24
25
 
# File 'lib/merge_accounting_client/models/accounting_period.rb', line 23

def end_date
  @end_date
end

#id ⇒ Object

Returns the value of attribute id.



30
31
32
 
# File 'lib/merge_accounting_client/models/accounting_period.rb', line 30

def id
  @id
end

#modified_at ⇒ Object

This is the datetime that this object was last updated by Merge



35
36
37
 
# File 'lib/merge_accounting_client/models/accounting_period.rb', line 35

def modified_at
  @modified_at
end

#name ⇒ Object

Name of the accounting period.



28
29
30
 
# File 'lib/merge_accounting_client/models/accounting_period.rb', line 28

def name
  @name
end

#start_date ⇒ Object

Beginning date of the period



20
21
22
 
# File 'lib/merge_accounting_client/models/accounting_period.rb', line 20

def start_date
  @start_date
end

#status ⇒ Object

Returns the value of attribute status.



25
26
27
 
# File 'lib/merge_accounting_client/models/accounting_period.rb', line 25

def status
  @status
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



51
52
53
 
# File 'lib/merge_accounting_client/models/accounting_period.rb', line 51

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/merge_accounting_client/models/accounting_period.rb', line 38

def self.attribute_map
  {
    :'start_date' => :'start_date',
    :'end_date' => :'end_date',
    :'status' => :'status',
    :'name' => :'name',
    :'id' => :'id',
    :'created_at' => :'created_at',
    :'modified_at' => :'modified_at'
  }
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



179
180
181
 
# File 'lib/merge_accounting_client/models/accounting_period.rb', line 179

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



69
70
71
72
73
74
75
76
 
# File 'lib/merge_accounting_client/models/accounting_period.rb', line 69

def self.openapi_nullable
  Set.new([
    :'start_date',
    :'end_date',
    :'status',
    :'name',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/merge_accounting_client/models/accounting_period.rb', line 56

def self.openapi_types
  {
    :'start_date' => :'Time',
    :'end_date' => :'Time',
    :'status' => :'AccountingPeriodStatusEnum',
    :'name' => :'String',
    :'id' => :'String',
    :'created_at' => :'Time',
    :'modified_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/merge_accounting_client/models/accounting_period.rb', line 152

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      status == o.status &&
      name == o.name &&
      id == o.id &&
      created_at == o.created_at &&
      modified_at == o.modified_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



209
210
211
212
213
214
215
216
217
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
 
# File 'lib/merge_accounting_client/models/accounting_period.rb', line 209

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value
  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
    # models (e.g. Pet) or oneOf
    klass = MergeAccountingClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/merge_accounting_client/models/accounting_period.rb', line 280

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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/merge_accounting_client/models/accounting_period.rb', line 186

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


166
167
168
 
# File 'lib/merge_accounting_client/models/accounting_period.rb', line 166

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



172
173
174
 
# File 'lib/merge_accounting_client/models/accounting_period.rb', line 172

def hash
  [start_date, end_date, status, name, id, created_at, modified_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



124
125
126
127
128
129
130
131
 
# File 'lib/merge_accounting_client/models/accounting_period.rb', line 124

def list_invalid_properties
  invalid_properties = Array.new
  if !@name.nil? && @name.to_s.length > 100
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
  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



256
257
258
 
# File 'lib/merge_accounting_client/models/accounting_period.rb', line 256

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



262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/merge_accounting_client/models/accounting_period.rb', line 262

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



250
251
252
 
# File 'lib/merge_accounting_client/models/accounting_period.rb', line 250

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



135
136
137
138
 
# File 'lib/merge_accounting_client/models/accounting_period.rb', line 135

def valid?
  return false if !@name.nil? && @name.to_s.length > 100
  true
end