kickflow 0.1.0

data/docs/ProxyApplicant.md

@@ -0,0 +1,32 @@
+# Kickflow::ProxyApplicant
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID |  |
+| **created_at** | **Time** | 作成日時 |  |
+| **updated_at** | **Time** | 更新日時 |  |
+| **user** | [**User**](User.md) |  |  |
+| **proxy_user** | [**User**](User.md) |  |  |
+| **starts_on** | **Date** | 開始日 |  |
+| **ends_on** | **Date** | 終了日 |  |
+| **workflows** | [**Array<Workflow>**](Workflow.md) | 対象ワークフロー |  |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::ProxyApplicant.new(
+  id: null,
+  created_at: null,
+  updated_at: null,
+  user: null,
+  proxy_user: null,
+  starts_on: null,
+  ends_on: null,
+  workflows: null
+)
+```
+

data/docs/ProxyApprover.md

@@ -0,0 +1,32 @@
+# Kickflow::ProxyApprover
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID |  |
+| **created_at** | **Time** | 作成日時 |  |
+| **updated_at** | **Time** | 更新日時 |  |
+| **user** | [**User**](User.md) |  |  |
+| **proxy_user** | [**User**](User.md) |  |  |
+| **starts_on** | **Date** | 開始日 |  |
+| **ends_on** | **Date** | 終了日 |  |
+| **workflows** | [**Array<Workflow>**](Workflow.md) | 対象ワークフロー |  |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::ProxyApprover.new(
+  id: null,
+  created_at: null,
+  updated_at: null,
+  user: null,
+  proxy_user: null,
+  starts_on: null,
+  ends_on: null,
+  workflows: null
+)
+```
+

data/docs/Role.md

