Class: MfkOpenapiRubyClient::PayoutTransactionApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PayoutTransactionApi

Returns a new instance of PayoutTransactionApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_payout_transaction(payout_transaction_id, opts = {}) ⇒ PayoutTransaction

債権取得

Parameters:

  • payout_transaction_id (String) —

    取得したい債権のID。

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

    the optional parameters

Returns:



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

def get_payout_transaction(payout_transaction_id, opts = {})
  data, _status_code, _headers = get_payout_transaction_with_http_info(payout_transaction_id, opts)
  data
end

#get_payout_transaction_with_http_info(payout_transaction_id, opts = {}) ⇒ Array<(PayoutTransaction, Integer, Hash)>

債権取得

Parameters:

  • payout_transaction_id (String) —

    取得したい債権のID。

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

    the optional parameters

Returns:

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

    PayoutTransaction data, response status code and response headers



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_transaction_api.rb', line 35

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

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

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

#get_payout_transactions_list(opts = {}) ⇒ PayoutTransactionsList

債権一覧取得

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:



90
91
92
93
 
# File 'lib/mfk_openapi_ruby_client/api/payout_transaction_api.rb', line 90

def get_payout_transactions_list(opts = {})
  data, _status_code, _headers = get_payout_transactions_list_with_http_info(opts)
  data
end

#get_payout_transactions_list_with_http_info(opts = {}) ⇒ Array<(PayoutTransactionsList, 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<(PayoutTransactionsList, Integer, Hash)>) —

    PayoutTransactionsList data, response status code and response headers



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
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
 
# File 'lib/mfk_openapi_ruby_client/api/payout_transaction_api.rb', line 102

def get_payout_transactions_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayoutTransactionApi.get_payout_transactions_list ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 200
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling PayoutTransactionApi.get_payout_transactions_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 PayoutTransactionApi.get_payout_transactions_list, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/payout_transactions'

  # 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] || 'PayoutTransactionsList'

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

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