Class: Checkbook::Wire

Inherits:
Object
  • Object
show all
Defined in:
lib/checkbook/api/wire.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ Wire

Returns a new instance of Wire.



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

def api_client
  @api_client
end

Instance Method Details

#add_wire(create_wire_request, opts = {}) ⇒ WireAccountResponse

Create wire account Create a new wire account

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/checkbook/api/wire.rb', line 27

def add_wire(create_wire_request, opts = {})
  data, _status_code, _headers = add_wire_with_http_info(create_wire_request, opts)
  data
end

#add_wire_with_http_info(create_wire_request, opts = {}) ⇒ Array<(WireAccountResponse, Integer, Hash)>

Create wire account Create a new wire account

Parameters:

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

    the optional parameters

Returns:

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

    WireAccountResponse 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/checkbook/api/wire.rb', line 37

def add_wire_with_http_info(create_wire_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Wire.add_wire ...'
  end
  # verify the required parameter 'create_wire_request' is set
  if @api_client.config.client_side_validation && create_wire_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_wire_request' when calling Wire.add_wire"
  end
  # resource path
  local_var_path = '/v3/account/wire'

  # 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']) unless header_params['Accept']
  # 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(create_wire_request)

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

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

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

#get_wire(opts = {}) ⇒ GetWireResponse

Get wire accounts Return the wire accounts

Parameters:

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

    the optional parameters

Returns:



94
95
96
97
 
# File 'lib/checkbook/api/wire.rb', line 94

def get_wire(opts = {})
  data, _status_code, _headers = get_wire_with_http_info(opts)
  data
end

#get_wire_with_http_info(opts = {}) ⇒ Array<(GetWireResponse, Integer, Hash)>

Get wire accounts Return the wire accounts

Parameters:

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

    the optional parameters

Returns:

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

    GetWireResponse data, response status code and response headers



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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/checkbook/api/wire.rb', line 103

def get_wire_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Wire.get_wire ...'
  end
  # resource path
  local_var_path = '/v3/account/wire'

  # 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']) unless header_params['Accept']

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

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

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

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

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

#put_wire(account_id, update_wire_request, opts = {}) ⇒ nil

Update Wire account Update an existing wire account

Parameters:

  • account_id (String)
  • update_wire_request (UpdateWireRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


153
154
155
156
 
# File 'lib/checkbook/api/wire.rb', line 153

def put_wire(, update_wire_request, opts = {})
  put_wire_with_http_info(, update_wire_request, opts)
  nil
end

#put_wire_with_http_info(account_id, update_wire_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update Wire account Update an existing wire account

Parameters:

  • account_id (String)
  • update_wire_request (UpdateWireRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
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
 
# File 'lib/checkbook/api/wire.rb', line 164

def put_wire_with_http_info(, update_wire_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Wire.put_wire ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling Wire.put_wire"
  end
  # verify the required parameter 'update_wire_request' is set
  if @api_client.config.client_side_validation && update_wire_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_wire_request' when calling Wire.put_wire"
  end
  # resource path
  local_var_path = '/v3/account/wire/{account_id}'.sub('{' + 'account_id' + '}', CGI.escape(.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']) unless header_params['Accept']
  # 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(update_wire_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#remove_wire(wire_id, opts = {}) ⇒ nil

Remove wire account Remove an existing wire account

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


226
227
228
229
 
# File 'lib/checkbook/api/wire.rb', line 226

def remove_wire(wire_id, opts = {})
  remove_wire_with_http_info(wire_id, opts)
  nil
end

#remove_wire_with_http_info(wire_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Remove wire account Remove an existing wire account

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
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
 
# File 'lib/checkbook/api/wire.rb', line 236

def remove_wire_with_http_info(wire_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Wire.remove_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 Wire.remove_wire"
  end
  # resource path
  local_var_path = '/v3/account/wire/{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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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