Class: Merge::Accounting::ContactsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/accounting/contacts/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Merge::Accounting::ContactsClient

Parameters:



24
25
26
 
# File 'lib/merge_ruby_client/accounting/contacts/client.rb', line 24

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Merge::RequestClient (readonly)

Returns:



20
21
22
 
# File 'lib/merge_ruby_client/accounting/contacts/client.rb', line 20

def request_client
  @request_client
end

Instance Method Details

#create(model:, is_debug_mode: nil, run_async: nil, request_options: nil) ⇒ Merge::Accounting::ContactResponse

Creates a ‘Contact` object with the given values.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.accounting.contacts.create(model: {  })

Parameters:

  • is_debug_mode (Boolean) (defaults to: nil) —

    Whether to include debug fields (such as log file links) in the response.

  • run_async (Boolean) (defaults to: nil) —

    Whether or not third-party updates should be run asynchronously.

  • model (Hash) —

    Request of type Merge::Accounting::ContactRequest, as a Hash

    • :name (String)

    • :is_supplier (Boolean)

    • :is_customer (Boolean)

    • :email_address (String)

    • :tax_number (String)

    • :status (Merge::Accounting::Status7D1Enum)

    • :currency (String)

    • :company (String)

    • :addresses (Array<Merge::Accounting::ContactRequestAddressesItem>)

    • :phone_numbers (Array<Merge::Accounting::AccountingPhoneNumberRequest>)

    • :integration_params (Hash=> Object)

    • :linked_account_params (Hash=> Object)

    • :remote_fields (Array<Merge::Accounting::RemoteFieldRequest>)

  • request_options (Merge::RequestOptions) (defaults to: nil)

Returns:



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/merge_ruby_client/accounting/contacts/client.rb', line 138

def create(model:, is_debug_mode: nil, run_async: nil, request_options: nil)
  response = @request_client.conn.post do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
    req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    req.params = {
      **(request_options&.additional_query_parameters || {}),
      "is_debug_mode": is_debug_mode,
      "run_async": run_async
    }.compact
    req.body = { **(request_options&.additional_body_parameters || {}), model: model }.compact
    req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/contacts"
  end
  Merge::Accounting::ContactResponse.from_json(json_object: response.body)
end

#list(company_id: nil, created_after: nil, created_before: nil, cursor: nil, email_address: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil, include_remote_fields: nil, include_shell_data: nil, is_customer: nil, is_supplier: nil, modified_after: nil, modified_before: nil, name: nil, page_size: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, status: nil, request_options: nil) ⇒ Merge::Accounting::PaginatedContactList

Returns a list of ‘Contact` objects.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.accounting.contacts.list(cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw")

Parameters:

  • company_id (String) (defaults to: nil) —

    If provided, will only return contacts for this company.

  • created_after (DateTime) (defaults to: nil) —

    If provided, will only return objects created after this datetime.

  • created_before (DateTime) (defaults to: nil) —

    If provided, will only return objects created before this datetime.

  • cursor (String) (defaults to: nil) —

    The pagination cursor value.

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

    If provided, will only return Contacts that match this email.

  • expand (Merge::Accounting::Contacts::ContactsListRequestExpand) (defaults to: nil) —

    Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

  • include_deleted_data (Boolean) (defaults to: nil) —

    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/).

  • include_remote_data (Boolean) (defaults to: nil) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

  • include_remote_fields (Boolean) (defaults to: nil) —

    Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.

  • include_shell_data (Boolean) (defaults to: nil) —

    Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

  • is_customer (String) (defaults to: nil) —

    If provided, will only return Contacts that are denoted as customers.

  • is_supplier (String) (defaults to: nil) —

    If provided, will only return Contacts that are denoted as suppliers.

  • modified_after (DateTime) (defaults to: nil) —

    If provided, only objects synced by Merge after this date time will be returned.

  • modified_before (DateTime) (defaults to: nil) —

    If provided, only objects synced by Merge before this date time will be returned.

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

    If provided, will only return Contacts that match this name.

  • page_size (Integer) (defaults to: nil) —

    Number of results to return per page.

  • remote_fields (String) (defaults to: nil) —

    Deprecated. Use show_enum_origins.

  • remote_id (String) (defaults to: nil) —

    The API provider’s ID for the given object.

  • show_enum_origins (String) (defaults to: nil) —

    A comma separated list of enum field names for which you’d like the original values to be returned, instead of Merge’s normalized enum values. [Learn e](help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)

  • status (String) (defaults to: nil) —

    If provided, will only return Contacts that match this status.

  • request_options (Merge::RequestOptions) (defaults to: nil)

