kickflow 0.1.0

data/docs/SubStatus.md

@@ -0,0 +1,28 @@
+# Kickflow::SubStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID |  |
+| **code** | **String** | コード |  |
+| **name** | **String** | 名前 |  |
+| **notes** | **String** | 説明 | [optional] |
+| **created_at** | **Time** | 作成日時 |  |
+| **updated_at** | **Time** | 更新日時 |  |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::SubStatus.new(
+  id: null,
+  code: null,
+  name: null,
+  notes: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/Team.md

@@ -0,0 +1,32 @@
+# Kickflow::Team
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID |  |
+| **name** | **String** | 名前 |  |
+| **full_name** | **String** | 上位組織を含む名前 |  |
+| **code** | **String** | コード |  |
+| **approve_only** | **Boolean** | 承認専用チームかどうか |  |
+| **users_count** | **Integer** | ユーザー数 |  |
+| **created_at** | **Time** | 作成日時 |  |
+| **updated_at** | **Time** | 更新日時 |  |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::Team.new(
+  id: null,
+  name: null,
+  full_name: null,
+  code: null,
+  approve_only: null,
+  users_count: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/TeamCreateBody.md

@@ -0,0 +1,24 @@
+# Kickflow::TeamCreateBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | 名前 |  |
+| **code** | **String** | コード。未指定の場合、ランダムな英数字がセットされます。 | [optional] |
+| **parent_id** | **String** | 親チームのUUID。nullの場合、作成したチームはルートになります。 | [optional] |
+| **approve_only** | **Boolean** | 承認専用チームかどうか | [optional] |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::TeamCreateBody.new(
+  name: null,
+  code: null,
+  parent_id: null,
+  approve_only: null
+)
+```
+

data/docs/TeamDetail.md

@@ -0,0 +1,38 @@
+# Kickflow::TeamDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID |  |
+| **name** | **String** | 名前 |  |
+| **full_name** | **String** | 上位組織を含む名前 |  |
+| **code** | **String** | コード |  |
+| **approve_only** | **Boolean** | 承認専用チームかどうか |  |
+| **users_count** | **Integer** | ユーザー数 |  |
+| **created_at** | **Time** | 作成日時 |  |
+| **updated_at** | **Time** | 更新日時 |  |
+| **parent** | [**Team**](Team.md) |  | [optional] |
+| **children** | [**Array<Team>**](Team.md) | 子チーム |  |
+| **users** | [**Array<MemberUser>**](MemberUser.md) | メンバーの配列。  注意：パフォーマンス上の理由から、100件を超えるメンバーを返すことはできません。101件以上のメンバーをすべて取得したい場合は、別途メンバー取得APIを呼び出してください。 |  |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::TeamDetail.new(
+  id: null,
+  name: null,
+  full_name: null,
+  code: null,
+  approve_only: null,
+  users_count: null,
+  created_at: null,
+  updated_at: null,
+  parent: null,
+  children: null,
+  users: null
+)
+```
+

data/docs/TeamUpdateBody.md

@@ -0,0 +1,24 @@
+# Kickflow::TeamUpdateBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | 名前 | [optional] |
+| **code** | **String** | コード。未指定の場合、ランダムな英数字がセットされます。 | [optional] |
+| **parent_id** | **String** | 親チームのID | [optional] |
+| **approve_only** | **Boolean** | 承認専用チームかどうか | [optional] |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::TeamUpdateBody.new(
+  name: null,
+  code: null,
+  parent_id: null,
+  approve_only: null
+)
+```
+

data/docs/Ticket.md

@@ -0,0 +1,50 @@
+# Kickflow::Ticket
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID |  |
+| **ticket_number** | **String** | チケット番号 |  |
+| **title** | **String** | タイトル | [optional] |
+| **status** | **String** | ステータス |  |
+| **sub_status** | [**SubStatus**](SubStatus.md) |  | [optional] |
+| **current_step** | **Float** | 現在のステップ。0が起票者、1が最初の承認ステップ。 |  |
+| **author** | [**User**](User.md) |  |  |
+| **proxy_client_user** | [**User**](User.md) |  |  |
+| **created_at** | **Time** | 作成日時 |  |
+| **opened_at** | **Time** | 申請日時 |  |
+| **completed_at** | **Time** | 完了日時 |  |
+| **archived_at** | **Time** | アーカイブ日時 |  |
+| **updated_at** | **Time** | 更新日時 |  |
+| **public_status** | **Boolean** | チケットが全体公開の場合true |  |
+| **forced_public_type** | **String** | チケットの強制公開設定 |  |
+| **workflow** | [**TicketWorkflow**](TicketWorkflow.md) |  |  |
+| **labels** | [**Array<Label>**](Label.md) | チケットのラベルの配列 |  |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::Ticket.new(
+  id: null,
+  ticket_number: null,
+  title: null,
+  status: null,
+  sub_status: null,
+  current_step: null,
+  author: null,
+  proxy_client_user: null,
+  created_at: null,
+  opened_at: null,
+  completed_at: null,
+  archived_at: null,
+  updated_at: null,
+  public_status: null,
+  forced_public_type: null,
+  workflow: null,
+  labels: null
+)
+```
+

data/docs/TicketAssignee.md

@@ -0,0 +1,28 @@
+# Kickflow::TicketAssignee
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID |  |
+| **step_order** | **Integer** | ステップ番号。1が最初の承認ステップ。 |  |
+| **current** | **Boolean** | 現在の承認ステップの場合true |  |
+| **completed** | **Boolean** | 承認済みの場合true |  |
+| **completed_at** | **Time** | 承認日時。古いデータではnullを返します。 |  |
+| **user** | [**User**](User.md) |  |  |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::TicketAssignee.new(
+  id: null,
+  step_order: null,
+  current: null,
+  completed: null,
+  completed_at: null,
+  user: null
+)
+```
+

data/docs/TicketDetail.md

@@ -0,0 +1,68 @@
+# Kickflow::TicketDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID |  |
+| **ticket_number** | **String** | チケット番号 |  |
+| **title** | **String** | タイトル | [optional] |
+| **status** | **String** | ステータス |  |
+| **sub_status** | [**SubStatus**](SubStatus.md) |  | [optional] |
+| **current_step** | **Float** | 現在のステップ。0が起票者、1が最初の承認ステップ。 |  |
+| **author** | [**User**](User.md) |  |  |
+| **proxy_client_user** | [**User**](User.md) |  |  |
+| **created_at** | **Time** | 作成日時 |  |
+| **opened_at** | **Time** | 申請日時 |  |
+| **completed_at** | **Time** | 完了日時 |  |
+| **archived_at** | **Time** | アーカイブ日時 |  |
+| **updated_at** | **Time** | 更新日時 |  |
+| **public_status** | **Boolean** | チケットが全体公開の場合true |  |
+| **forced_public_type** | **String** | チケットの強制公開設定 |  |
+| **workflow** | [**TicketWorkflow**](TicketWorkflow.md) |  |  |
+| **labels** | [**Array<Label>**](Label.md) | チケットのラベルの配列 |  |
+| **author_team** | [**Team**](Team.md) |  |  |
+| **route** | [**RouteDetail**](RouteDetail.md) |  |  |
+| **trigger_ticket** | [**Ticket**](Ticket.md) |  | [optional] |
+| **next_tickets** | [**Array<Ticket>**](Ticket.md) | 次のチケット（パイプラインで次のチケットを作成したときのみ値が入ります） | [optional] |
+| **slip_items** | [**Array<SlipItem>**](SlipItem.md) | 明細の入力 |  |
+| **ticket_sections** | [**Array<TicketSection>**](TicketSection.md) | セクションの配列 |  |
+| **inputs** | [**Array<TicketInput>**](TicketInput.md) | フォームの入力 |  |
+| **cloud_sign_document** | [**TicketDetailAllOfCloudSignDocument**](TicketDetailAllOfCloudSignDocument.md) |  |  |
+| **steps** | [**Array<TicketStep>**](TicketStep.md) | チケットのステップ |  |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::TicketDetail.new(
+  id: null,
+  ticket_number: null,
+  title: null,
+  status: null,
+  sub_status: null,
+  current_step: null,
+  author: null,
+  proxy_client_user: null,
+  created_at: null,
+  opened_at: null,
+  completed_at: null,
+  archived_at: null,
+  updated_at: null,
+  public_status: null,
+  forced_public_type: null,
+  workflow: null,
+  labels: null,
+  author_team: null,
+  route: null,
+  trigger_ticket: null,
+  next_tickets: null,
+  slip_items: null,
+  ticket_sections: null,
+  inputs: null,
+  cloud_sign_document: null,
+  steps: null
+)
+```
+

data/docs/TicketDetailAllOfCloudSignDocument.md

@@ -0,0 +1,32 @@
+# Kickflow::TicketDetailAllOfCloudSignDocument
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID |  |
+| **document_id** | **String** | クラウドサイン書類のID |  |
+| **document_title** | **String** | クラウドサイン書類のタイトル |  |
+| **status** | **String** | クラウドサイン書類のステータス |  |
+| **sandbox** | **Boolean** | クラウドサインがサンドボックス環境の場合true |  |
+| **created_at** | **Time** | 作成日時 |  |
+| **updated_at** | **Time** | 更新日時 |  |
+| **url** | **String** | クラウドサイン書類のURL |  |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::TicketDetailAllOfCloudSignDocument.new(
+  id: null,
+  document_id: null,
+  document_title: null,
+  status: null,
+  sandbox: null,
+  created_at: null,
+  updated_at: null,
+  url: null
+)
+```
+

data/docs/TicketInput.md

@@ -0,0 +1,32 @@
+# Kickflow::TicketInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID |  |
+| **value** | [**TicketInputValue**](TicketInputValue.md) |  |  |
+| **form_field** | [**FormField**](FormField.md) |  | [optional] |
+| **general_master_items** | [**Array<GeneralMasterItem>**](GeneralMasterItem.md) | 入力値: 汎用マスタアイテム | [optional] |
+| **users** | [**Array<User>**](User.md) | 入力値: ユーザー | [optional] |
+| **teams** | [**Array<Team>**](Team.md) | 入力値: チーム | [optional] |
+| **input_tickets** | [**Array<Ticket>**](Ticket.md) | 入力値: チケット | [optional] |
+| **attachments** | [**Array<Attachment>**](Attachment.md) | 添付ファイル | [optional] |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::TicketInput.new(
+  id: null,
+  value: null,
+  form_field: null,
+  general_master_items: null,
+  users: null,
+  teams: null,
+  input_tickets: null,
+  attachments: null
+)
+```
+

data/docs/TicketInputValue.md

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

data/docs/TicketSection.md

@@ -0,0 +1,22 @@
+# Kickflow::TicketSection
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **section_id** | **String** | ワークフローのセクションID |  |
+| **visible** | **Boolean** | セクションの表示状態 |  |
+| **inputs** | [**Array<TicketInput>**](TicketInput.md) | このセクションの入力の配列 |  |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::TicketSection.new(
+  section_id: null,
+  visible: null,
+  inputs: null
+)
+```
+

data/docs/TicketStep.md

@@ -0,0 +1,44 @@
+# Kickflow::TicketStep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID |  |
+| **route_step_id** | **String** | 経路ステップのUUID。カスタムステップの場合、nullになります。 |  |
+| **title** | **String** | ステップのタイトル |  |
+| **action_type** | **String** | アクションタイプ。承認/差し戻しの場合approve、回覧（確認あり）の場合confirm、回覧（確認なし）の場合noneになります。 |  |
+| **required_approvals_number** | **Integer** | 必要な承認人数 |  |
+| **required_approvals_percent** | **Integer** | 必要な承認割合% |  |
+| **step_order** | **Integer** | ステップの順序。最初の承認ステップが1。 |  |
+| **skip** | **Boolean** | スキップ可能な場合true |  |
+| **fallback** | **Boolean** | フォールバックした場合true |  |
+| **fallback_result** | **String** | フォールバックの結果 |  |
+| **author** | [**User**](User.md) |  |  |
+| **assignees** | [**Array<TicketAssignee>**](TicketAssignee.md) | 承認者 |  |
+| **completed** | **Boolean** | ステップが完了している場合true |  |
+| **completed_at** | **Time** | ステップが完了した日時。過去のデータではnullを返します。 |  |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::TicketStep.new(
+  id: null,
+  route_step_id: null,
+  title: null,
+  action_type: null,
+  required_approvals_number: null,
+  required_approvals_percent: null,
+  step_order: null,
+  skip: null,
+  fallback: null,
+  fallback_result: null,
+  author: null,
+  assignees: null,
+  completed: null,
+  completed_at: null
+)
+```
+

data/docs/TicketViewer.md

@@ -0,0 +1,24 @@
+# Kickflow::TicketViewer
+
+## 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::TicketViewer.new(
+  id: null,
+  user: null,
+  team: null,
+  grade: null
+)
+```
+

data/docs/TicketWorkflow.md

@@ -0,0 +1,74 @@
+# Kickflow::TicketWorkflow
+
+## 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::TicketWorkflow.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/User.md

@@ -0,0 +1,42 @@
+# Kickflow::User
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID |  |
+| **email** | **String** | メールアドレス |  |
+| **code** | **String** | コード |  |
+| **first_name** | **String** | 名 |  |
+| **last_name** | **String** | 姓 |  |
+| **full_name** | **String** | フルネーム |  |
+| **employee_id** | **String** | 社員番号 | [optional] |
+| **image** | [**UserImage**](UserImage.md) |  |  |
+| **status** | **String** | ステータス |  |
+| **locale** | **String** | ロケール（jaまたはen） |  |
+| **created_at** | **Time** | 作成日時 |  |
+| **updated_at** | **Time** | 更新日時 |  |
+| **deactivated_at** | **Time** | 削除日時 | [optional] |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::User.new(
+  id: null,
+  email: null,
+  code: null,
+  first_name: null,
+  last_name: null,
+  full_name: null,
+  employee_id: null,
+  image: null,
+  status: null,
+  locale: null,
+  created_at: null,
+  updated_at: null,
+  deactivated_at: null
+)
+```
+

data/docs/UserDetail.md

@@ -0,0 +1,42 @@
+# Kickflow::UserDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID |  |
+| **email** | **String** | メールアドレス |  |
+| **code** | **String** | コード |  |
+| **first_name** | **String** | 名 |  |
+| **last_name** | **String** | 姓 |  |
+| **full_name** | **String** | フルネーム |  |
+| **employee_id** | **String** | 社員番号 | [optional] |
+| **image** | [**UserImage**](UserImage.md) |  |  |
+| **status** | **String** | ステータス |  |
+| **locale** | **String** | ロケール（jaまたはen） |  |
+| **created_at** | **Time** | 作成日時 |  |
+| **updated_at** | **Time** | 更新日時 |  |
+| **deactivated_at** | **Time** | 削除日時 | [optional] |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::UserDetail.new(
+  id: null,
+  email: null,
+  code: null,
+  first_name: null,
+  last_name: null,
+  full_name: null,
+  employee_id: null,
+  image: null,
+  status: null,
+  locale: null,
+  created_at: null,
+  updated_at: null,
+  deactivated_at: null
+)
+```
+

data/docs/UserImage.md

@@ -0,0 +1,18 @@
+# Kickflow::UserImage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_100x100** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'kickflow'
+
+instance = Kickflow::UserImage.new(
+  _100x100: null
+)
+```
+