Class: Merge::Crm::AssociationsClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Parameters:



17
18
19
 
# File 'lib/merge_ruby_client/crm/associations/client.rb', line 17

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Merge::RequestClient (readonly)

Returns:



13
14
15
 
# File 'lib/merge_ruby_client/crm/associations/client.rb', line 13

def request_client
  @request_client
end

Instance Method Details

#custom_object_classes_custom_objects_associations_list(custom_object_class_id:, object_id:, association_type_id: nil, created_after: nil, created_before: nil, cursor: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: nil, request_options: nil) ⇒ Merge::Crm::PaginatedAssociationList

Returns a list of ‘Association` objects.

Examples:

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

Parameters:

  • custom_object_class_id (String)
  • object_id (String)
  • association_type_id (String) (defaults to: nil) —

    If provided, will only return opportunities with this association_type.

  • 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.

  • expand (String) (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) —

    Whether to include data that was marked as deleted by third party webhooks.

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

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

  • 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.

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

    Number of results to return per page.

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

    The API provider’s ID for the given object.

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

Returns:



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/merge_ruby_client/crm/associations/client.rb', line 48

def custom_object_classes_custom_objects_associations_list(custom_object_class_id:, object_id:,
                                                           association_type_id: nil, created_after: nil, created_before: nil, cursor: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: 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 || {}),
      "association_type_id": association_type_id,
      "created_after": created_after,
      "created_before": created_before,
      "cursor": cursor,
      "expand": expand,
      "include_deleted_data": include_deleted_data,
      "include_remote_data": include_remote_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/#{object_id}/associations"
  end
  Merge::Crm::PaginatedAssociationList.from_json(json_object: response.body)
end

#custom_object_classes_custom_objects_associations_update(association_type_id:, source_class_id:, source_object_id:, target_class_id:, target_object_id:, is_debug_mode: nil, run_async: nil, request_options: nil) ⇒ Merge::Crm::Association

Creates an Association between ‘source_object_id` and `target_object_id` of type

`association_type_id`.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.crm.associations.custom_object_classes_custom_objects_associations_update(
  association_type_id: "association_type_id",
  source_class_id: "source_class_id",
  source_object_id: "source_object_id",
  target_class_id: "target_class_id",
  target_object_id: "target_object_id"
)

Parameters:

  • association_type_id (String)
  • source_class_id (String)
  • source_object_id (String)
  • target_class_id (String)
  • target_object_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.

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

Returns:



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/merge_ruby_client/crm/associations/client.rb', line 106

def custom_object_classes_custom_objects_associations_update(association_type_id:, source_class_id:,
                                                             source_object_id:, target_class_id:, target_object_id:, is_debug_mode: nil, run_async: nil, request_options: nil)
  response = @request_client.conn.put 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
    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/#{association_type_id}/custom-objects/#{source_class_id}/associations/#{source_object_id}/#{target_class_id}/#{target_object_id}"
  end
  Merge::Crm::Association.from_json(json_object: response.body)
end