Returns:



69
70
71
72
73
74
75
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/contacts/client.rb', line 69

def list(company_id: nil, created_after: nil, created_before: nil, cursor: nil, email_address: nil, expand: nil,
         include_deleted_data: nil, include_remote_data: nil, include_remote_fields: nil, include_shell_data: nil, is_customer: nil, is_supplier: nil, modified_after: nil, modified_before: nil, name: nil, page_size: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, status: nil, request_options: nil)
  response = @request_client.conn.get do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
    req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    req.params = {
      **(request_options&.additional_query_parameters || {}),
      "company_id": company_id,
      "created_after": created_after,
      "created_before": created_before,
      "cursor": cursor,
      "email_address": email_address,
      "expand": expand,
      "include_deleted_data": include_deleted_data,
      "include_remote_data": include_remote_data,
      "include_remote_fields": include_remote_fields,
      "include_shell_data": include_shell_data,
      "is_customer": is_customer,
      "is_supplier": is_supplier,
      "modified_after": modified_after,
      "modified_before": modified_before,
      "name": name,
      "page_size": page_size,
      "remote_fields": remote_fields,
      "remote_id": remote_id,
      "show_enum_origins": show_enum_origins,
      "status": status
    }.compact
    unless request_options.nil? || request_options&.additional_body_parameters.nil?
      req.body = { **(request_options&.additional_body_parameters || {}) }.compact
    end
    req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/contacts"
  end
  Merge::Accounting::PaginatedContactList.from_json(json_object: response.body)
end

#meta_patch_retrieve(id:, request_options: nil) ⇒ Merge::Accounting::MetaResponse

Returns metadata for ‘Contact` PATCHs.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.accounting.contacts.meta_patch_retrieve(id: "id")

Parameters:

Returns:



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/merge_ruby_client/accounting/contacts/client.rb', line 272

def meta_patch_retrieve(id:, request_options: nil)
  response = @request_client.conn.get do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
    req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    unless request_options.nil? || request_options&.additional_query_parameters.nil?
      req.params = { **(request_options&.additional_query_parameters || {}) }.compact
    end
    unless request_options.nil? || request_options&.additional_body_parameters.nil?
      req.body = { **(request_options&.additional_body_parameters || {}) }.compact
    end
    req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/contacts/meta/patch/#{id}"
  end
  Merge::Accounting::MetaResponse.from_json(json_object: response.body)
end

#meta_post_retrieve(request_options: nil) ⇒ Merge::Accounting::MetaResponse

Returns metadata for ‘Contact` POSTs.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.accounting.contacts.meta_post_retrieve

Parameters:

Returns:



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/merge_ruby_client/accounting/contacts/client.rb', line 304

def meta_post_retrieve(request_options: nil)
  response = @request_client.conn.get do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
    req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    unless request_options.nil? || request_options&.additional_query_parameters.nil?
      req.params = { **(request_options&.additional_query_parameters || {}) }.compact
    end
    unless request_options.nil? || request_options&.additional_body_parameters.nil?
      req.body = { **(request_options&.additional_body_parameters || {}) }.compact
    end
    req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/contacts/meta/post"
  end
  Merge::Accounting::MetaResponse.from_json(json_object: response.body)
end

#partial_update(id:, model:, is_debug_mode: nil, run_async: nil, request_options: nil) ⇒ Merge::Accounting::ContactResponse

