Class: Merge::Accounting::Project

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

Overview

# The Project Object

### Description
The `Project` object is used to track and manage time, costs, resources, and
revenue for specific initiatives or work efforts.
It provides classification on transactions for allocating expenses, revenue, and
activities to a specific project for financial reporting.
### Usage Example
Fetch from the `GET Project` endpoint and view project information.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, is_active: OMIT, company: OMIT, contact: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Accounting::Project

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

    The project’s name

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

    ‘True` if the project is active, `False` if the project is not active.

  • company (Merge::Accounting::ProjectCompany) (defaults to: OMIT) —

    The subsidiary that the project belongs to.

  • contact (Merge::Accounting::ProjectContact) (defaults to: OMIT) —

    The supplier, or customer involved in the project.

  • 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



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
87
88
 
# File 'lib/merge_ruby_client/accounting/types/project.rb', line 61

def initialize(name:, id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, is_active: OMIT,
               company: OMIT, contact: 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
  @is_active = is_active if is_active != OMIT
  @company = company if company != OMIT
  @contact = contact if contact != 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,
    "is_active": is_active,
    "company": company,
    "contact": contact,
    "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



42
43
44
 
# File 'lib/merge_ruby_client/accounting/types/project.rb', line 42

def additional_properties
  @additional_properties
end

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

Returns The subsidiary that the project belongs to.

Returns:



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

def company
  @company
end

#contact ⇒ Merge::Accounting::ProjectContact (readonly)

Returns The supplier, or customer involved in the project.

Returns:



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

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



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

def created_at
  @created_at
end

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

Returns:

  • (Hash{String => Object}) 


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

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


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

def id
  @id
end

#is_active ⇒ Boolean (readonly)

Returns ‘True` if the project is active, `False` if the project is not active.

Returns:

  • (Boolean) —

    ‘True` if the project is active, `False` if the project is not active.



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

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



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

def modified_at
  @modified_at
end

#name ⇒ String (readonly)

Returns The project’s name.

Returns:

  • (String) —

    The project’s name



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

def name
  @name
end

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

Returns:



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

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.



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

def remote_id
  @remote_id
end

Class Method Details

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

Deserialize a JSON object to an instance of Project

Parameters:

  • json_object (String)

Returns:



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
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/merge_ruby_client/accounting/types/project.rb', line 94

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"]
  is_active = parsed_json["is_active"]
  if parsed_json["company"].nil?
    company = nil
  else
    company = parsed_json["company"].to_json
    company = Merge::Accounting::ProjectCompany.from_json(json_object: company)
  end
  if parsed_json["contact"].nil?
    contact = nil
  else
    contact = parsed_json["contact"].to_json
    contact = Merge::Accounting::ProjectContact.from_json(json_object: contact)
  end
  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,
    is_active: is_active,
    company: company,
    contact: contact,
    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) 


148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/merge_ruby_client/accounting/types/project.rb', line 148

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.is_active&.is_a?(Boolean) != false || raise("Passed value for field obj.is_active is not the expected type, validation failed.")
  obj.company.nil? || Merge::Accounting::ProjectCompany.validate_raw(obj: obj.company)
  obj.contact.nil? || Merge::Accounting::ProjectContact.validate_raw(obj: obj.contact)
  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 Project to a JSON object

Returns:

  • (String) 


138
139
140
 
# File 'lib/merge_ruby_client/accounting/types/project.rb', line 138

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