tungo-sdk 0.2.0

data/lib/tungo/models/webhook_event_payment_succeeded_data.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # Данные события — только id, суммы, токены, статусы и время, без персональных данных
+    class WebhookEventPaymentSucceededData < Tungo::Model
+      # @!attribute [r] amount_tiyn
+      #   Сумма, в тиынах (1 ₸ = 100 тиын)
+      #   @return [Integer]
+      required :amount_tiyn, :integer
+
+      # @!attribute [r] currency
+      #   Валюта (KZT)
+      #   @return [String]
+      required :currency, :string
+
+      # @!attribute [r] invoice_number
+      #   Номер счёта Tungo
+      #   @return [String, nil]
+      required :invoice_number, :string, nullable: true
+
+      # @!attribute [r] payment_id
+      #   id платежа (pay_…)
+      #   @return [String]
+      required :payment_id, :string
+
+      # @!attribute [r] purpose
+      #   За что: subscription — подписка, extra_usage — пополнение баланса чата, platform_topup —
+      #   пополнение баланса платформы, onboarding — подключение компании
+      #   @return [String]
+      required :purpose, :string
+
+      # @!attribute [r] vat_tiyn
+      #   НДС в сумме, в тиынах (1 ₸ = 100 тиын)
+      #   @return [Integer, nil]
+      required :vat_tiyn, :integer, nullable: true
+    end
+  end
+end

data/lib/tungo/models/webhook_event_ping.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # Пробное событие (POST …/endpoints/{id}/test): проверить, что адрес принимает вебхуки и подпись
+    # сходится. Приходит только на этот адрес, в счётчик месяца не идёт. data всегда пуст, company_id —
+    # null.
+    class WebhookEventPing < Tungo::Model
+      # @!attribute [r] company_id
+      #   Компания; null — событие организации (например, оплата) (co_…)
+      #   @return [String, nil]
+      required :company_id, :string, nullable: true
+
+      # @!attribute [r] created_at
+      #   Когда событие случилось
+      #   @return [String]
+      required :created_at, :string
+
+      # @!attribute [r] data
+      #   Данные события — только id, суммы, токены, статусы и время, без персональных данных
+      #   @return [Tungo::Models::WebhookEventPingData]
+      required :data, :WebhookEventPingData
+
+      # @!attribute [r] id
+      #   id события — тот же при повторной доставке: по нему отбрасывайте повторы (evt_…)
+      #   @return [String]
+      required :id, :string
+
+      # @!attribute [r] type
+      #   Вид события
+      #   @return [String]
+      required :type, :string
+
+      # @!attribute [r] workspace_id
+      #   Организация (ws_…)
+      #   @return [String]
+      required :workspace_id, :string
+    end
+  end
+end

data/lib/tungo/models/webhook_event_ping_data.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # Данные события — только id, суммы, токены, статусы и время, без персональных данных
+    class WebhookEventPingData < Tungo::Model
+    end
+  end
+end

data/lib/tungo/models/webhook_event_platform_balance_exhausted.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # Баланс платформы кончился этим списанием: следующие вызовы по ключам и автоматизации получат 402
+    # platform_balance_exhausted.
+    class WebhookEventPlatformBalanceExhausted < Tungo::Model
+      # @!attribute [r] company_id
+      #   Компания; null — событие организации (например, оплата) (co_…)
+      #   @return [String, nil]
+      required :company_id, :string, nullable: true
+
+      # @!attribute [r] created_at
+      #   Когда событие случилось
+      #   @return [String]
+      required :created_at, :string
+
+      # @!attribute [r] data
+      #   Данные события — только id, суммы, токены, статусы и время, без персональных данных
+      #   @return [Tungo::Models::WebhookEventPlatformBalanceExhaustedData]
+      required :data, :WebhookEventPlatformBalanceExhaustedData
+
+      # @!attribute [r] id
+      #   id события — тот же при повторной доставке: по нему отбрасывайте повторы (evt_…)
+      #   @return [String]
+      required :id, :string
+
+      # @!attribute [r] type
+      #   Вид события
+      #   @return [String]
+      required :type, :string
+
+      # @!attribute [r] workspace_id
+      #   Организация (ws_…)
+      #   @return [String]
+      required :workspace_id, :string
+    end
+  end
+end

