Class: MethodRuby::Resources::Entities::ManualConnect

Inherits:
Object
  • Object
show all
Defined in:
lib/method_ruby/resources/entities/manual_connect.rb

Overview

Account connection sessions for entities

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ ManualConnect

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of ManualConnect.

Parameters:



81
82
83
 
# File 'lib/method_ruby/resources/entities/manual_connect.rb', line 81

def initialize(client:)
  @client = client
end

Instance Method Details

#create(entity_id, bureau:, tradelines:, method_version:, idempotency_key: nil, request_options: {}) ⇒ MethodRuby::Models::Entities::ManualConnectCreateResponse

Some parameter documentations has been truncated, see Models::Entities::ManualConnectCreateParams for more details.

Creates a new manual connect session for the specified entity.

Parameters:

Returns:

See Also:



30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/method_ruby/resources/entities/manual_connect.rb', line 30

def create(entity_id, params)
  parsed, options = MethodRuby::Entities::ManualConnectCreateParams.dump_request(params)
  header_params = {method_version: "method-version", idempotency_key: "idempotency-key"}
  @client.request(
    method: :post,
    path: ["entities/%1$s/manual_connect", entity_id],
    headers: parsed.slice(*header_params.keys).transform_keys(header_params),
    body: parsed.except(*header_params.keys),
    model: MethodRuby::Models::Entities::ManualConnectCreateResponse,
    security: {secret_key: true},
    options: options
  )
end

#retrieve(mcxn_id, entity_id:, method_version:, request_options: {}) ⇒ MethodRuby::Models::Entities::ManualConnectRetrieveResponse

Some parameter documentations has been truncated, see Models::Entities::ManualConnectRetrieveParams for more details.

Returns a single entity manual connect session by its identifier.

Parameters:

Returns:

See Also:



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/method_ruby/resources/entities/manual_connect.rb', line 62

def retrieve(mcxn_id, params)
  parsed, options = MethodRuby::Entities::ManualConnectRetrieveParams.dump_request(params)
  entity_id =
    parsed.delete(:entity_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["entities/%1$s/manual_connect/%2$s", entity_id, mcxn_id],
    headers: parsed.transform_keys(method_version: "method-version"),
    model: MethodRuby::Models::Entities::ManualConnectRetrieveResponse,
    security: {secret_key: true},
    options: options
  )
end