Class: MfkOpenapiRubyClient::BillingApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BillingApi

Returns a new instance of BillingApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_billing(billing_id, opts = {}) ⇒ Billing

請求取得

Parameters:

  • billing_id (String) —

    対象の請求IDを指定してください。

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

    the optional parameters

Returns:



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

def get_billing(billing_id, opts = {})
  data, _status_code, _headers = get_billing_with_http_info(billing_id, opts)
  data
end

#get_billing_with_http_info(billing_id, opts = {}) ⇒ Array<(Billing, Integer, Hash)>

請求取得

Parameters:

  • billing_id (String) —

    対象の請求IDを指定してください。

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

    the optional parameters

Returns:

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

    Billing 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/billing_api.rb', line 35

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

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

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

#get_billings_list(opts = {}) ⇒ BillingsList

請求一覧取得

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :customer_id (String) —

    任意の顧客IDを指定します。指定した顧客への請求が返却されます。

  • :customer_number (String) —

    顧客番号を指定します。指定された顧客の請求を取得します。

  • :status (Array<String>) —

    請求ステータスを指定します。該当するステータスの請求が返却されます。複数指定することが可能です。指定できる値は &#x60;scheduled&#x60;(請求予定), &#x60;invoice_issued&#x60;(請求書発行済), &#x60;account_transfer_notified&#x60;(口座振替通知済)の3種類のみです。

  • :due_date_from (Date) —

    日付を指定します。指定した日付以降の支払期限となっている請求を取得できます。指定された日付のものも含まれます。

  • :due_date_to (Date) —

    日付を指定します。指定した日付以前の支払期限となっている請求を取得できます。指定された日付のものも含まれます。

  • :issue_date_from (Date) —

    日付を指定します。指定した日付以降の請求書発行日となっている請求を取得できます。指定された日付のものも含まれます。

  • :issue_date_to (Date) —

    日付を指定します。指定した日付以前の請求書発行日となっている請求を取得できます。指定された日付のものも含まれます。

  • :unpaid (Boolean) —

    未入金のあり(&#x60;true&#x60;)、なし(&#x60;false&#x60;)を指定します。空文字が指定された場合、&#x60;false&#x60;として扱われます。

  • :after (String) —

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

  • :before (String) —

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

  • :limit (Integer) —

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

Returns:



97
98
99
100
 
# File 'lib/mfk_openapi_ruby_client/api/billing_api.rb', line 97

def get_billings_list(opts = {})
  data, _status_code, _headers = get_billings_list_with_http_info(opts)
  data
end

#get_billings_list_with_http_info(opts = {}) ⇒ Array<(BillingsList, Integer, Hash)>

請求一覧取得

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :customer_id (String) —

    任意の顧客IDを指定します。指定した顧客への請求が返却されます。

  • :customer_number (String) —

    顧客番号を指定します。指定された顧客の請求を取得します。

  • :status (Array<String>) —

    請求ステータスを指定します。該当するステータスの請求が返却されます。複数指定することが可能です。指定できる値は &#x60;scheduled&#x60;(請求予定), &#x60;invoice_issued&#x60;(請求書発行済), &#x60;account_transfer_notified&#x60;(口座振替通知済)の3種類のみです。

  • :due_date_from (Date) —

    日付を指定します。指定した日付以降の支払期限となっている請求を取得できます。指定された日付のものも含まれます。

  • :due_date_to (Date) —

    日付を指定します。指定した日付以前の支払期限となっている請求を取得できます。指定された日付のものも含まれます。

  • :issue_date_from (Date) —

    日付を指定します。指定した日付以降の請求書発行日となっている請求を取得できます。指定された日付のものも含まれます。

  • :issue_date_to (Date) —

    日付を指定します。指定した日付以前の請求書発行日となっている請求を取得できます。指定された日付のものも含まれます。

  • :unpaid (Boolean) —

    未入金のあり(&#x60;true&#x60;)、なし(&#x60;false&#x60;)を指定します。空文字が指定された場合、&#x60;false&#x60;として扱われます。

  • :after (String) —

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

  • :before (String) —

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

  • :limit (Integer) —

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

Returns:

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

    BillingsList data, response status code and response headers



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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/mfk_openapi_ruby_client/api/billing_api.rb', line 116

def get_billings_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillingApi.get_billings_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 BillingApi.get_billings_list, the character length must be smaller than or equal to 100.'
  end

  allowable_values = ["scheduled", "invoice_issued", "account_transfer_notified"]
  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 BillingApi.get_billings_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 BillingApi.get_billings_list, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/billings'

  # 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[:'status'] = @api_client.build_collection_param(opts[:'status'], :csv) if !opts[:'status'].nil?
  query_params[:'due_date_from'] = opts[:'due_date_from'] if !opts[:'due_date_from'].nil?
  query_params[:'due_date_to'] = opts[:'due_date_to'] if !opts[:'due_date_to'].nil?
  query_params[:'issue_date_from'] = opts[:'issue_date_from'] if !opts[:'issue_date_from'].nil?
  query_params[:'issue_date_to'] = opts[:'issue_date_to'] if !opts[:'issue_date_to'].nil?
  query_params[:'unpaid'] = opts[:'unpaid'] if !opts[:'unpaid'].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] || 'BillingsList'

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

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