kickflow 0.1.0

data/docs/Workflow.md

@@ -0,0 +1,66 @@
+# Kickflow::Workflow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID |  |
+| **code** | **String** | コード |  |
+| **version_id** | **String** | バージョンのUUID |  |
+| **version_number** | **Integer** | バージョン番号 |  |
+| **name** | **String** | 名前 |  |
+| **description** | **String** | 説明 |  |
+| **status** | **String** | ステータス。visibleは有効、invisibleは無効、deletedは削除済み。 |  |
+| **public_ticket** | **Boolean** | チケットが全体公開される場合true | [default to false] |
+| **visible_to_manager** | **String** | 申請者の上長を閲覧者に追加するか。noneは追加しない、directは直属の上長のみ、allはすべての上長を表す。 |  |
+| **visible_to_team_members** | **Boolean** | 申請チームのメンバーが閲覧者に追加される場合true | [default to false] |
+| **title_description** | **String** | タイトルの説明 |  |
+| **slip** | **Boolean** | 明細を持つ場合true | [default to false] |
+| **slip_title** | **String** | 明細タイトル |  |
+| **slip_description** | **String** | 明細の説明 |  |
+| **slip_position** | **String** | 明細の位置 |  |
+| **ticket_number_format** | **String** | チケット番号のフォーマット |  |
+| **overwritable** | **Boolean** | 承認者による上書きが可能な場合true |  |
+| **created_at** | **String** | 作成日時 |  |
+| **updated_at** | **String** | 更新日時 |  |
+| **title_input_mode** | **String** | タイトル入力モード |  |
+| **title_formula** | **String** | タイトルの計算式 |  |
+| **author** | [**User**](User.md) |  |  |
+| **version_author** | [**User**](User.md) |  |  |
+| **folder** | [**Folder**](Folder.md) |  |  |
+| **categories** | [**Array<Category>**](Category.md) | カテゴリの配列 |  |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::Workflow.new(
+  id: null,
+  code: null,
+  version_id: null,
+  version_number: null,
+  name: null,
+  description: null,
+  status: null,
+  public_ticket: null,
+  visible_to_manager: null,
+  visible_to_team_members: null,
+  title_description: null,
+  slip: null,
+  slip_title: null,
+  slip_description: null,
+  slip_position: null,
+  ticket_number_format: null,
+  overwritable: null,
+  created_at: null,
+  updated_at: null,
+  title_input_mode: null,
+  title_formula: null,
+  author: null,
+  version_author: null,
+  folder: null,
+  categories: null
+)
+```
+

data/docs/WorkflowDetail.md

@@ -0,0 +1,76 @@
+# Kickflow::WorkflowDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID |  |
+| **code** | **String** | コード |  |
+| **version_id** | **String** | バージョンのUUID |  |
+| **version_number** | **Integer** | バージョン番号 |  |
+| **name** | **String** | 名前 |  |
+| **description** | **String** | 説明 |  |
+| **status** | **String** | ステータス。visibleは有効、invisibleは無効、deletedは削除済み。 |  |
+| **public_ticket** | **Boolean** | チケットが全体公開される場合true | [default to false] |
+| **visible_to_manager** | **String** | 申請者の上長を閲覧者に追加するか。noneは追加しない、directは直属の上長のみ、allはすべての上長を表す。 |  |
+| **visible_to_team_members** | **Boolean** | 申請チームのメンバーが閲覧者に追加される場合true | [default to false] |
+| **title_description** | **String** | タイトルの説明 |  |
+| **slip** | **Boolean** | 明細を持つ場合true | [default to false] |
+| **slip_title** | **String** | 明細タイトル |  |
+| **slip_description** | **String** | 明細の説明 |  |
+| **slip_position** | **String** | 明細の位置 |  |
+| **ticket_number_format** | **String** | チケット番号のフォーマット |  |
+| **overwritable** | **Boolean** | 承認者による上書きが可能な場合true |  |
+| **created_at** | **String** | 作成日時 |  |
+| **updated_at** | **String** | 更新日時 |  |
+| **title_input_mode** | **String** | タイトル入力モード |  |
+| **title_formula** | **String** | タイトルの計算式 |  |
+| **author** | [**User**](User.md) |  |  |
+| **version_author** | [**User**](User.md) |  |  |
+| **folder** | [**Folder**](Folder.md) |  |  |
+| **categories** | [**Array<Category>**](Category.md) | カテゴリの配列 |  |
+| **sections** | [**Array<Section>**](Section.md) | セクションの配列 |  |
+| **slip_fields** | [**Array<SlipFieldDetail>**](SlipFieldDetail.md) | 明細フィールド |  |
+| **ticket_viewers** | [**Array<WorkflowTicketViewer>**](WorkflowTicketViewer.md) | ワークフロー単位のチケット閲覧者 |  |
+| **cloud_sign_setting** | [**WorkflowInTicketAllOfCloudSignSetting**](WorkflowInTicketAllOfCloudSignSetting.md) |  |  |
+| **route_conditions** | [**Array<WorkflowRouteCondition>**](WorkflowRouteCondition.md) | 経路分岐 |  |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::WorkflowDetail.new(
+  id: null,
+  code: null,
+  version_id: null,
+  version_number: null,
+  name: null,
+  description: null,
+  status: null,
+  public_ticket: null,
+  visible_to_manager: null,
+  visible_to_team_members: null,
+  title_description: null,
+  slip: null,
+  slip_title: null,
+  slip_description: null,
+  slip_position: null,
+  ticket_number_format: null,
+  overwritable: null,
+  created_at: null,
+  updated_at: null,
+  title_input_mode: null,
+  title_formula: null,
+  author: null,
+  version_author: null,
+  folder: null,
+  categories: null,
+  sections: null,
+  slip_fields: null,
+  ticket_viewers: null,
+  cloud_sign_setting: null,
+  route_conditions: null
+)
+```
+

