Class: Kickflow::DefaultApi

Inherits:
Object
  • Object
show all
Defined in:
lib/kickflow/api/_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DefaultApi

Returns a new instance of DefaultApi.



19
20
21
 
# File 'lib/kickflow/api/_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/kickflow/api/_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_categories_category_id(category_id, opts = {}) ⇒ nil

カテゴリを削除 カテゴリを削除します。 このAPIの実行には、ワークフローの管理権限が必要です。

Parameters:

  • category_id (String) —

    カテゴリのUUID

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

    the optional parameters

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/kickflow/api/_api.rb', line 27

def delete_categories_category_id(category_id, opts = {})
  delete_categories_category_id_with_http_info(category_id, opts)
  nil
end

#delete_categories_category_id_with_http_info(category_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

カテゴリを削除 カテゴリを削除します。 このAPIの実行には、ワークフローの管理権限が必要です。

Parameters:

  • category_id (String) —

    カテゴリのUUID

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/kickflow/api/_api.rb', line 37

def delete_categories_category_id_with_http_info(category_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_categories_category_id ...'
  end
  # verify the required parameter 'category_id' is set
  if @api_client.config.client_side_validation && category_id.nil?
    fail ArgumentError, "Missing the required parameter 'category_id' when calling DefaultApi.delete_categories_category_id"
  end
  # resource path
  local_var_path = '/v1/categories/{categoryId}'.sub('{' + 'categoryId' + '}', CGI.escape(category_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

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

#delete_folders_folder_id(folder_id, opts = {}) ⇒ nil

フォルダを削除 フォルダを削除します。 このAPIの実行には、ワークフローの管理権限が必要です。 注意：このフォルダ以下のすべてのフォルダ・ワークフロー・経路・パイプラインも削除されます。

Parameters:

  • folder_id (String) —

    フォルダのUUIDまたはコード

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

    the optional parameters

Returns:

  • (nil) 


88
89
90
91
 
# File 'lib/kickflow/api/_api.rb', line 88

def delete_folders_folder_id(folder_id, opts = {})
  delete_folders_folder_id_with_http_info(folder_id, opts)
  nil
end

#delete_folders_folder_id_with_http_info(folder_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

フォルダを削除 フォルダを削除します。 このAPIの実行には、ワークフローの管理権限が必要です。 注意：このフォルダ以下のすべてのフォルダ・ワークフロー・経路・パイプラインも削除されます。

Parameters:

  • folder_id (String) —

    フォルダのUUIDまたはコード

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/kickflow/api/_api.rb', line 98

def delete_folders_folder_id_with_http_info(folder_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_folders_folder_id ...'
  end
  # verify the required parameter 'folder_id' is set
  if @api_client.config.client_side_validation && folder_id.nil?
    fail ArgumentError, "Missing the required parameter 'folder_id' when calling DefaultApi.delete_folders_folder_id"
  end
  # resource path
  local_var_path = '/v1/folders/{folderId}'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

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

#delete_general_masters_general_master_id(general_master_id, opts = {}) ⇒ nil

汎用マスタを削除 汎用マスタを削除します。この汎用マスタのすべてのアイテムも同時に削除されます。 このAPIの実行には、汎用マスタの管理権限が必要です。

Parameters:

  • general_master_id (String) —

    汎用マスタのUUIDまたはコード

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

    the optional parameters

Returns:

  • (nil) 


149
150
151
152
 
# File 'lib/kickflow/api/_api.rb', line 149

def delete_general_masters_general_master_id(general_master_id, opts = {})
  delete_general_masters_general_master_id_with_http_info(general_master_id, opts)
  nil
end

#delete_general_masters_general_master_id_items_item_id(general_master_id, item_id, opts = {}) ⇒ nil

汎用マスタアイテムを削除 汎用マスタアイテムを削除します。 このAPIの実行には、汎用マスタの管理権限が必要です。

Parameters:

  • general_master_id (String) —

    汎用マスタのUUIDまたはコード

  • item_id (String) —

    汎用マスタアイテムのUUIDまたはコード

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

    the optional parameters

Returns:

  • (nil) 


211
212
213
214
 
# File 'lib/kickflow/api/_api.rb', line 211

def delete_general_masters_general_master_id_items_item_id(general_master_id, item_id, opts = {})
  delete_general_masters_general_master_id_items_item_id_with_http_info(general_master_id, item_id, opts)
  nil
end

#delete_general_masters_general_master_id_items_item_id_with_http_info(general_master_id, item_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

汎用マスタアイテムを削除 汎用マスタアイテムを削除します。 このAPIの実行には、汎用マスタの管理権限が必要です。

Parameters:

  • general_master_id (String) —

    汎用マスタのUUIDまたはコード

  • item_id (String) —

    汎用マスタアイテムのUUIDまたはコード

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
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
 
# File 'lib/kickflow/api/_api.rb', line 222

def delete_general_masters_general_master_id_items_item_id_with_http_info(general_master_id, item_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_general_masters_general_master_id_items_item_id ...'
  end
  # verify the required parameter 'general_master_id' is set
  if @api_client.config.client_side_validation && general_master_id.nil?
    fail ArgumentError, "Missing the required parameter 'general_master_id' when calling DefaultApi.delete_general_masters_general_master_id_items_item_id"
  end
  # verify the required parameter 'item_id' is set
  if @api_client.config.client_side_validation && item_id.nil?
    fail ArgumentError, "Missing the required parameter 'item_id' when calling DefaultApi.delete_general_masters_general_master_id_items_item_id"
  end
  # resource path
  local_var_path = '/v1/generalMasters/{generalMasterId}/items/{itemId}'.sub('{' + 'generalMasterId' + '}', CGI.escape(general_master_id.to_s)).sub('{' + 'itemId' + '}', CGI.escape(item_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

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

#delete_general_masters_general_master_id_with_http_info(general_master_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

汎用マスタを削除 汎用マスタを削除します。この汎用マスタのすべてのアイテムも同時に削除されます。 このAPIの実行には、汎用マスタの管理権限が必要です。

Parameters:

  • general_master_id (String) —

    汎用マスタのUUIDまたはコード

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/kickflow/api/_api.rb', line 159

def delete_general_masters_general_master_id_with_http_info(general_master_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_general_masters_general_master_id ...'
  end
  # verify the required parameter 'general_master_id' is set
  if @api_client.config.client_side_validation && general_master_id.nil?
    fail ArgumentError, "Missing the required parameter 'general_master_id' when calling DefaultApi.delete_general_masters_general_master_id"
  end
  # resource path
  local_var_path = '/v1/generalMasters/{generalMasterId}'.sub('{' + 'generalMasterId' + '}', CGI.escape(general_master_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

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

#delete_grades_grade_id(grade_id, opts = {}) ⇒ nil

役職を削除 役職を削除します。 このAPIの実行には、ユーザーの管理権限が必要です。 注意：この役職を使用しているユーザーがいる場合、エラーとなります。先にユーザーから対象の役職を外してください。

Parameters:

  • grade_id (String) —

    役職のUUIDまたはコード

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

    the optional parameters

Returns:

  • (nil) 


277
278
279
280
 
# File 'lib/kickflow/api/_api.rb', line 277

def delete_grades_grade_id(grade_id, opts = {})
  delete_grades_grade_id_with_http_info(grade_id, opts)
  nil
end

#delete_grades_grade_id_with_http_info(grade_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

役職を削除 役職を削除します。 このAPIの実行には、ユーザーの管理権限が必要です。 注意：この役職を使用しているユーザーがいる場合、エラーとなります。先にユーザーから対象の役職を外してください。

Parameters:

  • grade_id (String) —

    役職のUUIDまたはコード

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/kickflow/api/_api.rb', line 287

def delete_grades_grade_id_with_http_info(grade_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_grades_grade_id ...'
  end
  # verify the required parameter 'grade_id' is set
  if @api_client.config.client_side_validation && grade_id.nil?
    fail ArgumentError, "Missing the required parameter 'grade_id' when calling DefaultApi.delete_grades_grade_id"
  end
  # resource path
  local_var_path = '/v1/grades/{gradeId}'.sub('{' + 'gradeId' + '}', CGI.escape(grade_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

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

#delete_organization_charts_organization_chart_id(organization_chart_id, opts = {}) ⇒ nil

組織図を削除 組織図を削除します。同時に、組織図内のチームや所属もすべて削除されます。 このAPIの実行には、チームの管理権限が必要です。 注意：現在有効な組織図は削除できません。 注意：組織図の削除は時間がかかることがあるため、削除は非同期で実行されます。削除の完了前にレスポンスを返すので注意してください。

Parameters:

  • organization_chart_id (String) —

    組織図のUUID

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

    the optional parameters

Returns:

  • (nil) 


338
339
340
341
 
# File 'lib/kickflow/api/_api.rb', line 338

def delete_organization_charts_organization_chart_id(organization_chart_id, opts = {})
  delete_organization_charts_organization_chart_id_with_http_info(organization_chart_id, opts)
  nil
end

#delete_organization_charts_organization_chart_id_with_http_info(organization_chart_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

組織図を削除 組織図を削除します。同時に、組織図内のチームや所属もすべて削除されます。 このAPIの実行には、チームの管理権限が必要です。 注意：現在有効な組織図は削除できません。 注意：組織図の削除は時間がかかることがあるため、削除は非同期で実行されます。削除の完了前にレスポンスを返すので注意してください。

Parameters:

  • organization_chart_id (String) —

    組織図のUUID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/kickflow/api/_api.rb', line 348

def delete_organization_charts_organization_chart_id_with_http_info(organization_chart_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_organization_charts_organization_chart_id ...'
  end
  # verify the required parameter 'organization_chart_id' is set
  if @api_client.config.client_side_validation && organization_chart_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_chart_id' when calling DefaultApi.delete_organization_charts_organization_chart_id"
  end
  # resource path
  local_var_path = '/v1/organizationCharts/{organizationChartId}'.sub('{' + 'organizationChartId' + '}', CGI.escape(organization_chart_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

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

#delete_proxy_applicants_proxy_applicant_id(proxy_applicant_id, opts = {}) ⇒ nil

代理申請を削除 指定した代理申請を削除します。 このAPIの実行には、ユーザーの管理権限が必要です。ただし、自分の代理申請の設定をすべてのユーザーに許可している場合、管理権限は不要です。

Parameters:

  • proxy_applicant_id (String) —

    代理申請のUUID

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

    the optional parameters

Returns:

  • (nil) 


399
400
401
402
 
# File 'lib/kickflow/api/_api.rb', line 399

def delete_proxy_applicants_proxy_applicant_id(proxy_applicant_id, opts = {})
  delete_proxy_applicants_proxy_applicant_id_with_http_info(proxy_applicant_id, opts)
  nil
end

#delete_proxy_applicants_proxy_applicant_id_with_http_info(proxy_applicant_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

代理申請を削除 指定した代理申請を削除します。 このAPIの実行には、ユーザーの管理権限が必要です。ただし、自分の代理申請の設定をすべてのユーザーに許可している場合、管理権限は不要です。

Parameters:

  • proxy_applicant_id (String) —

    代理申請のUUID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/kickflow/api/_api.rb', line 409

def delete_proxy_applicants_proxy_applicant_id_with_http_info(proxy_applicant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_proxy_applicants_proxy_applicant_id ...'
  end
  # verify the required parameter 'proxy_applicant_id' is set
  if @api_client.config.client_side_validation && proxy_applicant_id.nil?
    fail ArgumentError, "Missing the required parameter 'proxy_applicant_id' when calling DefaultApi.delete_proxy_applicants_proxy_applicant_id"
  end
  # resource path
  local_var_path = '/v1/proxyApplicants/{proxyApplicantId}'.sub('{' + 'proxyApplicantId' + '}', CGI.escape(proxy_applicant_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

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

#delete_proxy_approvers_proxy_approver_id(proxy_approver_id, opts = {}) ⇒ nil

代理承認を削除 指定した代理承認を削除します。 このAPIの実行には、ユーザーの管理権限が必要です。ただし、自分の代理承認の設定をすべてのユーザーに許可している場合、管理権限は不要です。

Parameters:

  • proxy_approver_id (String) —

    代理承認のUUID

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

    the optional parameters

Returns:

  • (nil) 


460
461
462
463
 
# File 'lib/kickflow/api/_api.rb', line 460

def delete_proxy_approvers_proxy_approver_id(proxy_approver_id, opts = {})
  delete_proxy_approvers_proxy_approver_id_with_http_info(proxy_approver_id, opts)
  nil
end

#delete_proxy_approvers_proxy_approver_id_with_http_info(proxy_approver_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

代理承認を削除 指定した代理承認を削除します。 このAPIの実行には、ユーザーの管理権限が必要です。ただし、自分の代理承認の設定をすべてのユーザーに許可している場合、管理権限は不要です。

Parameters:

  • proxy_approver_id (String) —

    代理承認のUUID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
 
# File 'lib/kickflow/api/_api.rb', line 470

def delete_proxy_approvers_proxy_approver_id_with_http_info(proxy_approver_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_proxy_approvers_proxy_approver_id ...'
  end
  # verify the required parameter 'proxy_approver_id' is set
  if @api_client.config.client_side_validation && proxy_approver_id.nil?
    fail ArgumentError, "Missing the required parameter 'proxy_approver_id' when calling DefaultApi.delete_proxy_approvers_proxy_approver_id"
  end
  # resource path
  local_var_path = '/v1/proxyApprovers/{proxyApproverId}'.sub('{' + 'proxyApproverId' + '}', CGI.escape(proxy_approver_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

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

#delete_roles_role_id(role_id, opts = {}) ⇒ nil

管理者ロールを削除 管理者ロールを削除します。 このAPIの実行には、ロールの管理権限が必要です。

Parameters:

  • role_id (String) —

    管理者ロールのUUID

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

    the optional parameters

Returns:

  • (nil) 


521
522
523
524
 
# File 'lib/kickflow/api/_api.rb', line 521

def delete_roles_role_id(role_id, opts = {})
  delete_roles_role_id_with_http_info(role_id, opts)
  nil
end

#delete_roles_role_id_memberships_user_id(role_id, user_id, opts = {}) ⇒ nil

管理者ロールからメンバーを削除 管理者ロールからメンバーを削除します。 このAPIの実行には、ロールの管理権限が必要です。

Parameters:

  • role_id (String) —

    管理者ロールのUUID

  • user_id (String) —

    ユーザーのUUIDまたはコード

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

    the optional parameters

Returns:

  • (nil) 


583
584
585
586
 
# File 'lib/kickflow/api/_api.rb', line 583

def delete_roles_role_id_memberships_user_id(role_id, user_id, opts = {})
  delete_roles_role_id_memberships_user_id_with_http_info(role_id, user_id, opts)
  nil
end

#delete_roles_role_id_memberships_user_id_with_http_info(role_id, user_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

管理者ロールからメンバーを削除 管理者ロールからメンバーを削除します。 このAPIの実行には、ロールの管理権限が必要です。

Parameters:

  • role_id (String) —

    管理者ロールのUUID

  • user_id (String) —

    ユーザーのUUIDまたはコード

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
 
# File 'lib/kickflow/api/_api.rb', line 594

def delete_roles_role_id_memberships_user_id_with_http_info(role_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_roles_role_id_memberships_user_id ...'
  end
  # verify the required parameter 'role_id' is set
  if @api_client.config.client_side_validation && role_id.nil?
    fail ArgumentError, "Missing the required parameter 'role_id' when calling DefaultApi.delete_roles_role_id_memberships_user_id"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.delete_roles_role_id_memberships_user_id"
  end
  # resource path
  local_var_path = '/v1/roles/{roleId}/memberships/{userId}'.sub('{' + 'roleId' + '}', CGI.escape(role_id.to_s)).sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

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

#delete_roles_role_id_with_http_info(role_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

管理者ロールを削除 管理者ロールを削除します。 このAPIの実行には、ロールの管理権限が必要です。

Parameters:

  • role_id (String) —

    管理者ロールのUUID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
 
# File 'lib/kickflow/api/_api.rb', line 531

def delete_roles_role_id_with_http_info(role_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_roles_role_id ...'
  end
  # verify the required parameter 'role_id' is set
  if @api_client.config.client_side_validation && role_id.nil?
    fail ArgumentError, "Missing the required parameter 'role_id' when calling DefaultApi.delete_roles_role_id"
  end
  # resource path
  local_var_path = '/v1/roles/{roleId}'.sub('{' + 'roleId' + '}', CGI.escape(role_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

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

#delete_teams_team_id(organization_chart_id, team_id, opts = {}) ⇒ nil

チームを削除 チームを削除します。同時に、このチームの所属もすべて削除されます。 このAPIの実行には、チームの管理権限が必要です。

Parameters:

  • organization_chart_id (String) —

    組織図のUUID

  • team_id (String) —

    チームのUUIDまたはコード

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

    the optional parameters

Returns:

  • (nil) 


650
651
652
653
 
# File 'lib/kickflow/api/_api.rb', line 650

def delete_teams_team_id(organization_chart_id, team_id, opts = {})
  delete_teams_team_id_with_http_info(organization_chart_id, team_id, opts)
  nil
end

#delete_teams_team_id_members(organization_chart_id, team_id, opts = {}) ⇒ nil

チームからメンバーを削除 指定したチームからメンバーを削除します。最大10人まで同時に削除可能です。 このAPIの実行には、チームの管理権限が必要です。 注意: 削除後もメンバーが残る場合、チームにリーダーは最低一人必要です。メンバー削除によってリーダーが不在になる場合、APIは422 Unprocessable Entityを返します。

Parameters:

  • organization_chart_id (String) —

    組織図のUUID

  • team_id (String) —

    チームのUUIDまたはコード

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


718
719
720
721
 
# File 'lib/kickflow/api/_api.rb', line 718

def delete_teams_team_id_members(organization_chart_id, team_id, opts = {})
  delete_teams_team_id_members_with_http_info(organization_chart_id, team_id, opts)
  nil
end

#delete_teams_team_id_members_with_http_info(organization_chart_id, team_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

チームからメンバーを削除 指定したチームからメンバーを削除します。最大10人まで同時に削除可能です。 このAPIの実行には、チームの管理権限が必要です。 注意: 削除後もメンバーが残る場合、チームにリーダーは最低一人必要です。メンバー削除によってリーダーが不在になる場合、APIは422 Unprocessable Entityを返します。

Parameters:

  • organization_chart_id (String) —

    組織図のUUID

  • team_id (String) —

    チームのUUIDまたはコード

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
 
# File 'lib/kickflow/api/_api.rb', line 730

def delete_teams_team_id_members_with_http_info(organization_chart_id, team_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_teams_team_id_members ...'
  end
  # verify the required parameter 'organization_chart_id' is set
  if @api_client.config.client_side_validation && organization_chart_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_chart_id' when calling DefaultApi.delete_teams_team_id_members"
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling DefaultApi.delete_teams_team_id_members"
  end
  # resource path
  local_var_path = '/v1/organizationCharts/{organizationChartId}/teams/{teamId}/memberships'.sub('{' + 'organizationChartId' + '}', CGI.escape(organization_chart_id.to_s)).sub('{' + 'teamId' + '}', CGI.escape(team_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#delete_teams_team_id_with_http_info(organization_chart_id, team_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

チームを削除 チームを削除します。同時に、このチームの所属もすべて削除されます。 このAPIの実行には、チームの管理権限が必要です。

Parameters:

  • organization_chart_id (String) —

    組織図のUUID

  • team_id (String) —

    チームのUUIDまたはコード

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
 
# File 'lib/kickflow/api/_api.rb', line 661

def delete_teams_team_id_with_http_info(organization_chart_id, team_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_teams_team_id ...'
  end
  # verify the required parameter 'organization_chart_id' is set
  if @api_client.config.client_side_validation && organization_chart_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_chart_id' when calling DefaultApi.delete_teams_team_id"
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling DefaultApi.delete_teams_team_id"
  end
  # resource path
  local_var_path = '/v1/organizationCharts/{organizationChartId}/teams/{teamId}'.sub('{' + 'organizationChartId' + '}', CGI.escape(organization_chart_id.to_s)).sub('{' + 'teamId' + '}', CGI.escape(team_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

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

#delete_tickets_id_comments_comment_id(ticket_id, comment_id, opts = {}) ⇒ nil

コメントを削除 チケットのコメントを削除します。

Parameters:

  • ticket_id (String) —

    チケットのUUID

  • comment_id (String) —

    コメントのUUID

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

    the optional parameters

Returns:

  • (nil) 


791
792
793
794
 
# File 'lib/kickflow/api/_api.rb', line 791

def delete_tickets_id_comments_comment_id(ticket_id, comment_id, opts = {})
  delete_tickets_id_comments_comment_id_with_http_info(ticket_id, comment_id, opts)
  nil
end

#delete_tickets_id_comments_comment_id_with_http_info(ticket_id, comment_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

コメントを削除 チケットのコメントを削除します。

Parameters:

  • ticket_id (String) —

    チケットのUUID

  • comment_id (String) —

    コメントのUUID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
 
# File 'lib/kickflow/api/_api.rb', line 802

def delete_tickets_id_comments_comment_id_with_http_info(ticket_id, comment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_tickets_id_comments_comment_id ...'
  end
  # verify the required parameter 'ticket_id' is set
  if @api_client.config.client_side_validation && ticket_id.nil?
    fail ArgumentError, "Missing the required parameter 'ticket_id' when calling DefaultApi.delete_tickets_id_comments_comment_id"
  end
  # verify the required parameter 'comment_id' is set
  if @api_client.config.client_side_validation && comment_id.nil?
    fail ArgumentError, "Missing the required parameter 'comment_id' when calling DefaultApi.delete_tickets_id_comments_comment_id"
  end
  # resource path
  local_var_path = '/v1/tickets/{ticketId}/comments/{commentId}'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_id.to_s)).sub('{' + 'commentId' + '}', CGI.escape(comment_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

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

#delete_tickets_id_viewers_viewer_id(ticket_id, viewer_id, opts = {}) ⇒ nil

閲覧者を削除 チケットの閲覧者を削除します。

Parameters:

  • ticket_id (String) —

    チケットのUUID

  • viewer_id (String) —

    閲覧者のUUID

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

    the optional parameters

Returns:

  • (nil) 


858
859
860
861
 
# File 'lib/kickflow/api/_api.rb', line 858

def delete_tickets_id_viewers_viewer_id(ticket_id, viewer_id, opts = {})
  delete_tickets_id_viewers_viewer_id_with_http_info(ticket_id, viewer_id, opts)
  nil
end

#delete_tickets_id_viewers_viewer_id_with_http_info(ticket_id, viewer_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

閲覧者を削除 チケットの閲覧者を削除します。

Parameters:

  • ticket_id (String) —

    チケットのUUID

  • viewer_id (String) —

    閲覧者のUUID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/kickflow/api/_api.rb', line 869

def delete_tickets_id_viewers_viewer_id_with_http_info(ticket_id, viewer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_tickets_id_viewers_viewer_id ...'
  end
  # verify the required parameter 'ticket_id' is set
  if @api_client.config.client_side_validation && ticket_id.nil?
    fail ArgumentError, "Missing the required parameter 'ticket_id' when calling DefaultApi.delete_tickets_id_viewers_viewer_id"
  end
  # verify the required parameter 'viewer_id' is set
  if @api_client.config.client_side_validation && viewer_id.nil?
    fail ArgumentError, "Missing the required parameter 'viewer_id' when calling DefaultApi.delete_tickets_id_viewers_viewer_id"
  end
  # resource path
  local_var_path = '/v1/tickets/{ticketId}/viewers/{viewerId}'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_id.to_s)).sub('{' + 'viewerId' + '}', CGI.escape(viewer_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

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

#delete_users_user_id(user_id, opts = {}) ⇒ UserDetail

ユーザーを削除 ユーザーを削除します（論理削除）。 削除されたユーザーは削除済ステータスとなりますが、引き続きユーザー情報にアクセス可能です。 このAPIの実行には、ユーザーの管理権限が必要です。

Parameters:

  • user_id (String) —

    ユーザーのUUIDまたはコード

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

    the optional parameters

Returns:



924
925
926
927
 
# File 'lib/kickflow/api/_api.rb', line 924

def delete_users_user_id(user_id, opts = {})
  data, _status_code, _headers = delete_users_user_id_with_http_info(user_id, opts)
  data
end

#delete_users_user_id_with_http_info(user_id, opts = {}) ⇒ Array<(UserDetail, Integer, Hash)>

ユーザーを削除 ユーザーを削除します（論理削除）。 削除されたユーザーは削除済ステータスとなりますが、引き続きユーザー情報にアクセス可能です。 このAPIの実行には、ユーザーの管理権限が必要です。

Parameters:

  • user_id (String) —

    ユーザーのUUIDまたはコード

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

    the optional parameters

Returns:

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

    UserDetail data, response status code and response headers



934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
 
# File 'lib/kickflow/api/_api.rb', line 934

def delete_users_user_id_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_users_user_id ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.delete_users_user_id"
  end
  # resource path
  local_var_path = '/v1/users/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_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] || 'UserDetail'

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

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

#get_categories(opts = {}) ⇒ Array<Category>

カテゴリの一覧を取得 カテゴリの一覧を取得します。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

  • :sort_by (String) —

    ソート。指定可能なフィールド: name, createdAt, updatedAt

Returns:



989
990
991
992
 
# File 'lib/kickflow/api/_api.rb', line 989

def get_categories(opts = {})
  data, _status_code, _headers = get_categories_with_http_info(opts)
  data
end

#get_categories_with_http_info(opts = {}) ⇒ Array<(Array<Category>, Integer, Hash)>

カテゴリの一覧を取得 カテゴリの一覧を取得します。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

  • :sort_by (String) —

    ソート。指定可能なフィールド: name, createdAt, updatedAt

Returns:

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

    Array<Category> data, response status code and response headers



1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
 
# File 'lib/kickflow/api/_api.rb', line 1001

def get_categories_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_categories ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DefaultApi.get_categories, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_categories, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_categories, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/categories'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'perPage'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].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] || 'Array<Category>'

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

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

#get_files_signed_id(signed_id, opts = {}) ⇒ GetFilesSignedId200Response

添付ファイルの情報を取得 添付ファイルのAmazon S3上のURLを含む情報を取得します。 注意: このAPIが返すURLは、5分間で失効します。 注意: チケットに添付されていないファイルはURLを取得できません。先にチケットに添付してください。

Parameters:

  • signed_id (String) —

    添付ファイルの署名済みID

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

    the optional parameters

Returns:



1065
1066
1067
1068
 
# File 'lib/kickflow/api/_api.rb', line 1065

def get_files_signed_id(signed_id, opts = {})
  data, _status_code, _headers = get_files_signed_id_with_http_info(signed_id, opts)
  data
end

#get_files_signed_id_with_http_info(signed_id, opts = {}) ⇒ Array<(GetFilesSignedId200Response, Integer, Hash)>

添付ファイルの情報を取得 添付ファイルのAmazon S3上のURLを含む情報を取得します。 注意: このAPIが返すURLは、5分間で失効します。 注意: チケットに添付されていないファイルはURLを取得できません。先にチケットに添付してください。

Parameters:

  • signed_id (String) —

    添付ファイルの署名済みID

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

    the optional parameters

Returns:

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

    GetFilesSignedId200Response data, response status code and response headers



1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
 
# File 'lib/kickflow/api/_api.rb', line 1075

def get_files_signed_id_with_http_info(signed_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_files_signed_id ...'
  end
  # verify the required parameter 'signed_id' is set
  if @api_client.config.client_side_validation && signed_id.nil?
    fail ArgumentError, "Missing the required parameter 'signed_id' when calling DefaultApi.get_files_signed_id"
  end
  # resource path
  local_var_path = '/v1/files/{signedId}'.sub('{' + 'signedId' + '}', CGI.escape(signed_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] || 'GetFilesSignedId200Response'

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

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

#get_folders(opts = {}) ⇒ Array<Folder>

フォルダの一覧を取得 フォルダの一覧を取得します。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

  • :sort_by (String) —

    ソート。 指定可能なフィールド: createdAt, name

Returns:



1130
1131
1132
1133
 
# File 'lib/kickflow/api/_api.rb', line 1130

def get_folders(opts = {})
  data, _status_code, _headers = get_folders_with_http_info(opts)
  data
end

#get_folders_folder_id(folder_id, opts = {}) ⇒ FolderDetail

フォルダを取得 フォルダを一件取得します。

Parameters:

  • folder_id (String) —

    フォルダのUUIDまたはコード

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

    the optional parameters

Returns:



1206
1207
1208
1209
 
# File 'lib/kickflow/api/_api.rb', line 1206

def get_folders_folder_id(folder_id, opts = {})
  data, _status_code, _headers = get_folders_folder_id_with_http_info(folder_id, opts)
  data
end

#get_folders_folder_id_with_http_info(folder_id, opts = {}) ⇒ Array<(FolderDetail, Integer, Hash)>

フォルダを取得 フォルダを一件取得します。

Parameters:

  • folder_id (String) —

    フォルダのUUIDまたはコード

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

    the optional parameters

Returns:

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

    FolderDetail data, response status code and response headers



1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
 
# File 'lib/kickflow/api/_api.rb', line 1216

def get_folders_folder_id_with_http_info(folder_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_folders_folder_id ...'
  end
  # verify the required parameter 'folder_id' is set
  if @api_client.config.client_side_validation && folder_id.nil?
    fail ArgumentError, "Missing the required parameter 'folder_id' when calling DefaultApi.get_folders_folder_id"
  end
  # resource path
  local_var_path = '/v1/folders/{folderId}'.sub('{' + 'folderId' + '}', CGI.escape(folder_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] || 'FolderDetail'

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

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

#get_folders_with_http_info(opts = {}) ⇒ Array<(Array<Folder>, Integer, Hash)>

フォルダの一覧を取得 フォルダの一覧を取得します。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

  • :sort_by (String) —

    ソート。 指定可能なフィールド: createdAt, name

Returns:

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

    Array<Folder> data, response status code and response headers



1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
 
# File 'lib/kickflow/api/_api.rb', line 1142

def get_folders_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_folders ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DefaultApi.get_folders, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_folders, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_folders, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/folders'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'perPage'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].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] || 'Array<Folder>'

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

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

#get_general_masters(opts = {}) ⇒ Array<GeneralMaster>

汎用マスタの一覧を取得 汎用マスタの一覧を取得します。 このAPIの実行には、汎用マスタの管理権限が必要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数å (default to 25)

  • :sort_by (String) —

    ソート。 指定可能なフィールド: createdAt, code, name

Returns:



1271
1272
1273
1274
 
# File 'lib/kickflow/api/_api.rb', line 1271

def get_general_masters(opts = {})
  data, _status_code, _headers = get_general_masters_with_http_info(opts)
  data
end

#get_general_masters_general_master_id(general_master_id, opts = {}) ⇒ GeneralMaster

汎用マスタを取得 汎用マスタを一件取得します。 このAPIの実行には、汎用マスタの管理権限が必要です。

Parameters:

  • general_master_id (String) —

    汎用マスタのUUIDまたはコード

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

    the optional parameters

Returns:



1347
1348
1349
1350
 
# File 'lib/kickflow/api/_api.rb', line 1347

def get_general_masters_general_master_id(general_master_id, opts = {})
  data, _status_code, _headers = get_general_masters_general_master_id_with_http_info(general_master_id, opts)
  data
end

#get_general_masters_general_master_id_items(general_master_id, opts = {}) ⇒ Array<GeneralMasterItem>

汎用マスタアイテムの一覧を取得 汎用マスタアイテムの一覧を取得します。

Parameters:

  • general_master_id (String) —

    汎用マスタのUUIDまたはコード

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

  • :sort_by (String) —

    ソート。 指定可能なフィールド: createdAt, code, name

Returns:



1413
1414
1415
1416
 
# File 'lib/kickflow/api/_api.rb', line 1413

def get_general_masters_general_master_id_items(general_master_id, opts = {})
  data, _status_code, _headers = get_general_masters_general_master_id_items_with_http_info(general_master_id, opts)
  data
end

#get_general_masters_general_master_id_items_item_id(general_master_id, item_id, opts = {}) ⇒ GeneralMasterItem

汎用マスタアイテムを取得 汎用マスタアイテムを一件取得します。

Parameters:

  • general_master_id (String) —

    汎用マスタのUUIDまたはコード

  • item_id (String) —

    汎用マスタアイテムのUUIDまたはコード

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

    the optional parameters

Returns:



1495
1496
1497
1498
 
# File 'lib/kickflow/api/_api.rb', line 1495

def get_general_masters_general_master_id_items_item_id(general_master_id, item_id, opts = {})
  data, _status_code, _headers = get_general_masters_general_master_id_items_item_id_with_http_info(general_master_id, item_id, opts)
  data
end

#get_general_masters_general_master_id_items_item_id_with_http_info(general_master_id, item_id, opts = {}) ⇒ Array<(GeneralMasterItem, Integer, Hash)>

汎用マスタアイテムを取得 汎用マスタアイテムを一件取得します。

Parameters:

  • general_master_id (String) —

    汎用マスタのUUIDまたはコード

  • item_id (String) —

    汎用マスタアイテムのUUIDまたはコード

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

    the optional parameters

Returns:

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

    GeneralMasterItem data, response status code and response headers



1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
 
# File 'lib/kickflow/api/_api.rb', line 1506

def get_general_masters_general_master_id_items_item_id_with_http_info(general_master_id, item_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_general_masters_general_master_id_items_item_id ...'
  end
  # verify the required parameter 'general_master_id' is set
  if @api_client.config.client_side_validation && general_master_id.nil?
    fail ArgumentError, "Missing the required parameter 'general_master_id' when calling DefaultApi.get_general_masters_general_master_id_items_item_id"
  end
  # verify the required parameter 'item_id' is set
  if @api_client.config.client_side_validation && item_id.nil?
    fail ArgumentError, "Missing the required parameter 'item_id' when calling DefaultApi.get_general_masters_general_master_id_items_item_id"
  end
  # resource path
  local_var_path = '/v1/generalMasters/{generalMasterId}/items/{itemId}'.sub('{' + 'generalMasterId' + '}', CGI.escape(general_master_id.to_s)).sub('{' + 'itemId' + '}', CGI.escape(item_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] || 'GeneralMasterItem'

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

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

#get_general_masters_general_master_id_items_with_http_info(general_master_id, opts = {}) ⇒ Array<(Array<GeneralMasterItem>, Integer, Hash)>

汎用マスタアイテムの一覧を取得 汎用マスタアイテムの一覧を取得します。

Parameters:

  • general_master_id (String) —

    汎用マスタのUUIDまたはコード

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

  • :sort_by (String) —

    ソート。 指定可能なフィールド: createdAt, code, name

Returns:

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

    Array<GeneralMasterItem> data, response status code and response headers



1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
 
# File 'lib/kickflow/api/_api.rb', line 1426

def get_general_masters_general_master_id_items_with_http_info(general_master_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_general_masters_general_master_id_items ...'
  end
  # verify the required parameter 'general_master_id' is set
  if @api_client.config.client_side_validation && general_master_id.nil?
    fail ArgumentError, "Missing the required parameter 'general_master_id' when calling DefaultApi.get_general_masters_general_master_id_items"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DefaultApi.get_general_masters_general_master_id_items, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_general_masters_general_master_id_items, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_general_masters_general_master_id_items, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/generalMasters/{generalMasterId}/items'.sub('{' + 'generalMasterId' + '}', CGI.escape(general_master_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'perPage'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].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] || 'Array<GeneralMasterItem>'

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

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

#get_general_masters_general_master_id_with_http_info(general_master_id, opts = {}) ⇒ Array<(GeneralMaster, Integer, Hash)>

汎用マスタを取得 汎用マスタを一件取得します。 このAPIの実行には、汎用マスタの管理権限が必要です。

Parameters:

  • general_master_id (String) —

    汎用マスタのUUIDまたはコード

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

    the optional parameters

Returns:

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

    GeneralMaster data, response status code and response headers



1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
 
# File 'lib/kickflow/api/_api.rb', line 1357

def get_general_masters_general_master_id_with_http_info(general_master_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_general_masters_general_master_id ...'
  end
  # verify the required parameter 'general_master_id' is set
  if @api_client.config.client_side_validation && general_master_id.nil?
    fail ArgumentError, "Missing the required parameter 'general_master_id' when calling DefaultApi.get_general_masters_general_master_id"
  end
  # resource path
  local_var_path = '/v1/generalMasters/{generalMasterId}'.sub('{' + 'generalMasterId' + '}', CGI.escape(general_master_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] || 'GeneralMaster'

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

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

#get_general_masters_with_http_info(opts = {}) ⇒ Array<(Array<GeneralMaster>, Integer, Hash)>

汎用マスタの一覧を取得 汎用マスタの一覧を取得します。 このAPIの実行には、汎用マスタの管理権限が必要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数å (default to 25)

  • :sort_by (String) —

    ソート。 指定可能なフィールド: createdAt, code, name

Returns:

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

    Array<GeneralMaster> data, response status code and response headers



1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
 
# File 'lib/kickflow/api/_api.rb', line 1283

def get_general_masters_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_general_masters ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DefaultApi.get_general_masters, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_general_masters, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_general_masters, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/generalMasters'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'perPage'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].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] || 'Array<GeneralMaster>'

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

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

#get_grades(opts = {}) ⇒ Array<Grade>

役職の一覧を取得 役職の一覧を取得します。 このAPIの実行には、ユーザーの管理権限が必要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

  • :sort_by (String) —

    ソート。指定可能なフィールド: level, code

Returns:



1565
1566
1567
1568
 
# File 'lib/kickflow/api/_api.rb', line 1565

def get_grades(opts = {})
  data, _status_code, _headers = get_grades_with_http_info(opts)
  data
end

#get_grades_grade_id(grade_id, opts = {}) ⇒ Grade

役職を取得 役職を一件取得します。 このAPIの実行には、ユーザーの管理権限が必要です。

Parameters:

  • grade_id (String) —

    役職のUUIDまたはコード

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

    the optional parameters

Returns:



1641
1642
1643
1644
 
# File 'lib/kickflow/api/_api.rb', line 1641

def get_grades_grade_id(grade_id, opts = {})
  data, _status_code, _headers = get_grades_grade_id_with_http_info(grade_id, opts)
  data
end

#get_grades_grade_id_with_http_info(grade_id, opts = {}) ⇒ Array<(Grade, Integer, Hash)>

役職を取得 役職を一件取得します。 このAPIの実行には、ユーザーの管理権限が必要です。

Parameters:

  • grade_id (String) —

    役職のUUIDまたはコード

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

    the optional parameters

Returns:

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

    Grade data, response status code and response headers



1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
 
# File 'lib/kickflow/api/_api.rb', line 1651

def get_grades_grade_id_with_http_info(grade_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_grades_grade_id ...'
  end
  # verify the required parameter 'grade_id' is set
  if @api_client.config.client_side_validation && grade_id.nil?
    fail ArgumentError, "Missing the required parameter 'grade_id' when calling DefaultApi.get_grades_grade_id"
  end
  # resource path
  local_var_path = '/v1/grades/{gradeId}'.sub('{' + 'gradeId' + '}', CGI.escape(grade_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] || 'Grade'

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

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

#get_grades_with_http_info(opts = {}) ⇒ Array<(Array<Grade>, Integer, Hash)>

役職の一覧を取得 役職の一覧を取得します。 このAPIの実行には、ユーザーの管理権限が必要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

  • :sort_by (String) —

    ソート。指定可能なフィールド: level, code

Returns:

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

    Array<Grade> data, response status code and response headers



1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
 
# File 'lib/kickflow/api/_api.rb', line 1577

def get_grades_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_grades ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DefaultApi.get_grades, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_grades, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_grades, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/grades'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'perPage'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].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] || 'Array<Grade>'

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

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

#get_organization_chart(opts = {}) ⇒ OrganizationChartDetail

現在の組織図を取得 現在有効になっている組織図を取得します。 このAPIの実行には、チームの管理権限が必要です。

Parameters:

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

    the optional parameters

Returns:



1703
1704
1705
1706
 
# File 'lib/kickflow/api/_api.rb', line 1703

def get_organization_chart(opts = {})
  data, _status_code, _headers = get_organization_chart_with_http_info(opts)
  data
end

#get_organization_chart_with_http_info(opts = {}) ⇒ Array<(OrganizationChartDetail, Integer, Hash)>

現在の組織図を取得 現在有効になっている組織図を取得します。 このAPIの実行には、チームの管理権限が必要です。

Parameters:

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

    the optional parameters

Returns:

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

    OrganizationChartDetail data, response status code and response headers



1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
 
# File 'lib/kickflow/api/_api.rb', line 1712

def get_organization_chart_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_organization_chart ...'
  end
  # resource path
  local_var_path = '/v1/organizationChart'

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

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

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

#get_organization_charts(opts = {}) ⇒ Array<OrganizationChart>

組織図の一覧を取得 組織図の一覧を取得します。 このAPIの実行には、チームの管理権限が必要です。 注意：パフォーマンス上の理由から、組織図の一覧取得時は組織図内のチームのリストがレスポンスに含まれません。 組織図のすべての情報を取得したい場合は、組織図を一件だけ取得するAPI経由で取得してください。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

  • :sort_by (String) —

    ソート。指定可能なフィールド: createdAt, name

Returns:



1763
1764
1765
1766
 
# File 'lib/kickflow/api/_api.rb', line 1763

def get_organization_charts(opts = {})
  data, _status_code, _headers = get_organization_charts_with_http_info(opts)
  data
end

#get_organization_charts_organization_chart_id(organization_chart_id, opts = {}) ⇒ OrganizationChartDetail

組織図を取得 組織図を一件取得します。 このAPIの実行には、チームの管理権限が必要です。

Parameters:

  • organization_chart_id (String) —

    組織図のUUID

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

    the optional parameters

Returns:



1839
1840
1841
1842
 
# File 'lib/kickflow/api/_api.rb', line 1839

def get_organization_charts_organization_chart_id(organization_chart_id, opts = {})
  data, _status_code, _headers = get_organization_charts_organization_chart_id_with_http_info(organization_chart_id, opts)
  data
end

#get_organization_charts_organization_chart_id_teams(organization_chart_id, opts = {}) ⇒ Array<Team>

チーム一覧を取得 指定した組織図内のチーム一覧を取得します。 parentIdを指定した場合は指定した親チームの配下チームの一覧を、parentIdを指定しない場合は組織図内のルートのチーム一覧を返します。 このAPIの実行には、チームの管理権限が必要です。

Parameters:

  • organization_chart_id (String) —

    組織図のUUID

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

    the optional parameters

Options Hash (opts):

  • :parent_id (String) —

    親チームのUUID

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

Returns:



1905
1906
1907
1908
 
# File 'lib/kickflow/api/_api.rb', line 1905

def get_organization_charts_organization_chart_id_teams(organization_chart_id, opts = {})
  data, _status_code, _headers = get_organization_charts_organization_chart_id_teams_with_http_info(organization_chart_id, opts)
  data
end

#get_organization_charts_organization_chart_id_teams_team_id_memberships(organization_chart_id, team_id, opts = {}) ⇒ Array<MemberUser>

チームのメンバー一覧を取得 チームのメンバー一覧を取得します。 このAPIの実行には、チームの管理権限が必要です。

Parameters:

  • organization_chart_id (String) —

    組織図のUUID

  • team_id (String) —

    チームのUUIDまたはコード

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ。1が先頭のページ。 (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

Returns:



1989
1990
1991
1992
 
# File 'lib/kickflow/api/_api.rb', line 1989

def get_organization_charts_organization_chart_id_teams_team_id_memberships(organization_chart_id, team_id, opts = {})
  data, _status_code, _headers = get_organization_charts_organization_chart_id_teams_team_id_memberships_with_http_info(organization_chart_id, team_id, opts)
  data
end

#get_organization_charts_organization_chart_id_teams_team_id_memberships_with_http_info(organization_chart_id, team_id, opts = {}) ⇒ Array<(Array<MemberUser>, Integer, Hash)>

チームのメンバー一覧を取得 チームのメンバー一覧を取得します。 このAPIの実行には、チームの管理権限が必要です。

Parameters:

  • organization_chart_id (String) —

    組織図のUUID

  • team_id (String) —

    チームのUUIDまたはコード

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ。1が先頭のページ。 (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

Returns:

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

    Array<MemberUser> data, response status code and response headers



2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
 
# File 'lib/kickflow/api/_api.rb', line 2002

def get_organization_charts_organization_chart_id_teams_team_id_memberships_with_http_info(organization_chart_id, team_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_organization_charts_organization_chart_id_teams_team_id_memberships ...'
  end
  # verify the required parameter 'organization_chart_id' is set
  if @api_client.config.client_side_validation && organization_chart_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_chart_id' when calling DefaultApi.get_organization_charts_organization_chart_id_teams_team_id_memberships"
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling DefaultApi.get_organization_charts_organization_chart_id_teams_team_id_memberships"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DefaultApi.get_organization_charts_organization_chart_id_teams_team_id_memberships, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_organization_charts_organization_chart_id_teams_team_id_memberships, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_organization_charts_organization_chart_id_teams_team_id_memberships, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/organizationCharts/{organizationChartId}/teams/{teamId}/memberships'.sub('{' + 'organizationChartId' + '}', CGI.escape(organization_chart_id.to_s)).sub('{' + 'teamId' + '}', CGI.escape(team_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'perPage'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'Array<MemberUser>'

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

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

#get_organization_charts_organization_chart_id_teams_with_http_info(organization_chart_id, opts = {}) ⇒ Array<(Array<Team>, Integer, Hash)>

チーム一覧を取得 指定した組織図内のチーム一覧を取得します。 parentIdを指定した場合は指定した親チームの配下チームの一覧を、parentIdを指定しない場合は組織図内のルートのチーム一覧を返します。 このAPIの実行には、チームの管理権限が必要です。

Parameters:

  • organization_chart_id (String) —

    組織図のUUID

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

    the optional parameters

Options Hash (opts):

  • :parent_id (String) —

    親チームのUUID

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

Returns:

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

    Array<Team> data, response status code and response headers



1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
 
# File 'lib/kickflow/api/_api.rb', line 1918

def get_organization_charts_organization_chart_id_teams_with_http_info(organization_chart_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_organization_charts_organization_chart_id_teams ...'
  end
  # verify the required parameter 'organization_chart_id' is set
  if @api_client.config.client_side_validation && organization_chart_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_chart_id' when calling DefaultApi.get_organization_charts_organization_chart_id_teams"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DefaultApi.get_organization_charts_organization_chart_id_teams, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_organization_charts_organization_chart_id_teams, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_organization_charts_organization_chart_id_teams, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/organizationCharts/{organizationChartId}/teams'.sub('{' + 'organizationChartId' + '}', CGI.escape(organization_chart_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'parentId'] = opts[:'parent_id'] if !opts[:'parent_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'perPage'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'Array<Team>'

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

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

#get_organization_charts_organization_chart_id_with_http_info(organization_chart_id, opts = {}) ⇒ Array<(OrganizationChartDetail, Integer, Hash)>

組織図を取得 組織図を一件取得します。 このAPIの実行には、チームの管理権限が必要です。

Parameters:

  • organization_chart_id (String) —

    組織図のUUID

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

    the optional parameters

Returns:

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

    OrganizationChartDetail data, response status code and response headers



1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
 
# File 'lib/kickflow/api/_api.rb', line 1849

def get_organization_charts_organization_chart_id_with_http_info(organization_chart_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_organization_charts_organization_chart_id ...'
  end
  # verify the required parameter 'organization_chart_id' is set
  if @api_client.config.client_side_validation && organization_chart_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_chart_id' when calling DefaultApi.get_organization_charts_organization_chart_id"
  end
  # resource path
  local_var_path = '/v1/organizationCharts/{organizationChartId}'.sub('{' + 'organizationChartId' + '}', CGI.escape(organization_chart_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] || 'OrganizationChartDetail'

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

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

#get_organization_charts_with_http_info(opts = {}) ⇒ Array<(Array<OrganizationChart>, Integer, Hash)>

組織図の一覧を取得 組織図の一覧を取得します。 このAPIの実行には、チームの管理権限が必要です。 注意：パフォーマンス上の理由から、組織図の一覧取得時は組織図内のチームのリストがレスポンスに含まれません。 組織図のすべての情報を取得したい場合は、組織図を一件だけ取得するAPI経由で取得してください。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

  • :sort_by (String) —

    ソート。指定可能なフィールド: createdAt, name

Returns:

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

    Array<OrganizationChart> data, response status code and response headers



1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
 
# File 'lib/kickflow/api/_api.rb', line 1775

def get_organization_charts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_organization_charts ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DefaultApi.get_organization_charts, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_organization_charts, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_organization_charts, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/organizationCharts'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'perPage'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].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] || 'Array<OrganizationChart>'

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

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

#get_proxy_applicants(opts = {}) ⇒ Array<ProxyApplicant>

代理申請一覧を取得 テナント内の代理申請の一覧を取得します。 このAPIの実行には、ユーザーの管理権限が必要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

Returns:



2074
2075
2076
2077
 
# File 'lib/kickflow/api/_api.rb', line 2074

def get_proxy_applicants(opts = {})
  data, _status_code, _headers = get_proxy_applicants_with_http_info(opts)
  data
end

#get_proxy_applicants_with_http_info(opts = {}) ⇒ Array<(Array<ProxyApplicant>, Integer, Hash)>

代理申請一覧を取得 テナント内の代理申請の一覧を取得します。 このAPIの実行には、ユーザーの管理権限が必要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

Returns:

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

    Array<ProxyApplicant> data, response status code and response headers



2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
 
# File 'lib/kickflow/api/_api.rb', line 2085

def get_proxy_applicants_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_proxy_applicants ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DefaultApi.get_proxy_applicants, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_proxy_applicants, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_proxy_applicants, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/proxyApplicants'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'perPage'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'Array<ProxyApplicant>'

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

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

#get_proxy_approvers(opts = {}) ⇒ Array<ProxyApprover>

代理承認一覧を取得 テナント内の代理承認の一覧を取得します。 このAPIの実行には、ユーザーの管理権限が必要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

Returns:



2149
2150
2151
2152
 
# File 'lib/kickflow/api/_api.rb', line 2149

def get_proxy_approvers(opts = {})
  data, _status_code, _headers = get_proxy_approvers_with_http_info(opts)
  data
end

#get_proxy_approvers_with_http_info(opts = {}) ⇒ Array<(Array<ProxyApprover>, Integer, Hash)>

代理承認一覧を取得 テナント内の代理承認の一覧を取得します。 このAPIの実行には、ユーザーの管理権限が必要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

Returns:

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

    Array<ProxyApprover> data, response status code and response headers



2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
 
# File 'lib/kickflow/api/_api.rb', line 2160

def get_proxy_approvers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_proxy_approvers ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DefaultApi.get_proxy_approvers, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_proxy_approvers, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_proxy_approvers, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/proxyApprovers'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'perPage'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'Array<ProxyApprover>'

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

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

#get_roles(opts = {}) ⇒ Array<Role>

管理者ロールの一覧を取得 管理者ロールの一覧を取得します。 このAPIの実行には、ロールの管理権限が必要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

  • :sort_by (String) —

    ソート。 指定可能なフィールド: createdAt, name

Returns:



2225
2226
2227
2228
 
# File 'lib/kickflow/api/_api.rb', line 2225

def get_roles(opts = {})
  data, _status_code, _headers = get_roles_with_http_info(opts)
  data
end

#get_roles_role_id(role_id, opts = {}) ⇒ RoleDetail

管理者ロールを取得 管理者ロールを一件取得します。 このAPIの実行には、ロールの管理権限が必要です。

Parameters:

  • role_id (String) —

    管理者ロールのUUID

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

    the optional parameters

Returns:



2301
2302
2303
2304
 
# File 'lib/kickflow/api/_api.rb', line 2301

def get_roles_role_id(role_id, opts = {})
  data, _status_code, _headers = get_roles_role_id_with_http_info(role_id, opts)
  data
end

#get_roles_role_id_memberships(role_id, opts = {}) ⇒ Array<User>

管理者ロールのメンバー一覧を取得 管理者ロールのメンバー一覧を取得します。 このAPIの実行には、ロールの管理権限が必要です。

Parameters:

  • role_id (String) —

    管理者ロールのUUID

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

Returns:



2366
2367
2368
2369
 
# File 'lib/kickflow/api/_api.rb', line 2366

def get_roles_role_id_memberships(role_id, opts = {})
  data, _status_code, _headers = get_roles_role_id_memberships_with_http_info(role_id, opts)
  data
end

#get_roles_role_id_memberships_with_http_info(role_id, opts = {}) ⇒ Array<(Array<User>, Integer, Hash)>

管理者ロールのメンバー一覧を取得 管理者ロールのメンバー一覧を取得します。 このAPIの実行には、ロールの管理権限が必要です。

Parameters:

  • role_id (String) —

    管理者ロールのUUID

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

Returns:

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

    Array<User> data, response status code and response headers



2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
 
# File 'lib/kickflow/api/_api.rb', line 2378

def get_roles_role_id_memberships_with_http_info(role_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_roles_role_id_memberships ...'
  end
  # verify the required parameter 'role_id' is set
  if @api_client.config.client_side_validation && role_id.nil?
    fail ArgumentError, "Missing the required parameter 'role_id' when calling DefaultApi.get_roles_role_id_memberships"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DefaultApi.get_roles_role_id_memberships, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_roles_role_id_memberships, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_roles_role_id_memberships, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/roles/{roleId}/memberships'.sub('{' + 'roleId' + '}', CGI.escape(role_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'perPage'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'Array<User>'

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

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

#get_roles_role_id_with_http_info(role_id, opts = {}) ⇒ Array<(RoleDetail, Integer, Hash)>

管理者ロールを取得 管理者ロールを一件取得します。 このAPIの実行には、ロールの管理権限が必要です。

Parameters:

  • role_id (String) —

    管理者ロールのUUID

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

    the optional parameters

Returns:

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

    RoleDetail data, response status code and response headers



2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
 
# File 'lib/kickflow/api/_api.rb', line 2311

def get_roles_role_id_with_http_info(role_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_roles_role_id ...'
  end
  # verify the required parameter 'role_id' is set
  if @api_client.config.client_side_validation && role_id.nil?
    fail ArgumentError, "Missing the required parameter 'role_id' when calling DefaultApi.get_roles_role_id"
  end
  # resource path
  local_var_path = '/v1/roles/{roleId}'.sub('{' + 'roleId' + '}', CGI.escape(role_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] || 'RoleDetail'

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

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

#get_roles_with_http_info(opts = {}) ⇒ Array<(Array<Role>, Integer, Hash)>

管理者ロールの一覧を取得 管理者ロールの一覧を取得します。 このAPIの実行には、ロールの管理権限が必要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

  • :sort_by (String) —

    ソート。 指定可能なフィールド: createdAt, name

Returns:

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

    Array<Role> data, response status code and response headers



2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
 
# File 'lib/kickflow/api/_api.rb', line 2237

def get_roles_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_roles ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DefaultApi.get_roles, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_roles, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_roles, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/roles'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'perPage'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].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] || 'Array<Role>'

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

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

#get_routes(opts = {}) ⇒ Array<Route>

経路一覧を取得 経路の一覧を取得します。ステータスやフォルダによる絞り込みが可能です。 このAPIの実行には、ワークフローの管理権限が必要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ。1が最初のページ。 (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

  • :sort_by (String) —

    ソート。ソート可能なフィールド: createdAt, folderId

  • :status (Array<String>) —

    ステータス

  • :folder_id (String) —

    フォルダのUUID

Returns:



2449
2450
2451
2452
 
# File 'lib/kickflow/api/_api.rb', line 2449

def get_routes(opts = {})
  data, _status_code, _headers = get_routes_with_http_info(opts)
  data
end

#get_routes_route_id(route_id, opts = {}) ⇒ RouteDetail

経路を取得 指定した経路を取得します。 このAPIの実行には、ワークフローの管理権限が必要です。

Parameters:

  • route_id (String) —

    経路のUUIDまたはコード

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

    the optional parameters

Returns:



2533
2534
2535
2536
 
# File 'lib/kickflow/api/_api.rb', line 2533

def get_routes_route_id(route_id, opts = {})
  data, _status_code, _headers = get_routes_route_id_with_http_info(route_id, opts)
  data
end

#get_routes_route_id_with_http_info(route_id, opts = {}) ⇒ Array<(RouteDetail, Integer, Hash)>

経路を取得 指定した経路を取得します。 このAPIの実行には、ワークフローの管理権限が必要です。

Parameters:

  • route_id (String) —

    経路のUUIDまたはコード

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

    the optional parameters

Returns:

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

    RouteDetail data, response status code and response headers



2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
 
# File 'lib/kickflow/api/_api.rb', line 2543

def get_routes_route_id_with_http_info(route_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_routes_route_id ...'
  end
  # verify the required parameter 'route_id' is set
  if @api_client.config.client_side_validation && route_id.nil?
    fail ArgumentError, "Missing the required parameter 'route_id' when calling DefaultApi.get_routes_route_id"
  end
  # resource path
  local_var_path = '/v1/routes/{routeId}'.sub('{' + 'routeId' + '}', CGI.escape(route_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] || 'RouteDetail'

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

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

#get_routes_with_http_info(opts = {}) ⇒ Array<(Array<Route>, Integer, Hash)>

経路一覧を取得 経路の一覧を取得します。ステータスやフォルダによる絞り込みが可能です。 このAPIの実行には、ワークフローの管理権限が必要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ。1が最初のページ。 (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

  • :sort_by (String) —

    ソート。ソート可能なフィールド: createdAt, folderId

  • :status (Array<String>) —

    ステータス

  • :folder_id (String) —

    フォルダのUUID

Returns:

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

    Array<Route> data, response status code and response headers



2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
 
# File 'lib/kickflow/api/_api.rb', line 2463

def get_routes_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_routes ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DefaultApi.get_routes, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_routes, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_routes, must be greater than or equal to 1.'
  end

  allowable_values = ["visible", "error"]
  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
  # resource path
  local_var_path = '/v1/routes'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'perPage'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
  query_params[:'status'] = @api_client.build_collection_param(opts[:'status'], :multi) if !opts[:'status'].nil?
  query_params[:'folderId'] = opts[:'folder_id'] if !opts[:'folder_id'].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] || 'Array<Route>'

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

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

#get_teams_team_id(organization_chart_id, team_id, opts = {}) ⇒ TeamDetail

チームを取得 チームを一件取得します。 このAPIの実行には、チームの管理権限が必要です。

Parameters:

  • organization_chart_id (String) —

    組織図のUUID

  • team_id (String) —

    チームのUUIDまたはコード

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

    the optional parameters

Returns:



2597
2598
2599
2600
 
# File 'lib/kickflow/api/_api.rb', line 2597

def get_teams_team_id(organization_chart_id, team_id, opts = {})
  data, _status_code, _headers = get_teams_team_id_with_http_info(organization_chart_id, team_id, opts)
  data
end

#get_teams_team_id_with_http_info(organization_chart_id, team_id, opts = {}) ⇒ Array<(TeamDetail, Integer, Hash)>

チームを取得 チームを一件取得します。 このAPIの実行には、チームの管理権限が必要です。

Parameters:

  • organization_chart_id (String) —

    組織図のUUID

  • team_id (String) —

    チームのUUIDまたはコード

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

    the optional parameters

Returns:

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

    TeamDetail data, response status code and response headers



2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
 
# File 'lib/kickflow/api/_api.rb', line 2608

def get_teams_team_id_with_http_info(organization_chart_id, team_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_teams_team_id ...'
  end
  # verify the required parameter 'organization_chart_id' is set
  if @api_client.config.client_side_validation && organization_chart_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_chart_id' when calling DefaultApi.get_teams_team_id"
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling DefaultApi.get_teams_team_id"
  end
  # resource path
  local_var_path = '/v1/organizationCharts/{organizationChartId}/teams/{teamId}'.sub('{' + 'organizationChartId' + '}', CGI.escape(organization_chart_id.to_s)).sub('{' + 'teamId' + '}', CGI.escape(team_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] || 'TeamDetail'

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

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

#get_tickets(opts = {}) ⇒ Array<TicketWithStep>

チケット一覧を取得 チケットの一覧を取得します。複数の条件を組み合わせて、フィルタ可能です。 注意1：パフォーマンス上の理由から、チケットの一覧取得ではフォームの入力や承認経路などはレスポンスに含まれません。 より詳細なチケット情報を取得したい場合は、チケットを一件だけ取得するAPIをで取得してください。 注意2：APIを実行するユーザーが閲覧可能なチケットのみ取得可能です。 テナント内のすべてのチケットを対象としたい場合、APIを実行するユーザーがチケットの管理権限（閲覧）を持っている必要があります。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

  • :sort_by (String) —

    ソート。指定可能なフィールド: createdAt, updatedAt

  • :status (GetTicketsStatusParameter) —

    ステータスの配列

  • :sub_status_ids (Array<String>) —

    サブステータスのUUIDの配列

  • :workflow_id (String) —

    ワークフローのUUID

  • :author_id (String) —

    申請者のUUID

  • :author_team_full_name (String) —

    申請時に選択したチームの上位組織を含む名前

  • :ticket_number (String) —

    チケット番号

  • :created_at_start (AnyOf) —

    作成日時の起点

  • :created_at_end (AnyOf) —

    作成日時の終点

  • :updated_at_start (AnyOf) —

    更新日時の起点

  • :updated_at_end (AnyOf) —

    更新日時の終点

  • :opened_at_start (AnyOf) —

    申請日時の起点

  • :opened_at_end (AnyOf) —

    申請日時の終点

  • :completed_at_start (AnyOf) —

    完了日時の起点

  • :completed_at_end (AnyOf) —

    完了日時の終点

  • :deleted_at_start (AnyOf) —

    削除日時の起点

  • :deleted_at_end (AnyOf) —

    削除日時の終点

  • :assignee_user_id (String) —

    承認者のUUID。assigneeStatusとセットで指定してください。

  • :assignee_status (Array<String>) —

    承認者の状態。assigneeUserIdとセットで指定してください。

  • :step_title (String) —

    現在の承認ステップ名

Returns:



2686
2687
2688
2689
 
# File 'lib/kickflow/api/_api.rb', line 2686

def get_tickets(opts = {})
  data, _status_code, _headers = get_tickets_with_http_info(opts)
  data
end

#get_tickets_id_comments(ticket_id, opts = {}) ⇒ Array<Comment>

コメントの一覧を取得 チケットのコメント一覧を取得します。

Parameters:

  • ticket_id (String) —

    チケットのUUID

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

  • :sort_by (String) —

    ソート。 指定可能なフィールド: createdAt

Returns:



2807
2808
2809
2810
 
# File 'lib/kickflow/api/_api.rb', line 2807

def get_tickets_id_comments(ticket_id, opts = {})
  data, _status_code, _headers = get_tickets_id_comments_with_http_info(ticket_id, opts)
  data
end

#get_tickets_id_comments_comment_id(ticket_id, comment_id, opts = {}) ⇒ Comment

コメントを取得 チケットのコメントを取得します。

Parameters:

  • ticket_id (String) —

    チケットのUUID

  • comment_id (String) —

    コメントのUUID

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

    the optional parameters

Returns:



2889
2890
2891
2892
 
# File 'lib/kickflow/api/_api.rb', line 2889

def get_tickets_id_comments_comment_id(ticket_id, comment_id, opts = {})
  data, _status_code, _headers = get_tickets_id_comments_comment_id_with_http_info(ticket_id, comment_id, opts)
  data
end

#get_tickets_id_comments_comment_id_with_http_info(ticket_id, comment_id, opts = {}) ⇒ Array<(Comment, Integer, Hash)>

コメントを取得 チケットのコメントを取得します。

Parameters:

  • ticket_id (String) —

    チケットのUUID

  • comment_id (String) —

    コメントのUUID

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

    the optional parameters

Returns:

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

    Comment data, response status code and response headers



2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
 
# File 'lib/kickflow/api/_api.rb', line 2900

def get_tickets_id_comments_comment_id_with_http_info(ticket_id, comment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_tickets_id_comments_comment_id ...'
  end
  # verify the required parameter 'ticket_id' is set
  if @api_client.config.client_side_validation && ticket_id.nil?
    fail ArgumentError, "Missing the required parameter 'ticket_id' when calling DefaultApi.get_tickets_id_comments_comment_id"
  end
  # verify the required parameter 'comment_id' is set
  if @api_client.config.client_side_validation && comment_id.nil?
    fail ArgumentError, "Missing the required parameter 'comment_id' when calling DefaultApi.get_tickets_id_comments_comment_id"
  end
  # resource path
  local_var_path = '/v1/tickets/{ticketId}/comments/{commentId}'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_id.to_s)).sub('{' + 'commentId' + '}', CGI.escape(comment_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] || 'Comment'

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

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

#get_tickets_id_comments_with_http_info(ticket_id, opts = {}) ⇒ Array<(Array<Comment>, Integer, Hash)>

コメントの一覧を取得 チケットのコメント一覧を取得します。

Parameters:

  • ticket_id (String) —

    チケットのUUID

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

  • :sort_by (String) —

    ソート。 指定可能なフィールド: createdAt

Returns:

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

    Array<Comment> data, response status code and response headers



2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
 
# File 'lib/kickflow/api/_api.rb', line 2820

def get_tickets_id_comments_with_http_info(ticket_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_tickets_id_comments ...'
  end
  # verify the required parameter 'ticket_id' is set
  if @api_client.config.client_side_validation && ticket_id.nil?
    fail ArgumentError, "Missing the required parameter 'ticket_id' when calling DefaultApi.get_tickets_id_comments"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DefaultApi.get_tickets_id_comments, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_tickets_id_comments, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_tickets_id_comments, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/tickets/{ticketId}/comments'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'perPage'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].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] || 'Array<Comment>'

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

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

#get_tickets_id_viewers(ticket_id, opts = {}) ⇒ Array<TicketViewer>

閲覧者の一覧を取得 チケットの閲覧者一覧を取得します。

Parameters:

  • ticket_id (String) —

    チケットのUUID

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

  • :sort_by (String) —

    ソート。 指定可能なフィールド: createdAt

Returns:



2960
2961
2962
2963
 
# File 'lib/kickflow/api/_api.rb', line 2960

def get_tickets_id_viewers(ticket_id, opts = {})
  data, _status_code, _headers = get_tickets_id_viewers_with_http_info(ticket_id, opts)
  data
end

#get_tickets_id_viewers_with_http_info(ticket_id, opts = {}) ⇒ Array<(Array<TicketViewer>, Integer, Hash)>

閲覧者の一覧を取得 チケットの閲覧者一覧を取得します。

Parameters:

  • ticket_id (String) —

    チケットのUUID

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

  • :sort_by (String) —

    ソート。 指定可能なフィールド: createdAt

Returns:

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

    Array<TicketViewer> data, response status code and response headers



2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
 
# File 'lib/kickflow/api/_api.rb', line 2973

def get_tickets_id_viewers_with_http_info(ticket_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_tickets_id_viewers ...'
  end
  # verify the required parameter 'ticket_id' is set
  if @api_client.config.client_side_validation && ticket_id.nil?
    fail ArgumentError, "Missing the required parameter 'ticket_id' when calling DefaultApi.get_tickets_id_viewers"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DefaultApi.get_tickets_id_viewers, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_tickets_id_viewers, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_tickets_id_viewers, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/tickets/{ticketId}/viewers'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'perPage'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].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] || 'Array<TicketViewer>'

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

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

#get_tickets_tasks(opts = {}) ⇒ Array<TicketWithStep>

承認リクエスト一覧を取得 現在のユーザーにアサインされている承認リクエストの一覧を取得します。複数の条件を組み合わせて、フィルタ可能です。 注意：パフォーマンス上の理由から、チケットの一覧取得ではフォームの入力や承認経路などはレスポンスに含まれません。 より詳細なチケット情報を取得したい場合は、チケットを一件だけ取得するAPIをで取得してください。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

  • :sort_by (String) —

    ソート。指定可能なフィールド: createdAt, updatedAt

  • :status (Array<String>) —

    ステータスの配列

  • :sub_status_ids (Array<String>) —

    サブステータスのUUIDの配列

  • :workflow_id (String) —

    ワークフローのUUID

  • :author_id (String) —

    申請者のUUID

  • :author_team_full_name (String) —

    申請時に選択したチームの上位組織を含む名前

  • :ticket_number (String) —

    チケット番号

  • :created_at_start (Time) —

    作成日時の起点

  • :created_at_end (Time) —

    作成日時の終点

  • :updated_at_start (Time) —

    更新日時の起点

  • :updated_at_end (Time) —

    更新日時の終点

  • :opened_at_start (Time) —

    申請日時の起点

  • :opened_at_end (Time) —

    申請日時の終点

  • :completed_at_start (Time) —

    完了日時の起点

  • :completed_at_end (Time) —

    完了日時の終点

  • :deleted_at_start (Time) —

    削除日時の起点

  • :deleted_at_end (Time) —

    削除日時の終点

  • :step_title (String) —

    現在の承認ステップ名

Returns:



3060
3061
3062
3063
 
# File 'lib/kickflow/api/_api.rb', line 3060

def get_tickets_tasks(opts = {})
  data, _status_code, _headers = get_tickets_tasks_with_http_info(opts)
  data
end

#get_tickets_tasks_with_http_info(opts = {}) ⇒ Array<(Array<TicketWithStep>, Integer, Hash)>

承認リクエスト一覧を取得 現在のユーザーにアサインされている承認リクエストの一覧を取得します。複数の条件を組み合わせて、フィルタ可能です。 注意：パフォーマンス上の理由から、チケットの一覧取得ではフォームの入力や承認経路などはレスポンスに含まれません。 より詳細なチケット情報を取得したい場合は、チケットを一件だけ取得するAPIをで取得してください。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

  • :sort_by (String) —

    ソート。指定可能なフィールド: createdAt, updatedAt

  • :status (Array<String>) —

    ステータスの配列

  • :sub_status_ids (Array<String>) —

    サブステータスのUUIDの配列

  • :workflow_id (String) —

    ワークフローのUUID

  • :author_id (String) —

    申請者のUUID

  • :author_team_full_name (String) —

    申請時に選択したチームの上位組織を含む名前

  • :ticket_number (String) —

    チケット番号

  • :created_at_start (Time) —

    作成日時の起点

  • :created_at_end (Time) —

    作成日時の終点

  • :updated_at_start (Time) —

    更新日時の起点

  • :updated_at_end (Time) —

    更新日時の終点

  • :opened_at_start (Time) —

    申請日時の起点

  • :opened_at_end (Time) —

    申請日時の終点

  • :completed_at_start (Time) —

    完了日時の起点

  • :completed_at_end (Time) —

    完了日時の終点

  • :deleted_at_start (Time) —

    削除日時の起点

  • :deleted_at_end (Time) —

    削除日時の終点

  • :step_title (String) —

    現在の承認ステップ名

Returns:

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

    Array<TicketWithStep> data, response status code and response headers



3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
 
# File 'lib/kickflow/api/_api.rb', line 3089

def get_tickets_tasks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_tickets_tasks ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DefaultApi.get_tickets_tasks, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_tickets_tasks, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_tickets_tasks, must be greater than or equal to 1.'
  end

  allowable_values = ["draft", "in_progress", "rejected", "completed", "deleted"]
  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
  # resource path
  local_var_path = '/v1/tickets/tasks'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'perPage'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
  query_params[:'status'] = @api_client.build_collection_param(opts[:'status'], :multi) if !opts[:'status'].nil?
  query_params[:'subStatusIds'] = @api_client.build_collection_param(opts[:'sub_status_ids'], :multi) if !opts[:'sub_status_ids'].nil?
  query_params[:'workflowId'] = opts[:'workflow_id'] if !opts[:'workflow_id'].nil?
  query_params[:'authorId'] = opts[:'author_id'] if !opts[:'author_id'].nil?
  query_params[:'authorTeamFullName'] = opts[:'author_team_full_name'] if !opts[:'author_team_full_name'].nil?
  query_params[:'ticketNumber'] = opts[:'ticket_number'] if !opts[:'ticket_number'].nil?
  query_params[:'createdAtStart'] = opts[:'created_at_start'] if !opts[:'created_at_start'].nil?
  query_params[:'createdAtEnd'] = opts[:'created_at_end'] if !opts[:'created_at_end'].nil?
  query_params[:'updatedAtStart'] = opts[:'updated_at_start'] if !opts[:'updated_at_start'].nil?
  query_params[:'updatedAtEnd'] = opts[:'updated_at_end'] if !opts[:'updated_at_end'].nil?
  query_params[:'openedAtStart'] = opts[:'opened_at_start'] if !opts[:'opened_at_start'].nil?
  query_params[:'openedAtEnd'] = opts[:'opened_at_end'] if !opts[:'opened_at_end'].nil?
  query_params[:'completedAtStart'] = opts[:'completed_at_start'] if !opts[:'completed_at_start'].nil?
  query_params[:'completedAtEnd'] = opts[:'completed_at_end'] if !opts[:'completed_at_end'].nil?
  query_params[:'deletedAtStart'] = opts[:'deleted_at_start'] if !opts[:'deleted_at_start'].nil?
  query_params[:'deletedAtEnd'] = opts[:'deleted_at_end'] if !opts[:'deleted_at_end'].nil?
  query_params[:'stepTitle'] = opts[:'step_title'] if !opts[:'step_title'].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] || 'Array<TicketWithStep>'

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

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

#get_tickets_ticket_id(ticket_id, opts = {}) ⇒ TicketDetail

チケットを取得 チケットを一件取得します。フォームの入力や承認経路などを含む詳細なデータを返します。

Parameters:

  • ticket_id (String) —

    チケットのUUID

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

    the optional parameters

Returns:



3174
3175
3176
3177
 
# File 'lib/kickflow/api/_api.rb', line 3174

def get_tickets_ticket_id(ticket_id, opts = {})
  data, _status_code, _headers = get_tickets_ticket_id_with_http_info(ticket_id, opts)
  data
end

#get_tickets_ticket_id_links(ticket_id, opts = {}) ⇒ Array<Ticket>

チケットの関連チケットを取得する 指定したチケットの関連チケットを取得します。

Parameters:

  • ticket_id (String) —

    チケットのUUID

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

Returns:



3239
3240
3241
3242
 
# File 'lib/kickflow/api/_api.rb', line 3239

def get_tickets_ticket_id_links(ticket_id, opts = {})
  data, _status_code, _headers = get_tickets_ticket_id_links_with_http_info(ticket_id, opts)
  data
end

#get_tickets_ticket_id_links_with_http_info(ticket_id, opts = {}) ⇒ Array<(Array<Ticket>, Integer, Hash)>

チケットの関連チケットを取得する 指定したチケットの関連チケットを取得します。

Parameters:

  • ticket_id (String) —

    チケットのUUID

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

Returns:

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

    Array<Ticket> data, response status code and response headers



3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
 
# File 'lib/kickflow/api/_api.rb', line 3251

def get_tickets_ticket_id_links_with_http_info(ticket_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_tickets_ticket_id_links ...'
  end
  # verify the required parameter 'ticket_id' is set
  if @api_client.config.client_side_validation && ticket_id.nil?
    fail ArgumentError, "Missing the required parameter 'ticket_id' when calling DefaultApi.get_tickets_ticket_id_links"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DefaultApi.get_tickets_ticket_id_links, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_tickets_ticket_id_links, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_tickets_ticket_id_links, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/tickets/{ticketId}/links'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'perPage'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'Array<Ticket>'

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

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

#get_tickets_ticket_id_with_http_info(ticket_id, opts = {}) ⇒ Array<(TicketDetail, Integer, Hash)>

チケットを取得 チケットを一件取得します。フォームの入力や承認経路などを含む詳細なデータを返します。

Parameters:

  • ticket_id (String) —

    チケットのUUID

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

    the optional parameters

Returns:

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

    TicketDetail data, response status code and response headers



3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
 
# File 'lib/kickflow/api/_api.rb', line 3184

def get_tickets_ticket_id_with_http_info(ticket_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_tickets_ticket_id ...'
  end
  # verify the required parameter 'ticket_id' is set
  if @api_client.config.client_side_validation && ticket_id.nil?
    fail ArgumentError, "Missing the required parameter 'ticket_id' when calling DefaultApi.get_tickets_ticket_id"
  end
  # resource path
  local_var_path = '/v1/tickets/{ticketId}'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_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] || 'TicketDetail'

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

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

#get_tickets_with_http_info(opts = {}) ⇒ Array<(Array<TicketWithStep>, Integer, Hash)>

チケット一覧を取得 チケットの一覧を取得します。複数の条件を組み合わせて、フィルタ可能です。 注意1：パフォーマンス上の理由から、チケットの一覧取得ではフォームの入力や承認経路などはレスポンスに含まれません。 より詳細なチケット情報を取得したい場合は、チケットを一件だけ取得するAPIをで取得してください。 注意2：APIを実行するユーザーが閲覧可能なチケットのみ取得可能です。 テナント内のすべてのチケットを対象としたい場合、APIを実行するユーザーがチケットの管理権限（閲覧）を持っている必要があります。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

  • :sort_by (String) —

    ソート。指定可能なフィールド: createdAt, updatedAt

  • :status (GetTicketsStatusParameter) —

    ステータスの配列

  • :sub_status_ids (Array<String>) —

    サブステータスのUUIDの配列

  • :workflow_id (String) —

    ワークフローのUUID

  • :author_id (String) —

    申請者のUUID

  • :author_team_full_name (String) —

    申請時に選択したチームの上位組織を含む名前

  • :ticket_number (String) —

    チケット番号

  • :created_at_start (AnyOf) —

    作成日時の起点

  • :created_at_end (AnyOf) —

    作成日時の終点

  • :updated_at_start (AnyOf) —

    更新日時の起点

  • :updated_at_end (AnyOf) —

    更新日時の終点

  • :opened_at_start (AnyOf) —

    申請日時の起点

  • :opened_at_end (AnyOf) —

    申請日時の終点

  • :completed_at_start (AnyOf) —

    完了日時の起点

  • :completed_at_end (AnyOf) —

    完了日時の終点

  • :deleted_at_start (AnyOf) —

    削除日時の起点

  • :deleted_at_end (AnyOf) —

    削除日時の終点

  • :assignee_user_id (String) —

    承認者のUUID。assigneeStatusとセットで指定してください。

  • :assignee_status (Array<String>) —

    承認者の状態。assigneeUserIdとセットで指定してください。

  • :step_title (String) —

    現在の承認ステップ名

Returns:

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

    Array<TicketWithStep> data, response status code and response headers



2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
 
# File 'lib/kickflow/api/_api.rb', line 2717

def get_tickets_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_tickets ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DefaultApi.get_tickets, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_tickets, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_tickets, must be greater than or equal to 1.'
  end

  allowable_values = ["all", "current", "approved"]
  if @api_client.config.client_side_validation && opts[:'assignee_status'] && !opts[:'assignee_status'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"assignee_status\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/tickets'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'perPage'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'subStatusIds'] = @api_client.build_collection_param(opts[:'sub_status_ids'], :multi) if !opts[:'sub_status_ids'].nil?
  query_params[:'workflowId'] = opts[:'workflow_id'] if !opts[:'workflow_id'].nil?
  query_params[:'authorId'] = opts[:'author_id'] if !opts[:'author_id'].nil?
  query_params[:'authorTeamFullName'] = opts[:'author_team_full_name'] if !opts[:'author_team_full_name'].nil?
  query_params[:'ticketNumber'] = opts[:'ticket_number'] if !opts[:'ticket_number'].nil?
  query_params[:'createdAtStart'] = opts[:'created_at_start'] if !opts[:'created_at_start'].nil?
  query_params[:'createdAtEnd'] = opts[:'created_at_end'] if !opts[:'created_at_end'].nil?
  query_params[:'updatedAtStart'] = opts[:'updated_at_start'] if !opts[:'updated_at_start'].nil?
  query_params[:'updatedAtEnd'] = opts[:'updated_at_end'] if !opts[:'updated_at_end'].nil?
  query_params[:'openedAtStart'] = opts[:'opened_at_start'] if !opts[:'opened_at_start'].nil?
  query_params[:'openedAtEnd'] = opts[:'opened_at_end'] if !opts[:'opened_at_end'].nil?
  query_params[:'completedAtStart'] = opts[:'completed_at_start'] if !opts[:'completed_at_start'].nil?
  query_params[:'completedAtEnd'] = opts[:'completed_at_end'] if !opts[:'completed_at_end'].nil?
  query_params[:'deletedAtStart'] = opts[:'deleted_at_start'] if !opts[:'deleted_at_start'].nil?
  query_params[:'deletedAtEnd'] = opts[:'deleted_at_end'] if !opts[:'deleted_at_end'].nil?
  query_params[:'assigneeUserId'] = opts[:'assignee_user_id'] if !opts[:'assignee_user_id'].nil?
  query_params[:'assigneeStatus'] = @api_client.build_collection_param(opts[:'assignee_status'], :multi) if !opts[:'assignee_status'].nil?
  query_params[:'stepTitle'] = opts[:'step_title'] if !opts[:'step_title'].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] || 'Array<TicketWithStep>'

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

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

#get_user(opts = {}) ⇒ UserDetail

現在のユーザーを取得 現在のユーザーを取得します。

Parameters:

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

    the optional parameters

Returns:



3317
3318
3319
3320
 
# File 'lib/kickflow/api/_api.rb', line 3317

def get_user(opts = {})
  data, _status_code, _headers = get_user_with_http_info(opts)
  data
end

#get_user_with_http_info(opts = {}) ⇒ Array<(UserDetail, Integer, Hash)>

現在のユーザーを取得 現在のユーザーを取得します。

Parameters:

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

    the optional parameters

Returns:

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

    UserDetail data, response status code and response headers



3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
 
# File 'lib/kickflow/api/_api.rb', line 3326

def get_user_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_user ...'
  end
  # resource path
  local_var_path = '/v1/user'

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

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

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

#get_users(opts = {}) ⇒ Array<User>

ユーザー一覧を取得 ユーザー一覧を取得します。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

  • :status (Array<String>) —

    ステータスによる絞り込み

  • :sort_by (String) —

    ソート。 指定可能なフィールド: email, code

Returns:



3378
3379
3380
3381
 
# File 'lib/kickflow/api/_api.rb', line 3378

def get_users(opts = {})
  data, _status_code, _headers = get_users_with_http_info(opts)
  data
end

#get_users_lookup_by_email(email, opts = {}) ⇒ UserDetail

メールアドレスからユーザーを取得 メールアドレスからユーザーを取得します（完全一致） ※メールアドレスはURLエンコードしたものを送ってください。

Parameters:

  • email (String) —

    メールアドレス（URLエンコードを行ったもの）

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

    the optional parameters

Returns:



3460
3461
3462
3463
 
# File 'lib/kickflow/api/_api.rb', line 3460

def get_users_lookup_by_email(email, opts = {})
  data, _status_code, _headers = get_users_lookup_by_email_with_http_info(email, opts)
  data
end

#get_users_lookup_by_email_with_http_info(email, opts = {}) ⇒ Array<(UserDetail, Integer, Hash)>

メールアドレスからユーザーを取得 メールアドレスからユーザーを取得します（完全一致） ※メールアドレスはURLエンコードしたものを送ってください。

Parameters:

  • email (String) —

    メールアドレス（URLエンコードを行ったもの）

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

    the optional parameters

Returns:

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

    UserDetail data, response status code and response headers



3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
 
# File 'lib/kickflow/api/_api.rb', line 3470

def get_users_lookup_by_email_with_http_info(email, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_users_lookup_by_email ...'
  end
  # verify the required parameter 'email' is set
  if @api_client.config.client_side_validation && email.nil?
    fail ArgumentError, "Missing the required parameter 'email' when calling DefaultApi.get_users_lookup_by_email"
  end
  # resource path
  local_var_path = '/v1/users/lookupByEmail'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'email'] = email

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

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

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

#get_users_user_id(user_id, opts = {}) ⇒ UserDetail

ユーザーを取得 ユーザーを一件取得します。

Parameters:

  • user_id (String) —

    ユーザーのUUIDまたはコード

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

    the optional parameters

Returns:



3524
3525
3526
3527
 
# File 'lib/kickflow/api/_api.rb', line 3524

def get_users_user_id(user_id, opts = {})
  data, _status_code, _headers = get_users_user_id_with_http_info(user_id, opts)
  data
end

#get_users_user_id_roles(user_id, opts = {}) ⇒ Array<Role>

ユーザーの管理者ロール一覧を取得 ユーザーの管理者ロール一覧を取得します。 このAPIの実行には、ロールの管理権限が必要です。

Parameters:

  • user_id (String) —

    ユーザーのUUIDまたはコード

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

Returns:



3589
3590
3591
3592
 
# File 'lib/kickflow/api/_api.rb', line 3589

def get_users_user_id_roles(user_id, opts = {})
  data, _status_code, _headers = get_users_user_id_roles_with_http_info(user_id, opts)
  data
end

#get_users_user_id_roles_with_http_info(user_id, opts = {}) ⇒ Array<(Array<Role>, Integer, Hash)>

ユーザーの管理者ロール一覧を取得 ユーザーの管理者ロール一覧を取得します。 このAPIの実行には、ロールの管理権限が必要です。

Parameters:

  • user_id (String) —

    ユーザーのUUIDまたはコード

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

Returns:

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

    Array<Role> data, response status code and response headers



3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
 
# File 'lib/kickflow/api/_api.rb', line 3601

def get_users_user_id_roles_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_users_user_id_roles ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.get_users_user_id_roles"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DefaultApi.get_users_user_id_roles, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_users_user_id_roles, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_users_user_id_roles, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/users/{userId}/roles'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'perPage'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'Array<Role>'

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

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

#get_users_user_id_teams(user_id, opts = {}) ⇒ Array<Team>

ユーザーの所属チーム一覧を取得 ユーザーの所属チーム一覧を取得します。 このAPIの実行には、チームの管理権限が必要です。

Parameters:

  • user_id (String) —

    ユーザーのUUIDまたはコード

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

  • :submittable (Boolean) —

    trueの場合、申請可能なチームのみ返す。デフォルトはfalse（すべてのチームを返す）

Returns:



3671
3672
3673
3674
 
# File 'lib/kickflow/api/_api.rb', line 3671

def get_users_user_id_teams(user_id, opts = {})
  data, _status_code, _headers = get_users_user_id_teams_with_http_info(user_id, opts)
  data
end

#get_users_user_id_teams_with_http_info(user_id, opts = {}) ⇒ Array<(Array<Team>, Integer, Hash)>

ユーザーの所属チーム一覧を取得 ユーザーの所属チーム一覧を取得します。 このAPIの実行には、チームの管理権限が必要です。

Parameters:

  • user_id (String) —

    ユーザーのUUIDまたはコード

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

  • :submittable (Boolean) —

    trueの場合、申請可能なチームのみ返す。デフォルトはfalse（すべてのチームを返す）

Returns:

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

    Array<Team> data, response status code and response headers



3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
 
# File 'lib/kickflow/api/_api.rb', line 3684

def get_users_user_id_teams_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_users_user_id_teams ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.get_users_user_id_teams"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DefaultApi.get_users_user_id_teams, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_users_user_id_teams, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_users_user_id_teams, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/users/{userId}/teams'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'perPage'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'submittable'] = opts[:'submittable'] if !opts[:'submittable'].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] || 'Array<Team>'

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

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

#get_users_user_id_with_http_info(user_id, opts = {}) ⇒ Array<(UserDetail, Integer, Hash)>

ユーザーを取得 ユーザーを一件取得します。

Parameters:

  • user_id (String) —

    ユーザーのUUIDまたはコード

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

    the optional parameters

Returns:

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

    UserDetail data, response status code and response headers



3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
 
# File 'lib/kickflow/api/_api.rb', line 3534

def get_users_user_id_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_users_user_id ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.get_users_user_id"
  end
  # resource path
  local_var_path = '/v1/users/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_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] || 'UserDetail'

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

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

#get_users_with_http_info(opts = {}) ⇒ Array<(Array<User>, Integer, Hash)>

ユーザー一覧を取得 ユーザー一覧を取得します。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

  • :status (Array<String>) —

    ステータスによる絞り込み

  • :sort_by (String) —

    ソート。 指定可能なフィールド: email, code

Returns:

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

    Array<User> data, response status code and response headers



3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
 
# File 'lib/kickflow/api/_api.rb', line 3391

def get_users_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_users ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DefaultApi.get_users, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_users, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_users, must be greater than or equal to 1.'
  end

  allowable_values = ["invited", "activated", "suspended", "deactivated"]
  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
  # resource path
  local_var_path = '/v1/users'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'perPage'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'status'] = @api_client.build_collection_param(opts[:'status'], :multi) if !opts[:'status'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].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] || 'Array<User>'

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

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

#get_workflows(opts = {}) ⇒ Array<Workflow>

ワークフロー一覧を取得 ワークフローの一覧を取得します。ステータスによる絞り込みが可能です。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ。1が最初のページ。 (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

  • :sort_by (String) —

    ソート。ソート可能なフィールド: createdAt, updatedAt, name, status

  • :status (Array<String>) —

    ステータス

Returns:



3755
3756
3757
3758
 
# File 'lib/kickflow/api/_api.rb', line 3755

def get_workflows(opts = {})
  data, _status_code, _headers = get_workflows_with_http_info(opts)
  data
end

#get_workflows_with_http_info(opts = {}) ⇒ Array<(Array<Workflow>, Integer, Hash)>

ワークフロー一覧を取得 ワークフローの一覧を取得します。ステータスによる絞り込みが可能です。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    ページ。1が最初のページ。 (default to 1)

  • :per_page (Integer) —

    1ページあたりの件数 (default to 25)

  • :sort_by (String) —

    ソート。ソート可能なフィールド: createdAt, updatedAt, name, status

  • :status (Array<String>) —

    ステータス

Returns:

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

    Array<Workflow> data, response status code and response headers



3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
 
# File 'lib/kickflow/api/_api.rb', line 3768

def get_workflows_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_workflows ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DefaultApi.get_workflows, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_workflows, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.get_workflows, must be greater than or equal to 1.'
  end

  allowable_values = ["visible", "invisible"]
  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
  # resource path
  local_var_path = '/v1/workflows'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'perPage'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
  query_params[:'status'] = @api_client.build_collection_param(opts[:'status'], :multi) if !opts[:'status'].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] || 'Array<Workflow>'

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

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

#get_workflows_workflow_id(workflow_id, opts = {}) ⇒ WorkflowDetail

ワークフローを取得 指定したIDのワークフローを取得します。

Parameters:

  • workflow_id (String) —

    ワークフローのUUIDまたはコード

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

    the optional parameters

Returns:



3837
3838
3839
3840
 
# File 'lib/kickflow/api/_api.rb', line 3837

def get_workflows_workflow_id(workflow_id, opts = {})
  data, _status_code, _headers = get_workflows_workflow_id_with_http_info(workflow_id, opts)
  data
end

#get_workflows_workflow_id_with_http_info(workflow_id, opts = {}) ⇒ Array<(WorkflowDetail, Integer, Hash)>

ワークフローを取得 指定したIDのワークフローを取得します。

Parameters:

  • workflow_id (String) —

    ワークフローのUUIDまたはコード

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

    the optional parameters

Returns:

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

    WorkflowDetail data, response status code and response headers



3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
 
# File 'lib/kickflow/api/_api.rb', line 3847

def get_workflows_workflow_id_with_http_info(workflow_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_workflows_workflow_id ...'
  end
  # verify the required parameter 'workflow_id' is set
  if @api_client.config.client_side_validation && workflow_id.nil?
    fail ArgumentError, "Missing the required parameter 'workflow_id' when calling DefaultApi.get_workflows_workflow_id"
  end
  # resource path
  local_var_path = '/v1/workflows/{workflowId}'.sub('{' + 'workflowId' + '}', CGI.escape(workflow_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] || 'WorkflowDetail'

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

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

#patch_categories_category_id(category_id, opts = {}) ⇒ Category

カテゴリを更新 カテゴリを更新します。 このAPIの実行には、ワークフローの管理権限が必要です。

Parameters:

  • category_id (String) —

    カテゴリのUUID

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

    the optional parameters

Options Hash (opts):

Returns:



3901
3902
3903
3904
 
# File 'lib/kickflow/api/_api.rb', line 3901

def patch_categories_category_id(category_id, opts = {})
  data, _status_code, _headers = patch_categories_category_id_with_http_info(category_id, opts)
  data
end

#patch_categories_category_id_with_http_info(category_id, opts = {}) ⇒ Array<(Category, Integer, Hash)>

カテゴリを更新 カテゴリを更新します。 このAPIの実行には、ワークフローの管理権限が必要です。

Parameters:

  • category_id (String) —

    カテゴリのUUID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Category data, response status code and response headers



3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
 
# File 'lib/kickflow/api/_api.rb', line 3912

def patch_categories_category_id_with_http_info(category_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.patch_categories_category_id ...'
  end
  # verify the required parameter 'category_id' is set
  if @api_client.config.client_side_validation && category_id.nil?
    fail ArgumentError, "Missing the required parameter 'category_id' when calling DefaultApi.patch_categories_category_id"
  end
  # resource path
  local_var_path = '/v1/categories/{categoryId}'.sub('{' + 'categoryId' + '}', CGI.escape(category_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#patch_folders_folder_id(folder_id, opts = {}) ⇒ FolderDetail

フォルダを更新 フォルダを更新します。 このAPIの実行には、ワークフローの管理権限が必要です。

Parameters:

  • folder_id (String) —

    フォルダのUUIDまたはコード

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

    the optional parameters

Options Hash (opts):

Returns:



3971
3972
3973
3974
 
# File 'lib/kickflow/api/_api.rb', line 3971

def patch_folders_folder_id(folder_id, opts = {})
  data, _status_code, _headers = patch_folders_folder_id_with_http_info(folder_id, opts)
  data
end

#patch_folders_folder_id_with_http_info(folder_id, opts = {}) ⇒ Array<(FolderDetail, Integer, Hash)>

フォルダを更新 フォルダを更新します。 このAPIの実行には、ワークフローの管理権限が必要です。

Parameters:

  • folder_id (String) —

    フォルダのUUIDまたはコード

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

    the optional parameters

Options Hash (opts):

Returns:

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

    FolderDetail data, response status code and response headers



3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
 
# File 'lib/kickflow/api/_api.rb', line 3982

def patch_folders_folder_id_with_http_info(folder_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.patch_folders_folder_id ...'
  end
  # verify the required parameter 'folder_id' is set
  if @api_client.config.client_side_validation && folder_id.nil?
    fail ArgumentError, "Missing the required parameter 'folder_id' when calling DefaultApi.patch_folders_folder_id"
  end
  # resource path
  local_var_path = '/v1/folders/{folderId}'.sub('{' + 'folderId' + '}', CGI.escape(folder_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#patch_general_masters_general_master_id(general_master_id, opts = {}) ⇒ GeneralMaster

汎用マスタを更新 汎用マスタを更新します。 このAPIの実行には、汎用マスタの管理権限が必要です。

Parameters:

  • general_master_id (String) —

    汎用マスタのUUIDまたはコード

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

    the optional parameters

Options Hash (opts):

Returns:



4041
4042
4043
4044
 
# File 'lib/kickflow/api/_api.rb', line 4041

def patch_general_masters_general_master_id(general_master_id, opts = {})
  data, _status_code, _headers = patch_general_masters_general_master_id_with_http_info(general_master_id, opts)
  data
end

#patch_general_masters_general_master_id_items_item_id(general_master_id, item_id, opts = {}) ⇒ GeneralMasterItem

汎用マスタアイテムを更新 汎用マスタアイテムを更新します。 このAPIの実行には、汎用マスタの管理権限が必要です。

Parameters:

  • general_master_id (String) —

    汎用マスタのUUIDまたはコード

  • item_id (String) —

    汎用マスタアイテムのUUIDまたはコード

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

    the optional parameters

Options Hash (opts):

Returns:



4112
4113
4114
4115
 
# File 'lib/kickflow/api/_api.rb', line 4112

def patch_general_masters_general_master_id_items_item_id(general_master_id, item_id, opts = {})
  data, _status_code, _headers = patch_general_masters_general_master_id_items_item_id_with_http_info(general_master_id, item_id, opts)
  data
end

#patch_general_masters_general_master_id_items_item_id_with_http_info(general_master_id, item_id, opts = {}) ⇒ Array<(GeneralMasterItem, Integer, Hash)>

汎用マスタアイテムを更新 汎用マスタアイテムを更新します。 このAPIの実行には、汎用マスタの管理権限が必要です。

Parameters:

  • general_master_id (String) —

    汎用マスタのUUIDまたはコード

  • item_id (String) —

    汎用マスタアイテムのUUIDまたはコード

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

    the optional parameters

Options Hash (opts):

Returns:

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

    GeneralMasterItem data, response status code and response headers



4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
 
# File 'lib/kickflow/api/_api.rb', line 4124

def patch_general_masters_general_master_id_items_item_id_with_http_info(general_master_id, item_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.patch_general_masters_general_master_id_items_item_id ...'
  end
  # verify the required parameter 'general_master_id' is set
  if @api_client.config.client_side_validation && general_master_id.nil?
    fail ArgumentError, "Missing the required parameter 'general_master_id' when calling DefaultApi.patch_general_masters_general_master_id_items_item_id"
  end
  # verify the required parameter 'item_id' is set
  if @api_client.config.client_side_validation && item_id.nil?
    fail ArgumentError, "Missing the required parameter 'item_id' when calling DefaultApi.patch_general_masters_general_master_id_items_item_id"
  end
  # resource path
  local_var_path = '/v1/generalMasters/{generalMasterId}/items/{itemId}'.sub('{' + 'generalMasterId' + '}', CGI.escape(general_master_id.to_s)).sub('{' + 'itemId' + '}', CGI.escape(item_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#patch_general_masters_general_master_id_with_http_info(general_master_id, opts = {}) ⇒ Array<(GeneralMaster, Integer, Hash)>

汎用マスタを更新 汎用マスタを更新します。 このAPIの実行には、汎用マスタの管理権限が必要です。

Parameters:

  • general_master_id (String) —

    汎用マスタのUUIDまたはコード

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

    the optional parameters

Options Hash (opts):

Returns:

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

    GeneralMaster data, response status code and response headers



4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
 
# File 'lib/kickflow/api/_api.rb', line 4052

def patch_general_masters_general_master_id_with_http_info(general_master_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.patch_general_masters_general_master_id ...'
  end
  # verify the required parameter 'general_master_id' is set
  if @api_client.config.client_side_validation && general_master_id.nil?
    fail ArgumentError, "Missing the required parameter 'general_master_id' when calling DefaultApi.patch_general_masters_general_master_id"
  end
  # resource path
  local_var_path = '/v1/generalMasters/{generalMasterId}'.sub('{' + 'generalMasterId' + '}', CGI.escape(general_master_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#patch_grades_grade_id(grade_id, opts = {}) ⇒ Grade

役職を更新 役職を更新します。 このAPIの実行には、ユーザーの管理権限が必要です。

Parameters:

  • grade_id (String) —

    役職のUUIDまたはコード

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

    the optional parameters

Options Hash (opts):

Returns:



4187
4188
4189
4190
 
# File 'lib/kickflow/api/_api.rb', line 4187

def patch_grades_grade_id(grade_id, opts = {})
  data, _status_code, _headers = patch_grades_grade_id_with_http_info(grade_id, opts)
  data
end

#patch_grades_grade_id_with_http_info(grade_id, opts = {}) ⇒ Array<(Grade, Integer, Hash)>

役職を更新 役職を更新します。 このAPIの実行には、ユーザーの管理権限が必要です。

Parameters:

  • grade_id (String) —

    役職のUUIDまたはコード

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Grade data, response status code and response headers



4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
 
# File 'lib/kickflow/api/_api.rb', line 4198

def patch_grades_grade_id_with_http_info(grade_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.patch_grades_grade_id ...'
  end
  # verify the required parameter 'grade_id' is set
  if @api_client.config.client_side_validation && grade_id.nil?
    fail ArgumentError, "Missing the required parameter 'grade_id' when calling DefaultApi.patch_grades_grade_id"
  end
  # resource path
  local_var_path = '/v1/grades/{gradeId}'.sub('{' + 'gradeId' + '}', CGI.escape(grade_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#patch_organization_charts_organization_chart_id(organization_chart_id, opts = {}) ⇒ OrganizationChartDetail

組織図を更新 組織図を更新します。 このAPIの実行には、チームの管理権限が必要です。

Parameters:

  • organization_chart_id (String) —

    組織図のUUID

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

    the optional parameters

Options Hash (opts):

Returns:



4257
4258
4259
4260
 
# File 'lib/kickflow/api/_api.rb', line 4257

def patch_organization_charts_organization_chart_id(organization_chart_id, opts = {})
  data, _status_code, _headers = patch_organization_charts_organization_chart_id_with_http_info(organization_chart_id, opts)
  data
end

#patch_organization_charts_organization_chart_id_with_http_info(organization_chart_id, opts = {}) ⇒ Array<(OrganizationChartDetail, Integer, Hash)>

組織図を更新 組織図を更新します。 このAPIの実行には、チームの管理権限が必要です。

Parameters:

  • organization_chart_id (String) —

    組織図のUUID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    OrganizationChartDetail data, response status code and response headers



4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
 
# File 'lib/kickflow/api/_api.rb', line 4268

def patch_organization_charts_organization_chart_id_with_http_info(organization_chart_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.patch_organization_charts_organization_chart_id ...'
  end
  # verify the required parameter 'organization_chart_id' is set
  if @api_client.config.client_side_validation && organization_chart_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_chart_id' when calling DefaultApi.patch_organization_charts_organization_chart_id"
  end
  # resource path
  local_var_path = '/v1/organizationCharts/{organizationChartId}'.sub('{' + 'organizationChartId' + '}', CGI.escape(organization_chart_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#patch_roles_role_id(role_id, opts = {}) ⇒ RoleDetail

管理者ロールを更新 管理者ロールを更新します。 このAPIの実行には、ロールの管理権限が必要です。

Parameters:

  • role_id (String) —

    管理者ロールのUUID

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

    the optional parameters

Options Hash (opts):

Returns:



4327
4328
4329
4330
 
# File 'lib/kickflow/api/_api.rb', line 4327

def patch_roles_role_id(role_id, opts = {})
  data, _status_code, _headers = patch_roles_role_id_with_http_info(role_id, opts)
  data
end

#patch_roles_role_id_with_http_info(role_id, opts = {}) ⇒ Array<(RoleDetail, Integer, Hash)>

管理者ロールを更新 管理者ロールを更新します。 このAPIの実行には、ロールの管理権限が必要です。

Parameters:

  • role_id (String) —

    管理者ロールのUUID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    RoleDetail data, response status code and response headers



4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
 
# File 'lib/kickflow/api/_api.rb', line 4338

def patch_roles_role_id_with_http_info(role_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.patch_roles_role_id ...'
  end
  # verify the required parameter 'role_id' is set
  if @api_client.config.client_side_validation && role_id.nil?
    fail ArgumentError, "Missing the required parameter 'role_id' when calling DefaultApi.patch_roles_role_id"
  end
  # resource path
  local_var_path = '/v1/roles/{roleId}'.sub('{' + 'roleId' + '}', CGI.escape(role_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#patch_teams_team_id(organization_chart_id, team_id, opts = {}) ⇒ TeamDetail

チームを編集 チームを更新します。 このAPIの実行には、チームの管理権限が必要です。

Parameters:

  • organization_chart_id (String) —

    組織図のUUID

  • team_id (String) —

    チームのUUIDまたはコード

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

    the optional parameters

Options Hash (opts):

Returns:



4398
4399
4400
4401
 
# File 'lib/kickflow/api/_api.rb', line 4398

def patch_teams_team_id(organization_chart_id, team_id, opts = {})
  data, _status_code, _headers = patch_teams_team_id_with_http_info(organization_chart_id, team_id, opts)
  data
end

#patch_teams_team_id_memberships_user_id(organization_chart_id, team_id, user_id, opts = {}) ⇒ nil

チームのメンバーを更新 指定したメンバーを更新します。 このAPIの実行には、チームの管理権限が必要です。 注意: チームにリーダーは最低一人は必要です。リーダーが不在の場合、APIは422 Unprocessable Entityを返します。

Parameters:

  • organization_chart_id (String) —

    組織図のUUID

  • team_id (String) —

    チームのUUIDまたはコード

  • user_id (String) —

    ユーザーのUUIDまたはコード

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


4475
4476
4477
4478
 
# File 'lib/kickflow/api/_api.rb', line 4475

def patch_teams_team_id_memberships_user_id(organization_chart_id, team_id, user_id, opts = {})
  patch_teams_team_id_memberships_user_id_with_http_info(organization_chart_id, team_id, user_id, opts)
  nil
end

#patch_teams_team_id_memberships_user_id_with_http_info(organization_chart_id, team_id, user_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

チームのメンバーを更新 指定したメンバーを更新します。 このAPIの実行には、チームの管理権限が必要です。 注意: チームにリーダーは最低一人は必要です。リーダーが不在の場合、APIは422 Unprocessable Entityを返します。

Parameters:

  • organization_chart_id (String) —

    組織図のUUID

  • team_id (String) —

    チームのUUIDまたはコード

  • user_id (String) —

    ユーザーのUUIDまたはコード

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
 
# File 'lib/kickflow/api/_api.rb', line 4488

def patch_teams_team_id_memberships_user_id_with_http_info(organization_chart_id, team_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.patch_teams_team_id_memberships_user_id ...'
  end
  # verify the required parameter 'organization_chart_id' is set
  if @api_client.config.client_side_validation && organization_chart_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_chart_id' when calling DefaultApi.patch_teams_team_id_memberships_user_id"
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling DefaultApi.patch_teams_team_id_memberships_user_id"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.patch_teams_team_id_memberships_user_id"
  end
  # resource path
  local_var_path = '/v1/organizationCharts/{organizationChartId}/teams/{teamId}/memberships/{userId}'.sub('{' + 'organizationChartId' + '}', CGI.escape(organization_chart_id.to_s)).sub('{' + 'teamId' + '}', CGI.escape(team_id.to_s)).sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#patch_teams_team_id_with_http_info(organization_chart_id, team_id, opts = {}) ⇒ Array<(TeamDetail, Integer, Hash)>

チームを編集 チームを更新します。 このAPIの実行には、チームの管理権限が必要です。

Parameters:

  • organization_chart_id (String) —

    組織図のUUID

  • team_id (String) —

    チームのUUIDまたはコード

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

    the optional parameters

Options Hash (opts):

Returns:

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

    TeamDetail data, response status code and response headers



4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
 
# File 'lib/kickflow/api/_api.rb', line 4410

def patch_teams_team_id_with_http_info(organization_chart_id, team_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.patch_teams_team_id ...'
  end
  # verify the required parameter 'organization_chart_id' is set
  if @api_client.config.client_side_validation && organization_chart_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_chart_id' when calling DefaultApi.patch_teams_team_id"
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling DefaultApi.patch_teams_team_id"
  end
  # resource path
  local_var_path = '/v1/organizationCharts/{organizationChartId}/teams/{teamId}'.sub('{' + 'organizationChartId' + '}', CGI.escape(organization_chart_id.to_s)).sub('{' + 'teamId' + '}', CGI.escape(team_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#patch_tickets_id_comments_comment_id(ticket_id, comment_id, opts = {}) ⇒ Comment

コメントを更新 チケットのコメントを更新します。添付ファイルは更新できません。

Parameters:

  • ticket_id (String) —

    チケットのUUID

  • comment_id (String) —

    コメントのUUID

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

    the optional parameters

Options Hash (opts):

Returns:



4554
4555
4556
4557
 
# File 'lib/kickflow/api/_api.rb', line 4554

def patch_tickets_id_comments_comment_id(ticket_id, comment_id, opts = {})
  data, _status_code, _headers = patch_tickets_id_comments_comment_id_with_http_info(ticket_id, comment_id, opts)
  data
end

#patch_tickets_id_comments_comment_id_with_http_info(ticket_id, comment_id, opts = {}) ⇒ Array<(Comment, Integer, Hash)>

コメントを更新 チケットのコメントを更新します。添付ファイルは更新できません。

Parameters:

  • ticket_id (String) —

    チケットのUUID

  • comment_id (String) —

    コメントのUUID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Comment data, response status code and response headers



4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
 
# File 'lib/kickflow/api/_api.rb', line 4566

def patch_tickets_id_comments_comment_id_with_http_info(ticket_id, comment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.patch_tickets_id_comments_comment_id ...'
  end
  # verify the required parameter 'ticket_id' is set
  if @api_client.config.client_side_validation && ticket_id.nil?
    fail ArgumentError, "Missing the required parameter 'ticket_id' when calling DefaultApi.patch_tickets_id_comments_comment_id"
  end
  # verify the required parameter 'comment_id' is set
  if @api_client.config.client_side_validation && comment_id.nil?
    fail ArgumentError, "Missing the required parameter 'comment_id' when calling DefaultApi.patch_tickets_id_comments_comment_id"
  end
  # resource path
  local_var_path = '/v1/tickets/{ticketId}/comments/{commentId}'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_id.to_s)).sub('{' + 'commentId' + '}', CGI.escape(comment_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#patch_tickets_ticket_id(ticket_id, opts = {}) ⇒ TicketDetail

チケットを更新 チケットを更新します。 注意1: チケットのステータスが下書きまたは差し戻しの場合、申請者が更新可能です。 注意2: チケットのステータスが処理中の場合、承認者が承認者用フィールドのみ更新可能です。リクエストボディにはslipItemsまたはinputsのみ設定してください（他のパラメータは無視されます）。 注意3: 明細ワークフローの場合、slipItemsは必須です。

Parameters:

  • ticket_id (String) —

    チケットのUUID

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

    the optional parameters

Options Hash (opts):

Returns:



4629
4630
4631
4632
 
# File 'lib/kickflow/api/_api.rb', line 4629

def patch_tickets_ticket_id(ticket_id, opts = {})
  data, _status_code, _headers = patch_tickets_ticket_id_with_http_info(ticket_id, opts)
  data
end

#patch_tickets_ticket_id_with_http_info(ticket_id, opts = {}) ⇒ Array<(TicketDetail, Integer, Hash)>

チケットを更新 チケットを更新します。 注意1: チケットのステータスが下書きまたは差し戻しの場合、申請者が更新可能です。 注意2: チケットのステータスが処理中の場合、承認者が承認者用フィールドのみ更新可能です。リクエストボディにはslipItemsまたはinputsのみ設定してください（他のパラメータは無視されます）。 注意3: 明細ワークフローの場合、slipItemsは必須です。

Parameters:

  • ticket_id (String) —

    チケットのUUID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    TicketDetail data, response status code and response headers



4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
 
# File 'lib/kickflow/api/_api.rb', line 4640

def patch_tickets_ticket_id_with_http_info(ticket_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.patch_tickets_ticket_id ...'
  end
  # verify the required parameter 'ticket_id' is set
  if @api_client.config.client_side_validation && ticket_id.nil?
    fail ArgumentError, "Missing the required parameter 'ticket_id' when calling DefaultApi.patch_tickets_ticket_id"
  end
  # resource path
  local_var_path = '/v1/tickets/{ticketId}'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#patch_users_user_id(user_id, opts = {}) ⇒ UserDetail

ユーザーを更新 ユーザーを更新します。 このAPIの実行には、ユーザーの管理権限が必要です。

Parameters:

  • user_id (String) —

    ユーザーのUUIDまたはコード

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

    the optional parameters

Options Hash (opts):

Returns:



4699
4700
4701
4702
 
# File 'lib/kickflow/api/_api.rb', line 4699

def patch_users_user_id(user_id, opts = {})
  data, _status_code, _headers = patch_users_user_id_with_http_info(user_id, opts)
  data
end

#patch_users_user_id_with_http_info(user_id, opts = {}) ⇒ Array<(UserDetail, Integer, Hash)>

ユーザーを更新 ユーザーを更新します。 このAPIの実行には、ユーザーの管理権限が必要です。

Parameters:

  • user_id (String) —

    ユーザーのUUIDまたはコード

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

    the optional parameters

Options Hash (opts):

Returns:

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

    UserDetail data, response status code and response headers



4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
 
# File 'lib/kickflow/api/_api.rb', line 4710

def patch_users_user_id_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.patch_users_user_id ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.patch_users_user_id"
  end
  # resource path
  local_var_path = '/v1/users/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#post_categories(opts = {}) ⇒ Category

カテゴリを作成 カテゴリを作成します。 このAPIの実行には、ワークフローの管理権限が必要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



4768
4769
4770
4771
 
# File 'lib/kickflow/api/_api.rb', line 4768

def post_categories(opts = {})
  data, _status_code, _headers = post_categories_with_http_info(opts)
  data
end

#post_categories_with_http_info(opts = {}) ⇒ Array<(Category, Integer, Hash)>

カテゴリを作成 カテゴリを作成します。 このAPIの実行には、ワークフローの管理権限が必要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Category data, response status code and response headers



4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
 
# File 'lib/kickflow/api/_api.rb', line 4778

def post_categories_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_categories ...'
  end
  # resource path
  local_var_path = '/v1/categories'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#post_files(opts = {}) ⇒ PostFiles200Response

添付ファイルをアップロード 添付ファイルをアップロードします。最大2MBまでのファイルをアップロード可能です。 注意：このAPIはエンタープライズプランのお客様のみ利用可能です。 注意：アップロードしたファイルはすみやかにチケット作成などで使用してください。チケットなどから参照されていないファイルは最短24時間経過後に自動的に削除されます。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :file (Object) —

    添付ファイル

Returns:



4832
4833
4834
4835
 
# File 'lib/kickflow/api/_api.rb', line 4832

def post_files(opts = {})
  data, _status_code, _headers = post_files_with_http_info(opts)
  data
end

#post_files_with_http_info(opts = {}) ⇒ Array<(PostFiles200Response, Integer, Hash)>

添付ファイルをアップロード 添付ファイルをアップロードします。最大2MBまでのファイルをアップロード可能です。 注意：このAPIはエンタープライズプランのお客様のみ利用可能です。 注意：アップロードしたファイルはすみやかにチケット作成などで使用してください。チケットなどから参照されていないファイルは最短24時間経過後に自動的に削除されます。

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :file (Object) —

    添付ファイル

Returns:

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

    PostFiles200Response data, response status code and response headers



4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
 
# File 'lib/kickflow/api/_api.rb', line 4842

def post_files_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_files ...'
  end
  # resource path
  local_var_path = '/v1/files'

  # 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'
  content_type = @api_client.select_header_content_type(['multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?

  # http body (model)
  post_body = opts[:debug_body]

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

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

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

#post_folders(opts = {}) ⇒ FolderDetail

フォルダを作成 フォルダを作成します。 このAPIの実行には、ワークフローの管理権限が必要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



4897
4898
4899
4900
 
# File 'lib/kickflow/api/_api.rb', line 4897

def post_folders(opts = {})
  data, _status_code, _headers = post_folders_with_http_info(opts)
  data
end

#post_folders_with_http_info(opts = {}) ⇒ Array<(FolderDetail, Integer, Hash)>

フォルダを作成 フォルダを作成します。 このAPIの実行には、ワークフローの管理権限が必要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    FolderDetail data, response status code and response headers



4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
 
# File 'lib/kickflow/api/_api.rb', line 4907

def post_folders_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_folders ...'
  end
  # resource path
  local_var_path = '/v1/folders'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#post_general_masters(opts = {}) ⇒ GeneralMaster

汎用マスタを作成 汎用マスタを作成します。 このAPIの実行には、汎用マスタの管理権限が必要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



4961
4962
4963
4964
 
# File 'lib/kickflow/api/_api.rb', line 4961

def post_general_masters(opts = {})
  data, _status_code, _headers = post_general_masters_with_http_info(opts)
  data
end

#post_general_masters_general_master_id_items(general_master_id, opts = {}) ⇒ GeneralMasterItem

汎用マスタアイテムを作成 汎用マスタアイテムを作成します。 このAPIの実行には、汎用マスタの管理権限が必要です。

Parameters:

  • general_master_id (String) —

    汎用マスタのUUIDまたはコード

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

    the optional parameters

Options Hash (opts):

Returns:



5026
5027
5028
5029
 
# File 'lib/kickflow/api/_api.rb', line 5026

def post_general_masters_general_master_id_items(general_master_id, opts = {})
  data, _status_code, _headers = post_general_masters_general_master_id_items_with_http_info(general_master_id, opts)
  data
end

#post_general_masters_general_master_id_items_with_http_info(general_master_id, opts = {}) ⇒ Array<(GeneralMasterItem, Integer, Hash)>

汎用マスタアイテムを作成 汎用マスタアイテムを作成します。 このAPIの実行には、汎用マスタの管理権限が必要です。

Parameters:

  • general_master_id (String) —

    汎用マスタのUUIDまたはコード

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

    the optional parameters

Options Hash (opts):

Returns:

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

    GeneralMasterItem data, response status code and response headers



5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
 
# File 'lib/kickflow/api/_api.rb', line 5037

def post_general_masters_general_master_id_items_with_http_info(general_master_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_general_masters_general_master_id_items ...'
  end
  # verify the required parameter 'general_master_id' is set
  if @api_client.config.client_side_validation && general_master_id.nil?
    fail ArgumentError, "Missing the required parameter 'general_master_id' when calling DefaultApi.post_general_masters_general_master_id_items"
  end
  # resource path
  local_var_path = '/v1/generalMasters/{generalMasterId}/items'.sub('{' + 'generalMasterId' + '}', CGI.escape(general_master_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#post_general_masters_with_http_info(opts = {}) ⇒ Array<(GeneralMaster, Integer, Hash)>

汎用マスタを作成 汎用マスタを作成します。 このAPIの実行には、汎用マスタの管理権限が必要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    GeneralMaster data, response status code and response headers



4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
 
# File 'lib/kickflow/api/_api.rb', line 4971

def post_general_masters_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_general_masters ...'
  end
  # resource path
  local_var_path = '/v1/generalMasters'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#post_grades(opts = {}) ⇒ Grade

役職を作成 役職を作成します。 このAPIの実行には、ユーザーの管理権限が必要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



5095
5096
5097
5098
 
# File 'lib/kickflow/api/_api.rb', line 5095

def post_grades(opts = {})
  data, _status_code, _headers = post_grades_with_http_info(opts)
  data
end

#post_grades_grade_id_default(grade_id, opts = {}) ⇒ nil

デフォルトの役職を変更 指定した役職をデフォルトにします。 同時に、これまでデフォルトだった役職は自動的にデフォルトではなくなります。 このAPIの実行には、ユーザーの管理権限が必要です。

Parameters:

  • grade_id (String) —

    役職のUUIDまたはコード

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

    the optional parameters

Returns:

  • (nil) 


5159
5160
5161
5162
 
# File 'lib/kickflow/api/_api.rb', line 5159

def post_grades_grade_id_default(grade_id, opts = {})
  post_grades_grade_id_default_with_http_info(grade_id, opts)
  nil
end

#post_grades_grade_id_default_with_http_info(grade_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

デフォルトの役職を変更 指定した役職をデフォルトにします。 同時に、これまでデフォルトだった役職は自動的にデフォルトではなくなります。 このAPIの実行には、ユーザーの管理権限が必要です。

Parameters:

  • grade_id (String) —

    役職のUUIDまたはコード

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
 
# File 'lib/kickflow/api/_api.rb', line 5169

def post_grades_grade_id_default_with_http_info(grade_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_grades_grade_id_default ...'
  end
  # verify the required parameter 'grade_id' is set
  if @api_client.config.client_side_validation && grade_id.nil?
    fail ArgumentError, "Missing the required parameter 'grade_id' when calling DefaultApi.post_grades_grade_id_default"
  end
  # resource path
  local_var_path = '/v1/grades/{gradeId}/default'.sub('{' + 'gradeId' + '}', CGI.escape(grade_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

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

#post_grades_with_http_info(opts = {}) ⇒ Array<(Grade, Integer, Hash)>

役職を作成 役職を作成します。 このAPIの実行には、ユーザーの管理権限が必要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Grade data, response status code and response headers



5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
 
# File 'lib/kickflow/api/_api.rb', line 5105

def post_grades_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_grades ...'
  end
  # resource path
  local_var_path = '/v1/grades'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#post_organization_charts(opts = {}) ⇒ OrganizationChartDetail

組織図を作成 組織図を作成します。 このAPIの実行には、チームの管理権限が必要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



5220
5221
5222
5223
 
# File 'lib/kickflow/api/_api.rb', line 5220

def post_organization_charts(opts = {})
  data, _status_code, _headers = post_organization_charts_with_http_info(opts)
  data
end

#post_organization_charts_organization_chart_id_activate(organization_chart_id, opts = {}) ⇒ OrganizationChartDetail

組織図を有効化 指定した組織図を有効化し、ワークフローで使用する組織図を切り替えます。 他の組織図に有効化の予定がある場合、それらの予定は削除されます。 このAPIの実行には、チームの管理権限が必要です。 注意：組織図の有効化は時間がかかることがあるため、有効化は非同期で実行されます。有効化の完了前にレスポンスを返すので注意してください。

Parameters:

  • organization_chart_id (String) —

    組織図のUUID

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

    the optional parameters

Options Hash (opts):

Returns:



5285
5286
5287
5288
 
# File 'lib/kickflow/api/_api.rb', line 5285

def post_organization_charts_organization_chart_id_activate(organization_chart_id, opts = {})
  data, _status_code, _headers = post_organization_charts_organization_chart_id_activate_with_http_info(organization_chart_id, opts)
  data
end

#post_organization_charts_organization_chart_id_activate_with_http_info(organization_chart_id, opts = {}) ⇒ Array<(OrganizationChartDetail, Integer, Hash)>

組織図を有効化 指定した組織図を有効化し、ワークフローで使用する組織図を切り替えます。 他の組織図に有効化の予定がある場合、それらの予定は削除されます。 このAPIの実行には、チームの管理権限が必要です。 注意：組織図の有効化は時間がかかることがあるため、有効化は非同期で実行されます。有効化の完了前にレスポンスを返すので注意してください。

Parameters:

  • organization_chart_id (String) —

    組織図のUUID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    OrganizationChartDetail data, response status code and response headers



5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
 
# File 'lib/kickflow/api/_api.rb', line 5296

def post_organization_charts_organization_chart_id_activate_with_http_info(organization_chart_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_organization_charts_organization_chart_id_activate ...'
  end
  # verify the required parameter 'organization_chart_id' is set
  if @api_client.config.client_side_validation && organization_chart_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_chart_id' when calling DefaultApi.post_organization_charts_organization_chart_id_activate"
  end
  # resource path
  local_var_path = '/v1/organizationCharts/{organizationChartId}/activate'.sub('{' + 'organizationChartId' + '}', CGI.escape(organization_chart_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#post_organization_charts_organization_chart_id_teams(organization_chart_id, opts = {}) ⇒ TeamDetail

チームを作成 指定した組織図内にチームを作成します。 このAPIの実行には、チームの管理権限が必要です。

Parameters:

  • organization_chart_id (String) —

    組織図のUUID

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

    the optional parameters

Options Hash (opts):

Returns:



5355
5356
5357
5358
 
# File 'lib/kickflow/api/_api.rb', line 5355

def post_organization_charts_organization_chart_id_teams(organization_chart_id, opts = {})
  data, _status_code, _headers = post_organization_charts_organization_chart_id_teams_with_http_info(organization_chart_id, opts)
  data
end

#post_organization_charts_organization_chart_id_teams_with_http_info(organization_chart_id, opts = {}) ⇒ Array<(TeamDetail, Integer, Hash)>

チームを作成 指定した組織図内にチームを作成します。 このAPIの実行には、チームの管理権限が必要です。

Parameters:

  • organization_chart_id (String) —

    組織図のUUID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    TeamDetail data, response status code and response headers



5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
 
# File 'lib/kickflow/api/_api.rb', line 5366

def post_organization_charts_organization_chart_id_teams_with_http_info(organization_chart_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_organization_charts_organization_chart_id_teams ...'
  end
  # verify the required parameter 'organization_chart_id' is set
  if @api_client.config.client_side_validation && organization_chart_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_chart_id' when calling DefaultApi.post_organization_charts_organization_chart_id_teams"
  end
  # resource path
  local_var_path = '/v1/organizationCharts/{organizationChartId}/teams'.sub('{' + 'organizationChartId' + '}', CGI.escape(organization_chart_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#post_organization_charts_with_http_info(opts = {}) ⇒ Array<(OrganizationChartDetail, Integer, Hash)>

組織図を作成 組織図を作成します。 このAPIの実行には、チームの管理権限が必要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    OrganizationChartDetail data, response status code and response headers



5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
 
# File 'lib/kickflow/api/_api.rb', line 5230

def post_organization_charts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_organization_charts ...'
  end
  # resource path
  local_var_path = '/v1/organizationCharts'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#post_proxy_applicants(opts = {}) ⇒ ProxyApplicant

代理申請を作成 代理申請を新規作成します。 このAPIの実行には、ユーザーの管理権限が必要です。ただし、自分の代理申請の設定をすべてのユーザーに許可している場合、管理権限は不要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



5424
5425
5426
5427
 
# File 'lib/kickflow/api/_api.rb', line 5424

def post_proxy_applicants(opts = {})
  data, _status_code, _headers = post_proxy_applicants_with_http_info(opts)
  data
end

#post_proxy_applicants_with_http_info(opts = {}) ⇒ Array<(ProxyApplicant, Integer, Hash)>

代理申請を作成 代理申請を新規作成します。 このAPIの実行には、ユーザーの管理権限が必要です。ただし、自分の代理申請の設定をすべてのユーザーに許可している場合、管理権限は不要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ProxyApplicant data, response status code and response headers



5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
 
# File 'lib/kickflow/api/_api.rb', line 5434

def post_proxy_applicants_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_proxy_applicants ...'
  end
  # resource path
  local_var_path = '/v1/proxyApplicants'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#post_proxy_approvers(opts = {}) ⇒ ProxyApprover

代理承認を作成 代理承認を新規作成します。 このAPIの実行には、ユーザーの管理権限が必要です。ただし、自分の代理承認の設定をすべてのユーザーに許可している場合、管理権限は不要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



5488
5489
5490
5491
 
# File 'lib/kickflow/api/_api.rb', line 5488

def post_proxy_approvers(opts = {})
  data, _status_code, _headers = post_proxy_approvers_with_http_info(opts)
  data
end

#post_proxy_approvers_with_http_info(opts = {}) ⇒ Array<(ProxyApprover, Integer, Hash)>

代理承認を作成 代理承認を新規作成します。 このAPIの実行には、ユーザーの管理権限が必要です。ただし、自分の代理承認の設定をすべてのユーザーに許可している場合、管理権限は不要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ProxyApprover data, response status code and response headers



5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
 
# File 'lib/kickflow/api/_api.rb', line 5498

def post_proxy_approvers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_proxy_approvers ...'
  end
  # resource path
  local_var_path = '/v1/proxyApprovers'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#post_roles(opts = {}) ⇒ RoleDetail

管理者ロールを作成 管理者ロールを作成します。 このAPIの実行には、ロールの管理権限が必要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



5552
5553
5554
5555
 
# File 'lib/kickflow/api/_api.rb', line 5552

def post_roles(opts = {})
  data, _status_code, _headers = post_roles_with_http_info(opts)
  data
end

#post_roles_role_id_memberships(role_id, opts = {}) ⇒ nil

管理者ロールにメンバーを追加 管理者ロールにメンバーを追加します。最大10人まで複数のメンバーを同時に追加可能です。 このAPIの実行には、ロールの管理権限が必要です。

Parameters:

  • role_id (String) —

    管理者ロールのUUID

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


5617
5618
5619
5620
 
# File 'lib/kickflow/api/_api.rb', line 5617

def post_roles_role_id_memberships(role_id, opts = {})
  post_roles_role_id_memberships_with_http_info(role_id, opts)
  nil
end

#post_roles_role_id_memberships_with_http_info(role_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

管理者ロールにメンバーを追加 管理者ロールにメンバーを追加します。最大10人まで複数のメンバーを同時に追加可能です。 このAPIの実行には、ロールの管理権限が必要です。

Parameters:

  • role_id (String) —

    管理者ロールのUUID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
 
# File 'lib/kickflow/api/_api.rb', line 5628

def post_roles_role_id_memberships_with_http_info(role_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_roles_role_id_memberships ...'
  end
  # verify the required parameter 'role_id' is set
  if @api_client.config.client_side_validation && role_id.nil?
    fail ArgumentError, "Missing the required parameter 'role_id' when calling DefaultApi.post_roles_role_id_memberships"
  end
  # resource path
  local_var_path = '/v1/roles/{roleId}/memberships'.sub('{' + 'roleId' + '}', CGI.escape(role_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#post_roles_with_http_info(opts = {}) ⇒ Array<(RoleDetail, Integer, Hash)>

管理者ロールを作成 管理者ロールを作成します。 このAPIの実行には、ロールの管理権限が必要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    RoleDetail data, response status code and response headers



5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
 
# File 'lib/kickflow/api/_api.rb', line 5562

def post_roles_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_roles ...'
  end
  # resource path
  local_var_path = '/v1/roles'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#post_teams_team_id_members(organization_chart_id, team_id, opts = {}) ⇒ nil

チームにメンバーを追加 指定したチームにメンバーを追加します。最大10人まで同時に追加可能です。 このAPIの実行には、チームの管理権限が必要です。 注意: チームにリーダーは最低一人必要です。リーダーが不在の場合、APIは422 Unprocessable Entityを返します。

Parameters:

  • organization_chart_id (String) —

    組織図のUUID

  • team_id (String) —

    チームのUUIDまたはコード

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


5686
5687
5688
5689
 
# File 'lib/kickflow/api/_api.rb', line 5686

def post_teams_team_id_members(organization_chart_id, team_id, opts = {})
  post_teams_team_id_members_with_http_info(organization_chart_id, team_id, opts)
  nil
end

#post_teams_team_id_members_with_http_info(organization_chart_id, team_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

チームにメンバーを追加 指定したチームにメンバーを追加します。最大10人まで同時に追加可能です。 このAPIの実行には、チームの管理権限が必要です。 注意: チームにリーダーは最低一人必要です。リーダーが不在の場合、APIは422 Unprocessable Entityを返します。

Parameters:

  • organization_chart_id (String) —

    組織図のUUID

  • team_id (String) —

    チームのUUIDまたはコード

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
 
# File 'lib/kickflow/api/_api.rb', line 5698

def post_teams_team_id_members_with_http_info(organization_chart_id, team_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_teams_team_id_members ...'
  end
  # verify the required parameter 'organization_chart_id' is set
  if @api_client.config.client_side_validation && organization_chart_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_chart_id' when calling DefaultApi.post_teams_team_id_members"
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling DefaultApi.post_teams_team_id_members"
  end
  # resource path
  local_var_path = '/v1/organizationCharts/{organizationChartId}/teams/{teamId}/memberships'.sub('{' + 'organizationChartId' + '}', CGI.escape(organization_chart_id.to_s)).sub('{' + 'teamId' + '}', CGI.escape(team_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#post_tickets(opts = {}) ⇒ TicketDetail

チケットを作成 チケットを作成します。

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



5758
5759
5760
5761
 
# File 'lib/kickflow/api/_api.rb', line 5758

def post_tickets(opts = {})
  data, _status_code, _headers = post_tickets_with_http_info(opts)
  data
end

#post_tickets_id_comments(ticket_id, opts = {}) ⇒ Comment

コメントを投稿 チケットにコメントを投稿します。

Parameters:

  • ticket_id (String) —

    チケットのUUID

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

    the optional parameters

Options Hash (opts):

Returns:



5823
5824
5825
5826
 
# File 'lib/kickflow/api/_api.rb', line 5823

def post_tickets_id_comments(ticket_id, opts = {})
  data, _status_code, _headers = post_tickets_id_comments_with_http_info(ticket_id, opts)
  data
end

#post_tickets_id_comments_with_http_info(ticket_id, opts = {}) ⇒ Array<(Comment, Integer, Hash)>

コメントを投稿 チケットにコメントを投稿します。

Parameters:

  • ticket_id (String) —

    チケットのUUID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Comment data, response status code and response headers



5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
 
# File 'lib/kickflow/api/_api.rb', line 5834

def post_tickets_id_comments_with_http_info(ticket_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_tickets_id_comments ...'
  end
  # verify the required parameter 'ticket_id' is set
  if @api_client.config.client_side_validation && ticket_id.nil?
    fail ArgumentError, "Missing the required parameter 'ticket_id' when calling DefaultApi.post_tickets_id_comments"
  end
  # resource path
  local_var_path = '/v1/tickets/{ticketId}/comments'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#post_tickets_id_viewers(ticket_id, opts = {}) ⇒ nil

閲覧者を追加 チケットに閲覧者を追加します。

Parameters:

  • ticket_id (String) —

    チケットのUUID

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


5893
5894
5895
5896
 
# File 'lib/kickflow/api/_api.rb', line 5893

def post_tickets_id_viewers(ticket_id, opts = {})
  post_tickets_id_viewers_with_http_info(ticket_id, opts)
  nil
end

#post_tickets_id_viewers_with_http_info(ticket_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

閲覧者を追加 チケットに閲覧者を追加します。

Parameters:

  • ticket_id (String) —

    チケットのUUID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
 
# File 'lib/kickflow/api/_api.rb', line 5904

def post_tickets_id_viewers_with_http_info(ticket_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_tickets_id_viewers ...'
  end
  # verify the required parameter 'ticket_id' is set
  if @api_client.config.client_side_validation && ticket_id.nil?
    fail ArgumentError, "Missing the required parameter 'ticket_id' when calling DefaultApi.post_tickets_id_viewers"
  end
  # resource path
  local_var_path = '/v1/tickets/{ticketId}/viewers'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#post_tickets_ticket_id_approve(ticket_id, opts = {}) ⇒ TicketDetail

チケットを承認または確認する 指定したチケットを承認もしくは確認します。 APIの実行ユーザーがチケットにアサインされていない場合、403 Forbiddenを返します。

Parameters:

  • ticket_id (String) —

    チケットのUUID

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

    the optional parameters

Returns:



5960
5961
5962
5963
 
# File 'lib/kickflow/api/_api.rb', line 5960

def post_tickets_ticket_id_approve(ticket_id, opts = {})
  data, _status_code, _headers = post_tickets_ticket_id_approve_with_http_info(ticket_id, opts)
  data
end

#post_tickets_ticket_id_approve_with_http_info(ticket_id, opts = {}) ⇒ Array<(TicketDetail, Integer, Hash)>

チケットを承認または確認する 指定したチケットを承認もしくは確認します。 APIの実行ユーザーがチケットにアサインされていない場合、403 Forbiddenを返します。

Parameters:

  • ticket_id (String) —

    チケットのUUID

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

    the optional parameters

Returns:

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

    TicketDetail data, response status code and response headers



5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
 
# File 'lib/kickflow/api/_api.rb', line 5970

def post_tickets_ticket_id_approve_with_http_info(ticket_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_tickets_ticket_id_approve ...'
  end
  # verify the required parameter 'ticket_id' is set
  if @api_client.config.client_side_validation && ticket_id.nil?
    fail ArgumentError, "Missing the required parameter 'ticket_id' when calling DefaultApi.post_tickets_ticket_id_approve"
  end
  # resource path
  local_var_path = '/v1/tickets/{ticketId}/approve'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_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] || 'TicketDetail'

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

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

#post_tickets_ticket_id_archive(ticket_id, opts = {}) ⇒ TicketDetail

チケットをアーカイブ チケットをアーカイブします。チケットのステータスがアーカイブステータスに変わりますが、引き続きUIやAPIでチケットにはアクセス可能です。 注意：チケットをアーカイブ可能なユーザーはチケットのステータスによって異なります。詳しくは(support.kickflow.com/hc/ja/articles/360058324973)をご覧ください。

Parameters:

  • ticket_id (String) —

    チケットのUUID

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

    the optional parameters

Returns:



6023
6024
6025
6026
 
# File 'lib/kickflow/api/_api.rb', line 6023

def post_tickets_ticket_id_archive(ticket_id, opts = {})
  data, _status_code, _headers = post_tickets_ticket_id_archive_with_http_info(ticket_id, opts)
  data
end

#post_tickets_ticket_id_archive_with_http_info(ticket_id, opts = {}) ⇒ Array<(TicketDetail, Integer, Hash)>

チケットをアーカイブ チケットをアーカイブします。チケットのステータスがアーカイブステータスに変わりますが、引き続きUIやAPIでチケットにはアクセス可能です。 注意：チケットをアーカイブ可能なユーザーはチケットのステータスによって異なります。詳しくは(support.kickflow.com/hc/ja/articles/360058324973)をご覧ください。

Parameters:

  • ticket_id (String) —

    チケットのUUID

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

    the optional parameters

Returns:

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

    TicketDetail data, response status code and response headers



6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
 
# File 'lib/kickflow/api/_api.rb', line 6033

def post_tickets_ticket_id_archive_with_http_info(ticket_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_tickets_ticket_id_archive ...'
  end
  # verify the required parameter 'ticket_id' is set
  if @api_client.config.client_side_validation && ticket_id.nil?
    fail ArgumentError, "Missing the required parameter 'ticket_id' when calling DefaultApi.post_tickets_ticket_id_archive"
  end
  # resource path
  local_var_path = '/v1/tickets/{ticketId}/archive'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_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] || 'TicketDetail'

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

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

#post_tickets_ticket_id_deny(ticket_id, opts = {}) ⇒ TicketDetail

チケットを却下する 指定したチケットを却下します。 APIの実行ユーザーがチケットにアサインされていない場合、403 Forbiddenを返します。

Parameters:

  • ticket_id (String) —

    チケットのUUID

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

    the optional parameters

Options Hash (opts):

  • :body (Object)

Returns:



6087
6088
6089
6090
 
# File 'lib/kickflow/api/_api.rb', line 6087

def post_tickets_ticket_id_deny(ticket_id, opts = {})
  data, _status_code, _headers = post_tickets_ticket_id_deny_with_http_info(ticket_id, opts)
  data
end

#post_tickets_ticket_id_deny_with_http_info(ticket_id, opts = {}) ⇒ Array<(TicketDetail, Integer, Hash)>

チケットを却下する 指定したチケットを却下します。 APIの実行ユーザーがチケットにアサインされていない場合、403 Forbiddenを返します。

Parameters:

  • ticket_id (String) —

    チケットのUUID

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

    the optional parameters

Options Hash (opts):

  • :body (Object)

Returns:

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

    TicketDetail data, response status code and response headers



6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
 
# File 'lib/kickflow/api/_api.rb', line 6098

def post_tickets_ticket_id_deny_with_http_info(ticket_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_tickets_ticket_id_deny ...'
  end
  # verify the required parameter 'ticket_id' is set
  if @api_client.config.client_side_validation && ticket_id.nil?
    fail ArgumentError, "Missing the required parameter 'ticket_id' when calling DefaultApi.post_tickets_ticket_id_deny"
  end
  # resource path
  local_var_path = '/v1/tickets/{ticketId}/deny'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#post_tickets_ticket_id_reject(ticket_id, opts = {}) ⇒ TicketDetail

チケットを差し戻す 指定したチケットを差し戻します。 APIの実行ユーザーがチケットにアサインされていない場合、403 Forbiddenを返します。

Parameters:

  • ticket_id (String) —

    チケットのUUID

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

    the optional parameters

Options Hash (opts):

Returns:



6157
6158
6159
6160
 
# File 'lib/kickflow/api/_api.rb', line 6157

def post_tickets_ticket_id_reject(ticket_id, opts = {})
  data, _status_code, _headers = post_tickets_ticket_id_reject_with_http_info(ticket_id, opts)
  data
end

#post_tickets_ticket_id_reject_with_http_info(ticket_id, opts = {}) ⇒ Array<(TicketDetail, Integer, Hash)>

チケットを差し戻す 指定したチケットを差し戻します。 APIの実行ユーザーがチケットにアサインされていない場合、403 Forbiddenを返します。

Parameters:

  • ticket_id (String) —

    チケットのUUID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    TicketDetail data, response status code and response headers



6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
 
# File 'lib/kickflow/api/_api.rb', line 6168

def post_tickets_ticket_id_reject_with_http_info(ticket_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_tickets_ticket_id_reject ...'
  end
  # verify the required parameter 'ticket_id' is set
  if @api_client.config.client_side_validation && ticket_id.nil?
    fail ArgumentError, "Missing the required parameter 'ticket_id' when calling DefaultApi.post_tickets_ticket_id_reject"
  end
  # resource path
  local_var_path = '/v1/tickets/{ticketId}/reject'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#post_tickets_ticket_id_withdraw(ticket_id, opts = {}) ⇒ TicketDetail

チケットを取り下げる 自分が作成したチケットを取り下げます。

Parameters:

  • ticket_id (String) —

    チケットのUUID

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

    the optional parameters

Returns:



6226
6227
6228
6229
 
# File 'lib/kickflow/api/_api.rb', line 6226

def post_tickets_ticket_id_withdraw(ticket_id, opts = {})
  data, _status_code, _headers = post_tickets_ticket_id_withdraw_with_http_info(ticket_id, opts)
  data
end

#post_tickets_ticket_id_withdraw_with_http_info(ticket_id, opts = {}) ⇒ Array<(TicketDetail, Integer, Hash)>

チケットを取り下げる 自分が作成したチケットを取り下げます。

Parameters:

  • ticket_id (String) —

    チケットのUUID

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

    the optional parameters

Returns:

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

    TicketDetail data, response status code and response headers



6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
 
# File 'lib/kickflow/api/_api.rb', line 6236

def post_tickets_ticket_id_withdraw_with_http_info(ticket_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_tickets_ticket_id_withdraw ...'
  end
  # verify the required parameter 'ticket_id' is set
  if @api_client.config.client_side_validation && ticket_id.nil?
    fail ArgumentError, "Missing the required parameter 'ticket_id' when calling DefaultApi.post_tickets_ticket_id_withdraw"
  end
  # resource path
  local_var_path = '/v1/tickets/{ticketId}/withdraw'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_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] || 'TicketDetail'

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

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

#post_tickets_with_http_info(opts = {}) ⇒ Array<(TicketDetail, Integer, Hash)>

チケットを作成 チケットを作成します。

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    TicketDetail data, response status code and response headers



5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
 
# File 'lib/kickflow/api/_api.rb', line 5768

def post_tickets_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_tickets ...'
  end
  # resource path
  local_var_path = '/v1/tickets'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#post_users(opts = {}) ⇒ UserDetail

ユーザーを作成（招待） ユーザーを作成します。 作成されたユーザーは招待済みステータスとなり、招待メールが送信されます。 このAPIの実行には、ユーザーの管理権限が必要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



6289
6290
6291
6292
 
# File 'lib/kickflow/api/_api.rb', line 6289

def post_users(opts = {})
  data, _status_code, _headers = post_users_with_http_info(opts)
  data
end

#post_users_user_id_reactivate(user_id, opts = {}) ⇒ User

ユーザーを再有効化 一時停止中のユーザーを有効化します。 このAPIの実行には、ユーザーの管理権限が必要です。

Parameters:

  • user_id (String) —

    ユーザーのUUIDまたはコード

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

    the optional parameters

Returns:



6353
6354
6355
6356
 
# File 'lib/kickflow/api/_api.rb', line 6353

def post_users_user_id_reactivate(user_id, opts = {})
  data, _status_code, _headers = post_users_user_id_reactivate_with_http_info(user_id, opts)
  data
end

#post_users_user_id_reactivate_with_http_info(user_id, opts = {}) ⇒ Array<(User, Integer, Hash)>

ユーザーを再有効化 一時停止中のユーザーを有効化します。 このAPIの実行には、ユーザーの管理権限が必要です。

Parameters:

  • user_id (String) —

    ユーザーのUUIDまたはコード

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

    the optional parameters

Returns:

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

    User data, response status code and response headers



6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
 
# File 'lib/kickflow/api/_api.rb', line 6363

def post_users_user_id_reactivate_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_users_user_id_reactivate ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.post_users_user_id_reactivate"
  end
  # resource path
  local_var_path = '/v1/users/{userId}/reactivate'.sub('{' + 'userId' + '}', CGI.escape(user_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] || 'User'

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

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

#post_users_user_id_reinvite(user_id, opts = {}) ⇒ User

ユーザーを再招待 削除されたユーザーを再び招待します。 このAPIの実行には、ユーザーの管理権限が必要です。

Parameters:

  • user_id (String) —

    ユーザーのUUIDまたはコード

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

    the optional parameters

Returns:



6416
6417
6418
6419
 
# File 'lib/kickflow/api/_api.rb', line 6416

def post_users_user_id_reinvite(user_id, opts = {})
  data, _status_code, _headers = post_users_user_id_reinvite_with_http_info(user_id, opts)
  data
end

#post_users_user_id_reinvite_with_http_info(user_id, opts = {}) ⇒ Array<(User, Integer, Hash)>

ユーザーを再招待 削除されたユーザーを再び招待します。 このAPIの実行には、ユーザーの管理権限が必要です。

Parameters:

  • user_id (String) —

    ユーザーのUUIDまたはコード

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

    the optional parameters

Returns:

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

    User data, response status code and response headers



6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
 
# File 'lib/kickflow/api/_api.rb', line 6426

def post_users_user_id_reinvite_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_users_user_id_reinvite ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.post_users_user_id_reinvite"
  end
  # resource path
  local_var_path = '/v1/users/{userId}/reinvite'.sub('{' + 'userId' + '}', CGI.escape(user_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] || 'User'

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

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

#post_users_user_id_suspend(user_id, opts = {}) ⇒ User

ユーザーを一時停止 有効なユーザーを一時停止します。 このAPIの実行には、ユーザーの管理権限が必要です。

Parameters:

  • user_id (String) —

    ユーザーのUUIDまたはコード

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

    the optional parameters

Returns:



6479
6480
6481
6482
 
# File 'lib/kickflow/api/_api.rb', line 6479

def post_users_user_id_suspend(user_id, opts = {})
  data, _status_code, _headers = post_users_user_id_suspend_with_http_info(user_id, opts)
  data
end

#post_users_user_id_suspend_with_http_info(user_id, opts = {}) ⇒ Array<(User, Integer, Hash)>

ユーザーを一時停止 有効なユーザーを一時停止します。 このAPIの実行には、ユーザーの管理権限が必要です。

Parameters:

  • user_id (String) —

    ユーザーのUUIDまたはコード

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

    the optional parameters

Returns:

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

    User data, response status code and response headers



6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
 
# File 'lib/kickflow/api/_api.rb', line 6489

def post_users_user_id_suspend_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_users_user_id_suspend ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.post_users_user_id_suspend"
  end
  # resource path
  local_var_path = '/v1/users/{userId}/suspend'.sub('{' + 'userId' + '}', CGI.escape(user_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] || 'User'

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

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

#post_users_with_http_info(opts = {}) ⇒ Array<(UserDetail, Integer, Hash)>

ユーザーを作成（招待） ユーザーを作成します。 作成されたユーザーは招待済みステータスとなり、招待メールが送信されます。 このAPIの実行には、ユーザーの管理権限が必要です。

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    UserDetail data, response status code and response headers



6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
 
# File 'lib/kickflow/api/_api.rb', line 6299

def post_users_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.post_users ...'
  end
  # resource path
  local_var_path = '/v1/users'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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