Class: MfkOpenapiRubyClient::PayoutApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PayoutApi 



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

def api_client
  @api_client
end

Instance Method Details

#get_payout(payout_id, opts = {}) ⇒ Payout

振込取得



26
27
28
29
 
# File 'lib/mfk_openapi_ruby_client/api/payout_api.rb', line 26

def get_payout(payout_id, opts = {})
  data, _status_code, _headers = get_payout_with_http_info(payout_id, opts)
  data
end

#get_payout_with_http_info(payout_id, opts = {}) ⇒ Array<(Payout, Integer, Hash)>

振込取得



35
36
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
 
# File 'lib/mfk_openapi_ruby_client/api/payout_api.rb', line 35

def get_payout_with_http_info(payout_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayoutApi.get_payout ...'
  end
  # verify the required parameter 'payout_id' is set
  if @api_client.config.client_side_validation && payout_id.nil?
    fail ArgumentError, "Missing the required parameter 'payout_id' when calling PayoutApi.get_payout"
  end
  # resource path
  local_var_path = '/payouts/{payout_id}'.sub('{' + 'payout_id' + '}', CGI.escape(payout_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'])

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

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

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

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

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

#get_payouts_list(opts = {}) ⇒ PayoutsList

振込一覧取得

Options Hash (opts):

  • :status (Array<String>) —

    振込ステータスを指定します。該当するステータスの振込が返却されます。指定できる値は &#x60;in_progress&#x60;(振込手続中), &#x60;completed&#x60;(振込完了)の2種類のみです。

  • :payout_date_from (Date) —

    日付を指定します。指定した日付以降の振込予定日となっている振込を取得できます。指定された日付のものも含まれます。

  • :payout_date_to (Date) —

    日付を指定します。指定した日付以前の振込予定日となっている振込を取得できます。指定された日付のものも含まれます。

  • :after (String) —

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

  • :before (String) —

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

  • :limit (Integer) —

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



92
93
94
95
 
# File 'lib/mfk_openapi_ruby_client/api/payout_api.rb', line 92

def get_payouts_list(opts = {})
  data, _status_code, _headers = get_payouts_list_with_http_info(opts)
  data
end

#get_payouts_list_with_http_info(opts = {}) ⇒ Array<(PayoutsList, Integer, Hash)>

振込一覧取得

Options Hash (opts):

  • :status (Array<String>) —

    振込ステータスを指定します。該当するステータスの振込が返却されます。指定できる値は &#x60;in_progress&#x60;(振込手続中), &#x60;completed&#x60;(振込完了)の2種類のみです。

  • :payout_date_from (Date) —

    日付を指定します。指定した日付以降の振込予定日となっている振込を取得できます。指定された日付のものも含まれます。

  • :payout_date_to (Date) —

    日付を指定します。指定した日付以前の振込予定日となっている振込を取得できます。指定された日付のものも含まれます。

  • :after (String) —

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

  • :before (String) —

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

  • :limit (Integer) —

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



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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/mfk_openapi_ruby_client/api/payout_api.rb', line 106

def get_payouts_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayoutApi.get_payouts_list ...'
  end
  allowable_values = ["in_progress", "completed"]
  if @api_client.config.client_side_validation && opts[:'status'] && !opts[:'status'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"status\", must include one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 200
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling PayoutApi.get_payouts_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 PayoutApi.get_payouts_list, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/payouts'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'status'] = @api_client.build_collection_param(opts[:'status'], :csv) if !opts[:'status'].nil?
  query_params[:'payout_date_from'] = opts[:'payout_date_from'] if !opts[:'payout_date_from'].nil?
  query_params[:'payout_date_to'] = opts[:'payout_date_to'] if !opts[:'payout_date_to'].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] || 'PayoutsList'

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

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