Class: TransferZero::PayoutMethodsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/transferzero-sdk/api/payout_methods_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PayoutMethodsApi

Returns a new instance of PayoutMethodsApi.



19
20
21
 
# File 'lib/transferzero-sdk/api/payout_methods_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/transferzero-sdk/api/payout_methods_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_payout_method(payout_method_id, opts = {}) ⇒ PayoutMethodResponse

Deleting a payout method Deletes a single payout method by the Payout Method ID

Parameters:

  • payout_method_id —

    ID of the payout method to delete. Example: `/v1/payout_methods/bf9ff782-e182-45ac-abea-5bce83ad6670`

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

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/transferzero-sdk/api/payout_methods_api.rb', line 29

def delete_payout_method(payout_method_id, opts = {})
  data, _status_code, _headers = delete_payout_method_with_http_info(payout_method_id, opts)
  data
end

#delete_payout_method_with_http_info(payout_method_id, opts = {}) ⇒ Array<(PayoutMethodResponse, Fixnum, Hash)>

Deleting a payout method Deletes a single payout method by the Payout Method ID

Parameters:

  • payout_method_id —

    ID of the payout method to delete. Example: &#x60;/v1/payout_methods/bf9ff782-e182-45ac-abea-5bce83ad6670&#x60;

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

    the optional parameters

Returns:

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

    PayoutMethodResponse 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
 
# File 'lib/transferzero-sdk/api/payout_methods_api.rb', line 39

