Class: MfkOpenapiRubyClient::PayoutRefundApi

Inherits:
Object
  • Object
show all
Defined in:
lib/mfk_openapi_ruby_client/api/payout_refund_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PayoutRefundApi

Returns a new instance of PayoutRefundApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_payout_refunds_list(opts = {}) ⇒ PayoutRefundsList

返金一覧取得

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :payout_id (String) —

    任意の振込IDを指定します。指定した振込に含まれる返金が返却されます。

  • :after (String) —

    任意のリソースIDを指定します。追加日時の降順でこのIDのリソースよりも後のリソースを取得します。この時`after`で指定したIDのリソースは結果に含まれません。

  • :before (String) —

    任意のリソースIDを指定します。追加日時の降順でこのIDのリソースよりも前のリソースを取得します。この時`before`で指定したIDのリソースは結果に含まれません。

  • :limit (Integer) —

    取得したいリソースの最大件数を指定します。1~200の間の整数で指定してください。指定がない場合は20になります。

Returns:



29
30
31
32
 
# File 'lib/mfk_openapi_ruby_client/api/payout_refund_api.rb', line 29

def get_payout_refunds_list(opts = {})
  data, _status_code, _headers = get_payout_refunds_list_with_http_info(opts)
  data
end

#get_payout_refunds_list_with_http_info(opts = {}) ⇒ Array<(PayoutRefundsList, Integer, Hash)>

返金一覧取得

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :payout_id (String) —

    任意の振込IDを指定します。指定した振込に含まれる返金が返却されます。

  • :after (String) —

    任意のリソースIDを指定します。追加日時の降順でこのIDのリソースよりも後のリソースを取得します。この時&#x60;after&#x60;で指定したIDのリソースは結果に含まれません。

  • :before (String) —

    任意のリソースIDを指定します。追加日時の降順でこのIDのリソースよりも前のリソースを取得します。この時&#x60;before&#x60;で指定したIDのリソースは結果に含まれません。

  • :limit (Integer) —

    取得したいリソースの最大件数を指定します。1~200の間の整数で指定してください。指定がない場合は20になります。

Returns:

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

    PayoutRefundsList data, response status code and response headers



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
92
93
94
95
 
# File 'lib/mfk_openapi_ruby_client/api/payout_refund_api.rb', line 41

def get_payout_refunds_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayoutRefundApi.get_payout_refunds_list ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 200
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling PayoutRefundApi.get_payout_refunds_list, must be smaller than or equal to 200.'
  end

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

  # resource path
  local_var_path = '/payout_refunds'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'payout_id'] = opts[:'payout_id'] if !opts[:'payout_id'].nil?
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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] || 'PayoutRefundsList'

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

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