Class: Merge::Crm::AsyncCustomObjectsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/crm/custom_objects/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Merge::Crm::AsyncCustomObjectsClient 



268
269
270
 
# File 'lib/merge_ruby_client/crm/custom_objects/client.rb', line 268

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Merge::AsyncRequestClient (readonly) 



264
265
266
 
# File 'lib/merge_ruby_client/crm/custom_objects/client.rb', line 264

def request_client
  @request_client
end

Instance Method Details

#custom_object_classes_custom_objects_create(custom_object_class_id:, model:, is_debug_mode: nil, run_async: nil, request_options: nil) ⇒ Merge::Crm::CrmCustomObjectResponse

Creates a CustomObject 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.crm.custom_objects.custom_object_classes_custom_objects_create(custom_object_class_id: "custom_object_class_id", model: { fields: { "test_field": "hello" } })



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/merge_ruby_client/crm/custom_objects/client.rb', line 355

def custom_object_classes_custom_objects_create(custom_object_class_id:, model:, is_debug_mode: nil,
                                                run_async: nil, request_options: nil)
  Async do
    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)}/crm/v1/custom-object-classes/#{custom_object_class_id}/custom-objects"
    end
    Merge::Crm::CrmCustomObjectResponse.from_json(json_object: response.body)
  end
end

#custom_object_classes_custom_objects_list(custom_object_class_id:, created_after: nil, created_before: nil, cursor: nil, include_deleted_data: nil, include_remote_data: nil, include_remote_fields: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: nil, request_options: nil) ⇒ Merge::Crm::PaginatedCustomObjectList

Returns a list of CustomObject objects.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.crm.custom_objects.custom_object_classes_custom_objects_list(custom_object_class_id: "custom_object_class_id", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw")



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/merge_ruby_client/crm/custom_objects/client.rb', line 302

def custom_object_classes_custom_objects_list(custom_object_class_id:, created_after: nil, created_before: nil,
                                              cursor: nil, include_deleted_data: nil, include_remote_data: nil, include_remote_fields: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: nil, request_options: nil)
  Async do
    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 || {}),
        "created_after": created_after,
        "created_before": created_before,
        "cursor": cursor,
        "include_deleted_data": include_deleted_data,
        "include_remote_data": include_remote_data,
        "include_remote_fields": include_remote_fields,
        "include_shell_data": include_shell_data,
        "modified_after": modified_after,
        "modified_before": modified_before,
        "page_size": page_size,
        "remote_id": remote_id
      }.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)}/crm/v1/custom-object-classes/#{custom_object_class_id}/custom-objects"
    end
    Merge::Crm::PaginatedCustomObjectList.from_json(json_object: response.body)
  end
end

#custom_object_classes_custom_objects_meta_post_retrieve(custom_object_class_id:, request_options: nil) ⇒ Merge::Crm::MetaResponse

Returns metadata for CRMCustomObject POSTs.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve(custom_object_class_id: "custom_object_class_id")



437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/merge_ruby_client/crm/custom_objects/client.rb', line 437

def custom_object_classes_custom_objects_meta_post_retrieve(custom_object_class_id:, request_options: nil)
  Async do
    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)}/crm/v1/custom-object-classes/#{custom_object_class_id}/custom-objects/meta/post"
    end
    Merge::Crm::MetaResponse.from_json(json_object: response.body)
  end
end

#custom_object_classes_custom_objects_remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil, include_remote_fields: nil, include_shell_data: nil, is_common_model_field: nil, is_custom: nil, page_size: nil, request_options: nil) ⇒ Merge::Crm::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.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list(cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw")



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
 
# File 'lib/merge_ruby_client/crm/custom_objects/client.rb', line 486

def custom_object_classes_custom_objects_remote_field_classes_list(cursor: nil, include_deleted_data: nil,
                                                                   include_remote_data: nil, include_remote_fields: nil, include_shell_data: nil, is_common_model_field: nil, is_custom: nil, page_size: nil, request_options: nil)
  Async do
    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_remote_fields": include_remote_fields,
        "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)}/crm/v1/custom-object-classes/custom-objects/remote-field-classes"
    end
    Merge::Crm::PaginatedRemoteFieldClassList.from_json(json_object: response.body)
  end
end

#custom_object_classes_custom_objects_retrieve(custom_object_class_id:, id:, include_remote_data: nil, include_remote_fields: nil, include_shell_data: nil, request_options: nil) ⇒ Merge::Crm::CustomObject

Returns a CustomObject 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.crm.custom_objects.custom_object_classes_custom_objects_retrieve(custom_object_class_id: "custom_object_class_id", id: "id")



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/merge_ruby_client/crm/custom_objects/client.rb', line 398

def custom_object_classes_custom_objects_retrieve(custom_object_class_id:, id:, include_remote_data: nil,
                                                  include_remote_fields: nil, include_shell_data: nil, request_options: nil)
  Async do
    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 || {}),
        "include_remote_data": include_remote_data,
        "include_remote_fields": include_remote_fields,
        "include_shell_data": include_shell_data
      }.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)}/crm/v1/custom-object-classes/#{custom_object_class_id}/custom-objects/#{id}"
    end
    Merge::Crm::CustomObject.from_json(json_object: response.body)
  end
end