Class: TripletexRubyClient::BankstatementtransactionApi

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_ruby_client/api/bankstatementtransaction_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BankstatementtransactionApi

Returns a new instance of BankstatementtransactionApi.



19
20
21
 
# File 'lib/tripletex_ruby_client/api/bankstatementtransaction_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/tripletex_ruby_client/api/bankstatementtransaction_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get(id, opts = {}) ⇒ ResponseWrapperBankTransaction

BETA

Get bank transaction by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



28
29
30
31
 
# File 'lib/tripletex_ruby_client/api/bankstatementtransaction_api.rb', line 28

def get(id, opts = {})
  data, _status_code, _headers = get_with_http_info(id, opts)
  data
end

#get_details(id, opts = {}) ⇒ ResponseWrapperObject

BETA

Get additional details about transaction by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



81
82
83
84
 
# File 'lib/tripletex_ruby_client/api/bankstatementtransaction_api.rb', line 81

def get_details(id, opts = {})
  data, _status_code, _headers = get_details_with_http_info(id, opts)
  data
end

#get_details_with_http_info(id, opts = {}) ⇒ Array<(ResponseWrapperObject, Fixnum, Hash)>

BETA

Get additional details about transaction by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ResponseWrapperObject data, response status code and response headers



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/tripletex_ruby_client/api/bankstatementtransaction_api.rb', line 92

def get_details_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankstatementtransactionApi.get_details ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling BankstatementtransactionApi.get_details"
  end
  # resource path
  local_var_path = '/bank/statement/transaction/{id}/details'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  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,
    :return_type => 'ResponseWrapperObject')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BankstatementtransactionApi#get_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_with_http_info(id, opts = {}) ⇒ Array<(ResponseWrapperBankTransaction, Fixnum, Hash)>

BETA

Get bank transaction by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



39
40
41
42
43
44
45
46
47
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
 
# File 'lib/tripletex_ruby_client/api/bankstatementtransaction_api.rb', line 39

def get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankstatementtransactionApi.get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling BankstatementtransactionApi.get"
  end
  # resource path
  local_var_path = '/bank/statement/transaction/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  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,
    :return_type => 'ResponseWrapperBankTransaction')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BankstatementtransactionApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search(bank_statement_id, opts = {}) ⇒ ListResponseBankTransaction

BETA

Find bank transaction corresponding with sent data.

Parameters:

  • bank_statement_id —

    Bank statement ID

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

    the optional parameters

Options Hash (opts):

  • :from (Integer) —

    From index (default to 0)

  • :count (Integer) —

    Number of elements to return (default to 1000)

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



139
140
141
142
 
# File 'lib/tripletex_ruby_client/api/bankstatementtransaction_api.rb', line 139

def search(bank_statement_id, opts = {})
  data, _status_code, _headers = search_with_http_info(bank_statement_id, opts)
  data
end

#search_with_http_info(bank_statement_id, opts = {}) ⇒ Array<(ListResponseBankTransaction, Fixnum, Hash)>

BETA

Find bank transaction corresponding with sent data.

Parameters:

  • bank_statement_id —

    Bank statement ID

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

    the optional parameters

Options Hash (opts):

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/tripletex_ruby_client/api/bankstatementtransaction_api.rb', line 153

def search_with_http_info(bank_statement_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankstatementtransactionApi.search ...'
  end
  # verify the required parameter 'bank_statement_id' is set
  if @api_client.config.client_side_validation && bank_statement_id.nil?
    fail ArgumentError, "Missing the required parameter 'bank_statement_id' when calling BankstatementtransactionApi.search"
  end
  # resource path
  local_var_path = '/bank/statement/transaction'

  # query parameters
  query_params = {}
  query_params[:'bankStatementId'] = bank_statement_id
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'sorting'] = opts[:'sorting'] if !opts[:'sorting'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  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,
    :return_type => 'ListResponseBankTransaction')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BankstatementtransactionApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end