@@ -0,0 +1,28 @@
+# Kickflow::Role
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID |  |
+| **name** | **String** | 名前 |  |
+| **editable** | **Boolean** | 編集可能かどうか。「すべての管理者」のときだけfalseになります。 |  |
+| **users_count** | **Integer** | この管理者ロールに所属するユーザー数 |  |
+| **created_at** | **Time** | 作成日時 |  |
+| **updated_at** | **Time** | 更新日時 |  |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::Role.new(
+  id: null,
+  name: null,
+  editable: null,
+  users_count: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/RoleCreateBody.md

@@ -0,0 +1,20 @@
+# Kickflow::RoleCreateBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | 名前 |  |
+| **permission_list** | [**Array<RoleCreateBodyPermissionListInner>**](RoleCreateBodyPermissionListInner.md) | 権限リスト |  |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::RoleCreateBody.new(
+  name: null,
+  permission_list: null
+)
+```
+

data/docs/RoleCreateBodyPermissionListInner.md

@@ -0,0 +1,26 @@
+# Kickflow::RoleCreateBodyPermissionListInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **permission** | **String** | 権限タイプ |  |
+| **restricted** | **Boolean** | 管理対象を制限する場合true |  |
+| **folder_ids** | **Array<String>** | 管理対象のフォルダID | [optional] |
+| **general_master_ids** | **Array<String>** | 管理対象の汎用マスタID | [optional] |
+| **team_ids** | **Array<String>** | 管理対象のチームID | [optional] |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::RoleCreateBodyPermissionListInner.new(
+  permission: null,
+  restricted: null,
+  folder_ids: null,
+  general_master_ids: null,
+  team_ids: null
+)
+```
+

data/docs/RoleDetail.md

@@ -0,0 +1,30 @@
+# Kickflow::RoleDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID |  |
+| **name** | **String** | 名前 |  |
+| **editable** | **Boolean** | 編集可能かどうか。「すべての管理者」のときだけfalseになります。 |  |
+| **users_count** | **Integer** | この管理者ロールに所属するユーザー数 |  |
+| **created_at** | **Time** | 作成日時 |  |
+| **updated_at** | **Time** | 更新日時 |  |
+| **permission_list** | [**Array<RoleDetailAllOfPermissionList>**](RoleDetailAllOfPermissionList.md) | 権限のリスト |  |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::RoleDetail.new(
+  id: null,
+  name: null,
+  editable: null,
+  users_count: null,
+  created_at: null,
+  updated_at: null,
+  permission_list: null
+)
+```
+

data/docs/RoleDetailAllOfPermissionList.md

@@ -0,0 +1,26 @@
+# Kickflow::RoleDetailAllOfPermissionList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **permission** | **String** | 権限タイプ |  |
+| **restricted** | **Boolean** | 管理対象が制限されている場合true |  |
+| **folders** | [**Array<Folder>**](Folder.md) | 管理対象のフォルダ |  |
+| **general_masters** | [**Array<GeneralMaster>**](GeneralMaster.md) | 管理対象の汎用マスタ |  |
+| **teams** | [**Array<Team>**](Team.md) | 管理対象のチーム |  |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::RoleDetailAllOfPermissionList.new(
+  permission: null,
+  restricted: null,
+  folders: null,
+  general_masters: null,
+  teams: null
+)
+```
+

data/docs/RoleUpdateBody.md

@@ -0,0 +1,20 @@
+# Kickflow::RoleUpdateBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | 名前 | [optional] |
+| **permission_list** | [**Array<RoleUpdateBodyPermissionListInner>**](RoleUpdateBodyPermissionListInner.md) | 権限リスト | [optional] |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::RoleUpdateBody.new(
+  name: null,
+  permission_list: null
+)
+```
+

data/docs/RoleUpdateBodyPermissionListInner.md

@@ -0,0 +1,26 @@
+# Kickflow::RoleUpdateBodyPermissionListInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **permission** | **String** | 権限タイプ |  |
+| **restricted** | **Boolean** | 管理対象を制限する場合true |  |
+| **folder_ids** | **Array<String>** | 管理対象のフォルダID |  |
+| **general_master_ids** | **Array<String>** | 管理対象の汎用マスタID |  |
+| **team_ids** | **Array<String>** | 管理対象のチームID |  |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::RoleUpdateBodyPermissionListInner.new(
+  permission: null,
+  restricted: null,
+  folder_ids: null,
+  general_master_ids: null,
+  team_ids: null
+)
+```
+

data/docs/Route.md

@@ -0,0 +1,40 @@
+# Kickflow::Route
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID |  |
+| **code** | **String** | コード |  |
+| **status** | **String** | ステータス |  |
+| **version_id** | **String** | バージョンのID |  |
+| **version_number** | **Integer** | バージョン番号 |  |
+| **name** | **String** | 名前 |  |
+| **description** | **String** | 説明文 |  |
+| **created_at** | **String** | 作成日時 |  |
+| **updated_at** | **String** | 更新日時 |  |
+| **author** | [**User**](User.md) |  | [optional] |
+| **version_author** | [**User**](User.md) |  | [optional] |
+| **folder** | [**Folder**](Folder.md) |  |  |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::Route.new(
+  id: null,
+  code: null,
+  status: null,
+  version_id: null,
+  version_number: null,
+  name: null,
+  description: null,
+  created_at: null,
+  updated_at: null,
+  author: null,
+  version_author: null,
+  folder: null
+)
+```
+

data/docs/RouteDetail.md

@@ -0,0 +1,42 @@
+# Kickflow::RouteDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID |  |
+| **code** | **String** | コード |  |
+| **status** | **String** | ステータス |  |
+| **version_id** | **String** | バージョンのID |  |
+| **version_number** | **Integer** | バージョン番号 |  |
+| **name** | **String** | 名前 |  |
+| **description** | **String** | 説明文 |  |
+| **created_at** | **String** | 作成日時 |  |
+| **updated_at** | **String** | 更新日時 |  |
+| **author** | [**User**](User.md) |  | [optional] |
+| **version_author** | [**User**](User.md) |  | [optional] |
+| **folder** | [**Folder**](Folder.md) |  |  |
+| **steps** | [**Array<RouteStep>**](RouteStep.md) | 経路ステップ |  |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::RouteDetail.new(
+  id: null,
+  code: null,
+  status: null,
+  version_id: null,
+  version_number: null,
+  name: null,
+  description: null,
+  created_at: null,
+  updated_at: null,
+  author: null,
+  version_author: null,
+  folder: null,
+  steps: null
+)
+```
+

data/docs/RouteStep.md

@@ -0,0 +1,44 @@
+# Kickflow::RouteStep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID |  |
+| **step_order** | **Integer** | ステップ順序（1から始まります） |  |
+| **step_type** | **String** | ステップのタイプ |  |
+| **title** | **String** | タイトル |  |
+| **action_type** | **String** | アクションタイプ。承認/差し戻しの場合approve、回覧（確認あり）の場合confirm、回覧（確認なし）の場合noneになります。 |  |
+| **instruction** | **String** | 承認者への指示 |  |
+| **required_approvals_number** | **Integer** | 必要な承認人数 |  |
+| **required_approvals_percent** | **Integer** | 必要な承認割合（%） |  |
+| **fallback_type** | **String** | フォールバックのタイプ |  |
+| **allow_self_approval** | **Boolean** | 自己承認を許可するか |  |
+| **min_custom_assignees** | **Integer** | 最小指名人数。「申請者が指名」ステップのみ設定可能。 |  |
+| **users** | [**Array<User>**](User.md) | 承認者の指定に使うユーザーの配列 |  |
+| **targets** | [**Array<RouteStepTarget>**](RouteStepTarget.md) | 承認者の指定に使うチームと役職の条件 | [optional] |
+| **route_step_condition** | [**RouteStepCondition**](RouteStepCondition.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::RouteStep.new(
+  id: null,
+  step_order: null,
+  step_type: null,
+  title: null,
+  action_type: null,
+  instruction: null,
+  required_approvals_number: null,
+  required_approvals_percent: null,
+  fallback_type: null,
+  allow_self_approval: null,
+  min_custom_assignees: null,
+  users: null,
+  targets: null,
+  route_step_condition: null
+)
+```
+

data/docs/RouteStepCondition.md

@@ -0,0 +1,24 @@
+# Kickflow::RouteStepCondition
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID | [optional] |
+| **condition_type** | **String** | 実行タイプ | [optional] |
+| **combination_type** | **String** | 条件の組み合わせタイプ | [optional] |
+| **route_step_condition_fields** | [**RouteStepConditionField**](RouteStepConditionField.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::RouteStepCondition.new(
+  id: null,
+  condition_type: null,
+  combination_type: null,
+  route_step_condition_fields: null
+)
+```
+

data/docs/RouteStepConditionField.md

@@ -0,0 +1,34 @@
+# Kickflow::RouteStepConditionField
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID | [optional] |
+| **display_order** | **Float** | 変数 | [optional] |
+| **variable** | **String** | 変数 | [optional] |
+| **field_key** | **String** | 変数のフィールド | [optional] |
+| **symbol** | **String** | 演算子 | [optional] |
+| **value** | **String** | しきい値 | [optional] |
+| **grade** | [**Grade**](Grade.md) |  | [optional] |
+| **team** | [**Team**](Team.md) |  | [optional] |
+| **general_master_item** | [**GeneralMasterItem**](GeneralMasterItem.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::RouteStepConditionField.new(
+  id: null,
+  display_order: null,
+  variable: null,
+  field_key: null,
+  symbol: null,
+  value: null,
+  grade: null,
+  team: null,
+  general_master_item: null
+)
+```
+

data/docs/RouteStepTarget.md

@@ -0,0 +1,24 @@
+# Kickflow::RouteStepTarget
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **team** | [**Team**](Team.md) |  | [optional] |
+| **descendants** | **Boolean** | stepType=author_customizableまたはstepType=assignee_customizableの場合に、指定したチームの下位チームのメンバーも承認者候補に含めるかどうか（true: 含める、false: 含めない） | [optional] |
+| **grade_symbol** | **String** | 役職の比較条件。役職が指定されているときのみ値が入ります。 | [optional] |
+| **grades** | [**Array<Grade>**](Grade.md) | 承認者の指定に使う役職の配列 | [optional] |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::RouteStepTarget.new(
+  team: null,
+  descendants: null,
+  grade_symbol: null,
+  grades: null
+)
+```
+

data/docs/Section.md

@@ -0,0 +1,32 @@
+# Kickflow::Section
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID |  |
+| **title** | **String** | タイトル |  |
+| **description** | **String** | 説明 |  |
+| **form_fields** | [**Array<FormFieldDetail>**](FormFieldDetail.md) | フォームフィールド |  |
+| **created_at** | **Time** | 作成日時 |  |
+| **updated_at** | **Time** | 更新日時 |  |
+| **conditional** | **Boolean** | 表示条件があるかどうか |  |
+| **condition_all_of** | **Boolean** | 条件をすべて満たす必要があるかどうか |  |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::Section.new(
+  id: null,
+  title: null,
+  description: null,
+  form_fields: null,
+  created_at: null,
+  updated_at: null,
+  conditional: null,
+  condition_all_of: null
+)
+```
+

data/docs/SlipField.md

@@ -0,0 +1,56 @@
+# Kickflow::SlipField
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID |  |
+| **field_type** | **String** | フィールドの型 |  |
+| **code** | **String** | フィールドのコード |  |
+| **title** | **String** | タイトル |  |
+| **required** | **Boolean** | 入力必須の場合true |  |
+| **show_total** | **Boolean** | 列の合計を表示する場合true |  |
+| **options** | **Array<String>** | 選択肢。プルダウンまたはチェックボックスのときのみ値が入ります。 |  |
+| **regexp_format** | **String** | 正規表現フォーマット |  |
+| **formula** | **String** | 計算式。型が自動計算のときのみ値が入ります。 |  |
+| **max_value** | **Float** | 最大値 |  |
+| **min_value** | **Float** | 最小値 |  |
+| **default_value** | **String** | 初期値 |  |
+| **decimal_digit** | **Integer** | 小数の桁数 |  |
+| **delimited** | **Boolean** | カンマ区切りで表示する場合true。 整数、数値、自動計算フィールド以外ではnullが入ります。 |  |
+| **allowed_extensions** | **Array<String>** | 添付可能な拡張子リスト |  |
+| **prefix** | **String** | 単位（接頭辞） |  |
+| **suffix** | **String** | 単位（接尾辞） |  |
+| **approver** | **Boolean** | 承認者が編集可能かどうか |  |
+| **author** | **Boolean** | 申請者が編集可能かどうか | [optional] |
+| **hidden** | **Boolean** | 隠しフィールドである場合true | [optional] |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::SlipField.new(
+  id: null,
+  field_type: null,
+  code: null,
+  title: null,
+  required: null,
+  show_total: null,
+  options: null,
+  regexp_format: null,
+  formula: null,
+  max_value: null,
+  min_value: null,
+  default_value: null,
+  decimal_digit: null,
+  delimited: null,
+  allowed_extensions: null,
+  prefix: null,
+  suffix: null,
+  approver: null,
+  author: null,
+  hidden: null
+)
+```
+

data/docs/SlipFieldDetail.md

@@ -0,0 +1,60 @@
+# Kickflow::SlipFieldDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID |  |
+| **field_type** | **String** | フィールドの型 |  |
+| **code** | **String** | フィールドのコード |  |
+| **title** | **String** | タイトル |  |
+| **required** | **Boolean** | 入力必須の場合true |  |
+| **show_total** | **Boolean** | 列の合計を表示する場合true |  |
+| **options** | **Array<String>** | 選択肢。プルダウンまたはチェックボックスのときのみ値が入ります。 |  |
+| **regexp_format** | **String** | 正規表現フォーマット |  |
+| **formula** | **String** | 計算式。型が自動計算のときのみ値が入ります。 |  |
+| **max_value** | **Float** | 最大値 |  |
+| **min_value** | **Float** | 最小値 |  |
+| **default_value** | **String** | 初期値 |  |
+| **decimal_digit** | **Integer** | 小数の桁数 |  |
+| **delimited** | **Boolean** | カンマ区切りで表示する場合true。 整数、数値、自動計算フィールド以外ではnullが入ります。 |  |
+| **allowed_extensions** | **Array<String>** | 添付可能な拡張子リスト |  |
+| **prefix** | **String** | 単位（接頭辞） |  |
+| **suffix** | **String** | 単位（接尾辞） |  |
+| **approver** | **Boolean** | 承認者が編集可能かどうか |  |
+| **author** | **Boolean** | 申請者が編集可能かどうか | [optional] |
+| **hidden** | **Boolean** | 隠しフィールドである場合true | [optional] |
+| **general_master** | [**GeneralMaster**](GeneralMaster.md) |  | [optional] |
+| **default_general_master_item** | [**GeneralMasterItem**](GeneralMasterItem.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::SlipFieldDetail.new(
+  id: null,
+  field_type: null,
+  code: null,
+  title: null,
+  required: null,
+  show_total: null,
+  options: null,
+  regexp_format: null,
+  formula: null,
+  max_value: null,
+  min_value: null,
+  default_value: null,
+  decimal_digit: null,
+  delimited: null,
+  allowed_extensions: null,
+  prefix: null,
+  suffix: null,
+  approver: null,
+  author: null,
+  hidden: null,
+  general_master: null,
+  default_general_master_item: null
+)
+```
+

data/docs/SlipItem.md

@@ -0,0 +1,24 @@
+# Kickflow::SlipItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID |  |
+| **inputs** | [**Array<SlipItemInput>**](SlipItemInput.md) | 明細アイテムの入力の配列 |  |
+| **created_at** | **Time** | 作成日時 |  |
+| **updated_at** | **Time** | 更新日時 |  |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::SlipItem.new(
+  id: null,
+  inputs: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/SlipItemInput.md

@@ -0,0 +1,30 @@
+# Kickflow::SlipItemInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID |  |
+| **slip_field_id** | **String** | 明細フィールドのUUID |  |
+| **created_at** | **Time** | 作成日時 |  |
+| **updated_at** | **Time** | 更新日時 |  |
+| **value** | [**SlipItemInputValue**](SlipItemInputValue.md) |  |  |
+| **general_master_items** | [**Array<GeneralMasterItem>**](GeneralMasterItem.md) | 入力値: 汎用マスタアイテム |  |
+| **attachments** | [**Array<Attachment>**](Attachment.md) | 添付ファイル |  |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::SlipItemInput.new(
+  id: null,
+  slip_field_id: null,
+  created_at: null,
+  updated_at: null,
+  value: null,
+  general_master_items: null,
+  attachments: null
+)
+```
+

data/docs/SlipItemInputValue.md

@@ -0,0 +1,15 @@
+# Kickflow::SlipItemInputValue
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::SlipItemInputValue.new()
+```
+