data/lib/tungo/models/webhook_event_platform_balance_exhausted_data.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
+    # Данные события — только id, суммы, токены, статусы и время, без персональных данных
+    class WebhookEventPlatformBalanceExhaustedData < Tungo::Model
+      # @!attribute [r] balance_tiyn
+      #   Баланс платформы после списания, в тиынах; может быть меньше нуля на один вызов
+      #   @return [Integer]
+      required :balance_tiyn, :integer
+
+      # @!attribute [r] threshold_tiyn
+      #   Порог письма и вебхука, в тиынах
+      #   @return [Integer]
+      required :threshold_tiyn, :integer
+    end
+  end
+end

data/lib/tungo/models/webhook_event_platform_balance_low.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # Баланс платформы для разработчиков этим списанием опустился ниже порога (настройка платформы
+    # platform.billing). Пополнить — POST /v1/workspaces/{ws}/platform/purchases.
+    class WebhookEventPlatformBalanceLow < Tungo::Model
+      # @!attribute [r] company_id
+      #   Компания; null — событие организации (например, оплата) (co_…)
+      #   @return [String, nil]
+      required :company_id, :string, nullable: true
+
+      # @!attribute [r] created_at
+      #   Когда событие случилось
+      #   @return [String]
+      required :created_at, :string
+
+      # @!attribute [r] data
+      #   Данные события — только id, суммы, токены, статусы и время, без персональных данных
+      #   @return [Tungo::Models::WebhookEventPlatformBalanceLowData]
+      required :data, :WebhookEventPlatformBalanceLowData
+
+      # @!attribute [r] id
+      #   id события — тот же при повторной доставке: по нему отбрасывайте повторы (evt_…)
+      #   @return [String]
+      required :id, :string
+
+      # @!attribute [r] type
+      #   Вид события
+      #   @return [String]
+      required :type, :string
+
+      # @!attribute [r] workspace_id
+      #   Организация (ws_…)
+      #   @return [String]
+      required :workspace_id, :string
+    end
+  end
+end

data/lib/tungo/models/webhook_event_platform_balance_low_data.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
+    # Данные события — только id, суммы, токены, статусы и время, без персональных данных
+    class WebhookEventPlatformBalanceLowData < Tungo::Model
+      # @!attribute [r] balance_tiyn
+      #   Баланс платформы после списания, в тиынах; может быть меньше нуля на один вызов
+      #   @return [Integer]
+      required :balance_tiyn, :integer
+
+      # @!attribute [r] threshold_tiyn
+      #   Порог письма и вебхука, в тиынах
+      #   @return [Integer]
+      required :threshold_tiyn, :integer
+    end
+  end
+end

data/lib/tungo/models/webhook_event_platform_cap_threshold_reached.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # Траты платформы за месяц дошли до порога месячного потолка (spend.alert_thresholds_pct, по умолчанию
+    # 80%). Один раз на порог за месяц.
+    class WebhookEventPlatformCapThresholdReached < Tungo::Model
+      # @!attribute [r] company_id
+      #   Компания; null — событие организации (например, оплата) (co_…)
+      #   @return [String, nil]
+      required :company_id, :string, nullable: true
+
+      # @!attribute [r] created_at
+      #   Когда событие случилось
+      #   @return [String]
+      required :created_at, :string
+
+      # @!attribute [r] data
+      #   Данные события — только id, суммы, токены, статусы и время, без персональных данных
+      #   @return [Tungo::Models::WebhookEventPlatformCapThresholdReachedData]
+      required :data, :WebhookEventPlatformCapThresholdReachedData
+
+      # @!attribute [r] id
+      #   id события — тот же при повторной доставке: по нему отбрасывайте повторы (evt_…)
+      #   @return [String]
+      required :id, :string
+
+      # @!attribute [r] type
+      #   Вид события
+      #   @return [String]
+      required :type, :string
+
+      # @!attribute [r] workspace_id
+      #   Организация (ws_…)
+      #   @return [String]
+      required :workspace_id, :string
+    end
+  end
+end

