tungo-sdk 0.2.0

data/lib/tungo/models/automation_scenario_step.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # Шаг сценария.
+    class AutomationScenarioStep < Tungo::Model
+      # @!attribute [r] action
+      #   `agent` — ход ИИ (платный); `checks` — проверки учёта; `directbank` — опрос выписки
+      #   DirectBank; `notify` — вебхук automation.run.notice разработчику
+      #   @return [String]
+      required :action, :AutomationScenarioStepAction
+
+      # @!attribute [r] instruction
+      #   Поручение ИИ (только у agent); null — у шага без ИИ
+      #   @return [String, nil]
+      required :instruction, :string, nullable: true
+
+      # @!attribute [r] output
+      #   Форма итога (только у agent); null — нет
+      #   @return [Object]
+      required :output, :AutomationOutputSpec, nullable: true
+
+      # @!attribute [r] when
+      #   Когда выполняется шаг: always, previous_created_proposals, checks_found_issues,
+      #   previous_failed
+      #   @return [String]
+      required :when, :AutomationScenarioStepWhen
+    end
+  end
+end

data/lib/tungo/models/automation_scenario_step_action.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # `agent` — ход ИИ (платный); `checks` — проверки учёта; `directbank` — опрос выписки DirectBank;
+    # `notify` — вебхук automation.run.notice разработчику
+    #
+    # A value this SDK version does not know is passed through unchanged.
+    module AutomationScenarioStepAction
+      extend Tungo::Internal::Enum
+
+      AGENT = "agent"
+      CHECKS = "checks"
+      DIRECTBANK = "directbank"
+      NOTIFY = "notify"
+    end
+  end
+end

data/lib/tungo/models/automation_scenario_step_when.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # Когда выполняется шаг: always, previous_created_proposals, checks_found_issues, previous_failed
+    #
+    # A value this SDK version does not know is passed through unchanged.
+    module AutomationScenarioStepWhen
+      extend Tungo::Internal::Enum
+
+      ALWAYS = "always"
+      PREVIOUS_CREATED_PROPOSALS = "previous_created_proposals"
+      CHECKS_FOUND_ISSUES = "checks_found_issues"
+      PREVIOUS_FAILED = "previous_failed"
+    end
+  end
+end

data/lib/tungo/models/automation_schedule.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # Расписание запуска по Алматы. Пропущенный запуск (сервис был недоступен) догоняется одним запуском,
+    # а не пачкой за все пропущенные слоты.
+    #
+    # The variant is selected by the +kind+ property. An object with a value this SDK version
+    # does not know is returned as a {Tungo::UnknownVariant}.
+    module AutomationSchedule
+      extend Tungo::Internal::Union
+
+      discriminated_by(
+        "kind",
+        "daily" => :AutomationScheduleDaily,
+        "weekly" => :AutomationScheduleWeekly,
+        "monthly" => :AutomationScheduleMonthly,
+        "interval" => :AutomationScheduleInterval
+      )
+      variants(
+        :AutomationScheduleDaily,
+        :AutomationScheduleWeekly,
+        :AutomationScheduleMonthly,
+        :AutomationScheduleInterval
+      )
+    end
+  end
+end

data/lib/tungo/models/automation_schedule_daily.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # Каждый день в время at по Алматы.
+    class AutomationScheduleDaily < Tungo::Model
+      # @!attribute [r] at
+      #   Время запуска ЧЧ:ММ (24 часа) по Алматы (Asia/Almaty). Показывать как есть, в пояс
+      #   пользователя не переводить.
+      #   @return [String]
+      required :at, :string
+
+      # @!attribute [r] kind
+      #   `daily` — каждый день
+      #   @return [String]
+      required :kind, :string
+    end
+  end
+end

