Class: SyncteraRubySdk::InternationalWiresAlphaApi

Inherits:
Object
  • Object
show all
Defined in:
lib/synctera_ruby_sdk/api/international_wires_alpha_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InternationalWiresAlphaApi

Returns a new instance of InternationalWiresAlphaApi.



19
20
21
 
# File 'lib/synctera_ruby_sdk/api/international_wires_alpha_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/synctera_ruby_sdk/api/international_wires_alpha_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_international_wire(international_wire_post, opts = {}) ⇒ InternationalWireResponse

Create an International Wire Create an international wire transfer. For now these need manual approval and submission to the wire terminal by bank operations team. Created wires will result in an auth, posting only happens when bank operations team confirms the wire. The wire will be subsequently updated with the reference ID and synctera case ID when the wire is submitted via the wire terminal. Wire processing is subject to the bank’s processing schedule. Cross currency wires may only be available during certain hours of banking days.

Parameters:

  • international_wire_post (InternationalWirePost) —

    International wire transfer request

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Returns:



28
29
30
31
 
# File 'lib/synctera_ruby_sdk/api/international_wires_alpha_api.rb', line 28

def create_international_wire(international_wire_post, opts = {})
  data, _status_code, _headers = create_international_wire_with_http_info(international_wire_post, opts)
  data
end

#create_international_wire_with_http_info(international_wire_post, opts = {}) ⇒ Array<(InternationalWireResponse, Integer, Hash)>

Create an International Wire Create an international wire transfer. For now these need manual approval and submission to the wire terminal by bank operations team. Created wires will result in an auth, posting only happens when bank operations team confirms the wire. The wire will be subsequently updated with the reference ID and synctera case ID when the wire is submitted via the wire terminal. Wire processing is subject to the bank&#39;s processing schedule. Cross currency wires may only be available during certain hours of banking days.

Parameters:

  • international_wire_post (InternationalWirePost) —

    International wire transfer request

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Returns:

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

    InternationalWireResponse data, response status code and response headers



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
89
90
91
 
# File 'lib/synctera_ruby_sdk/api/international_wires_alpha_api.rb', line 39