data/lib/tungo/models/webhook_event_platform_cap_threshold_reached_data.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
+    # Данные события — только id, суммы, токены, статусы и время, без персональных данных
+    class WebhookEventPlatformCapThresholdReachedData < Tungo::Model
+      # @!attribute [r] cap_tiyn
+      #   Месячный потолок, в тиынах
+      #   @return [Integer]
+      required :cap_tiyn, :integer
+
+      # @!attribute [r] month
+      #   Месяц по Алматы — первое число, ГГГГ-ММ-ДД
+      #   @return [String]
+      required :month, :string
+
+      # @!attribute [r] spent_tiyn
+      #   Траты за месяц, в тиынах
+      #   @return [Integer]
+      required :spent_tiyn, :integer
+
+      # @!attribute [r] threshold_pct
+      #   Порог, проценты
+      #   @return [Integer]
+      required :threshold_pct, :integer
+    end
+  end
+end

data/lib/tungo/models/webhook_event_proposal_awaiting_approval.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
+    # Предложение (документ для 1С) готово и ждёт одобрения. blocked — есть блокеры, одобрить пока нельзя.
+    class WebhookEventProposalAwaitingApproval < Tungo::Model
+      # @!attribute [r] company_id
+      #   Компания; null — событие организации (например, оплата) (co_…)
+      #   @return [String, nil]
+      required :company_id, :string, nullable: true
+
+      # @!attribute [r] created_at
+      #   Когда событие случилось
+      #   @return [String]
+      required :created_at, :string
+
+      # @!attribute [r] data
+      #   Данные события — только id, суммы, токены, статусы и время, без персональных данных
+      #   @return [Tungo::Models::WebhookEventProposalAwaitingApprovalData]
+      required :data, :WebhookEventProposalAwaitingApprovalData
+
+      # @!attribute [r] id
+      #   id события — тот же при повторной доставке: по нему отбрасывайте повторы (evt_…)
+      #   @return [String]
+      required :id, :string
+
+      # @!attribute [r] type
+      #   Вид события
+      #   @return [String]
+      required :type, :string
+
+      # @!attribute [r] workspace_id
+      #   Организация (ws_…)
+      #   @return [String]
+      required :workspace_id, :string
+    end
+  end
+end

data/lib/tungo/models/webhook_event_proposal_awaiting_approval_data.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
+    # Данные события — только id, суммы, токены, статусы и время, без персональных данных
+    class WebhookEventProposalAwaitingApprovalData < Tungo::Model
+      # @!attribute [r] amount_tiyn
+      #   Сумма документа, в тиынах (1 ₸ = 100 тиын)
+      #   @return [Integer, nil]
+      required :amount_tiyn, :integer, nullable: true
+
+      # @!attribute [r] blocked
+      #   Есть блокеры — одобрить пока нельзя
+      #   @return [Boolean]
+      required :blocked, :boolean
+
+      # @!attribute [r] created_at
+      #   Когда предложение создано
+      #   @return [String]
+      required :created_at, :string
+
+      # @!attribute [r] kind
+      #   Вид документа (purchase, payment_out, …)
+      #   @return [String]
+      required :kind, :string
+
+      # @!attribute [r] proposal_id
+      #   id предложения — GET /v1/companies/{co}/proposals/{id}
+      #   @return [String]
+      required :proposal_id, :string
+
+      # @!attribute [r] status
+      #   Статус предложения после смены
+      #   @return [String]
+      required :status, :string
+    end
+  end
+end