data/lib/tungo/models/automation_schedule_interval.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # Запуски в from, from + N ч, from + 2N ч … не позже to, в выбранные дни. Например, каждые 2 часа с
+    # 09:00 до 19:00 по будням — проверить остаток на счёте.
+    class AutomationScheduleInterval < Tungo::Model
+      # @!attribute [r] days
+      #   Дни недели по ISO (1 — понедельник … 7 — воскресенье) без повторов; нет — каждый день.
+      #   @return [Array<Integer>, nil]
+      optional :days, array_of(:integer)
+
+      # @!attribute [r] every_hours
+      #   Шаг в часах, 1…12.
+      #   @return [Integer]
+      required :every_hours, :integer
+
+      # @!attribute [r] from
+      #   Первый запуск дня, ЧЧ:ММ по Алматы.
+      #   @return [String]
+      required :from, :string
+
+      # @!attribute [r] kind
+      #   `interval` — каждые N часов в пределах дня
+      #   @return [String]
+      required :kind, :string
+
+      # @!attribute [r] to
+      #   Позже этого времени (ЧЧ:ММ по Алматы) запусков в этот день нет; раньше from быть не может.
+      #   @return [String]
+      required :to, :string
+    end
+  end
+end

data/lib/tungo/models/automation_schedule_monthly.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # По числам месяца в время at по Алматы. Например, 25-го в 10:00 — проверить НДС; последний рабочий
+    # день в 18:00 — закрытие месяца.
+    class AutomationScheduleMonthly < Tungo::Model
+      # @!attribute [r] at
+      #   Время запуска ЧЧ:ММ (24 часа) по Алматы (Asia/Almaty). Показывать как есть, в пояс
+      #   пользователя не переводить.
+      #   @return [String]
+      required :at, :string
+
+      # @!attribute [r] days
+      #   Числа месяца 1…31 без повторов. Числа, которого нет в месяце (31 в ноябре, 30 в феврале), в
+      #   этом месяце запуска нет — на последний день месяца используйте last_day.
+      #   @return [Array<Integer>, nil]
+      optional :days, array_of(:integer)
+
+      # @!attribute [r] kind
+      #   `monthly` — по числам месяца
+      #   @return [String]
+      required :kind, :string
+
+      # @!attribute [r] last_day
+      #   true — ещё и в последний день месяца (28, 29, 30 или 31-е).
+      #   @return [Boolean, nil]
+      optional :last_day, :boolean
+
+      # @!attribute [r] last_workday
+      #   true — ещё и в последний рабочий день месяца по производственному календарю РК из базы знаний
+      #   (выходные и праздники Закона «О праздниках в РК»). Оговорка календаря: Учтены выходные
+      #   (суббота, воскресенье) и праздники Зако…
+      #   @return [Boolean, nil]
+      optional :last_workday, :boolean
+    end
+  end
+end

data/lib/tungo/models/automation_schedule_weekly.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # По выбранным дням недели в время at по Алматы.
+    class AutomationScheduleWeekly < Tungo::Model
+      # @!attribute [r] at
+      #   Время запуска ЧЧ:ММ (24 часа) по Алматы (Asia/Almaty). Показывать как есть, в пояс
+      #   пользователя не переводить.
+      #   @return [String]
+      required :at, :string
+
+      # @!attribute [r] days
+      #   Дни недели по ISO: 1 — понедельник … 7 — воскресенье; от 1 до 7 дней без повторов. День — по
+      #   календарю Алматы.
+      #   @return [Array<Integer>]
+      required :days, array_of(:integer)
+
+      # @!attribute [r] kind
+      #   `weekly` — по выбранным дням недели
+      #   @return [String]
+      required :kind, :string
+    end
+  end
+end

data/lib/tungo/models/automation_state.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # Пауза автоматизаций компании и очередь.
+    class AutomationState < Tungo::Model
+      # @!attribute [r] paused
+      #   true — автоматизации компании на паузе: запуски не начинаются, события хуков принимаются и
+      #   ждут в очереди
+      #   @return [Boolean]
+      required :paused, :boolean
+
+      # @!attribute [r] paused_at
+      #   С какого момента пауза, ISO 8601 UTC; null — не на паузе
+      #   @return [String, nil]
+      required :paused_at, :string, nullable: true
+
+      # @!attribute [r] queued
+      #   Сколько запусков компании ждёт в очереди
+      #   @return [Integer]
+      required :queued, :integer
+
+      # @!attribute [r] reason
+      #   Причина паузы, как её указали; null — не указана или не на паузе
+      #   @return [String, nil]
+      required :reason, :string, nullable: true
+
+      # @!attribute [r] running
+      #   Сколько запусков компании идёт сейчас (обычно 0 или 1: у компании идёт один запуск за раз)
+      #   @return [Integer]
+      required :running, :integer
+    end
+  end
+end

