Class: Merge::Crm::AsyncAssociationTypesClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Parameters:



207
208
209
 
# File 'lib/merge_ruby_client/crm/association_types/client.rb', line 207

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Merge::AsyncRequestClient (readonly)

Returns:



203
204
205
 
# File 'lib/merge_ruby_client/crm/association_types/client.rb', line 203

def request_client
  @request_client
end

Instance Method Details

#custom_object_classes_association_types_create(custom_object_class_id:, model:, is_debug_mode: nil, run_async: nil, request_options: nil) ⇒ Merge::Crm::CrmAssociationTypeResponse

Creates an ‘AssociationType` 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.association_types.custom_object_classes_association_types_create(custom_object_class_id: "custom_object_class_id", model: { source_object_class: { id: "id", origin_type: CUSTOM_OBJECT }, target_object_classes: [{ id: "id", origin_type: CUSTOM_OBJECT }], remote_key_name: "remote_key_name" })

Parameters:

  • custom_object_class_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::Crm::AssociationTypeRequestRequest, as a Hash

    • :source_object_class (Hash)

      • :id (String)

      • :origin_type (Merge::Crm::OriginTypeEnum)

    • :target_object_classes (Array<Merge::Crm::ObjectClassDescriptionRequest>)

    • :remote_key_name (String)

    • :display_name (String)

    • :cardinality (Merge::Crm::CardinalityEnum)

    • :is_required (Boolean)

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

Returns:



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/merge_ruby_client/crm/association_types/client.rb', line 293

def custom_object_classes_association_types_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}/association-types"
    end
    Merge::Crm::CrmAssociationTypeResponse.from_json(json_object: response.body)
  end
end

#custom_object_classes_association_types_list(custom_object_class_id:, 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::PaginatedAssociationTypeList

Returns a list of ‘AssociationType` objects.

Examples:

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

Parameters:

  • custom_object_class_id (String)
  • 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:



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/merge_ruby_client/crm/association_types/client.rb', line 236

def custom_object_classes_association_types_list(custom_object_class_id:, 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)
  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,
        "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}/association-types"
    end
    Merge::Crm::PaginatedAssociationTypeList.from_json(json_object: response.body)
  end
end

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

Returns metadata for ‘CRMAssociationType` POSTs.

Examples:

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

Parameters:

Returns:



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/merge_ruby_client/crm/association_types/client.rb', line 372

def custom_object_classes_association_types_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}/association-types/meta/post"
    end
    Merge::Crm::MetaResponse.from_json(json_object: response.body)
  end
end

#custom_object_classes_association_types_retrieve(custom_object_class_id:, id:, expand: nil, include_remote_data: nil, request_options: nil) ⇒ Merge::Crm::AssociationType

Returns an ‘AssociationType` 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.association_types.custom_object_classes_association_types_retrieve(custom_object_class_id: "custom_object_class_id", id: "id")

Parameters:

  • custom_object_class_id (String)
  • id (String)
  • expand (String) (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.

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

Returns:



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/merge_ruby_client/crm/association_types/client.rb', line 334

def custom_object_classes_association_types_retrieve(custom_object_class_id:, id:, expand: nil,
                                                     include_remote_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 || {}),
        "expand": expand,
        "include_remote_data": include_remote_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}/association-types/#{id}"
    end
    Merge::Crm::AssociationType.from_json(json_object: response.body)
  end
end