Class: MfkOpenapiRubyClient::CreditFacilityApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CreditFacilityApi

Returns a new instance of CreditFacilityApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_credit_facilities_list(opts = {}) ⇒ CreditFacilitiesList

与信枠の一覧を取得します。顧客IDや取引登録期間開始日・終了日で絞り込んで取得することもできます。与信枠一覧取得

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :customer_id (String) —

    顧客IDを指定します。指定された顧客の与信枠を取得します。

  • :customer_number (String) —

    顧客番号を指定します。 指定された顧客の与信枠を取得します。

  • :customer_examination_id (String) —

    与信枠審査IDを指定します。指定された与信枠審査によって付与された与信枠を取得します。

  • :status (Array<String>) —

    ステータスを指定します。該当するステータスの与信枠が返却されます。指定できる値は &#x60;expired&#x60;(期限切れ), &#x60;active&#x60;(適用中), &#x60;inactive&#x60;(未適用), の３種類のみです。ステータスは複数指定することができます。 複数指定する場合は&#x60;?status&#x3D;expired&amp;status&#x3D;active&#x60;もしくは&#x60;?status&#x3D;expired,active&#x60;のように指定してください。

  • :start_date_from (Time) —

    取引登録期間開始日が指定された日時よりも後の与信枠を取得します。指定された日時のものも含まれます。

  • :start_date_to (Time) —

    取引登録期間開始日が指定された日時よりも前の与信枠を取得します。指定された日時のものも含まれます。

  • :end_date_from (Time) —

    取引登録期間終了日が指定された日時よりも後の与信枠を取得します。指定された日時のものも含まれます。

  • :end_date_to (Time) —

    取引登録期間終了日が指定された日時よりも前の与信枠を取得します。指定された日時のものも含まれます。

  • :after (String) —

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

  • :before (String) —

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

  • :limit (Integer) —

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

Returns:



37
38
39
40
 
# File 'lib/mfk_openapi_ruby_client/api/credit_facility_api.rb', line 37

def get_credit_facilities_list(opts = {})
  data, _status_code, _headers = get_credit_facilities_list_with_http_info(opts)
  data
end

#get_credit_facilities_list_with_http_info(opts = {}) ⇒ Array<(CreditFacilitiesList, Integer, Hash)>

与信枠の一覧を取得します。顧客IDや取引登録期間開始日・終了日で絞り込んで取得することもできます。与信枠一覧取得

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :customer_id (String) —

    顧客IDを指定します。指定された顧客の与信枠を取得します。

  • :customer_number (String) —

    顧客番号を指定します。 指定された顧客の与信枠を取得します。

  • :customer_examination_id (String) —

    与信枠審査IDを指定します。指定された与信枠審査によって付与された与信枠を取得します。

  • :status (Array<String>) —

    ステータスを指定します。該当するステータスの与信枠が返却されます。指定できる値は &#x60;expired&#x60;(期限切れ), &#x60;active&#x60;(適用中), &#x60;inactive&#x60;(未適用), の３種類のみです。ステータスは複数指定することができます。 複数指定する場合は&#x60;?status&#x3D;expired&amp;status&#x3D;active&#x60;もしくは&#x60;?status&#x3D;expired,active&#x60;のように指定してください。

  • :start_date_from (Time) —

    取引登録期間開始日が指定された日時よりも後の与信枠を取得します。指定された日時のものも含まれます。

  • :start_date_to (Time) —

    取引登録期間開始日が指定された日時よりも前の与信枠を取得します。指定された日時のものも含まれます。

  • :end_date_from (Time) —

    取引登録期間終了日が指定された日時よりも後の与信枠を取得します。指定された日時のものも含まれます。

  • :end_date_to (Time) —

    取引登録期間終了日が指定された日時よりも前の与信枠を取得します。指定された日時のものも含まれます。

  • :after (String) —

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

  • :before (String) —

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

  • :limit (Integer) —

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

Returns:

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

    CreditFacilitiesList data, response status code and response headers



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

def get_credit_facilities_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CreditFacilityApi.get_credit_facilities_list ...'
  end
  if @api_client.config.client_side_validation && !opts[:'customer_number'].nil? && opts[:'customer_number'].to_s.length > 100
    fail ArgumentError, 'invalid value for "opts[:"customer_number"]" when calling CreditFacilityApi.get_credit_facilities_list, the character length must be smaller than or equal to 100.'
  end

  allowable_values = ["expired", "active", "inactive"]
  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 CreditFacilityApi.get_credit_facilities_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 CreditFacilityApi.get_credit_facilities_list, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/credit_facilities'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'customer_id'] = opts[:'customer_id'] if !opts[:'customer_id'].nil?
  query_params[:'customer_number'] = opts[:'customer_number'] if !opts[:'customer_number'].nil?
  query_params[:'customer_examination_id'] = opts[:'customer_examination_id'] if !opts[:'customer_examination_id'].nil?
  query_params[:'status'] = @api_client.build_collection_param(opts[:'status'], :csv) if !opts[:'status'].nil?
  query_params[:'start_date_from'] = opts[:'start_date_from'] if !opts[:'start_date_from'].nil?
  query_params[:'start_date_to'] = opts[:'start_date_to'] if !opts[:'start_date_to'].nil?
  query_params[:'end_date_from'] = opts[:'end_date_from'] if !opts[:'end_date_from'].nil?
  query_params[:'end_date_to'] = opts[:'end_date_to'] if !opts[:'end_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] || 'CreditFacilitiesList'

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

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

#get_credit_facility(credit_facility_id, opts = {}) ⇒ CreditFacility

与信枠IDを指定して対象与信枠１件を取得することができます。与信枠取得

Parameters:

  • credit_facility_id (String) —

    対象の与信枠IDを指定してください。

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

    the optional parameters

Returns:



133
134
135
136
 
# File 'lib/mfk_openapi_ruby_client/api/credit_facility_api.rb', line 133

def get_credit_facility(credit_facility_id, opts = {})
  data, _status_code, _headers = get_credit_facility_with_http_info(credit_facility_id, opts)
  data
end

#get_credit_facility_with_http_info(credit_facility_id, opts = {}) ⇒ Array<(CreditFacility, Integer, Hash)>

与信枠IDを指定して対象与信枠１件を取得することができます。与信枠取得

Parameters:

  • credit_facility_id (String) —

    対象の与信枠IDを指定してください。

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

    the optional parameters

Returns:

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

    CreditFacility data, response status code and response headers



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
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
 
# File 'lib/mfk_openapi_ruby_client/api/credit_facility_api.rb', line 143

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

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

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