Class: BridgeBankin::Connect

Inherits:
BridgeObject show all
Extended by:
API::Resource
Defined in:
lib/bridge_bankin/connect.rb

Overview

Connect resource

Constant Summary

Constants inherited from BridgeObject

BridgeObject::HIDDEN_ATTRIBUTES

Class Method Summary collapse

Methods inherited from BridgeObject

#==, convert_to_bridge_object, #initialize, #to_hash, #to_json

Constructor Details

This class inherits a constructor from BridgeBankin::BridgeObject

Class Method Details

.connect_item(access_token:, **params) ⇒ BridgeObject

Request URL to Bridge's Connect funnel for adding an item

Parameters:

  • access_token (String)

    the access token provided during the user authentication

  • params (Hash)

    any params that might be required (or optional) to communicate with the API

Returns:

  • (BridgeObject)

    URL to Bridge's Connect funnel for adding an item


19
20
21
22
23
24
# File 'lib/bridge_bankin/connect.rb', line 19

def connect_item(access_token:, **params)
  protected_resource(access_token) do
    data = api_client.get("/v2/connect/items/add/url", params)
    convert_to_bridge_object(data)
  end
end

.connect_item_with_iban(access_token:, **params) ⇒ BridgeObject

Returns the URL to Bridge's Connect funnel for adding an item using IBAN

Parameters:

  • access_token (String)

    the access token provided during the user authentication

  • params (Hash)

    any params that might be required (or optional) to communicate with the API

Returns:

  • (BridgeObject)

    the URL to Bridge's Connect funnel for adding an item using IBAN


34
35
36
37
38
39
# File 'lib/bridge_bankin/connect.rb', line 34

def connect_item_with_iban(access_token:, **params)
  protected_resource(access_token) do
    data = api_client.post("/v2/connect/items/add/url", params)
    convert_to_bridge_object(data)
  end
end

.edit_item(access_token:, **params) ⇒ BridgeObject

Request the URL to Bridge's Connect funnel for editing an item

Parameters:

  • access_token (String)

    the access token provided during the user authentication

  • params (Hash)

    any params that might be required (or optional) to communicate with the API

Returns:

  • (BridgeObject)

    the URL to Bridge's Connect funnel for editing an item


49
50
51
52
53
54
# File 'lib/bridge_bankin/connect.rb', line 49

def edit_item(access_token:, **params)
  protected_resource(access_token) do
    data = api_client.get("/v2/connect/items/edit/url", params)
    convert_to_bridge_object(data)
  end
end

.item_sync(access_token:, **params) ⇒ BridgeObject

Request the URL to Bridge's Connect funnel for managing a Strong Customer Authentication and synchronizing an item

Parameters:

  • access_token (String)

    the access token provided during the user authentication

  • params (Hash)

    any params that might be required (or optional) to communicate with the API

Returns:

  • (BridgeObject)

    the URL to Bridge's Connect funnel for managing


65
66
67
68
69
70
# File 'lib/bridge_bankin/connect.rb', line 65

def item_sync(access_token:, **params)
  protected_resource(access_token) do
    data = api_client.get("/v2/connect/items/sync", params)
    convert_to_bridge_object(data)
  end
end

.validate_email(access_token:, **params) ⇒ BridgeObject

Request the URL to Bridge's Connect funnel for validating a user's email

Parameters:

  • access_token (String)

    the access token provided during the user authentication

  • params (Hash)

    any params that might be required (or optional) to communicate with the API

Returns:

  • (BridgeObject)

    the URL to Bridge's Connect funnel for validating a user's email


80
81
82
83
84
85
# File 'lib/bridge_bankin/connect.rb', line 80

def validate_email(access_token:, **params)
  protected_resource(access_token) do
    data = api_client.get("/v2/connect/users/email/confirmation/url", params)
    convert_to_bridge_object(data)
  end
end

.validate_pro_items(access_token:, **params) ⇒ BridgeObject

Request the URL to Bridge's Connect funnel for validating pro items

Parameters:

  • access_token (String)

    the access token provided during the user authentication

  • params (Hash)

    any params that might be required (or optional) to communicate with the API

Returns:

  • (BridgeObject)

    the URL to Bridge's Connect funnel for validating pro items


95
96
97
98
99
100
# File 'lib/bridge_bankin/connect.rb', line 95

def validate_pro_items(access_token:, **params)
  protected_resource(access_token) do
    data = api_client.get("/v2/connect/items/pro/confirmation/url", params)
    convert_to_bridge_object(data)
  end
end