Updates a ‘Contact` object with the given `id`.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.accounting.contacts.partial_update(id: "id", model: {  })

Parameters:

  • id (String)
  • is_debug_mode (Boolean) (defaults to: nil) —

    Whether to include debug fields (such as log file links) in the response.

  • run_async (Boolean) (defaults to: nil) —

    Whether or not third-party updates should be run asynchronously.

  • model (Hash) —

    Request of type Merge::Accounting::PatchedContactRequest, as a Hash

    • :name (String)

    • :is_supplier (Boolean)

    • :is_customer (Boolean)

    • :email_address (String)

    • :tax_number (String)

    • :status (Merge::Accounting::Status7D1Enum)

    • :currency (String)

    • :company (String)

    • :addresses (Array<Merge::Accounting::PatchedContactRequestAddressesItem>)

    • :phone_numbers (Array<Merge::Accounting::AccountingPhoneNumberRequest>)

    • :integration_params (Hash=> Object)

    • :linked_account_params (Hash=> Object)

    • :remote_fields (Array<Merge::Accounting::RemoteFieldRequest>)

  • request_options (Merge::RequestOptions) (defaults to: nil)

Returns:



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/merge_ruby_client/accounting/contacts/client.rb', line 239

def partial_update(id:, model:, is_debug_mode: nil, run_async: nil, request_options: nil)
  response = @request_client.conn.patch do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
    req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    req.params = {
      **(request_options&.additional_query_parameters || {}),
      "is_debug_mode": is_debug_mode,
      "run_async": run_async
    }.compact
    req.body = { **(request_options&.additional_body_parameters || {}), model: model }.compact
    req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/contacts/#{id}"
  end
  Merge::Accounting::ContactResponse.from_json(json_object: response.body)
end

#remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, is_common_model_field: nil, is_custom: nil, page_size: nil, request_options: nil) ⇒ Merge::Accounting::PaginatedRemoteFieldClassList

Returns a list of ‘RemoteFieldClass` objects.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.accounting.contacts.remote_field_classes_list(cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw")

Parameters:

  • cursor (String) (defaults to: nil) —

    The pagination cursor value.

  • include_deleted_data (Boolean) (defaults to: nil) —

    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/).

  • include_remote_data (Boolean) (defaults to: nil) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

  • include_shell_data (Boolean) (defaults to: nil) —

    Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

  • is_common_model_field (Boolean) (defaults to: nil) —

    If provided, will only return remote field classes with this is_common_model_field value

  • is_custom (Boolean) (defaults to: nil) —

    If provided, will only return remote fields classes with this is_custom value

  • page_size (Integer) (defaults to: nil) —

    Number of results to return per page.

  • request_options (Merge::RequestOptions) (defaults to: nil)

Returns:



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/merge_ruby_client/accounting/contacts/client.rb', line 349

def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
                              include_shell_data: nil, is_common_model_field: nil, is_custom: nil, page_size: nil, request_options: nil)
  response = @request_client.conn.get do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
    req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    req.params = {
      **(request_options&.additional_query_parameters || {}),
      "cursor": cursor,
      "include_deleted_data": include_deleted_data,
      "include_remote_data": include_remote_data,
      "include_shell_data": include_shell_data,
      "is_common_model_field": is_common_model_field,
      "is_custom": is_custom,
      "page_size": page_size
    }.compact
    unless request_options.nil? || request_options&.additional_body_parameters.nil?
      req.body = { **(request_options&.additional_body_parameters || {}) }.compact
    end
    req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/contacts/remote-field-classes"
  end
  Merge::Accounting::PaginatedRemoteFieldClassList.from_json(json_object: response.body)
end

#retrieve(id:, expand: nil, include_remote_data: nil, include_remote_fields: nil, include_shell_data: nil, remote_fields: nil, show_enum_origins: nil, request_options: nil) ⇒ Merge::Accounting::Contact

Returns a ‘Contact` object with the given `id`.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.accounting.contacts.retrieve(id: "id")

Parameters:

  • id (String)
  • expand (Merge::Accounting::Contacts::ContactsRetrieveRequestExpand) (defaults to: nil) —

    Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

  • include_remote_data (Boolean) (defaults to: nil) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

  • include_remote_fields (Boolean) (defaults to: nil) —

    Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.

  • include_shell_data (Boolean) (defaults to: nil) —

    Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

  • remote_fields (String) (defaults to: nil) —

    Deprecated. Use show_enum_origins.

  • show_enum_origins (String) (defaults to: nil) —

    A comma separated list of enum field names for which you’d like the original values to be returned, instead of Merge’s normalized enum values. [Learn e](help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)

  • request_options (Merge::RequestOptions) (defaults to: nil)

Returns:



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/merge_ruby_client/accounting/contacts/client.rb', line 183

def retrieve(id:, expand: nil, include_remote_data: nil, include_remote_fields: nil, include_shell_data: nil,
             remote_fields: nil, show_enum_origins: nil, request_options: nil)
  response = @request_client.conn.get do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
    req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    req.params = {
      **(request_options&.additional_query_parameters || {}),
      "expand": expand,
      "include_remote_data": include_remote_data,
      "include_remote_fields": include_remote_fields,
      "include_shell_data": include_shell_data,
      "remote_fields": remote_fields,
      "show_enum_origins": show_enum_origins
    }.compact
    unless request_options.nil? || request_options&.additional_body_parameters.nil?
      req.body = { **(request_options&.additional_body_parameters || {}) }.compact
    end
    req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/contacts/#{id}"
  end
  Merge::Accounting::Contact.from_json(json_object: response.body)
end