Class: Merge::Accounting::ContactRequest

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

Overview

# The Contact Object

### Description
A `Contact` is an individual or business entity to which products and services
are sold to or purchased from. The `Contact` model contains both Customers, in
which products and services are sold to, and Vendors (or Suppliers), in which
products and services are purchased from.
* A `Contact` is a Vendor/Supplier if the `is_supplier` property is true.
* A `Contact` is a customer if the `is_customer` property is true.
### Usage Example
Fetch from the `LIST Contacts` endpoint and view a company's contacts.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name: OMIT, is_supplier: OMIT, is_customer: OMIT, email_address: OMIT, tax_number: OMIT, status: OMIT, currency: OMIT, company: OMIT, addresses: OMIT, phone_numbers: OMIT, integration_params: OMIT, linked_account_params: OMIT, remote_fields: OMIT, additional_properties: nil) ⇒ Merge::Accounting::ContactRequest

Parameters:

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

    The contact’s name.

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

    Whether the contact is a supplier.

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

    Whether the contact is a customer.

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

    The contact’s email address.

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

    The contact’s tax number.

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

    The contact’s status

    • ‘ACTIVE` - ACTIVE

    • ‘ARCHIVED` - ARCHIVED

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

    The currency the contact’s transactions are in.

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

    The company the contact belongs to.

  • addresses (Array<Merge::Accounting::ContactRequestAddressesItem>) (defaults to: OMIT) —

    ‘Address` object IDs for the given `Contacts` object.

  • phone_numbers (Array<Merge::Accounting::AccountingPhoneNumberRequest>) (defaults to: OMIT) —

    ‘AccountingPhoneNumber` object for the given `Contacts` object.

  • integration_params (Hash{String => Object}) (defaults to: OMIT)
  • linked_account_params (Hash{String => Object}) (defaults to: OMIT)
  • remote_fields (Array<Merge::Accounting::RemoteFieldRequest>) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



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
109
 
# File 'lib/merge_ruby_client/accounting/types/contact_request.rb', line 76

def initialize(name: OMIT, is_supplier: OMIT, is_customer: OMIT, email_address: OMIT, tax_number: OMIT,
               status: OMIT, currency: OMIT, company: OMIT, addresses: OMIT, phone_numbers: OMIT, integration_params: OMIT, linked_account_params: OMIT, remote_fields: OMIT, additional_properties: nil)
  @name = name if name != OMIT
  @is_supplier = is_supplier if is_supplier != OMIT
  @is_customer = is_customer if is_customer != OMIT
  @email_address = email_address if email_address != OMIT
  @tax_number = tax_number if tax_number != OMIT
  @status = status if status != OMIT
  @currency = currency if currency != OMIT
  @company = company if company != OMIT
  @addresses = addresses if addresses != OMIT
  @phone_numbers = phone_numbers if phone_numbers != OMIT
  @integration_params = integration_params if integration_params != OMIT
  @linked_account_params =  if  != OMIT
  @remote_fields = remote_fields if remote_fields != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "name": name,
    "is_supplier": is_supplier,
    "is_customer": is_customer,
    "email_address": email_address,
    "tax_number": tax_number,
    "status": status,
    "currency": currency,
    "company": company,
    "addresses": addresses,
    "phone_numbers": phone_numbers,
    "integration_params": integration_params,
    "linked_account_params": ,
    "remote_fields": remote_fields
  }.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/contact_request.rb', line 52

def additional_properties
  @additional_properties
end

#addresses ⇒ Array<Merge::Accounting::ContactRequestAddressesItem> (readonly)

Returns ‘Address` object IDs for the given `Contacts` object.

Returns:



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

def addresses
  @addresses
end

#company ⇒ String (readonly)

Returns The company the contact belongs to.

Returns:

  • (String) —

    The company the contact belongs to.



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

def company
  @company
end

#currency ⇒ String (readonly)

Returns The currency the contact’s transactions are in.

Returns:

  • (String) —

    The currency the contact’s transactions are in.



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

def currency
  @currency
end

#email_address ⇒ String (readonly)

Returns The contact’s email address.

Returns:

  • (String) —

    The contact’s email address.



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

def email_address
  @email_address
end

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

Returns:

  • (Hash{String => Object}) 


46
47
48
 
# File 'lib/merge_ruby_client/accounting/types/contact_request.rb', line 46

def integration_params
  @integration_params
end

#is_customer ⇒ Boolean (readonly)

Returns Whether the contact is a customer.

Returns:

  • (Boolean) —

    Whether the contact is a customer.



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

def is_customer
  @is_customer
end

#is_supplier ⇒ Boolean (readonly)

Returns Whether the contact is a supplier.

Returns:

  • (Boolean) —

    Whether the contact is a supplier.



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

def is_supplier
  @is_supplier
end

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

Returns:

  • (Hash{String => Object}) 


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

def 
  @linked_account_params
end

#name ⇒ String (readonly)

Returns The contact’s name.

Returns:

  • (String) —

    The contact’s name.



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

def name
  @name
end

#phone_numbers ⇒ Array<Merge::Accounting::AccountingPhoneNumberRequest> (readonly)

Returns ‘AccountingPhoneNumber` object for the given `Contacts` object.

