Class: MfkOpenapiRubyClient::DestinationApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DestinationApi

Returns a new instance of DestinationApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_destination(payload, opts = {}) ⇒ Destination

顧客を指定して請求先を登録することができます。 <aside class="info">請求先は更新ができません。更新したい場合は新規登録をしてご利用ください。</aside> 請求先登録

Parameters:

  • payload (DestinationPayload) —

    請求先登録情報です。

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/mfk_openapi_ruby_client/api/destination_api.rb', line 27

def create_destination(payload, opts = {})
  data, _status_code, _headers = create_destination_with_http_info(payload, opts)
  data
end

#create_destination_with_http_info(payload, opts = {}) ⇒ Array<(Destination, Integer, Hash)>

顧客を指定して請求先を登録することができます。 &lt;aside class&#x3D;&quot;info&quot;&gt;請求先は更新ができません。更新したい場合は新規登録をしてご利用ください。&lt;/aside&gt; 請求先登録

Parameters:

  • payload (DestinationPayload) —

    請求先登録情報です。

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

    the optional parameters

Returns:

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

    Destination data, response status code and response headers



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
82
83
84
85
 
# File 'lib/mfk_openapi_ruby_client/api/destination_api.rb', line 37

def create_destination_with_http_info(payload, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DestinationApi.create_destination ...'
  end
  # verify the required parameter 'payload' is set
  if @api_client.config.client_side_validation && payload.nil?
    fail ArgumentError, "Missing the required parameter 'payload' when calling DestinationApi.create_destination"
  end
  # resource path
  local_var_path = '/destinations'

  # 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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(payload)

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

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

  new_options = opts.merge(
    :operation => :"DestinationApi.create_destination",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DestinationApi#create_destination\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_destination(destination_id, opts = {}) ⇒ Destination

請求先IDを指定して対象請求先１件を取得することができます。請求先取得

Parameters:

  • destination_id (String) —

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

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

    the optional parameters

Returns:



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

def get_destination(destination_id, opts = {})
  data, _status_code, _headers = get_destination_with_http_info(destination_id, opts)
  data
end

#get_destination_with_http_info(destination_id, opts = {}) ⇒ Array<(Destination, Integer, Hash)>

請求先IDを指定して対象請求先１件を取得することができます。請求先取得

Parameters:

  • destination_id (String) —

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

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

    the optional parameters

Returns:

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

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

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

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

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

#get_destinations_list(opts = {}) ⇒ DestinationsList

請求先の一覧を取得します。顧客IDや顧客番号で特定の顧客に紐づく請求先に絞り込んで取得することもできます。請求先一覧取得

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :customer_id (String) —

    顧客IDを指定します。指定された顧客の請求先を取得します。&#x60;customer_number&#x60;に別の顧客の顧客番号を指定した場合には該当請求先は0件になります。

  • :customer_number (String) —

    顧客番号を指定します。指定された顧客の請求先を取得します。&#x60;customer_id&#x60;に別の顧客の顧客IDを指定した場合には該当請求先は0件になります。

  • :created_at_from (Time) —

    指定された日時以降に作成された請求先を取得します。指定された日時に作成されたものも含まれます。 RFC3339の&#x60;date-time&#x60;(2019-04-01T10:36:43%2B09:00)で指定してください。

  • :created_at_to (Time) —

    指定された日時以前に作成された請求先を取得します。指定された日時に作成されたものも含まれます。 RFC3339の&#x60;date-time&#x60;(2019-04-01T10:36:43%2B09:00)で指定してください。

  • :after (String) —

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

  • :before (String) —

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

  • :limit (Integer) —

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

Returns:



161
162
163
164
 
# File 'lib/mfk_openapi_ruby_client/api/destination_api.rb', line 161

def get_destinations_list(opts = {})
  data, _status_code, _headers = get_destinations_list_with_http_info(opts)
  data
end

#get_destinations_list_with_http_info(opts = {}) ⇒ Array<(DestinationsList, Integer, Hash)>

請求先の一覧を取得します。顧客IDや顧客番号で特定の顧客に紐づく請求先に絞り込んで取得することもできます。請求先一覧取得

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :customer_id (String) —

    顧客IDを指定します。指定された顧客の請求先を取得します。&#x60;customer_number&#x60;に別の顧客の顧客番号を指定した場合には該当請求先は0件になります。

  • :customer_number (String) —

    顧客番号を指定します。指定された顧客の請求先を取得します。&#x60;customer_id&#x60;に別の顧客の顧客IDを指定した場合には該当請求先は0件になります。

  • :created_at_from (Time) —

    指定された日時以降に作成された請求先を取得します。指定された日時に作成されたものも含まれます。 RFC3339の&#x60;date-time&#x60;(2019-04-01T10:36:43%2B09:00)で指定してください。

  • :created_at_to (Time) —

    指定された日時以前に作成された請求先を取得します。指定された日時に作成されたものも含まれます。 RFC3339の&#x60;date-time&#x60;(2019-04-01T10:36:43%2B09:00)で指定してください。

  • :after (String) —

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

  • :before (String) —

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

  • :limit (Integer) —

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

Returns:

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

    DestinationsList data, response status code and response headers



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/mfk_openapi_ruby_client/api/destination_api.rb', line 177

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

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 200
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling DestinationApi.get_destinations_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 DestinationApi.get_destinations_list, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/destinations'

  # 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[:'created_at_from'] = opts[:'created_at_from'] if !opts[:'created_at_from'].nil?
  query_params[:'created_at_to'] = opts[:'created_at_to'] if !opts[:'created_at_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] || 'DestinationsList'

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

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