def create_international_wire_with_http_info(international_wire_post, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InternationalWiresAlphaApi.create_international_wire ...'
  end
  # verify the required parameter 'international_wire_post' is set
  if @api_client.config.client_side_validation && international_wire_post.nil?
    fail ArgumentError, "Missing the required parameter 'international_wire_post' when calling InternationalWiresAlphaApi.create_international_wire"
  end
  # resource path
  local_var_path = '/international_wires'

  # 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', 'application/problem+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
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

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

#get_international_wire(wire_id, opts = {}) ⇒ InternationalWireResponse

Get an international wire by id Get an international wire by id

Parameters:

  • wire_id (String) —

    The unique identifier of a wire transfer.

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

    the optional parameters

Returns:



98
99
100
101
 
# File 'lib/synctera_ruby_sdk/api/international_wires_alpha_api.rb', line 98

def get_international_wire(wire_id, opts = {})
  data, _status_code, _headers = get_international_wire_with_http_info(wire_id, opts)
  data
end

#get_international_wire_with_http_info(wire_id, opts = {}) ⇒ Array<(InternationalWireResponse, Integer, Hash)>

Get an international wire by id Get an international wire by id

Parameters:

  • wire_id (String) —

    The unique identifier of a wire transfer.

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

    the optional parameters

Returns:

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

    InternationalWireResponse data, response status code and response headers



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/synctera_ruby_sdk/api/international_wires_alpha_api.rb', line 108

def get_international_wire_with_http_info(wire_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InternationalWiresAlphaApi.get_international_wire ...'
  end
  # verify the required parameter 'wire_id' is set
  if @api_client.config.client_side_validation && wire_id.nil?
    fail ArgumentError, "Missing the required parameter 'wire_id' when calling InternationalWiresAlphaApi.get_international_wire"
  end
  # resource path
  local_var_path = '/international_wires/{wire_id}'.sub('{' + 'wire_id' + '}', CGI.escape(wire_id.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', 'application/problem+json'])

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

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

#list_international_wires(opts = {}) ⇒ InternationalWireList

List International Wires Get paginated list of international wires

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) — default: default to 100
  • :page_token (String)
  • :international_wire_status (InternationalWireStatus) —

    The status of the international wire transfer.

  • :customer_id (String) —

    The unique identifier of a customer.

  • :originating_account_id (String) —

    The unique identifier of the originating account.

  • :receiving_account_id (String) —

    The unique identifier of the receiving account.

Returns:



166
167
168
169
 
# File 'lib/synctera_ruby_sdk/api/international_wires_alpha_api.rb', line 166

def list_international_wires(opts = {})
  data, _status_code, _headers = list_international_wires_with_http_info(opts)
  data
end

#list_international_wires_with_http_info(opts = {}) ⇒ Array<(InternationalWireList, Integer, Hash)>

List International Wires Get paginated list of international wires

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) — default: default to 100
  • :page_token (String)
  • :international_wire_status (InternationalWireStatus) —

    The status of the international wire transfer.

  • :customer_id (String) —

    The unique identifier of a customer.

  • :originating_account_id (String) —

    The unique identifier of the originating account.

  • :receiving_account_id (String) —

    The unique identifier of the receiving account.

Returns:

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

    InternationalWireList data, response status code and response headers



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
227
228
229
230
231
232
233
 
# File 'lib/synctera_ruby_sdk/api/international_wires_alpha_api.rb', line 181

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

  # resource path
  local_var_path = '/international_wires'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'page_token'] = opts[:'page_token'] if !opts[:'page_token'].nil?
  query_params[:'international_wire_status'] = opts[:'international_wire_status'] if !opts[:'international_wire_status'].nil?
  query_params[:'customer_id'] = opts[:'customer_id'] if !opts[:'customer_id'].nil?
  query_params[:'originating_account_id'] = opts[:'originating_account_id'] if !opts[:'originating_account_id'].nil?
  query_params[:'receiving_account_id'] = opts[:'receiving_account_id'] if !opts[:'receiving_account_id'].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

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

#patch_international_wire(wire_id, international_wire_patch, opts = {}) ⇒ InternationalWireResponse

Update an international wire to various statuses Update an outgoing international wire. End customers can only cancel a wire while its status is still PENDING. All other updates must be done by Synctera operations team or bank operations team.

Parameters:

  • wire_id (String) —

    The unique identifier of a wire transfer.

  • international_wire_patch (InternationalWirePatch) —

    Instruction to update an international wire

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Returns:



242
243
244
245
 
# File 'lib/synctera_ruby_sdk/api/international_wires_alpha_api.rb', line 242

def patch_international_wire(wire_id, international_wire_patch, opts = {})
  data, _status_code, _headers = patch_international_wire_with_http_info(wire_id, international_wire_patch, opts)
  data
end

#patch_international_wire_with_http_info(wire_id, international_wire_patch, opts = {}) ⇒ Array<(InternationalWireResponse, Integer, Hash)>

Update an international wire to various statuses Update an outgoing international wire. End customers can only cancel a wire while its status is still PENDING. All other updates must be done by Synctera operations team or bank operations team.

Parameters:

  • wire_id (String) —

    The unique identifier of a wire transfer.

  • international_wire_patch (InternationalWirePatch) —

    Instruction to update an international wire

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Returns:

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

    InternationalWireResponse data, response status code and response headers



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/synctera_ruby_sdk/api/international_wires_alpha_api.rb', line 254

def patch_international_wire_with_http_info(wire_id, international_wire_patch, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InternationalWiresAlphaApi.patch_international_wire ...'
  end
  # verify the required parameter 'wire_id' is set
  if @api_client.config.client_side_validation && wire_id.nil?
    fail ArgumentError, "Missing the required parameter 'wire_id' when calling InternationalWiresAlphaApi.patch_international_wire"
  end
  # verify the required parameter 'international_wire_patch' is set
  if @api_client.config.client_side_validation && international_wire_patch.nil?
    fail ArgumentError, "Missing the required parameter 'international_wire_patch' when calling InternationalWiresAlphaApi.patch_international_wire"
  end
  # resource path
  local_var_path = '/international_wires/{wire_id}'.sub('{' + 'wire_id' + '}', CGI.escape(wire_id.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', 'application/problem+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
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"InternationalWiresAlphaApi.patch_international_wire",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InternationalWiresAlphaApi#patch_international_wire\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end