data/lib/tungo/models/automation_state_input.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # Поставить автоматизации компании на паузу или снять её.
+    class AutomationStateInput < Tungo::Model
+      # @!attribute [r] paused
+      #   true — поставить все автоматизации компании на паузу: новые запуски не начинаются (идущий
+      #   доводит текущий шаг, остановить его — POST …/runs/{id}/cancel), события хуков принимаются и
+      #   ждут в очереди; false — снять паузу (п…
+      #   @return [Boolean]
+      required :paused, :boolean
+
+      # @!attribute [r] reason
+      #   Почему пауза — для журнала и коллег (до 500 знаков)
+      #   @return [String, nil]
+      optional :reason, :string, nullable: true
+    end
+  end
+end

data/lib/tungo/models/automation_step.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # Шаг сценария: действие и когда его выполнять.
+    class AutomationStep < Tungo::Model
+      # @!attribute [r] action
+      #   `agent` — ход ИИ-бухгалтера по поручению instruction (платный: каждый такой шаг — отдельный
+      #   ход ИИ); `checks` — проверки учёта (без ИИ); `directbank` — опрос выписки DirectBank (без ИИ);
+      #   `notify` — без ИИ: вебхук automat…
+      #   @return [String]
+      required :action, :AutomationStepAction
+
+      # @!attribute [r] instruction
+      #   Поручение ИИ — только у agent и для него обязательно (длина — не больше
+      #   instruction_max_chars).
+      #   @return [String, nil]
+      optional :instruction, :string
+
+      # @!attribute [r] output
+      #   @return [Object]
+      optional :output, :AutomationOutputSpec
+
+      # @!attribute [r] when
+      #   Когда выполнять шаг (нет — `always`): `always` — всегда; `previous_created_proposals` —
+      #   прошлый шаг подготовил предложения; `checks_found_issues` — последние проверки этого запуска
+      #   нашли ошибки; `previous_failed` — прошл…
+      #   @return [String, nil]
+      optional :when, :AutomationStepWhen
+    end
+  end
+end

data/lib/tungo/models/automation_step_action.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # `agent` — ход ИИ-бухгалтера по поручению instruction (платный: каждый такой шаг — отдельный ход ИИ);
+    # `checks` — проверки учёта (без ИИ); `directbank` — опрос выписки DirectBank (без ИИ); `notify` — без
+    # ИИ: вебхук automat…
+    #
+    # A value this SDK version does not know is passed through unchanged.
+    module AutomationStepAction
+      extend Tungo::Internal::Enum
+
+      AGENT = "agent"
+      CHECKS = "checks"
+      DIRECTBANK = "directbank"
+      NOTIFY = "notify"
+    end
+  end
+end

data/lib/tungo/models/automation_step_when.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # Когда выполнять шаг (нет — `always`): `always` — всегда; `previous_created_proposals` — прошлый шаг
+    # подготовил предложения; `checks_found_issues` — последние проверки этого запуска нашли ошибки;
+    # `previous_failed` — прошл…
+    #
+    # A value this SDK version does not know is passed through unchanged.
+    module AutomationStepWhen
+      extend Tungo::Internal::Enum
+
+      ALWAYS = "always"
+      PREVIOUS_CREATED_PROPOSALS = "previous_created_proposals"
+      CHECKS_FOUND_ISSUES = "checks_found_issues"
+      PREVIOUS_FAILED = "previous_failed"
+    end
+  end
+end

