tungo-sdk 0.2.0

data/lib/tungo/resources/webhooks.rb

@@ -0,0 +1,423 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Resources
+    # Исходящие вебхуки организации (Svix): адреса, каталог событий, доставки и проверка подписи
+    class Webhooks
+      # @api private
+      def initialize(client)
+        @client = client
+        freeze
+      end
+
+      # Адреса вебхуков
+      #
+      # +GET /v1/workspaces/{ws}/webhooks/endpoints+
+      #
+      # @param cursor [String] next_cursor прошлой страницы; без него — первая страница
+      # @param limit [Integer] Сколько на странице: 1–250, по умолчанию 50
+      # @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::WebhookEndpoint>]
+      def list_endpoints(cursor: OMIT, limit: OMIT, workspace_id: nil, request_options: nil)
+        @client.page(
+          method: :get,
+          path: "/v1/workspaces/{ws}/webhooks/endpoints",
+          path_params: { ws: @client.resolve_workspace_id(workspace_id) },
+          query: { "cursor" => cursor, "limit" => limit },
+          model: :ListWorkspaceWebhooksEndpointsResponse,
+          options: request_options
+        )
+      end
+
+      # Адреса вебхуков. Iterates over every item of every page, fetching pages lazily.
+      #
+      # +GET /v1/workspaces/{ws}/webhooks/endpoints+
+      #
+      # @param cursor [String] next_cursor прошлой страницы; без него — первая страница
+      # @param limit [Integer] Сколько на странице: 1–250, по умолчанию 50
+      # @param workspace_id [String, nil] overrides the client's workspace
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Enumerator<Tungo::Models::WebhookEndpoint>]
+      def list_endpoints_all(cursor: OMIT, limit: OMIT, workspace_id: nil, request_options: nil)
+        Tungo::Page.auto_paging do
+          list_endpoints(cursor: cursor, limit: limit, workspace_id: workspace_id, request_options: request_options)
+        end
+      end
+
+      # Завести адрес
+      #
+      # +POST /v1/workspaces/{ws}/webhooks/endpoints+
+      #
+      # @param url [String] Адрес приёмника: только https и не во внутренней сети (localhost, 10.x,
+      #   192.168.x… — проверяется и по DNS), до 2000 знаков
+      # @param channels [Array<String>, nil] Каналы — id сценариев автоматизаций (scn_…, до 10). Заданы — на
+      #   адрес приходят только события этих сценариев (automation.run.completed, automation.run.failed,
+      #   automation.run.notice, automation.write_unknown), и никаких д…
+      # @param description [String] Подпись адреса для людей (до 500 знаков)
+      # @param enabled [Boolean] false — не слать на адрес, пока не включат снова. При заведении по
+      #   умолчанию — включён
+      # @param event_types [Array<String>, nil] Какие события слать на адрес — имена из GET
+      #   …/webhooks/event-types (до 50). null или не передано при заведении — все события
+      # @param workspace_id [String, nil] overrides the client's workspace
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Tungo::Models::WebhookEndpointCreated]
+      def create_endpoint(
+        url:,
+        channels: OMIT,
+        description: OMIT,
+        enabled: OMIT,
+        event_types: OMIT,
+        workspace_id: nil,
+        request_options: nil
+      )
+        @client.request(
+          method: :post,
+          path: "/v1/workspaces/{ws}/webhooks/endpoints",
+          path_params: { ws: @client.resolve_workspace_id(workspace_id) },
+          body: {
+            "url" => url,
+            "channels" => channels,
+            "description" => description,
+            "enabled" => enabled,
+            "event_types" => event_types
+          },
+          idempotency_header: "Idempotency-Key",
+          model: :WebhookEndpointCreated,
+          options: request_options
+        )
+      end
+
+      # Адрес
+      #
+      # +GET /v1/workspaces/{ws}/webhooks/endpoints/{id}+
+      #
+      # @param id [String] id адреса вебхуков (ep_…)
+      # @param workspace_id [String, nil] overrides the client's workspace
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Tungo::Models::WebhookEndpoint]
+      def get_endpoint(id, workspace_id: nil, request_options: nil)
+        @client.request(
+          method: :get,
+          path: "/v1/workspaces/{ws}/webhooks/endpoints/{id}",
+          path_params: { ws: @client.resolve_workspace_id(workspace_id), id: id },
+          model: :WebhookEndpoint,
+          options: request_options
+        )
+      end
+
+      # Поменять адрес
+      #
+      # +PATCH /v1/workspaces/{ws}/webhooks/endpoints/{id}+
+      #
+      # @param id [String] id адреса вебхуков (ep_…)
+      # @param channels [Array<String>, nil] Каналы — id сценариев автоматизаций (scn_…, до 10). Заданы — на
+      #   адрес приходят только события этих сценариев (automation.run.completed, automation.run.failed,
+      #   automation.run.notice, automation.write_unknown), и никаких д…
+      # @param description [String] Подпись адреса для людей (до 500 знаков)
+      # @param enabled [Boolean] false — не слать на адрес, пока не включат снова. При заведении по
+      #   умолчанию — включён
+      # @param event_types [Array<String>, nil] Какие события слать на адрес — имена из GET
+      #   …/webhooks/event-types (до 50). null или не передано при заведении — все события
+      # @param url [String] Адрес приёмника: только https и не во внутренней сети (localhost, 10.x,
+      #   192.168.x… — проверяется и по DNS), до 2000 знаков
+      # @param workspace_id [String, nil] overrides the client's workspace
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Tungo::Models::WebhookEndpoint]
+      def update_endpoint(
+        id,
+        channels: OMIT,
+        description: OMIT,
+        enabled: OMIT,
+        event_types: OMIT,
+        url: OMIT,
+        workspace_id: nil,
+        request_options: nil
+      )
+        @client.request(
+          method: :patch,
+          path: "/v1/workspaces/{ws}/webhooks/endpoints/{id}",
+          path_params: { ws: @client.resolve_workspace_id(workspace_id), id: id },
+          body: {
+            "channels" => channels,
+            "description" => description,
+            "enabled" => enabled,
+            "event_types" => event_types,
+            "url" => url
+          },
+          model: :WebhookEndpoint,
+          options: request_options
+        )
+      end
+
+      # Удалить адрес
+      #
+      # +DELETE /v1/workspaces/{ws}/webhooks/endpoints/{id}+
+      #
+      # @param id [String] id адреса вебхуков (ep_…)
+      # @param workspace_id [String, nil] overrides the client's workspace
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Tungo::APIResponse]
+      def delete_endpoint(id, workspace_id: nil, request_options: nil)
+        @client.request(
+          method: :delete,
+          path: "/v1/workspaces/{ws}/webhooks/endpoints/{id}",
+          path_params: { ws: @client.resolve_workspace_id(workspace_id), id: id },
+          options: request_options
+        )
+      end
+
+      # Попытки доставки на адрес
+      #
+      # +GET /v1/workspaces/{ws}/webhooks/endpoints/{id}/attempts+
+      #
+      # @param id [String] id адреса вебхуков (ep_…)
+      # @param cursor [String] next_cursor прошлой страницы; без него — первая страница
+      # @param limit [Integer] Сколько на странице: 1–250, по умолчанию 50
+      # @param status [String] Только попытки в этом состоянии: `succeeded` — доставлено; `pending` — ждёт
+      #   отправки или повтора; `failed` — не доставлено; `sending` — отправляется сейчас
+      # @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::WebhookAttempt>]
+      def list_endpoint_attempts(id, cursor: OMIT, limit: OMIT, status: OMIT, workspace_id: nil, request_options: nil)
+        @client.page(
+          method: :get,
+          path: "/v1/workspaces/{ws}/webhooks/endpoints/{id}/attempts",
+          path_params: { ws: @client.resolve_workspace_id(workspace_id), id: id },
+          query: { "cursor" => cursor, "limit" => limit, "status" => status },
+          model: :ListWorkspaceWebhooksEndpointAttemptsResponse,
+          options: request_options
+        )
+      end
+
+      # Попытки доставки на адрес. Iterates over every item of every page, fetching pages lazily.
+      #
+      # +GET /v1/workspaces/{ws}/webhooks/endpoints/{id}/attempts+
+      #
+      # @param id [String] id адреса вебхуков (ep_…)
+      # @param cursor [String] next_cursor прошлой страницы; без него — первая страница
+      # @param limit [Integer] Сколько на странице: 1–250, по умолчанию 50
+      # @param status [String] Только попытки в этом состоянии: `succeeded` — доставлено; `pending` — ждёт
+      #   отправки или повтора; `failed` — не доставлено; `sending` — отправляется сейчас
+      # @param workspace_id [String, nil] overrides the client's workspace
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Enumerator<Tungo::Models::WebhookAttempt>]
+      def list_endpoint_attempts_all(
+        id,
+        cursor: OMIT,
+        limit: OMIT,
+        status: OMIT,
+        workspace_id: nil,
+        request_options: nil
+      )
+        Tungo::Page.auto_paging do
+          list_endpoint_attempts(
+            id,
+            cursor: cursor,
+            limit: limit,
+            status: status,
+            workspace_id: workspace_id,
+            request_options: request_options
+          )
+        end
+      end
+
+      # Новый секрет подписи
+      #
+      # +POST /v1/workspaces/{ws}/webhooks/endpoints/{id}/secret/rotate+
+      #
+      # @param id [String] id адреса вебхуков (ep_…)
+      # @param workspace_id [String, nil] overrides the client's workspace
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Tungo::Models::WebhookSecretRotated]
+      def rotate_endpoint_secret(id, workspace_id: nil, request_options: nil)
+        @client.request(
+          method: :post,
+          path: "/v1/workspaces/{ws}/webhooks/endpoints/{id}/secret/rotate",
+          path_params: { ws: @client.resolve_workspace_id(workspace_id), id: id },
+          idempotency_header: "Idempotency-Key",
+          model: :WebhookSecretRotated,
+          options: request_options
+        )
+      end
+
+      # Пробное событие на адрес
+      #
+      # +POST /v1/workspaces/{ws}/webhooks/endpoints/{id}/test+
+      #
+      # @param id [String] id адреса вебхуков (ep_…)
+      # @param workspace_id [String, nil] overrides the client's workspace
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Tungo::Models::WebhookMessage]
+      def test_endpoint(id, workspace_id: nil, request_options: nil)
+        @client.request(
+          method: :post,
+          path: "/v1/workspaces/{ws}/webhooks/endpoints/{id}/test",
+          path_params: { ws: @client.resolve_workspace_id(workspace_id), id: id },
+          idempotency_header: "Idempotency-Key",
+          model: :WebhookMessage,
+          options: request_options
+        )
+      end
+
+      # Какие события бывают
+      #
+      # +GET /v1/workspaces/{ws}/webhooks/event-types+
+      #
+      # @param workspace_id [String, nil] overrides the client's workspace
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Tungo::Models::ListWorkspaceWebhooksEventTypesResponse]
+      def list_event_types(workspace_id: nil, request_options: nil)
+        @client.request(
+          method: :get,
+          path: "/v1/workspaces/{ws}/webhooks/event-types",
+          path_params: { ws: @client.resolve_workspace_id(workspace_id) },
+          model: :ListWorkspaceWebhooksEventTypesResponse,
+          options: request_options
+        )
+      end
+
+      # Отправленные события
+      #
+      # +GET /v1/workspaces/{ws}/webhooks/messages+
+      #
+      # @param cursor [String] next_cursor прошлой страницы; без него — первая страница
+      # @param event_type [String] Только события этого вида (имя из …/webhooks/event-types)
+      # @param limit [Integer] Сколько на странице: 1–250, по умолчанию 50
+      # @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::WebhookMessage>]
+      def list_messages(cursor: OMIT, event_type: OMIT, limit: OMIT, workspace_id: nil, request_options: nil)
+        @client.page(
+          method: :get,
+          path: "/v1/workspaces/{ws}/webhooks/messages",
+          path_params: { ws: @client.resolve_workspace_id(workspace_id) },
+          query: { "cursor" => cursor, "event_type" => event_type, "limit" => limit },
+          model: :ListWorkspaceWebhooksMessagesResponse,
+          options: request_options
+        )
+      end
+
+      # Отправленные события. Iterates over every item of every page, fetching pages lazily.
+      #
+      # +GET /v1/workspaces/{ws}/webhooks/messages+
+      #
+      # @param cursor [String] next_cursor прошлой страницы; без него — первая страница
+      # @param event_type [String] Только события этого вида (имя из …/webhooks/event-types)
+      # @param limit [Integer] Сколько на странице: 1–250, по умолчанию 50
+      # @param workspace_id [String, nil] overrides the client's workspace
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Enumerator<Tungo::Models::WebhookMessage>]
+      def list_messages_all(cursor: OMIT, event_type: OMIT, limit: OMIT, workspace_id: nil, request_options: nil)
+        Tungo::Page.auto_paging do
+          list_messages(
+            cursor: cursor,
+            event_type: event_type,
+            limit: limit,
+            workspace_id: workspace_id,
+            request_options: request_options
+          )
+        end
+      end
+
+      # Попытки доставки события
+      #
+      # +GET /v1/workspaces/{ws}/webhooks/messages/{id}/attempts+
+      #
+      # @param id [String] id события (evt_…) или сообщения Svix (msg_…)
+      # @param cursor [String] next_cursor прошлой страницы; без него — первая страница
+      # @param endpoint_id [String] Только попытки на этот адрес (ep_…)
+      # @param limit [Integer] Сколько на странице: 1–250, по умолчанию 50
+      # @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::WebhookAttempt>]
+      def list_message_attempts(
+        id,
+        cursor: OMIT,
+        endpoint_id: OMIT,
+        limit: OMIT,
+        workspace_id: nil,
+        request_options: nil
+      )
+        @client.page(
+          method: :get,
+          path: "/v1/workspaces/{ws}/webhooks/messages/{id}/attempts",
+          path_params: { ws: @client.resolve_workspace_id(workspace_id), id: id },
+          query: { "cursor" => cursor, "endpoint_id" => endpoint_id, "limit" => limit },
+          model: :ListWorkspaceWebhooksMessageAttemptsResponse,
+          options: request_options
+        )
+      end
+
+      # Попытки доставки события. Iterates over every item of every page, fetching pages lazily.
+      #
+      # +GET /v1/workspaces/{ws}/webhooks/messages/{id}/attempts+
+      #
+      # @param id [String] id события (evt_…) или сообщения Svix (msg_…)
+      # @param cursor [String] next_cursor прошлой страницы; без него — первая страница
+      # @param endpoint_id [String] Только попытки на этот адрес (ep_…)
+      # @param limit [Integer] Сколько на странице: 1–250, по умолчанию 50
+      # @param workspace_id [String, nil] overrides the client's workspace
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Enumerator<Tungo::Models::WebhookAttempt>]
+      def list_message_attempts_all(
+        id,
+        cursor: OMIT,
+        endpoint_id: OMIT,
+        limit: OMIT,
+        workspace_id: nil,
+        request_options: nil
+      )
+        Tungo::Page.auto_paging do
+          list_message_attempts(
+            id,
+            cursor: cursor,
+            endpoint_id: endpoint_id,
+            limit: limit,
+            workspace_id: workspace_id,
+            request_options: request_options
+          )
+        end
+      end
+
+      # Отправить событие на адрес ещё раз
+      #
+      # +POST /v1/workspaces/{ws}/webhooks/messages/{id}/resend+
+      #
+      # @param id [String] id события (evt_…) или сообщения Svix (msg_…)
+      # @param endpoint_id [String] На какой адрес отправить ещё раз — id адреса (ep_…) этой организации
+      # @param workspace_id [String, nil] overrides the client's workspace
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Tungo::APIResponse]
+      def resend_message(id, endpoint_id:, workspace_id: nil, request_options: nil)
+        @client.request(
+          method: :post,
+          path: "/v1/workspaces/{ws}/webhooks/messages/{id}/resend",
+          path_params: { ws: @client.resolve_workspace_id(workspace_id), id: id },
+          body: { "endpoint_id" => endpoint_id },
+          idempotency_header: "Idempotency-Key",
+          options: request_options
+        )
+      end
+
+      # Счётчик событий месяца
+      #
+      # +GET /v1/workspaces/{ws}/webhooks/usage+
+      #
+      # @param workspace_id [String, nil] overrides the client's workspace
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Tungo::Models::WebhookUsage]
+      def get_usage(workspace_id: nil, request_options: nil)
+        @client.request(
+          method: :get,
+          path: "/v1/workspaces/{ws}/webhooks/usage",
+          path_params: { ws: @client.resolve_workspace_id(workspace_id) },
+          model: :WebhookUsage,
+          options: request_options
+        )
+      end
+    end
+  end
+end

