kickflow

Kickflow - the Ruby gem for the kickflow REST API v1

kickflowの開発者用REST API (v1)

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 0.2.0
  • Generator version: 7.7.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://kickflow.com

Installation

Build a gem

To build the Ruby code into a gem:

gem build kickflow.gemspec

Then either install the gem locally:

gem install ./kickflow-0.2.0.gem

(for development, run gem install --dev ./kickflow-0.2.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'kickflow', '~> 0.2.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'kickflow', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'kickflow'

api_instance = Kickflow::DefaultApi.new
category_id = 'category_id_example' # String | カテゴリのUUID

begin
  #カテゴリを削除
  api_instance.delete_categories_category_id(category_id)
rescue Kickflow::ApiError => e
  puts "Exception when calling DefaultApi->delete_categories_category_id: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.kickflow.com

Class Method HTTP request Description
Kickflow::DefaultApi delete_categories_category_id DELETE /v1/categories/categoryId カテゴリを削除
Kickflow::DefaultApi delete_folders_folder_id DELETE /v1/folders/folderId フォルダを削除
Kickflow::DefaultApi delete_general_masters_general_master_id DELETE /v1/generalMasters/generalMasterId 汎用マスタを削除
Kickflow::DefaultApi delete_general_masters_general_master_id_items_item_id DELETE /v1/generalMasters/generalMasterId/items/itemId 汎用マスタアイテムを削除
Kickflow::DefaultApi delete_grades_grade_id DELETE /v1/grades/gradeId 役職を削除
Kickflow::DefaultApi delete_organization_charts_organization_chart_id DELETE /v1/organizationCharts/organizationChartId 組織図を削除
Kickflow::DefaultApi delete_proxy_applicants_proxy_applicant_id DELETE /v1/proxyApplicants/proxyApplicantId 代理申請を削除
Kickflow::DefaultApi delete_proxy_approvers_proxy_approver_id DELETE /v1/proxyApprovers/proxyApproverId 代理承認を削除
Kickflow::DefaultApi delete_roles_role_id DELETE /v1/roles/roleId 管理者ロールを削除
Kickflow::DefaultApi delete_roles_role_id_memberships_user_id DELETE /v1/roles/roleId/memberships/userId 管理者ロールからメンバーを削除
Kickflow::DefaultApi delete_teams_team_id DELETE /v1/organizationCharts/organizationChartId/teams/teamId チームを削除
Kickflow::DefaultApi delete_teams_team_id_members DELETE /v1/organizationCharts/organizationChartId/teams/teamId/memberships チームからメンバーを削除
Kickflow::DefaultApi delete_tickets_id_comments_comment_id DELETE /v1/tickets/ticketId/comments/commentId コメントを削除
Kickflow::DefaultApi delete_tickets_id_viewers_viewer_id DELETE /v1/tickets/ticketId/viewers/viewerId 閲覧者を削除
Kickflow::DefaultApi delete_users_user_id DELETE /v1/users/userId ユーザーを削除
Kickflow::DefaultApi get_categories GET /v1/categories カテゴリの一覧を取得
Kickflow::DefaultApi get_files_signed_id GET /v1/files/signedId 添付ファイルの情報を取得
Kickflow::DefaultApi get_folders GET /v1/folders フォルダの一覧を取得
Kickflow::DefaultApi get_folders_folder_id GET /v1/folders/folderId フォルダを取得
Kickflow::DefaultApi get_general_masters GET /v1/generalMasters 汎用マスタの一覧を取得
Kickflow::DefaultApi get_general_masters_general_master_id GET /v1/generalMasters/generalMasterId 汎用マスタを取得
Kickflow::DefaultApi get_general_masters_general_master_id_items GET /v1/generalMasters/generalMasterId/items 汎用マスタアイテムの一覧を取得
Kickflow::DefaultApi get_general_masters_general_master_id_items_item_id GET /v1/generalMasters/generalMasterId/items/itemId 汎用マスタアイテムを取得
Kickflow::DefaultApi get_grades GET /v1/grades 役職の一覧を取得
Kickflow::DefaultApi get_grades_grade_id GET /v1/grades/gradeId 役職を取得
Kickflow::DefaultApi get_organization_chart GET /v1/organizationChart 現在の組織図を取得
Kickflow::DefaultApi get_organization_charts GET /v1/organizationCharts 組織図の一覧を取得
Kickflow::DefaultApi get_organization_charts_organization_chart_id GET /v1/organizationCharts/organizationChartId 組織図を取得
Kickflow::DefaultApi get_organization_charts_organization_chart_id_teams GET /v1/organizationCharts/organizationChartId/teams チーム一覧を取得
Kickflow::DefaultApi get_organization_charts_organization_chart_id_teams_team_id_memberships GET /v1/organizationCharts/organizationChartId/teams/teamId/memberships チームのメンバー一覧を取得
Kickflow::DefaultApi get_proxy_applicants GET /v1/proxyApplicants 代理申請一覧を取得
Kickflow::DefaultApi get_proxy_approvers GET /v1/proxyApprovers 代理承認一覧を取得
Kickflow::DefaultApi get_roles GET /v1/roles 管理者ロールの一覧を取得
Kickflow::DefaultApi get_roles_role_id GET /v1/roles/roleId 管理者ロールを取得
Kickflow::DefaultApi get_roles_role_id_memberships GET /v1/roles/roleId/memberships 管理者ロールのメンバー一覧を取得
Kickflow::DefaultApi get_routes GET /v1/routes 経路一覧を取得
Kickflow::DefaultApi get_routes_route_id GET /v1/routes/routeId 経路を取得
Kickflow::DefaultApi get_teams_team_id GET /v1/organizationCharts/organizationChartId/teams/teamId チームを取得
Kickflow::DefaultApi get_tickets GET /v1/tickets チケット一覧を取得
Kickflow::DefaultApi get_tickets_id_comments GET /v1/tickets/ticketId/comments コメントの一覧を取得
Kickflow::DefaultApi get_tickets_id_comments_comment_id GET /v1/tickets/ticketId/comments/commentId コメントを取得
Kickflow::DefaultApi get_tickets_id_viewers GET /v1/tickets/ticketId/viewers 閲覧者の一覧を取得
Kickflow::DefaultApi get_tickets_tasks GET /v1/tickets/tasks 承認リクエスト一覧を取得
Kickflow::DefaultApi get_tickets_ticket_id GET /v1/tickets/ticketId チケットを取得
Kickflow::DefaultApi get_tickets_ticket_id_links GET /v1/tickets/ticketId/links チケットの関連チケットを取得する
Kickflow::DefaultApi get_user GET /v1/user 現在のユーザーを取得
Kickflow::DefaultApi get_users GET /v1/users ユーザー一覧を取得
Kickflow::DefaultApi get_users_lookup_by_email GET /v1/users/lookupByEmail メールアドレスからユーザーを取得
Kickflow::DefaultApi get_users_user_id GET /v1/users/userId ユーザーを取得
Kickflow::DefaultApi get_users_user_id_roles GET /v1/users/userId/roles ユーザーの管理者ロール一覧を取得
Kickflow::DefaultApi get_users_user_id_teams GET /v1/users/userId/teams ユーザーの所属チーム一覧を取得
Kickflow::DefaultApi get_workflows GET /v1/workflows ワークフロー一覧を取得
Kickflow::DefaultApi get_workflows_workflow_id GET /v1/workflows/workflowId ワークフローを取得
Kickflow::DefaultApi patch_categories_category_id PATCH /v1/categories/categoryId カテゴリを更新
Kickflow::DefaultApi patch_folders_folder_id PATCH /v1/folders/folderId フォルダを更新
Kickflow::DefaultApi patch_general_masters_general_master_id PATCH /v1/generalMasters/generalMasterId 汎用マスタを更新
Kickflow::DefaultApi patch_general_masters_general_master_id_items_item_id PATCH /v1/generalMasters/generalMasterId/items/itemId 汎用マスタアイテムを更新
Kickflow::DefaultApi patch_grades_grade_id PATCH /v1/grades/gradeId 役職を更新
Kickflow::DefaultApi patch_organization_charts_organization_chart_id PATCH /v1/organizationCharts/organizationChartId 組織図を更新
Kickflow::DefaultApi patch_roles_role_id PATCH /v1/roles/roleId 管理者ロールを更新
Kickflow::DefaultApi patch_teams_team_id PATCH /v1/organizationCharts/organizationChartId/teams/teamId チームを編集
Kickflow::DefaultApi patch_teams_team_id_memberships_user_id PATCH /v1/organizationCharts/organizationChartId/teams/teamId/memberships/userId チームのメンバーを更新
Kickflow::DefaultApi patch_tickets_id_comments_comment_id PATCH /v1/tickets/ticketId/comments/commentId コメントを更新
Kickflow::DefaultApi patch_tickets_ticket_id PATCH /v1/tickets/ticketId チケットを更新
Kickflow::DefaultApi patch_users_user_id PATCH /v1/users/userId ユーザーを更新
Kickflow::DefaultApi post_categories POST /v1/categories カテゴリを作成
Kickflow::DefaultApi post_files POST /v1/files 添付ファイルをアップロード
Kickflow::DefaultApi post_folders POST /v1/folders フォルダを作成
Kickflow::DefaultApi post_general_masters POST /v1/generalMasters 汎用マスタを作成
Kickflow::DefaultApi post_general_masters_general_master_id_items POST /v1/generalMasters/generalMasterId/items 汎用マスタアイテムを作成
Kickflow::DefaultApi post_grades POST /v1/grades 役職を作成
Kickflow::DefaultApi post_grades_grade_id_default POST /v1/grades/gradeId/default デフォルトの役職を変更
Kickflow::DefaultApi post_organization_charts POST /v1/organizationCharts 組織図を作成
Kickflow::DefaultApi post_organization_charts_organization_chart_id_activate POST /v1/organizationCharts/organizationChartId/activate 組織図を有効化
Kickflow::DefaultApi post_organization_charts_organization_chart_id_teams POST /v1/organizationCharts/organizationChartId/teams チームを作成
Kickflow::DefaultApi post_proxy_applicants POST /v1/proxyApplicants 代理申請を作成
Kickflow::DefaultApi post_proxy_approvers POST /v1/proxyApprovers 代理承認を作成
Kickflow::DefaultApi post_roles POST /v1/roles 管理者ロールを作成
Kickflow::DefaultApi post_roles_role_id_memberships POST /v1/roles/roleId/memberships 管理者ロールにメンバーを追加
Kickflow::DefaultApi post_teams_team_id_members POST /v1/organizationCharts/organizationChartId/teams/teamId/memberships チームにメンバーを追加
Kickflow::DefaultApi post_tickets POST /v1/tickets チケットを作成
Kickflow::DefaultApi post_tickets_id_comments POST /v1/tickets/ticketId/comments コメントを投稿
Kickflow::DefaultApi post_tickets_id_viewers POST /v1/tickets/ticketId/viewers 閲覧者を追加
Kickflow::DefaultApi post_tickets_ticket_id_approve POST /v1/tickets/ticketId/approve チケットを承認または確認する
Kickflow::DefaultApi post_tickets_ticket_id_archive POST /v1/tickets/ticketId/archive チケットをアーカイブ
Kickflow::DefaultApi post_tickets_ticket_id_deny POST /v1/tickets/ticketId/deny チケットを却下する
Kickflow::DefaultApi post_tickets_ticket_id_reject POST /v1/tickets/ticketId/reject チケットを差し戻す
Kickflow::DefaultApi post_tickets_ticket_id_withdraw POST /v1/tickets/ticketId/withdraw チケットを取り下げる
Kickflow::DefaultApi post_users POST /v1/users ユーザーを作成（招待）
Kickflow::DefaultApi post_users_user_id_reactivate POST /v1/users/userId/reactivate ユーザーを再有効化
Kickflow::DefaultApi post_users_user_id_reinvite POST /v1/users/userId/reinvite ユーザーを再招待
Kickflow::DefaultApi post_users_user_id_suspend POST /v1/users/userId/suspend ユーザーを一時停止

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

Authorization

  • Type: Bearer authentication