data/lib/tungo/models/automation_trigger.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # Когда запускается сценарий; вид — в kind (hook, schedule, event, manual).
+    #
+    # The variant is selected by the +kind+ property. An object with a value this SDK version
+    # does not know is returned as a {Tungo::UnknownVariant}.
+    module AutomationTrigger
+      extend Tungo::Internal::Union
+
+      discriminated_by(
+        "kind",
+        "hook" => :AutomationTriggerHook,
+        "schedule" => :AutomationTriggerSchedule,
+        "event" => :AutomationTriggerEvent,
+        "manual" => :AutomationTriggerManual
+      )
+      variants(
+        :AutomationTriggerHook,
+        :AutomationTriggerSchedule,
+        :AutomationTriggerEvent,
+        :AutomationTriggerManual
+      )
+    end
+  end
+end

data/lib/tungo/models/automation_trigger_event.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # Запуск по событию внутри Tungo этой компании: входящие ЭСФ, выписка, решение по предложению, связь с
+    # 1С.
+    class AutomationTriggerEvent < Tungo::Model
+      # @!attribute [r] event
+      #   Вид события компании — имя из раздела webhooks этого описания. Например:
+      #   `esf.incoming.received` — пришли входящие ЭСФ; `bank_statement.received` — пришла выписка
+      #   (загружена человеком или забрана кнопкой; выписка, забран…
+      #   @return [String]
+      required :event, :AutomationTriggerEventEvent
+
+      # @!attribute [r] filter
+      #   @return [Tungo::Models::AutomationEventFilter, nil]
+      optional :filter, :AutomationEventFilter
+
+      # @!attribute [r] kind
+      #   `event` — по событию внутри Tungo
+      #   @return [String]
+      required :kind, :string
+    end
+  end
+end

data/lib/tungo/models/automation_trigger_event_event.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # Вид события компании — имя из раздела webhooks этого описания. Например: `esf.incoming.received` —
+    # пришли входящие ЭСФ; `bank_statement.received` — пришла выписка (загружена человеком или забрана
+    # кнопкой; выписка, забран…
+    #
+    # A value this SDK version does not know is passed through unchanged.
+    module AutomationTriggerEventEvent
+      extend Tungo::Internal::Enum
+
+      PROPOSAL_AWAITING_APPROVAL = "proposal.awaiting_approval"
+      PROPOSAL_WRITTEN = "proposal.written"
+      PROPOSAL_FAILED = "proposal.failed"
+      ESF_INCOMING_RECEIVED = "esf.incoming.received"
+      BANK_STATEMENT_RECEIVED = "bank_statement.received"
+      PROPOSAL_REJECTED = "proposal.rejected"
+      BATCH_COMPLETED = "batch.completed"
+      BATCH_FAILED = "batch.failed"
+      ONEC_CONNECTION_CHANGED = "onec.connection.changed"
+    end
+  end
+end

data/lib/tungo/models/automation_trigger_hook.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # Запуск по событию хука.
+    class AutomationTriggerHook < Tungo::Model
+      # @!attribute [r] filter
+      #   @return [Tungo::Models::AutomationEventFilter, nil]
+      optional :filter, :AutomationEventFilter
+
+      # @!attribute [r] hook_id
+      #   Хук, события которого запускают сценарий (hk_…)
+      #   @return [String]
+      required :hook_id, :string
+
+      # @!attribute [r] kind
+      #   `hook` — по событию хука
+      #   @return [String]
+      required :kind, :string
+    end
+  end
+end

data/lib/tungo/models/automation_trigger_manual.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # Только ручной запуск.
+    class AutomationTriggerManual < Tungo::Model
+      # @!attribute [r] kind
+      #   `manual` — только вручную: POST …/scenarios/{id}/run
+      #   @return [String]
+      required :kind, :string
+    end
+  end
+end

data/lib/tungo/models/automation_trigger_schedule.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # Запуск по расписанию.
+    class AutomationTriggerSchedule < Tungo::Model
+      # @!attribute [r] kind
+      #   `schedule` — по расписанию
+      #   @return [String]
+      required :kind, :string
+
+      # @!attribute [r] schedule
+      #   @return [Object]
+      required :schedule, :AutomationSchedule
+
+      # @!attribute [r] timezone
+      #   Всегда Asia/Almaty: время в schedule — по Алматы
+      #   @return [String]
+      required :timezone, :string
+    end
+  end
+end

