tungo-sdk 0.2.0

data/lib/tungo/resources/platform.rb

@@ -0,0 +1,316 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Resources
+    # Баланс платформы, книга движений, отчёты о расходе, лимиты, аудит и тарифы моделей
+    class Platform
+      # @api private
+      def initialize(client)
+        @client = client
+        freeze
+      end
+
+      # Цены моделей
+      #
+      # +GET /v1/usage-rates+
+      #
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Tungo::Models::ListUsageRatesResponse]
+      def list_usage_rates(request_options: nil)
+        @client.request(
+          method: :get,
+          path: "/v1/usage-rates",
+          auth: :none,
+          model: :ListUsageRatesResponse,
+          options: request_options
+        )
+      end
+
+      # Счёт платформы
+      #
+      # +GET /v1/workspaces/{ws}/platform/account+
+      #
+      # @param workspace_id [String, nil] overrides the client's workspace
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Tungo::Models::PlatformAccount]
+      def get_account(workspace_id: nil, request_options: nil)
+        @client.request(
+          method: :get,
+          path: "/v1/workspaces/{ws}/platform/account",
+          path_params: { ws: @client.resolve_workspace_id(workspace_id) },
+          model: :PlatformAccount,
+          options: request_options
+        )
+      end
+
+      # Журнал действий организации
+      #
+      # +GET /v1/workspaces/{ws}/platform/audit+
+      #
+      # @param action [String] Только действия, начинающиеся с этой строки: «workspace.member_» — все
+      #   действия с сотрудниками, «api_key.created» — точное
+      # @param api_key_id [String] Только действия, сделанные этим ключом API (key_…)
+      # @param cursor [String] next_cursor прошлой страницы (aud_…); без него — самые свежие записи
+      # @param from [String, nil] Записи не раньше этого момента, ISO 8601 (включительно). Нет — с самого
+      #   начала
+      # @param limit [Integer] Записей на странице, 1–200; по умолчанию 50
+      # @param to [String, nil] Записи раньше этого момента, ISO 8601 (не включительно); позже from. Нет —
+      #   до сейчас
+      # @param workspace_id [String, nil] overrides the client's workspace
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Tungo::Page<Tungo::Models::AuditEntry>]
+      def get_audit(
+        action: OMIT,
+        api_key_id: OMIT,
+        cursor: OMIT,
+        from: OMIT,
+        limit: OMIT,
+        to: OMIT,
+        workspace_id: nil,
+        request_options: nil
+      )
+        @client.page(
+          method: :get,
+          path: "/v1/workspaces/{ws}/platform/audit",
+          path_params: { ws: @client.resolve_workspace_id(workspace_id) },
+          query: {
+            "action" => action,
+            "api_key_id" => api_key_id,
+            "cursor" => cursor,
+            "from" => from,
+            "limit" => limit,
+            "to" => to
+          },
+          model: :GetWorkspacePlatformAuditResponse,
+          options: request_options
+        )
+      end
+
+      # Журнал действий организации. Iterates over every item of every page, fetching pages lazily.
+      #
+      # +GET /v1/workspaces/{ws}/platform/audit+
+      #
+      # @param action [String] Только действия, начинающиеся с этой строки: «workspace.member_» — все
+      #   действия с сотрудниками, «api_key.created» — точное
+      # @param api_key_id [String] Только действия, сделанные этим ключом API (key_…)
+      # @param cursor [String] next_cursor прошлой страницы (aud_…); без него — самые свежие записи
+      # @param from [String, nil] Записи не раньше этого момента, ISO 8601 (включительно). Нет — с самого
+      #   начала
+      # @param limit [Integer] Записей на странице, 1–200; по умолчанию 50
+      # @param to [String, nil] Записи раньше этого момента, ISO 8601 (не включительно); позже from. Нет —
+      #   до сейчас
+      # @param workspace_id [String, nil] overrides the client's workspace
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Enumerator<Tungo::Models::AuditEntry>]
+      def get_audit_all(
+        action: OMIT,
+        api_key_id: OMIT,
+        cursor: OMIT,
+        from: OMIT,
+        limit: OMIT,
+        to: OMIT,
+        workspace_id: nil,
+        request_options: nil
+      )
+        Tungo::Page.auto_paging do
+          get_audit(
+            action: action,
+            api_key_id: api_key_id,
+            cursor: cursor,
+            from: from,
+            limit: limit,
+            to: to,
+            workspace_id: workspace_id,
+            request_options: request_options
+          )
+        end
+      end
+
+      # Движения баланса платформы
+      #
+      # +GET /v1/workspaces/{ws}/platform/ledger+
+      #
+      # @param cursor [String] next_cursor прошлой страницы (led_…); без него — первая страница
+      # @param limit [Integer] Сколько движений на странице: 1–200, по умолчанию 100
+      # @param workspace_id [String, nil] overrides the client's workspace
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Tungo::Page<Tungo::Models::PlatformLedgerEntry>]
+      def get_ledger(cursor: OMIT, limit: OMIT, workspace_id: nil, request_options: nil)
+        @client.page(
+          method: :get,
+          path: "/v1/workspaces/{ws}/platform/ledger",
+          path_params: { ws: @client.resolve_workspace_id(workspace_id) },
+          query: { "cursor" => cursor, "limit" => limit },
+          model: :GetWorkspacePlatformLedgerResponse,
+          options: request_options
+        )
+      end
+
+      # Движения баланса платформы. Iterates over every item of every page, fetching pages lazily.
+      #
+      # +GET /v1/workspaces/{ws}/platform/ledger+
+      #
+      # @param cursor [String] next_cursor прошлой страницы (led_…); без него — первая страница
+      # @param limit [Integer] Сколько движений на странице: 1–200, по умолчанию 100
+      # @param workspace_id [String, nil] overrides the client's workspace
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Enumerator<Tungo::Models::PlatformLedgerEntry>]
+      def get_ledger_all(cursor: OMIT, limit: OMIT, workspace_id: nil, request_options: nil)
+        Tungo::Page.auto_paging do
+          get_ledger(cursor: cursor, limit: limit, workspace_id: workspace_id, request_options: request_options)
+        end
+      end
+
+      # Пределы платформы и сколько осталось
+      #
+      # +GET /v1/workspaces/{ws}/platform/limits+
+      #
+      # @param api_key_id [String] Ключ (key_…), чьи счётчики показать. По ключу API — только он сам; нет —
+      #   по ключу API он сам, по сессии — только значения пределов
+      # @param workspace_id [String, nil] overrides the client's workspace
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Tungo::Models::PlatformLimits]
+      def list_limits(api_key_id: OMIT, workspace_id: nil, request_options: nil)
+        @client.request(
+          method: :get,
+          path: "/v1/workspaces/{ws}/platform/limits",
+          path_params: { ws: @client.resolve_workspace_id(workspace_id) },
+          query: { "api_key_id" => api_key_id },
+          model: :PlatformLimits,
+          options: request_options
+        )
+      end
+
+      # Журнал запросов по ключам
+      #
+      # +GET /v1/workspaces/{ws}/platform/requests+
+      #
+      # @param api_key_id [String] Только запросы этого ключа (key_…)
+      # @param client_request_id [String] Номер, который вы сами прислали в заголовке x-request-id
+      # @param cursor [String] next_cursor прошлой страницы (rlg_…); без него — первая страница
+      # @param from [String, nil] Начало периода, ISO 8601 (включительно)
+      # @param limit [Integer] Сколько запросов на странице: 1–200, по умолчанию 100
+      # @param path [String] Адрес начинается с этой строки
+      # @param request_id [String] Номер запроса (req_…) — из заголовка x-request-id ответа или из ошибки
+      # @param status [Integer] Точный статус HTTP
+      # @param status_max [Integer] Статус не больше
+      # @param status_min [Integer] Статус не меньше (400 — все отказы и ошибки)
+      # @param to [String, nil] Конец периода, ISO 8601 (не включительно); позже from
+      # @param workspace_id [String, nil] overrides the client's workspace
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Tungo::Page<Tungo::Models::PlatformRequest>]
+      def list_requests(
+        api_key_id: OMIT,
+        client_request_id: OMIT,
+        cursor: OMIT,
+        from: OMIT,
+        limit: OMIT,
+        path: OMIT,
+        request_id: OMIT,
+        status: OMIT,
+        status_max: OMIT,
+        status_min: OMIT,
+        to: OMIT,
+        workspace_id: nil,
+        request_options: nil
+      )
+        @client.page(
+          method: :get,
+          path: "/v1/workspaces/{ws}/platform/requests",
+          path_params: { ws: @client.resolve_workspace_id(workspace_id) },
+          query: {
+            "api_key_id" => api_key_id,
+            "client_request_id" => client_request_id,
+            "cursor" => cursor,
+            "from" => from,
+            "limit" => limit,
+            "path" => path,
+            "request_id" => request_id,
+            "status" => status,
+            "status_max" => status_max,
+            "status_min" => status_min,
+            "to" => to
+          },
+          model: :ListWorkspacePlatformRequestsResponse,
+          options: request_options
+        )
+      end
+
+      # Журнал запросов по ключам. Iterates over every item of every page, fetching pages lazily.
+      #
+      # +GET /v1/workspaces/{ws}/platform/requests+
+      #
+      # @param api_key_id [String] Только запросы этого ключа (key_…)
+      # @param client_request_id [String] Номер, который вы сами прислали в заголовке x-request-id
+      # @param cursor [String] next_cursor прошлой страницы (rlg_…); без него — первая страница
+      # @param from [String, nil] Начало периода, ISO 8601 (включительно)
+      # @param limit [Integer] Сколько запросов на странице: 1–200, по умолчанию 100
+      # @param path [String] Адрес начинается с этой строки
+      # @param request_id [String] Номер запроса (req_…) — из заголовка x-request-id ответа или из ошибки
+      # @param status [Integer] Точный статус HTTP
+      # @param status_max [Integer] Статус не больше
+      # @param status_min [Integer] Статус не меньше (400 — все отказы и ошибки)
+      # @param to [String, nil] Конец периода, ISO 8601 (не включительно); позже from
+      # @param workspace_id [String, nil] overrides the client's workspace
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Enumerator<Tungo::Models::PlatformRequest>]
+      def list_requests_all(
+        api_key_id: OMIT,
+        client_request_id: OMIT,
+        cursor: OMIT,
+        from: OMIT,
+        limit: OMIT,
+        path: OMIT,
+        request_id: OMIT,
+        status: OMIT,
+        status_max: OMIT,
+        status_min: OMIT,
+        to: OMIT,
+        workspace_id: nil,
+        request_options: nil
+      )
+        Tungo::Page.auto_paging do
+          list_requests(
+            api_key_id: api_key_id,
+            client_request_id: client_request_id,
+            cursor: cursor,
+            from: from,
+            limit: limit,
+            path: path,
+            request_id: request_id,
+            status: status,
+            status_max: status_max,
+            status_min: status_min,
+            to: to,
+            workspace_id: workspace_id,
+            request_options: request_options
+          )
+        end
+      end
+
+      # Расход платформы
+      #
+      # +GET /v1/workspaces/{ws}/platform/usage+
+      #
+      # @param from [String, nil] Начало периода, ISO 8601 (включительно). Нет — 1-е число текущего месяца,
+      #   00:00 по Алматы
+      # @param to [String, nil] Конец периода, ISO 8601 (не включительно); позже from и не дальше 400 дней
+      #   от него. Нет — сейчас
+      # @param workspace_id [String, nil] overrides the client's workspace
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Tungo::Models::PlatformUsage]
+      def get_usage(from: OMIT, to: OMIT, workspace_id: nil, request_options: nil)
+        @client.request(
+          method: :get,
+          path: "/v1/workspaces/{ws}/platform/usage",
+          path_params: { ws: @client.resolve_workspace_id(workspace_id) },
+          query: { "from" => from, "to" => to },
+          model: :PlatformUsage,
+          options: request_options
+        )
+      end
+    end
+  end
+end

