Class: Merge::Accounting::AccountingPeriod

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/accounting/types/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.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, name: OMIT, status: OMIT, start_date: OMIT, end_date: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Accounting::AccountingPeriod

Parameters:

  • id (String) (defaults to: OMIT)
  • remote_id (String) (defaults to: OMIT) —

    The third-party API ID of the matching object.

  • created_at (DateTime) (defaults to: OMIT) —

    The datetime that this object was created by Merge.

  • modified_at (DateTime) (defaults to: OMIT) —

    The datetime that this object was modified by Merge.

  • name (String) (defaults to: OMIT) —

    Name of the accounting period.

  • status (Merge::Accounting::Status895Enum) (defaults to: OMIT)
  • start_date (DateTime) (defaults to: OMIT) —

    Beginning date of the period

  • end_date (DateTime) (defaults to: OMIT) —

    End date of the period

  • field_mappings (Hash{String => Object}) (defaults to: OMIT)
  • remote_data (Array<Merge::Accounting::RemoteData>) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/merge_ruby_client/accounting/types/accounting_period.rb', line 59

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, name: OMIT, status: OMIT,
               start_date: OMIT, end_date: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil)
  @id = id if id != OMIT
  @remote_id = remote_id if remote_id != OMIT
  @created_at = created_at if created_at != OMIT
  @modified_at = modified_at if modified_at != OMIT
  @name = name if name != OMIT
  @status = status if status != OMIT
  @start_date = start_date if start_date != OMIT
  @end_date = end_date if end_date != OMIT
  @field_mappings = field_mappings if field_mappings != OMIT
  @remote_data = remote_data if remote_data != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "id": id,
    "remote_id": remote_id,
    "created_at": created_at,
    "modified_at": modified_at,
    "name": name,
    "status": status,
    "start_date": start_date,
    "end_date": end_date,
    "field_mappings": field_mappings,
    "remote_data": remote_data
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



40
41
42
 
# File 'lib/merge_ruby_client/accounting/types/accounting_period.rb', line 40

def additional_properties
  @additional_properties
end

#created_at ⇒ DateTime (readonly)

Returns The datetime that this object was created by Merge.

Returns:

  • (DateTime) —

    The datetime that this object was created by Merge.



24
25
26
 
# File 'lib/merge_ruby_client/accounting/types/accounting_period.rb', line 24

def created_at
  @created_at
end

#end_date ⇒ DateTime (readonly)

Returns End date of the period.

Returns:

  • (DateTime) —

    End date of the period



34
35
36
 
# File 'lib/merge_ruby_client/accounting/types/accounting_period.rb', line 34

def end_date
  @end_date
end

#field_mappings ⇒ Hash{String => Object} (readonly)

Returns:

  • (Hash{String => Object}) 


36
37
38
 
# File 'lib/merge_ruby_client/accounting/types/accounting_period.rb', line 36

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


20
21
22
 
# File 'lib/merge_ruby_client/accounting/types/accounting_period.rb', line 20

def id
  @id
end

#modified_at ⇒ DateTime (readonly)

Returns The datetime that this object was modified by Merge.

Returns:

  • (DateTime) —

    The datetime that this object was modified by Merge.



26
27
28
 
# File 'lib/merge_ruby_client/accounting/types/accounting_period.rb', line 26

def modified_at
  @modified_at
end

#name ⇒ String (readonly)

Returns Name of the accounting period.

Returns:

  • (String) —

    Name of the accounting period.



28
29
30
 
# File 'lib/merge_ruby_client/accounting/types/accounting_period.rb', line 28

def name
  @name
end

#remote_data ⇒ Array<Merge::Accounting::RemoteData> (readonly)

Returns:



38
39
40
 
# File 'lib/merge_ruby_client/accounting/types/accounting_period.rb', line 38

def remote_data
  @remote_data
end

#remote_id ⇒ String (readonly)

Returns The third-party API ID of the matching object.

Returns:

  • (String) —

    The third-party API ID of the matching object.



22
23
24
 
# File 'lib/merge_ruby_client/accounting/types/accounting_period.rb', line 22

def remote_id
  @remote_id
end

#start_date ⇒ DateTime (readonly)

Returns Beginning date of the period.

Returns:

  • (DateTime) —

    Beginning date of the period



32
33
34
 
# File 'lib/merge_ruby_client/accounting/types/accounting_period.rb', line 32

def start_date
  @start_date
end

#status ⇒ Merge::Accounting::Status895Enum (readonly)

Returns:



30
31
32
 
# File 'lib/merge_ruby_client/accounting/types/accounting_period.rb', line 30

def status
  @status
end

Class Method Details

.from_json(json_object:) ⇒ Merge::Accounting::AccountingPeriod

Deserialize a JSON object to an instance of AccountingPeriod

Parameters:

  • json_object (String)

Returns:



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
121
 
# File 'lib/merge_ruby_client/accounting/types/accounting_period.rb', line 92

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  id = parsed_json["id"]
  remote_id = parsed_json["remote_id"]
  created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?)
  modified_at = (DateTime.parse(parsed_json["modified_at"]) unless parsed_json["modified_at"].nil?)
  name = parsed_json["name"]
  status = parsed_json["status"]
  start_date = (DateTime.parse(parsed_json["start_date"]) unless parsed_json["start_date"].nil?)
  end_date = (DateTime.parse(parsed_json["end_date"]) unless parsed_json["end_date"].nil?)
  field_mappings = parsed_json["field_mappings"]
  remote_data = parsed_json["remote_data"]&.map do |item|
    item = item.to_json
    Merge::Accounting::RemoteData.from_json(json_object: item)
  end
  new(
    id: id,
    remote_id: remote_id,
    created_at: created_at,
    modified_at: modified_at,
    name: name,
    status: status,
    start_date: start_date,
    end_date: end_date,
    field_mappings: field_mappings,
    remote_data: remote_data,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/merge_ruby_client/accounting/types/accounting_period.rb', line 136

def self.validate_raw(obj:)
  obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.remote_id&.is_a?(String) != false || raise("Passed value for field obj.remote_id is not the expected type, validation failed.")
  obj.created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
  obj.modified_at&.is_a?(DateTime) != false || raise("Passed value for field obj.modified_at is not the expected type, validation failed.")
  obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
  obj.status&.is_a?(Merge::Accounting::Status895Enum) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
  obj.start_date&.is_a?(DateTime) != false || raise("Passed value for field obj.start_date is not the expected type, validation failed.")
  obj.end_date&.is_a?(DateTime) != false || raise("Passed value for field obj.end_date is not the expected type, validation failed.")
  obj.field_mappings&.is_a?(Hash) != false || raise("Passed value for field obj.field_mappings is not the expected type, validation failed.")
  obj.remote_data&.is_a?(Array) != false || raise("Passed value for field obj.remote_data is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of AccountingPeriod to a JSON object

Returns:

  • (String) 


126
127
128
 
# File 'lib/merge_ruby_client/accounting/types/accounting_period.rb', line 126

def to_json(*_args)
  @_field_set&.to_json
end