data/docs/WorkflowInTicket.md

@@ -0,0 +1,74 @@
+# Kickflow::WorkflowInTicket
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID |  |
+| **code** | **String** | コード |  |
+| **version_id** | **String** | バージョンのUUID |  |
+| **version_number** | **Integer** | バージョン番号 |  |
+| **name** | **String** | 名前 |  |
+| **description** | **String** | 説明 |  |
+| **status** | **String** | ステータス。visibleは有効、invisibleは無効、deletedは削除済み。 |  |
+| **public_ticket** | **Boolean** | チケットが全体公開される場合true | [default to false] |
+| **visible_to_manager** | **String** | 申請者の上長を閲覧者に追加するか。noneは追加しない、directは直属の上長のみ、allはすべての上長を表す。 |  |
+| **visible_to_team_members** | **Boolean** | 申請チームのメンバーが閲覧者に追加される場合true | [default to false] |
+| **title_description** | **String** | タイトルの説明 |  |
+| **slip** | **Boolean** | 明細を持つ場合true | [default to false] |
+| **slip_title** | **String** | 明細タイトル |  |
+| **slip_description** | **String** | 明細の説明 |  |
+| **slip_position** | **String** | 明細の位置 |  |
+| **ticket_number_format** | **String** | チケット番号のフォーマット |  |
+| **overwritable** | **Boolean** | 承認者による上書きが可能な場合true |  |
+| **created_at** | **String** | 作成日時 |  |
+| **updated_at** | **String** | 更新日時 |  |
+| **title_input_mode** | **String** | タイトル入力モード |  |
+| **title_formula** | **String** | タイトルの計算式 |  |
+| **author** | [**User**](User.md) |  |  |
+| **version_author** | [**User**](User.md) |  |  |
+| **folder** | [**Folder**](Folder.md) |  |  |
+| **categories** | [**Array<Category>**](Category.md) | カテゴリの配列 |  |
+| **sections** | [**Array<Section>**](Section.md) | セクションの配列 |  |
+| **slip_fields** | [**Array<SlipFieldDetail>**](SlipFieldDetail.md) | 明細フィールドの配列 | [optional] |
+| **ticket_viewers** | [**Array<WorkflowTicketViewer>**](WorkflowTicketViewer.md) | ワークフロー単位のチケット閲覧者 |  |
+| **cloud_sign_setting** | [**WorkflowInTicketAllOfCloudSignSetting**](WorkflowInTicketAllOfCloudSignSetting.md) |  |  |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::WorkflowInTicket.new(
+  id: null,
+  code: null,
+  version_id: null,
+  version_number: null,
+  name: null,
+  description: null,
+  status: null,
+  public_ticket: null,
+  visible_to_manager: null,
+  visible_to_team_members: null,
+  title_description: null,
+  slip: null,
+  slip_title: null,
+  slip_description: null,
+  slip_position: null,
+  ticket_number_format: null,
+  overwritable: null,
+  created_at: null,
+  updated_at: null,
+  title_input_mode: null,
+  title_formula: null,
+  author: null,
+  version_author: null,
+  folder: null,
+  categories: null,
+  sections: null,
+  slip_fields: null,
+  ticket_viewers: null,
+  cloud_sign_setting: null
+)
+```
+

data/docs/WorkflowInTicketAllOfCloudSignSetting.md

@@ -0,0 +1,18 @@
+# Kickflow::WorkflowInTicketAllOfCloudSignSetting
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **required** | **Boolean** | 書類の添付が必須な場合true |  |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::WorkflowInTicketAllOfCloudSignSetting.new(
+  required: null
+)
+```
+