data/lib/tungo/models/webhook_event_proposal_failed.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # Записать предложение в 1С не удалось. Причина — в карточке предложения (GET
+    # /v1/companies/{co}/proposals/{id}).
+    class WebhookEventProposalFailed < Tungo::Model
+      # @!attribute [r] company_id
+      #   Компания; null — событие организации (например, оплата) (co_…)
+      #   @return [String, nil]
+      required :company_id, :string, nullable: true
+
+      # @!attribute [r] created_at
+      #   Когда событие случилось
+      #   @return [String]
+      required :created_at, :string
+
+      # @!attribute [r] data
+      #   Данные события — только id, суммы, токены, статусы и время, без персональных данных
+      #   @return [Tungo::Models::WebhookEventProposalFailedData]
+      required :data, :WebhookEventProposalFailedData
+
+      # @!attribute [r] id
+      #   id события — тот же при повторной доставке: по нему отбрасывайте повторы (evt_…)
+      #   @return [String]
+      required :id, :string
+
+      # @!attribute [r] type
+      #   Вид события
+      #   @return [String]
+      required :type, :string
+
+      # @!attribute [r] workspace_id
+      #   Организация (ws_…)
+      #   @return [String]
+      required :workspace_id, :string
+    end
+  end
+end

data/lib/tungo/models/webhook_event_proposal_failed_data.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
+    # Данные события — только id, суммы, токены, статусы и время, без персональных данных
+    class WebhookEventProposalFailedData < Tungo::Model
+      # @!attribute [r] amount_tiyn
+      #   Сумма документа, в тиынах (1 ₸ = 100 тиын)
+      #   @return [Integer, nil]
+      required :amount_tiyn, :integer, nullable: true
+
+      # @!attribute [r] kind
+      #   Вид документа (purchase, payment_out, …)
+      #   @return [String]
+      required :kind, :string
+
+      # @!attribute [r] proposal_id
+      #   id предложения — GET /v1/companies/{co}/proposals/{id}
+      #   @return [String]
+      required :proposal_id, :string
+
+      # @!attribute [r] status
+      #   Статус предложения после смены
+      #   @return [String]
+      required :status, :string
+    end
+  end
+end

data/lib/tungo/models/webhook_event_proposal_rejected.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # Предложение отклонено человеком — в 1С его не запишут. Кто и почему — в карточке предложения (GET
+    # /v1/companies/{co}/proposals/{id}).
+    class WebhookEventProposalRejected < Tungo::Model
+      # @!attribute [r] company_id
+      #   Компания; null — событие организации (например, оплата) (co_…)
+      #   @return [String, nil]
+      required :company_id, :string, nullable: true
+
+      # @!attribute [r] created_at
+      #   Когда событие случилось
+      #   @return [String]
+      required :created_at, :string
+
+      # @!attribute [r] data
+      #   Данные события — только id, суммы, токены, статусы и время, без персональных данных
+      #   @return [Tungo::Models::WebhookEventProposalRejectedData]
+      required :data, :WebhookEventProposalRejectedData
+
+      # @!attribute [r] id
+      #   id события — тот же при повторной доставке: по нему отбрасывайте повторы (evt_…)
+      #   @return [String]
+      required :id, :string
+
+      # @!attribute [r] type
+      #   Вид события
+      #   @return [String]
+      required :type, :string
+
+      # @!attribute [r] workspace_id
+      #   Организация (ws_…)
+      #   @return [String]
+      required :workspace_id, :string
+    end
+  end
+end

data/lib/tungo/models/webhook_event_proposal_rejected_data.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
+    # Данные события — только id, суммы, токены, статусы и время, без персональных данных
+    class WebhookEventProposalRejectedData < Tungo::Model
+      # @!attribute [r] amount_tiyn
+      #   Сумма документа, в тиынах (1 ₸ = 100 тиын)
+      #   @return [Integer, nil]
+      required :amount_tiyn, :integer, nullable: true
+
+      # @!attribute [r] kind
+      #   Вид документа (purchase, payment_out, …)
+      #   @return [String]
+      required :kind, :string
+
+      # @!attribute [r] proposal_id
+      #   id предложения — GET /v1/companies/{co}/proposals/{id}
+      #   @return [String]
+      required :proposal_id, :string
+
+      # @!attribute [r] status
+      #   Статус предложения после смены
+      #   @return [String]
+      required :status, :string
+    end
+  end
+end

