Class: CybridApiBank::CounterpartiesBankApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CounterpartiesBankApi

Returns a new instance of CounterpartiesBankApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_counterparty(post_counterparty_bank_model, opts = {}) ⇒ CounterpartyBankModel

Create Counterparty Creates a counterparty. ## Counterparty Type Counterparty resources are an abstraction for real world individuals and businesses that are not directly on the Cybrid Platform. ## State | State | Description | |——-|————-| | storing | The Platform is storing the counterparty details in our private store | | unverified | The Platform has not yet verified the counterparty’s identity | | verified | The Platform has verified the counterparty’s identity | | rejected | The Platform was not able to successfully verify the counterparty’s identity | Required scope: counterparties:execute

Parameters:

Returns:



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

def create_counterparty(post_counterparty_bank_model, opts = {})
  data, _status_code, _headers = create_counterparty_with_http_info(post_counterparty_bank_model, opts)
  data
end

#create_counterparty_with_http_info(post_counterparty_bank_model, opts = {}) ⇒ Array<(CounterpartyBankModel, Integer, Hash)>

Create Counterparty Creates a counterparty. ## Counterparty Type Counterparty resources are an abstraction for real world individuals and businesses that are not directly on the Cybrid Platform. ## State | State | Description | |——-|————-| | storing | The Platform is storing the counterparty details in our private store | | unverified | The Platform has not yet verified the counterparty&#39;s identity | | verified | The Platform has verified the counterparty&#39;s identity | | rejected | The Platform was not able to successfully verify the counterparty&#39;s identity | Required scope: counterparties:execute

Parameters:

Returns:

  • (Array<(CounterpartyBankModel, Integer, Hash)>) —

    CounterpartyBankModel data, response status code and response headers



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/counterparties_bank_api.rb', line 37

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

  # 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_counterparty_bank_model)

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

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

  new_options = opts.merge(
    :operation => :"CounterpartiesBankApi.create_counterparty",
    :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: CounterpartiesBankApi#create_counterparty\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_counterparty(counterparty_guid, opts = {}) ⇒ CounterpartyBankModel

Get Counterparty Retrieves a counterparty. Required scope: counterparties:read

Parameters:

  • counterparty_guid (String) —

    Identifier for the counterparty.

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

    the optional parameters

Options Hash (opts):

  • :include_pii (Boolean) —

    Include PII in the response.

Returns:



96
97
98
99
 
# File 'lib/cybrid_api_bank_ruby/api/counterparties_bank_api.rb', line 96

def get_counterparty(counterparty_guid, opts = {})
  data, _status_code, _headers = get_counterparty_with_http_info(counterparty_guid, opts)
  data
end

#get_counterparty_with_http_info(counterparty_guid, opts = {}) ⇒ Array<(CounterpartyBankModel, Integer, Hash)>

Get Counterparty Retrieves a counterparty. Required scope: counterparties:read

Parameters:

  • counterparty_guid (String) —

    Identifier for the counterparty.

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

    the optional parameters

Options Hash (opts):

  • :include_pii (Boolean) —

    Include PII in the response.

Returns:

  • (Array<(CounterpartyBankModel, Integer, Hash)>) —

    CounterpartyBankModel data, response status code and response headers



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
152
153
154
 
# File 'lib/cybrid_api_bank_ruby/api/counterparties_bank_api.rb', line 107

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include_pii'] = opts[:'include_pii'] if !opts[:'include_pii'].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] || 'CounterpartyBankModel'

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

  new_options = opts.merge(
    :operation => :"CounterpartiesBankApi.get_counterparty",
    :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: CounterpartiesBankApi#get_counterparty\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_counterparties(opts = {}) ⇒ CounterpartyListBankModel

Get counterparties list Retrieves a listing of counterparties. Required scope: counterparties:read

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :per_page (Integer)
  • :type (String) —

    Comma separated types to list counterparties for.

  • :bank_guid (String) —

    Comma separated bank_guids to list counterparties for.

  • :customer_guid (String) —

    Comma separated customer_guids to list counterparties for.

  • :guid (String) —

    Comma separated counterparty_guids to list counterparties for.

  • :label (String) —

    Comma separated labels to list counterparties for.

Returns:



167
168
169
170
 
# File 'lib/cybrid_api_bank_ruby/api/counterparties_bank_api.rb', line 167

def list_counterparties(opts = {})
  data, _status_code, _headers = list_counterparties_with_http_info(opts)
  data
end

#list_counterparties_with_http_info(opts = {}) ⇒ Array<(CounterpartyListBankModel, Integer, Hash)>

Get counterparties list Retrieves a listing of counterparties. Required scope: counterparties:read

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :per_page (Integer)
  • :type (String) —

    Comma separated types to list counterparties for.

  • :bank_guid (String) —

    Comma separated bank_guids to list counterparties for.

  • :customer_guid (String) —

    Comma separated customer_guids to list counterparties for.

  • :guid (String) —

    Comma separated counterparty_guids to list counterparties for.

  • :label (String) —

    Comma separated labels to list counterparties for.

Returns:

  • (Array<(CounterpartyListBankModel, Integer, Hash)>) —

    CounterpartyListBankModel data, response status code and response headers



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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/cybrid_api_bank_ruby/api/counterparties_bank_api.rb', line 183

def list_counterparties_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CounterpartiesBankApi.list_counterparties ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling CounterpartiesBankApi.list_counterparties, 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 CounterpartiesBankApi.list_counterparties, 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 CounterpartiesBankApi.list_counterparties, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/api/counterparties'

  # 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?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'bank_guid'] = opts[:'bank_guid'] if !opts[:'bank_guid'].nil?
  query_params[:'customer_guid'] = opts[:'customer_guid'] if !opts[:'customer_guid'].nil?
  query_params[:'guid'] = opts[:'guid'] if !opts[:'guid'].nil?
  query_params[:'label'] = opts[:'label'] if !opts[:'label'].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] || 'CounterpartyListBankModel'

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

  new_options = opts.merge(
    :operation => :"CounterpartiesBankApi.list_counterparties",
    :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: CounterpartiesBankApi#list_counterparties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end