Class: BudgeaClient::TransferApi

Inherits:
Object
  • Object
show all
Defined in:
lib/budgea_client/api/transfer_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TransferApi

Returns a new instance of TransferApi.



19
20
21
 
# File 'lib/budgea_client/api/transfer_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/budgea_client/api/transfer_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#webauth_get(opts = {}) ⇒ nil

First step to establish an oAuth2 connection. The route encapsulate 2 functionalities: 1. Create or update a connection through oAuth2 session.
2. Execute a transfer through OAuth2 session.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :id_connector (Integer) —

    ID of the connector

  • :id_transfer (Integer) —

    ID of the transfer

  • :connector_uuid (String) —

    Optional unique ID of the connector (replaces id_connector)

  • :client_id (Integer) —

    Client Application ID

  • :redirect_uri (String) —

    Redirect URI

  • :state (String) —

    Optional state

  • :fields (String) —

    Optional fields

  • :id_connection (Integer) —

    Optional already existing connection to update

Returns:

  • (nil) 


34
35
36
37
 
# File 'lib/budgea_client/api/transfer_api.rb', line 34

def webauth_get(opts = {})
  webauth_get_with_http_info(opts)
  nil
end

#webauth_get_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

First step to establish an oAuth2 connection. The route encapsulate 2 functionalities: 1. Create or update a connection through oAuth2 session.&lt;br&gt;&lt;br&gt;2. Execute a transfer through OAuth2 session.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :id_connector (Integer) —

    ID of the connector

  • :id_transfer (Integer) —

    ID of the transfer

  • :connector_uuid (String) —

    Optional unique ID of the connector (replaces id_connector)

  • :client_id (Integer) —

    Client Application ID

  • :redirect_uri (String) —

    Redirect URI

  • :state (String) —

    Optional state

  • :fields (String) —

    Optional fields

  • :id_connection (Integer) —

    Optional already existing connection to update

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



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
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/budgea_client/api/transfer_api.rb', line 51

def webauth_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransferApi.webauth_get ...'
  end
  # resource path
  local_var_path = '/webauth'

  # query parameters
  query_params = {}
  query_params[:'id_connector'] = opts[:'id_connector'] if !opts[:'id_connector'].nil?
  query_params[:'id_transfer'] = opts[:'id_transfer'] if !opts[:'id_transfer'].nil?
  query_params[:'connector_uuid'] = opts[:'connector_uuid'] if !opts[:'connector_uuid'].nil?
  query_params[:'client_id'] = opts[:'client_id'] if !opts[:'client_id'].nil?
  query_params[:'redirect_uri'] = opts[:'redirect_uri'] if !opts[:'redirect_uri'].nil?
  query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'id_connection'] = opts[:'id_connection'] if !opts[:'id_connection'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransferApi#webauth_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end