Class: CybridApiBank::TradingConfigurationsBankApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cybrid_api_bank_ruby/api/trading_configurations_bank_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TradingConfigurationsBankApi

Returns a new instance of TradingConfigurationsBankApi.



19
20
21
 
# File 'lib/cybrid_api_bank_ruby/api/trading_configurations_bank_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/cybrid_api_bank_ruby/api/trading_configurations_bank_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_trading_configuration(post_trading_configuration_bank_model, opts = {}) ⇒ TradingConfigurationBankModel

Create TradingConfiguration Creates a trading configuration. Required scope: banks:write

Parameters:

Returns:



27
28
29
30
 
# File 'lib/cybrid_api_bank_ruby/api/trading_configurations_bank_api.rb', line 27

def create_trading_configuration(post_trading_configuration_bank_model, opts = {})
  data, _status_code, _headers = create_trading_configuration_with_http_info(post_trading_configuration_bank_model, opts)
  data
end

#create_trading_configuration_with_http_info(post_trading_configuration_bank_model, opts = {}) ⇒ Array<(TradingConfigurationBankModel, Integer, Hash)>

Create TradingConfiguration Creates a trading configuration. Required scope: banks:write

Parameters:

Returns:



37
38
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/cybrid_api_bank_ruby/api/trading_configurations_bank_api.rb', line 37

def create_trading_configuration_with_http_info(post_trading_configuration_bank_model, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TradingConfigurationsBankApi.create_trading_configuration ...'
  end
  # verify the required parameter 'post_trading_configuration_bank_model' is set
  if @api_client.config.client_side_validation && post_trading_configuration_bank_model.nil?
    fail ArgumentError, "Missing the required parameter 'post_trading_configuration_bank_model' when calling TradingConfigurationsBankApi.create_trading_configuration"
  end
  # resource path
  local_var_path = '/api/trading_configurations'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(post_trading_configuration_bank_model)

  # return_type
  return_type = opts[:debug_return_type] || 'TradingConfigurationBankModel'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

  new_options = opts.merge(
    :operation => :"TradingConfigurationsBankApi.create_trading_configuration",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TradingConfigurationsBankApi#create_trading_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_trading_configuration(trading_configuration_guid, opts = {}) ⇒ TradingConfigurationBankModel

Get TradingConfiguration Retrieves a trading configuration. Required scope: banks:read

Parameters:

  • trading_configuration_guid (String) —

    Identifier for the trading configuration.

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

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/cybrid_api_bank_ruby/api/trading_configurations_bank_api.rb', line 95

def get_trading_configuration(trading_configuration_guid, opts = {})
  data, _status_code, _headers = get_trading_configuration_with_http_info(trading_configuration_guid, opts)
  data
end

#get_trading_configuration_with_http_info(trading_configuration_guid, opts = {}) ⇒ Array<(TradingConfigurationBankModel, Integer, Hash)>

Get TradingConfiguration Retrieves a trading configuration. Required scope: banks:read

Parameters:

  • trading_configuration_guid (String) —

    Identifier for the trading configuration.

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

    the optional parameters

Returns:



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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/cybrid_api_bank_ruby/api/trading_configurations_bank_api.rb', line 105

def get_trading_configuration_with_http_info(trading_configuration_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TradingConfigurationsBankApi.get_trading_configuration ...'
  end
  # verify the required parameter 'trading_configuration_guid' is set
  if @api_client.config.client_side_validation && trading_configuration_guid.nil?
    fail ArgumentError, "Missing the required parameter 'trading_configuration_guid' when calling TradingConfigurationsBankApi.get_trading_configuration"
  end
  # resource path
  local_var_path = '/api/trading_configurations/{trading_configuration_guid}'.sub('{' + 'trading_configuration_guid' + '}', CGI.escape(trading_configuration_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TradingConfigurationBankModel'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

  new_options = opts.merge(
    :operation => :"TradingConfigurationsBankApi.get_trading_configuration",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TradingConfigurationsBankApi#get_trading_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_trading_configurations(opts = {}) ⇒ TradingConfigurationListBankModel

List trading configurations Retrieves a listing of trading configurations for a bank. Required scope: banks:read

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) — default: default to 0
  • :per_page (Integer) — default: default to 10

Returns:



159
160
161
162
 
# File 'lib/cybrid_api_bank_ruby/api/trading_configurations_bank_api.rb', line 159

def list_trading_configurations(opts = {})
  data, _status_code, _headers = list_trading_configurations_with_http_info(opts)
  data
end

#list_trading_configurations_with_http_info(opts = {}) ⇒ Array<(TradingConfigurationListBankModel, Integer, Hash)>

List trading configurations Retrieves a listing of trading configurations for a bank. Required scope: banks:read

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :per_page (Integer)

Returns:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/cybrid_api_bank_ruby/api/trading_configurations_bank_api.rb', line 170

def list_trading_configurations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TradingConfigurationsBankApi.list_trading_configurations ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling TradingConfigurationsBankApi.list_trading_configurations, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling TradingConfigurationsBankApi.list_trading_configurations, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling TradingConfigurationsBankApi.list_trading_configurations, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/api/trading_configurations'

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

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TradingConfigurationListBankModel'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

  new_options = opts.merge(
    :operation => :"TradingConfigurationsBankApi.list_trading_configurations",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TradingConfigurationsBankApi#list_trading_configurations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end