data/lib/tungo/models/autonomy_level.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # Уровень самостоятельности ИИ для этого вида операции по политике компании (подпись — в level_title):
+    # - L0 — только чтение; L1 — ИИ предлагает, одобряет человек (обычный случай); - L2 — ИИ сам
+    # записывает черновик; L3 — ИИ…
+    #
+    # A value this SDK version does not know is passed through unchanged.
+    module AutonomyLevel
+      extend Tungo::Internal::Enum
+
+      L0 = "L0"
+      L1 = "L1"
+      L2 = "L2"
+      L3 = "L3"
+      L4 = "L4"
+      H_U_M_A_N_O_N_L_Y = "HUMAN_ONLY"
+      F_O_R_B_I_D_D_E_N = "FORBIDDEN"
+    end
+  end
+end

data/lib/tungo/models/bank_statement_job_request.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # Банковская выписка, которую разобрать в предложения
+    class BankStatementJobRequest < Tungo::Model
+      # @!attribute [r] file
+      #   Файл выписки в base64 как есть из банка (обычно в кодировке cp1251). Нужно одно из двух: text
+      #   или file
+      #   @return [String, nil]
+      optional :file, :string
+
+      # @!attribute [r] file_name
+      #   Имя файла — попадёт в название задания
+      #   @return [String, nil]
+      optional :file_name, :string
+
+      # @!attribute [r] limit
+      #   Сколько строк взять в работу (1–2000); без него — все
+      #   @return [Integer, nil]
+      optional :limit, :integer
+
+      # @!attribute [r] text
+      #   Содержимое выписки в формате 1CClientBankExchange («выгрузка для 1С» из интернет-банка)
+      #   текстом, до 8 МБ
+      #   @return [String, nil]
+      optional :text, :string
+    end
+  end
+end

data/lib/tungo/models/batch_approve_job.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # Задание одобрения пачкой, запущенное в фоне
+    class BatchApproveJob < Tungo::Model
+      # @!attribute [r] async
+      #   Всегда true: пачка идёт в фоне
+      #   @return [Boolean]
+      required :async, :boolean
+
+      # @!attribute [r] error
+      #   Почему задание прервано — текст для человека; нет — без ошибки
+      #   @return [String, nil]
+      optional :error, :string
+
+      # @!attribute [r] events
+      #   Сколько событий прогресса уже накоплено
+      #   @return [Integer, BigDecimal]
+      required :events, :number
+
+      # @!attribute [r] finished_at
+      #   Когда закончилось, ISO 8601 UTC; нет — ещё идёт
+      #   @return [String, nil]
+      optional :finished_at, :string
+
+      # @!attribute [r] id
+      #   id задания (bat_…): по нему — GET …/batch/{id}, …/summary, …/events, POST …/stop
+      #   @return [String]
+      required :id, :string
+
+      # @!attribute [r] kind
+      #   Вид задания: bank_statement — разбор загруженной банковской выписки; esf_purchases —
+      #   поступления по входящим ЭСФ; approve_batch — одобрение пачкой в фоне; directbank — выписка
+      #   дня, пришедшая сама из банка (DirectBank)
+      #   @return [String]
+      required :kind, :BatchApproveJobKind
+
+      # @!attribute [r] message
+      #   Что происходит — текст для человека
+      #   @return [String]
+      required :message, :string
+
+      # @!attribute [r] report
+      #   @return [Tungo::Models::BatchJobReport, nil]
+      optional :report, :BatchJobReport
+
+      # @!attribute [r] requested
+      #   Сколько предложений в пачке (вместе со снятыми галочкой)
+      #   @return [Integer, BigDecimal]
+      required :requested, :number
+
+      # @!attribute [r] running
+      #   true — задание идёт: показать прогресс (…/events), кнопку «Остановить»
+      #   @return [Boolean]
+      required :running, :boolean
+
+      # @!attribute [r] started_at
+      #   Когда задание началось, ISO 8601 UTC
+      #   @return [String]
+      required :started_at, :string
+
+      # @!attribute [r] title
+      #   Название задания для списка
+      #   @return [String]
+      required :title, :string
+    end
+  end
+end