Class: Kendama::V1Api

Inherits:
Object
  • Object
show all
Defined in:
lib/kendama/api/v1_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ V1Api

Returns a new instance of V1Api.



19
20
21
 
# File 'lib/kendama/api/v1_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/kendama/api/v1_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_announcement_by_diff(id, from, to, type, opts = {}) ⇒ ResponseBody

取得期間を指定して情報を取得 取得期間を指定し、当該期間内に「更新年月日」が含まれる公表情報を取得

Parameters:

  • id (String)
  • from (Date)
  • to (Date)
  • type (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :division (String) — default: default to '1'
  • :divide (String) — default: default to '1'

Returns:



32
33
34
35
 
# File 'lib/kendama/api/v1_api.rb', line 32

def get_announcement_by_diff(id, from, to, type, opts = {})
  data, _status_code, _headers = get_announcement_by_diff_with_http_info(id, from, to, type, opts)
  data
end

#get_announcement_by_diff_with_http_info(id, from, to, type, opts = {}) ⇒ Array<(ResponseBody, Integer, Hash)>

取得期間を指定して情報を取得 取得期間を指定し、当該期間内に「更新年月日」が含まれる公表情報を取得

Parameters:

  • id (String)
  • from (Date)
  • to (Date)
  • type (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :division (String) — default: default to '1'
  • :divide (String) — default: default to '1'

Returns:

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

    ResponseBody data, response status code and response headers



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
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
127
128
 
# File 'lib/kendama/api/v1_api.rb', line 47

def get_announcement_by_diff_with_http_info(id, from, to, type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V1Api.get_announcement_by_diff ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling V1Api.get_announcement_by_diff"
  end
  # verify the required parameter 'from' is set
  if @api_client.config.client_side_validation && from.nil?
    fail ArgumentError, "Missing the required parameter 'from' when calling V1Api.get_announcement_by_diff"
  end
  # verify the required parameter 'to' is set
  if @api_client.config.client_side_validation && to.nil?
    fail ArgumentError, "Missing the required parameter 'to' when calling V1Api.get_announcement_by_diff"
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling V1Api.get_announcement_by_diff"
  end
  # verify enum value
  allowable_values = ["21"]
  if @api_client.config.client_side_validation && !allowable_values.include?(type)
    fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
  end
  allowable_values = ["1", "2"]
  if @api_client.config.client_side_validation && opts[:'division'] && !allowable_values.include?(opts[:'division'])
    fail ArgumentError, "invalid value for \"division\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'divide'].nil? && opts[:'divide'].to_s.length > 999999
    fail ArgumentError, 'invalid value for "opts[:"divide"]" when calling V1Api.get_announcement_by_diff, the character length must be smaller than or equal to 999999.'
  end

  if @api_client.config.client_side_validation && !opts[:'divide'].nil? && opts[:'divide'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"divide"]" when calling V1Api.get_announcement_by_diff, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/1/diff'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id'] = id
  query_params[:'from'] = from
  query_params[:'to'] = to
  query_params[:'type'] = type
  query_params[:'division'] = opts[:'division'] if !opts[:'division'].nil?
  query_params[:'divide'] = opts[:'divide'] if !opts[:'divide'].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] || 'ResponseBody'

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

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

#get_announcement_by_number(id, number, type, opts = {}) ⇒ ResponseBody

登録番号を指定して情報を取得 指定された登録番号に係る登録年月日、取消年月日及び失効年月日に紐づく最新情報（履歴情報は任意）を取得

Parameters:

  • id (String)
  • number (String)
  • type (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :history (String)

Returns:



138
139
140
141
 
# File 'lib/kendama/api/v1_api.rb', line 138

def get_announcement_by_number(id, number, type, opts = {})
  data, _status_code, _headers = get_announcement_by_number_with_http_info(id, number, type, opts)
  data
end

#get_announcement_by_number_with_http_info(id, number, type, opts = {}) ⇒ Array<(ResponseBody, Integer, Hash)>

登録番号を指定して情報を取得 指定された登録番号に係る登録年月日、取消年月日及び失効年月日に紐づく最新情報（履歴情報は任意）を取得

Parameters:

  • id (String)
  • number (String)
  • type (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :history (String)

Returns:

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

    ResponseBody data, response status code and response headers



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
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
 
# File 'lib/kendama/api/v1_api.rb', line 151

def get_announcement_by_number_with_http_info(id, number, type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V1Api.get_announcement_by_number ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling V1Api.get_announcement_by_number"
  end
  # verify the required parameter 'number' is set
  if @api_client.config.client_side_validation && number.nil?
    fail ArgumentError, "Missing the required parameter 'number' when calling V1Api.get_announcement_by_number"
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling V1Api.get_announcement_by_number"
  end
  # verify enum value
  allowable_values = ["21"]
  if @api_client.config.client_side_validation && !allowable_values.include?(type)
    fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
  end
  allowable_values = ["0", "1"]
  if @api_client.config.client_side_validation && opts[:'history'] && !allowable_values.include?(opts[:'history'])
    fail ArgumentError, "invalid value for \"history\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/1/num'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id'] = id
  query_params[:'number'] = number
  query_params[:'type'] = type
  query_params[:'history'] = opts[:'history'] if !opts[:'history'].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] || 'ResponseBody'

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

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

#get_announcement_by_valid(id, number, day, type, opts = {}) ⇒ ResponseBody

登録番号と日付を指定して情報を取得 登録番号及び指定された日付を基準日とした直近の登録年月日、取消年月日、失効年月日に紐づく情報を取得

Parameters:

  • id (String)
  • number (String)
  • day (Date)
  • type (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



228
229
230
231
 
# File 'lib/kendama/api/v1_api.rb', line 228

def get_announcement_by_valid(id, number, day, type, opts = {})
  data, _status_code, _headers = get_announcement_by_valid_with_http_info(id, number, day, type, opts)
  data
end

#get_announcement_by_valid_with_http_info(id, number, day, type, opts = {}) ⇒ Array<(ResponseBody, Integer, Hash)>

登録番号と日付を指定して情報を取得 登録番号及び指定された日付を基準日とした直近の登録年月日、取消年月日、失効年月日に紐づく情報を取得

Parameters:

  • id (String)
  • number (String)
  • day (Date)
  • type (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    ResponseBody data, response status code and response headers



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/kendama/api/v1_api.rb', line 241

def get_announcement_by_valid_with_http_info(id, number, day, type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V1Api.get_announcement_by_valid ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling V1Api.get_announcement_by_valid"
  end
  # verify the required parameter 'number' is set
  if @api_client.config.client_side_validation && number.nil?
    fail ArgumentError, "Missing the required parameter 'number' when calling V1Api.get_announcement_by_valid"
  end
  # verify the required parameter 'day' is set
  if @api_client.config.client_side_validation && day.nil?
    fail ArgumentError, "Missing the required parameter 'day' when calling V1Api.get_announcement_by_valid"
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling V1Api.get_announcement_by_valid"
  end
  # verify enum value
  allowable_values = ["21"]
  if @api_client.config.client_side_validation && !allowable_values.include?(type)
    fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/1/valid'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id'] = id
  query_params[:'number'] = number
  query_params[:'day'] = day
  query_params[:'type'] = type

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

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

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