Class: Merge::Accounting::TrackingCategory

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/accounting/types/tracking_category.rb

Overview

# The TrackingCategory Object

### Description
A `TrackingCategory` object represents a categorization method used to classify
transactions within an accounting platform. They are often used to group records
for reporting and analysis purposes. The most common types of
`TrackingCategories` are Classes and Departments.
### Usage Example
Fetch from the `GET TrackingCategory` endpoint and view a company's tracking
category.

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, category_type: OMIT, parent_category: OMIT, company: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, additional_properties: nil) ⇒ Merge::Accounting::TrackingCategory

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) —

    The tracking category’s name.

  • status (Merge::Accounting::Status7D1Enum) (defaults to: OMIT) —

    The tracking category’s status.

    • ‘ACTIVE` - ACTIVE

    • ‘ARCHIVED` - ARCHIVED

  • category_type (Merge::Accounting::CategoryTypeEnum) (defaults to: OMIT) —

    The tracking category’s type.

    • ‘CLASS` - CLASS

    • ‘DEPARTMENT` - DEPARTMENT

  • parent_category (String) (defaults to: OMIT)
  • company (Merge::Accounting::TrackingCategoryCompany) (defaults to: OMIT) —

    The company the GeneralLedgerTransaction belongs to.

  • remote_was_deleted (Boolean) (defaults to: OMIT) —

    Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).

  • field_mappings (Hash{String => Object}) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



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/merge_ruby_client/accounting/types/tracking_category.rb', line 79

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, name: OMIT, status: OMIT,
               category_type: OMIT, parent_category: OMIT, company: OMIT, remote_was_deleted: OMIT, field_mappings: 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
  @category_type = category_type if category_type != OMIT
  @parent_category = parent_category if parent_category != OMIT
  @company = company if company != OMIT
  @remote_was_deleted = remote_was_deleted if remote_was_deleted != OMIT
  @field_mappings = field_mappings if field_mappings != 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,
    "category_type": category_type,
    "parent_category": parent_category,
    "company": company,
    "remote_was_deleted": remote_was_deleted,
    "field_mappings": field_mappings
  }.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



52
53
54
 
# File 'lib/merge_ruby_client/accounting/types/tracking_category.rb', line 52

def additional_properties
  @additional_properties
end

#category_type ⇒ Merge::Accounting::CategoryTypeEnum (readonly)

Returns The tracking category’s type.

  • ‘CLASS` - CLASS

  • ‘DEPARTMENT` - DEPARTMENT.

Returns:



39
40
41
 
# File 'lib/merge_ruby_client/accounting/types/tracking_category.rb', line 39

def category_type
  @category_type
end

#company ⇒ Merge::Accounting::TrackingCategoryCompany (readonly)

Returns The company the GeneralLedgerTransaction belongs to.

Returns:



43
44
45
 
# File 'lib/merge_ruby_client/accounting/types/tracking_category.rb', line 43

def company
  @company
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.



27
28
29
 
# File 'lib/merge_ruby_client/accounting/types/tracking_category.rb', line 27

def created_at
  @created_at
end

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

Returns:

  • (Hash{String => Object}) 


50
51
52
 
# File 'lib/merge_ruby_client/accounting/types/tracking_category.rb', line 50

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


23
24
25
 
# File 'lib/merge_ruby_client/accounting/types/tracking_category.rb', line 23

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.



29
30
31
 
# File 'lib/merge_ruby_client/accounting/types/tracking_category.rb', line 29

def modified_at
  @modified_at
end

#name ⇒ String (readonly)

Returns The tracking category’s name.

Returns:

  • (String) —

    The tracking category’s name.



31
32
33
 
# File 'lib/merge_ruby_client/accounting/types/tracking_category.rb', line 31

def name
  @name
end

#parent_category ⇒ String (readonly)

Returns:

  • (String) 


41
42
43
 
# File 'lib/merge_ruby_client/accounting/types/tracking_category.rb', line 41

def parent_category
  @parent_category
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.



25
26
27
 
# File 'lib/merge_ruby_client/accounting/types/tracking_category.rb', line 25

def remote_id
  @remote_id
end

#remote_was_deleted ⇒ Boolean (readonly)

Returns Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).

Returns:

  • (Boolean) —

    Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).



48
49
50
 
# File 'lib/merge_ruby_client/accounting/types/tracking_category.rb', line 48

def remote_was_deleted
  @remote_was_deleted
end

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

Returns The tracking category’s status.

  • ‘ACTIVE` - ACTIVE

  • ‘ARCHIVED` - ARCHIVED.

Returns:



35
36
37
 
# File 'lib/merge_ruby_client/accounting/types/tracking_category.rb', line 35

def status
  @status
end

Class Method Details

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

Deserialize a JSON object to an instance of TrackingCategory

Parameters:

  • json_object (String)

Returns:



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/merge_ruby_client/accounting/types/tracking_category.rb', line 114

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"]
  category_type = parsed_json["category_type"]
  parent_category = parsed_json["parent_category"]
  if parsed_json["company"].nil?
    company = nil
  else
    company = parsed_json["company"].to_json
    company = Merge::Accounting::TrackingCategoryCompany.from_json(json_object: company)
  end
  remote_was_deleted = parsed_json["remote_was_deleted"]
  field_mappings = parsed_json["field_mappings"]
  new(
    id: id,
    remote_id: remote_id,
    created_at: created_at,
    modified_at: modified_at,
    name: name,
    status: status,
    category_type: category_type,
    parent_category: parent_category,
    company: company,
    remote_was_deleted: remote_was_deleted,
    field_mappings: field_mappings,
    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) 


162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/merge_ruby_client/accounting/types/tracking_category.rb', line 162

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::Status7D1Enum) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
  obj.category_type&.is_a?(Merge::Accounting::CategoryTypeEnum) != false || raise("Passed value for field obj.category_type is not the expected type, validation failed.")
  obj.parent_category&.is_a?(String) != false || raise("Passed value for field obj.parent_category is not the expected type, validation failed.")
  obj.company.nil? || Merge::Accounting::TrackingCategoryCompany.validate_raw(obj: obj.company)
  obj.remote_was_deleted&.is_a?(Boolean) != false || raise("Passed value for field obj.remote_was_deleted 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.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of TrackingCategory to a JSON object

Returns:

  • (String) 


152
153
154
 
# File 'lib/merge_ruby_client/accounting/types/tracking_category.rb', line 152

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