data/lib/tungo/resources/workspaces.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Resources
+    # Организации (workspace), доступные ключу API
+    class Workspaces
+      # @api private
+      def initialize(client)
+        @client = client
+        freeze
+      end
+
+      # Мои организации (workspace) с публичными id ws_…
+      #
+      # +GET /v1/workspaces+
+      #
+      # @param request_options [Tungo::RequestOptions, Hash, nil] per-request overrides
+      # @return [Tungo::Models::ListWorkspacesResponse]
+      def list(request_options: nil)
+        @client.request(
+          method: :get,
+          path: "/v1/workspaces",
+          model: :ListWorkspacesResponse,
+          options: request_options
+        )
+      end
+    end
+  end
+end

data/lib/tungo/resources.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+require_relative "resources/workspaces"
+require_relative "resources/companies"
+require_relative "resources/platform"
+require_relative "resources/api_keys"
+require_relative "resources/webhooks"
+require_relative "resources/chat"
+require_relative "resources/proposals"
+require_relative "resources/feed"
+require_relative "resources/batches"
+require_relative "resources/esf"
+require_relative "resources/forms"
+require_relative "resources/onec"
+require_relative "resources/automations"
+
+module Tungo
+  # One class per group of API operations; reach them through the client (+client.chat+, ...).
+  module Resources
+    # The resource readers of {Tungo::Client}.
+    module Accessors
+      # @return [Tungo::Resources::Workspaces] Организации (workspace), доступные ключу API
+      attr_reader :workspaces
+
+      # @return [Tungo::Resources::Companies] Компании организации и их карточки
+      attr_reader :companies
+
+      # @return [Tungo::Resources::Platform] Баланс платформы, книга движений, отчёты о расходе, лимиты,
+      #   аудит и тарифы моделей
+      attr_reader :platform
+
+      # @return [Tungo::Resources::ApiKeys] Сведения о текущем ключе API и статистика его расхода
+      attr_reader :api_keys
+
+      # @return [Tungo::Resources::Webhooks] Исходящие вебхуки организации (Svix): адреса, каталог событий,
+      #   доставки и проверка подписи
+      attr_reader :webhooks
+
+      # @return [Tungo::Resources::Chat] Диалоги с ИИ-бухгалтером: вопросы, потоковый чат (SSE), подсчёт
+      #   токенов и история
+      attr_reader :chat
+
+      # @return [Tungo::Resources::Proposals] Предложения документов ИИ-бухгалтера: просмотр, одобрение
+      #   записи в 1С и отклонение
+      attr_reader :proposals
+
+      # @return [Tungo::Resources::Feed] Лента событий и предложений компании (страницы и живой поток SSE)
+      attr_reader :feed
+
+      # @return [Tungo::Resources::Batches] Пачки обработки банковских выписок, входящих ЭСФ и DirectBank
+      attr_reader :batches
+
+      # @return [Tungo::Resources::Esf] Входящие и исходящие электронные счета-фактуры (ИС ЭСФ)
+      attr_reader :esf
+
+      # @return [Tungo::Resources::Forms] Налоговые формы (ФНО 100.00 и др.): сборка, проверка ИСНА и
+      #   разрывы данных
+      attr_reader :forms
+
+      # @return [Tungo::Resources::Onec] Состояние подключения компании к базе 1С
+      attr_reader :onec
+
+      # @return [Tungo::Resources::Automations] Автоматизации компании: входящие хуки, сценарии, цепочки
+      #   шагов, запуски и уровень автономности ИИ
+      attr_reader :automations
+
+      private
+
+      def build_resources
+        @workspaces = Workspaces.new(self)
+        @companies = Companies.new(self)
+        @platform = Platform.new(self)
+        @api_keys = ApiKeys.new(self)
+        @webhooks = Webhooks.new(self)
+        @chat = Chat.new(self)
+        @proposals = Proposals.new(self)
+        @feed = Feed.new(self)
+        @batches = Batches.new(self)
+        @esf = Esf.new(self)
+        @forms = Forms.new(self)
+        @onec = Onec.new(self)
+        @automations = Automations.new(self)
+      end
+    end
+  end
+end