data/docs/WorkflowRouteCondition.md

@@ -0,0 +1,30 @@
+# Kickflow::WorkflowRouteCondition
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID |  |
+| **condition_type** | **String** | 経路分岐タイプ |  |
+| **combination_type** | **String** | 条件の組み合わせタイプ |  |
+| **combination_expression** | **String** | 高度な条件式 |  |
+| **route** | [**Route**](Route.md) |  |  |
+| **condition_fields** | [**Array<WorkflowRouteConditionField>**](WorkflowRouteConditionField.md) | 条件 |  |
+| **error_message** | **String** | 申請拒否時のエラーメッセージ。routeまたはerrorMessageは片方のみ値が入ります。 |  |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::WorkflowRouteCondition.new(
+  id: null,
+  condition_type: null,
+  combination_type: null,
+  combination_expression: null,
+  route: null,
+  condition_fields: null,
+  error_message: null
+)
+```
+

data/docs/WorkflowRouteConditionField.md

@@ -0,0 +1,30 @@
+# Kickflow::WorkflowRouteConditionField
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID |  |
+| **symbol** | **String** | 演算子 |  |
+| **value** | **String** | しきい値 |  |
+| **form_field** | [**FormField**](FormField.md) |  |  |
+| **grade** | [**Grade**](Grade.md) |  |  |
+| **team** | [**Team**](Team.md) |  |  |
+| **general_master_item** | [**GeneralMasterItem**](GeneralMasterItem.md) |  |  |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::WorkflowRouteConditionField.new(
+  id: null,
+  symbol: null,
+  value: null,
+  form_field: null,
+  grade: null,
+  team: null,
+  general_master_item: null
+)
+```
+

data/docs/WorkflowTicketViewer.md

@@ -0,0 +1,24 @@
+# Kickflow::WorkflowTicketViewer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID |  |
+| **user** | [**User**](User.md) |  |  |
+| **team** | [**Team**](Team.md) |  |  |
+| **grade** | [**Grade**](Grade.md) |  |  |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::WorkflowTicketViewer.new(
+  id: null,
+  user: null,
+  team: null,
+  grade: null
+)
+```
+

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'

data/kickflow.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path("../lib", __FILE__)
+require "kickflow/version"
+
+Gem::Specification.new do |s|
+  s.name        = "kickflow"
+  s.version     = Kickflow::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["gemmaro"]
+  s.email       = ["gemmaro.dev@gmail.com"]
+  s.homepage    = "https://codeberg.org/gemmaro/kickflow"
+  s.summary     = "kickflow REST API client"
+  s.description = <<~TEXT
+    This gem is a REST API client for the kickflow[https://kickflow.com/].
+    For its REST API documentation, see {kickflow Developer / REST API}[https://developer.kickflow.com/rest/].
+
+    Example::
+      Kickflow.configure { |config| config.access_token = YOUR_ACCESS_TOKEN }
+      Kickflow::DefaultApi.new.get_categories(debug_auth_names: ["Authorization"]) #=> [...]
+  TEXT
+  s.license = "Apache-2.0"
+  s.required_ruby_version = ">= 3.0"
+  s.metadata = {}
+
+  s.add_runtime_dependency 'faraday', '>= 1.0.1', '< 3.0'
+  s.add_runtime_dependency 'faraday-multipart'
+  s.add_runtime_dependency 'marcel'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end