Returns:



44
45
46
 
# File 'lib/merge_ruby_client/accounting/types/contact_request.rb', line 44

def phone_numbers
  @phone_numbers
end

#remote_fields ⇒ Array<Merge::Accounting::RemoteFieldRequest> (readonly)

Returns:



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

def remote_fields
  @remote_fields
end

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

Returns The contact’s status

  • ‘ACTIVE` - ACTIVE

  • ‘ARCHIVED` - ARCHIVED.

Returns:



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

def status
  @status
end

#tax_number ⇒ String (readonly)

Returns The contact’s tax number.

Returns:

  • (String) —

    The contact’s tax number.



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

def tax_number
  @tax_number
end

Class Method Details

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

Deserialize a JSON object to an instance of ContactRequest

Parameters:

  • json_object (String)

Returns:



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
148
149
150
151
152
153
154
155
156
 
# File 'lib/merge_ruby_client/accounting/types/contact_request.rb', line 115

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  name = parsed_json["name"]
  is_supplier = parsed_json["is_supplier"]
  is_customer = parsed_json["is_customer"]
  email_address = parsed_json["email_address"]
  tax_number = parsed_json["tax_number"]
  status = parsed_json["status"]
  currency = parsed_json["currency"]
  company = parsed_json["company"]
  addresses = parsed_json["addresses"]&.map do |item|
    item = item.to_json
    Merge::Accounting::ContactRequestAddressesItem.from_json(json_object: item)
  end
  phone_numbers = parsed_json["phone_numbers"]&.map do |item|
    item = item.to_json
    Merge::Accounting::AccountingPhoneNumberRequest.from_json(json_object: item)
  end
  integration_params = parsed_json["integration_params"]
   = parsed_json["linked_account_params"]
  remote_fields = parsed_json["remote_fields"]&.map do |item|
    item = item.to_json
    Merge::Accounting::RemoteFieldRequest.from_json(json_object: item)
  end
  new(
    name: name,
    is_supplier: is_supplier,
    is_customer: is_customer,
    email_address: email_address,
    tax_number: tax_number,
    status: status,
    currency: currency,
    company: company,
    addresses: addresses,
    phone_numbers: phone_numbers,
    integration_params: integration_params,
    linked_account_params: ,
    remote_fields: remote_fields,
    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) 


171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/merge_ruby_client/accounting/types/contact_request.rb', line 171

def self.validate_raw(obj:)
  obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
  obj.is_supplier&.is_a?(Boolean) != false || raise("Passed value for field obj.is_supplier is not the expected type, validation failed.")
  obj.is_customer&.is_a?(Boolean) != false || raise("Passed value for field obj.is_customer is not the expected type, validation failed.")
  obj.email_address&.is_a?(String) != false || raise("Passed value for field obj.email_address is not the expected type, validation failed.")
  obj.tax_number&.is_a?(String) != false || raise("Passed value for field obj.tax_number 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.currency&.is_a?(String) != false || raise("Passed value for field obj.currency is not the expected type, validation failed.")
  obj.company&.is_a?(String) != false || raise("Passed value for field obj.company is not the expected type, validation failed.")
  obj.addresses&.is_a?(Array) != false || raise("Passed value for field obj.addresses is not the expected type, validation failed.")
  obj.phone_numbers&.is_a?(Array) != false || raise("Passed value for field obj.phone_numbers is not the expected type, validation failed.")
  obj.integration_params&.is_a?(Hash) != false || raise("Passed value for field obj.integration_params is not the expected type, validation failed.")
  obj.&.is_a?(Hash) != false || raise("Passed value for field obj.linked_account_params is not the expected type, validation failed.")
  obj.remote_fields&.is_a?(Array) != false || raise("Passed value for field obj.remote_fields is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of ContactRequest to a JSON object

Returns:

  • (String) 


161
162
163
 
# File 'lib/merge_ruby_client/accounting/types/contact_request.rb', line 161

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