data/lib/tungo/models/webhook_event_proposal_written.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # Предложение записано в 1С (документ создан или дополнен). onec_document_number — номер документа в
+    # 1С.
+    class WebhookEventProposalWritten < Tungo::Model
+      # @!attribute [r] company_id
+      #   Компания; null — событие организации (например, оплата) (co_…)
+      #   @return [String, nil]
+      required :company_id, :string, nullable: true
+
+      # @!attribute [r] created_at
+      #   Когда событие случилось
+      #   @return [String]
+      required :created_at, :string
+
+      # @!attribute [r] data
+      #   Данные события — только id, суммы, токены, статусы и время, без персональных данных
+      #   @return [Tungo::Models::WebhookEventProposalWrittenData]
+      required :data, :WebhookEventProposalWrittenData
+
+      # @!attribute [r] id
+      #   id события — тот же при повторной доставке: по нему отбрасывайте повторы (evt_…)
+      #   @return [String]
+      required :id, :string
+
+      # @!attribute [r] type
+      #   Вид события
+      #   @return [String]
+      required :type, :string
+
+      # @!attribute [r] workspace_id
+      #   Организация (ws_…)
+      #   @return [String]
+      required :workspace_id, :string
+    end
+  end
+end

data/lib/tungo/models/webhook_event_proposal_written_data.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Code generated by tungo-sdkgen from the Tungo Platform API contract. DO NOT EDIT.
+
+module Tungo
+  module Models
+    # Данные события — только id, суммы, токены, статусы и время, без персональных данных
+    class WebhookEventProposalWrittenData < Tungo::Model
+      # @!attribute [r] amount_tiyn
+      #   Сумма документа, в тиынах (1 ₸ = 100 тиын)
+      #   @return [Integer, nil]
+      required :amount_tiyn, :integer, nullable: true
+
+      # @!attribute [r] kind
+      #   Вид документа (purchase, payment_out, …)
+      #   @return [String]
+      required :kind, :string
+
+      # @!attribute [r] onec_document_number
+      #   Номер документа в 1С
+      #   @return [String, nil]
+      required :onec_document_number, :string, nullable: true
+
+      # @!attribute [r] proposal_id
+      #   id предложения — GET /v1/companies/{co}/proposals/{id}
+      #   @return [String]
+      required :proposal_id, :string
+
+      # @!attribute [r] status
+      #   Статус предложения после смены
+      #   @return [String]
+      required :status, :string
+    end
+  end
+end

data/lib/tungo/models/webhook_event_type.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
+    # Вид события вебхуков.
+    class WebhookEventType < Tungo::Model
+      # @!attribute [r] description
+      #   Что значит событие и что в его data — текст для людей
+      #   @return [String]
+      required :description, :string
+
+      # @!attribute [r] example
+      #   @return [Tungo::Models::WebhookEnvelope]
+      required :example, :WebhookEnvelope
+
+      # @!attribute [r] name
+      #   Имя события — поле type в теле вебхука и значение для event_types
+      #   @return [String]
+      required :name, :string
+
+      # @!attribute [r] schema
+      #   JSON Schema (draft 2020-12) всего тела вебхука: обёртка и data. Та же схема — в разделе
+      #   webhooks этого описания и в каталоге Svix
+      #   @return [Hash{String=>Object}]
+      required :schema, map_of(:any)
+    end
+  end
+end

data/lib/tungo/models/webhook_message.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 Models
+    # Событие, отправленное на адреса вебхуков организации.
+    class WebhookMessage < Tungo::Model
+      # @!attribute [r] created_at
+      #   Когда событие отправлено в доставку, ISO 8601 UTC
+      #   @return [String]
+      required :created_at, :string
+
+      # @!attribute [r] event_type
+      #   Вид события (имя из …/webhooks/event-types; у пробного — ping)
+      #   @return [String]
+      required :event_type, :string
+
+      # @!attribute [r] id
+      #   id события (evt_…) — тот же, что в теле вебхука; у пробного — id сообщения Svix (msg_…), в
+      #   теле пробы свой evt_…
+      #   @return [String]
+      required :id, :string
+
+      # @!attribute [r] svix_message_id
+      #   id сообщения в сервере доставки Svix (заголовок webhook-id у доставки)
+      #   @return [String]
+      required :svix_message_id, :string
+    end
+  end
+end