def delete_payout_method_with_http_info(payout_method_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayoutMethodsApi.delete_payout_method ...'
  end
  # verify the required parameter 'payout_method_id' is set
  if @api_client.config.client_side_validation && payout_method_id.nil?
    fail ArgumentError, "Missing the required parameter 'payout_method_id' when calling PayoutMethodsApi.delete_payout_method"
  end
  # resource path
  local_var_path = '/payout_methods/{Payout Method ID}'.sub('{' + 'Payout Method ID' + '}', payout_method_id.to_s)

  # query parameters
  query_params = {}

  # 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 = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PayoutMethodResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayoutMethodsApi#delete_payout_method\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_payout_method(payout_method_id, opts = {}) ⇒ PayoutMethodResponse

Fetching a payout method Show a payout method by id

Parameters:

  • payout_method_id —

    ID of the payout method to get. Example: &#x60;/v1/payout_methods/bf9ff782-e182-45ac-abea-5bce83ad6670&#x60;

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

    the optional parameters

Returns:



83
84
85
86
 
# File 'lib/transferzero-sdk/api/payout_methods_api.rb', line 83

def get_payout_method(payout_method_id, opts = {})
  data, _status_code, _headers = get_payout_method_with_http_info(payout_method_id, opts)
  data
end

#get_payout_method_with_http_info(payout_method_id, opts = {}) ⇒ Array<(PayoutMethodResponse, Fixnum, Hash)>

Fetching a payout method Show a payout method by id

Parameters:

  • payout_method_id —

    ID of the payout method to get. Example: &#x60;/v1/payout_methods/bf9ff782-e182-45ac-abea-5bce83ad6670&#x60;

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

    the optional parameters

Returns:

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

    PayoutMethodResponse data, response status code and response headers



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/transferzero-sdk/api/payout_methods_api.rb', line 93

def get_payout_method_with_http_info(payout_method_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayoutMethodsApi.get_payout_method ...'
  end
  # verify the required parameter 'payout_method_id' is set
  if @api_client.config.client_side_validation && payout_method_id.nil?
    fail ArgumentError, "Missing the required parameter 'payout_method_id' when calling PayoutMethodsApi.get_payout_method"
  end
  # resource path
  local_var_path = '/payout_methods/{Payout Method ID}'.sub('{' + 'Payout Method ID' + '}', payout_method_id.to_s)

  # query parameters
  query_params = {}

  # 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 = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature']
  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 => 'PayoutMethodResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayoutMethodsApi#get_payout_method\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_payout_methods(opts = {}) ⇒ PayoutMethodListResponse

Listing payout methods List available payout methods

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :state (Array<String>) —

    Allows filtering results by &#x60;state&#x60; of the payout method. Example: &#x60;/v1/payout_methods?state[]&#x3D;enabled&#x60;

  • :type (Array<String>) —

    Allows filtering results by the specified type. Example: &#x60;/v1/payout_methods?type[]&#x3D;NGN::Bank&#x60;

  • :sender_id (String) —

    Allows filtering results by the specified sender id. Example: &#x60;/v1/payout_methods?sender_id&#x3D;bf9ff782-e182-45ac-abea-5bce83ad6670&#x60;

  • :page (Integer) —

    The page number to request (defaults to 1)

  • :per (Integer) —

    The number of results to load per page (defaults to 10)

  • :created_at_from (String) —

    Start date to filter recipients by created_at range Allows filtering results by the specified &#x60;created_at&#x60; timeframe. Example: &#x60;/v1/recipients?created_at_from&#x3D;2018-06-06&amp;created_at_to&#x3D;2018-06-08&#x60;

  • :created_at_to (String) —

    End date to filter recipients by created_at range Allows filtering results by the specified &#x60;created_at&#x60; timeframe. Example: &#x60;/v1/recipients?created_at_from&#x3D;2018-06-06&amp;created_at_to&#x3D;2018-06-08&#x60;

Returns:



143
144
145
146
 
# File 'lib/transferzero-sdk/api/payout_methods_api.rb', line 143

def get_payout_methods(opts = {})
  data, _status_code, _headers = get_payout_methods_with_http_info(opts)
  data
end

#get_payout_methods_with_http_info(opts = {}) ⇒ Array<(PayoutMethodListResponse, Fixnum, Hash)>

Listing payout methods List available payout methods

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :state (Array<String>) —

    Allows filtering results by &#x60;state&#x60; of the payout method. Example: &#x60;/v1/payout_methods?state[]&#x3D;enabled&#x60;

  • :type (Array<String>) —

    Allows filtering results by the specified type. Example: &#x60;/v1/payout_methods?type[]&#x3D;NGN::Bank&#x60;

  • :sender_id (String) —

    Allows filtering results by the specified sender id. Example: &#x60;/v1/payout_methods?sender_id&#x3D;bf9ff782-e182-45ac-abea-5bce83ad6670&#x60;

  • :page (Integer) —

    The page number to request (defaults to 1)

  • :per (Integer) —

    The number of results to load per page (defaults to 10)

  • :created_at_from (String) —

    Start date to filter recipients by created_at range Allows filtering results by the specified &#x60;created_at&#x60; timeframe. Example: &#x60;/v1/recipients?created_at_from&#x3D;2018-06-06&amp;created_at_to&#x3D;2018-06-08&#x60;

  • :created_at_to (String) —

    End date to filter recipients by created_at range Allows filtering results by the specified &#x60;created_at&#x60; timeframe. Example: &#x60;/v1/recipients?created_at_from&#x3D;2018-06-06&amp;created_at_to&#x3D;2018-06-08&#x60;

Returns:

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

    PayoutMethodListResponse data, response status code and response headers



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
193
194
195
196
197
198
199
200
201
 
# File 'lib/transferzero-sdk/api/payout_methods_api.rb', line 159

def get_payout_methods_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayoutMethodsApi.get_payout_methods ...'
  end
  if @api_client.config.client_side_validation && opts[:'state'] && !opts[:'state'].all? { |item| ['enabled', 'disabled'].include?(item) }
    fail ArgumentError, 'invalid value for "state", must include one of enabled, disabled'
  end
  # resource path
  local_var_path = '/payout_methods'

  # query parameters
  query_params = {}
  query_params[:'state'] = @api_client.build_collection_param(opts[:'state'], :multi) if !opts[:'state'].nil?
  query_params[:'type'] = @api_client.build_collection_param(opts[:'type'], :multi) if !opts[:'type'].nil?
  query_params[:'sender_id'] = opts[:'sender_id'] if !opts[:'sender_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per'] = opts[:'per'] if !opts[:'per'].nil?
  query_params[:'created_at_from'] = opts[:'created_at_from'] if !opts[:'created_at_from'].nil?
  query_params[:'created_at_to'] = opts[:'created_at_to'] if !opts[:'created_at_to'].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 = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature']
  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 => 'PayoutMethodListResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayoutMethodsApi#get_payout_methods\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_payout_method(payout_method_id, payout_method, opts = {}) ⇒ PayoutMethodResponse

Updating a payout method Updates a single payout method by the Payout Method ID

Parameters:

  • payout_method_id —

    ID of the payout method to get. Example: &#x60;/v1/payout_methods/bf9ff782-e182-45ac-abea-5bce83ad6670&#x60;

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

    the optional parameters

Returns:



210
211
212
213
 
# File 'lib/transferzero-sdk/api/payout_methods_api.rb', line 210

def patch_payout_method(payout_method_id, payout_method, opts = {})
  data, _status_code, _headers = patch_payout_method_with_http_info(payout_method_id, payout_method, opts)
  data
end

#patch_payout_method_with_http_info(payout_method_id, payout_method, opts = {}) ⇒ Array<(PayoutMethodResponse, Fixnum, Hash)>

Updating a payout method Updates a single payout method by the Payout Method ID

Parameters:

  • payout_method_id —

    ID of the payout method to get. Example: &#x60;/v1/payout_methods/bf9ff782-e182-45ac-abea-5bce83ad6670&#x60;

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

    the optional parameters

Returns:

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

    PayoutMethodResponse data, response status code and response headers



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
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
 
# File 'lib/transferzero-sdk/api/payout_methods_api.rb', line 221

def patch_payout_method_with_http_info(payout_method_id, payout_method, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayoutMethodsApi.patch_payout_method ...'
  end
  # verify the required parameter 'payout_method_id' is set
  if @api_client.config.client_side_validation && payout_method_id.nil?
    fail ArgumentError, "Missing the required parameter 'payout_method_id' when calling PayoutMethodsApi.patch_payout_method"
  end
  # verify the required parameter 'payout_method' is set
  if @api_client.config.client_side_validation && payout_method.nil?
    fail ArgumentError, "Missing the required parameter 'payout_method' when calling PayoutMethodsApi.patch_payout_method"
  end
  # resource path
  local_var_path = '/payout_methods/{Payout Method ID}'.sub('{' + 'Payout Method ID' + '}', payout_method_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(payout_method)
  auth_names = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PayoutMethodResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayoutMethodsApi#patch_payout_method\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_payout_methods(payout_method_request, opts = {}) ⇒ PayoutMethodResponse

Creating a payout method Creates a new payout method in our system.

Parameters:

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

    the optional parameters

Returns:



271
272
273
274
 
# File 'lib/transferzero-sdk/api/payout_methods_api.rb', line 271

def post_payout_methods(payout_method_request, opts = {})
  data, _status_code, _headers = post_payout_methods_with_http_info(payout_method_request, opts)
  data
end

#post_payout_methods_with_http_info(payout_method_request, opts = {}) ⇒ Array<(PayoutMethodResponse, Fixnum, Hash)>

Creating a payout method Creates a new payout method in our system.

Parameters:

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

    the optional parameters

Returns:

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

    PayoutMethodResponse data, response status code and response headers



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
311
312
313
314
315
316
317
318
319
 
# File 'lib/transferzero-sdk/api/payout_methods_api.rb', line 281

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(payout_method_request)
  auth_names = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PayoutMethodResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayoutMethodsApi#post_payout_methods\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end