data/lib/tungo/resources/proposals.rb

@@ -0,0 +1,230 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Resources
+    # Предложения документов ИИ-бухгалтера: просмотр, одобрение записи в 1С и отклонение
+    class Proposals
+      # @api private
+      def initialize(client)
+        @client = client
+        freeze
+      end
+
+      # Очередь предложений
+      #
+      # +GET /v1/companies/{co}/proposals+
+      #
+      # @param cursor [String] next_cursor из ответа прошлой страницы; без него — первая (самая свежая)
+      #   страница. Остальные фильтры — те же, что у первой страницы.
+      # @param date_from [String] Созданные не раньше этого дня (ГГГГ-ММ-ДД, день по Алматы)
+      # @param date_to [String] Созданные не позже этого дня включительно (ГГГГ-ММ-ДД, день по Алматы)
+      # @param kind [String] Только этих видов: один или несколько через запятую (sale, purchase,
+      #   bank_receipt, bank_payment, counterparty, contract, revert, inventory_writeoff, cash_order_in,
+      #   cash_order_out, advance_report). Неизвестный — 400
+      # @param limit [Integer] Сколько на странице: 1–100, по умолчанию 20
+      # @param q [String] Поиск без учёта регистра: номер предложения (P-…), номер документа 1С, контрагент
+      #   (имя из превью), БИН/ИИН и другие реквизиты документа
+      # @param status [String] Только в этих статусах: один или несколько через запятую (previewed,
+      #   approved, rejected, committed, posted, verified, mismatch, failed); без него — все. Неизвестный —
+      #   400
+      # @param company_id [String, nil] overrides the client's company
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Tungo::Page<Tungo::Models::ProposalListItem>]
+      def list(
+        cursor: OMIT,
+        date_from: OMIT,
+        date_to: OMIT,
+        kind: OMIT,
+        limit: OMIT,
+        q: OMIT,
+        status: OMIT,
+        company_id: nil,
+        request_options: nil
+      )
+        @client.page(
+          method: :get,
+          path: "/v1/companies/{co}/proposals",
+          path_params: { co: @client.resolve_company_id(company_id) },
+          query: {
+            "cursor" => cursor,
+            "date_from" => date_from,
+            "date_to" => date_to,
+            "kind" => kind,
+            "limit" => limit,
+            "q" => q,
+            "status" => status
+          },
+          model: :ProposalPage,
+          options: request_options
+        )
+      end
+
+      # Очередь предложений. Iterates over every item of every page, fetching pages lazily.
+      #
+      # +GET /v1/companies/{co}/proposals+
+      #
+      # @param cursor [String] next_cursor из ответа прошлой страницы; без него — первая (самая свежая)
+      #   страница. Остальные фильтры — те же, что у первой страницы.
+      # @param date_from [String] Созданные не раньше этого дня (ГГГГ-ММ-ДД, день по Алматы)
+      # @param date_to [String] Созданные не позже этого дня включительно (ГГГГ-ММ-ДД, день по Алматы)
+      # @param kind [String] Только этих видов: один или несколько через запятую (sale, purchase,
+      #   bank_receipt, bank_payment, counterparty, contract, revert, inventory_writeoff, cash_order_in,
+      #   cash_order_out, advance_report). Неизвестный — 400
+      # @param limit [Integer] Сколько на странице: 1–100, по умолчанию 20
+      # @param q [String] Поиск без учёта регистра: номер предложения (P-…), номер документа 1С, контрагент
+      #   (имя из превью), БИН/ИИН и другие реквизиты документа
+      # @param status [String] Только в этих статусах: один или несколько через запятую (previewed,
+      #   approved, rejected, committed, posted, verified, mismatch, failed); без него — все. Неизвестный —
+      #   400
+      # @param company_id [String, nil] overrides the client's company
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Enumerator<Tungo::Models::ProposalListItem>]
+      def list_all(
+        cursor: OMIT,
+        date_from: OMIT,
+        date_to: OMIT,
+        kind: OMIT,
+        limit: OMIT,
+        q: OMIT,
+        status: OMIT,
+        company_id: nil,
+        request_options: nil
+      )
+        Tungo::Page.auto_paging do
+          list(
+            cursor: cursor,
+            date_from: date_from,
+            date_to: date_to,
+            kind: kind,
+            limit: limit,
+            q: q,
+            status: status,
+            company_id: company_id,
+            request_options: request_options
+          )
+        end
+      end
+
+      # Одобрить пачку предложений
+      #
+      # +POST /v1/companies/{co}/proposals/approve-batch+
+      #
+      # @param async [Boolean] Одобрить заданием в фоне: ответ 202 с номером задания сразу, прогресс —
+      #   …/batch/:id/events, итог — …/batch/:id (report.approval). Пачка больше 50 предложений идёт заданием
+      #   всегда.
+      # @param batch_id [String] Задание пачки (bat_… — id из ответа на загрузку выписки или ЭСФ): все
+      #   предложения этого задания
+      # @param exclude [Array<String>] Что снято галочками — эти предложения не одобряются (не больше 2000)
+      # @param idempotency_key [String] То же, что заголовок Idempotency-Key
+      # @param ids [Array<String>] Явный список предложений. Взаимоисключающе с batch_id.
+      # @param note [String] Комментарий к решению: попадёт в журнал по каждому предложению
+      # @param post [Boolean] Проводить документы после записи (по умолчанию true)
+      # @param company_id [String, nil] overrides the client's company
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Object]
+      def approve_batch(
+        async: OMIT,
+        batch_id: OMIT,
+        exclude: OMIT,
+        idempotency_key: OMIT,
+        ids: OMIT,
+        note: OMIT,
+        post: OMIT,
+        company_id: nil,
+        request_options: nil
+      )
+        @client.request(
+          method: :post,
+          path: "/v1/companies/{co}/proposals/approve-batch",
+          path_params: { co: @client.resolve_company_id(company_id) },
+          body: {
+            "async" => async,
+            "batch_id" => batch_id,
+            "exclude" => exclude,
+            "idempotency_key" => idempotency_key,
+            "ids" => ids,
+            "note" => note,
+            "post" => post
+          },
+          idempotency_header: "Idempotency-Key",
+          models: { 200 => :BatchApproveResponse, 202 => :BatchApproveJob },
+          model: :ApproveBatchCompanyProposalsResponse,
+          options: request_options
+        )
+      end
+
+      # Карточка предложения
+      #
+      # +GET /v1/companies/{co}/proposals/{id}+
+      #
+      # @param id [String] Номер предложения внутри компании: P- и шесть цифр (P-000123). У двух компаний
+      #   номера могут совпадать
+      # @param company_id [String, nil] overrides the client's company
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Tungo::Models::ProposalCard]
+      def get(id, company_id: nil, request_options: nil)
+        @client.request(
+          method: :get,
+          path: "/v1/companies/{co}/proposals/{id}",
+          path_params: { co: @client.resolve_company_id(company_id), id: id },
+          model: :ProposalCard,
+          options: request_options
+        )
+      end
+
+      # Одобрить и записать в 1С
+      #
+      # +POST /v1/companies/{co}/proposals/{id}/approve+
+      #
+      # @param id [String] Номер предложения внутри компании: P- и шесть цифр (P-000123). У двух компаний
+      #   номера могут совпадать
+      # @param idempotency_key [String] То же, что заголовок Idempotency-Key: свой UUID, тот же при повторе
+      #   нажатия
+      # @param note [String] Комментарий к решению — в журнал (до 1000 знаков)
+      # @param post [Boolean] true (по умолчанию) — записать и провести; false — записать черновиком без
+      #   проведения. Только true/false: другое — 400
+      # @param company_id [String, nil] overrides the client's company
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Tungo::Models::ProposalDecision]
+      def approve(id, idempotency_key: OMIT, note: OMIT, post: OMIT, company_id: nil, request_options: nil)
+        @client.request(
+          method: :post,
+          path: "/v1/companies/{co}/proposals/{id}/approve",
+          path_params: { co: @client.resolve_company_id(company_id), id: id },
+          body: { "idempotency_key" => idempotency_key, "note" => note, "post" => post },
+          body_required: false,
+          idempotency_header: "Idempotency-Key",
+          model: :ProposalDecision,
+          options: request_options
+        )
+      end
+
+      # Отклонить с причиной
+      #
+      # +POST /v1/companies/{co}/proposals/{id}/reject+
+      #
+      # @param id [String] Номер предложения внутри компании: P- и шесть цифр (P-000123). У двух компаний
+      #   номера могут совпадать
+      # @param reason [String] Причина отклонения от человека, от 3 до 1000 знаков — в журнал аудита и в
+      #   обучение ИИ на правках
+      # @param confirm_unknown_write [Boolean] Только человек в кабинете (по ключу API — 403
+      #   permission_error, code human_only). Отклонить одобренное «не знаем, записан ли» (write_unknown) или
+      #   отмену «не знаем, отменён ли» (revert_unknown), пока подключён снимок базы…
+      # @param company_id [String, nil] overrides the client's company
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Tungo::Models::ProposalDecision]
+      def reject(id, reason:, confirm_unknown_write: OMIT, company_id: nil, request_options: nil)
+        @client.request(
+          method: :post,
+          path: "/v1/companies/{co}/proposals/{id}/reject",
+          path_params: { co: @client.resolve_company_id(company_id), id: id },
+          body: { "reason" => reason, "confirm_unknown_write" => confirm_unknown_write },
+          model: :ProposalDecision,
+          options: request_options
+        )
+      end
+    end
+  end
+end