cloudpayments-ruby 0.4.1

data/rbi/cloudpayments_ruby/request_options.rbi

@@ -0,0 +1,64 @@
+# typed: strong
+
+module CloudpaymentsRuby
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < CloudpaymentsRuby::Internal::Type::BaseModel
+    OrHash =
+      T.type_alias do
+        T.any(
+          CloudpaymentsRuby::RequestOptions,
+          CloudpaymentsRuby::Internal::AnyHash
+        )
+      end
+
+    # @api private
+    sig { params(opts: CloudpaymentsRuby::RequestOptions::OrHash).void }
+    def self.validate!(opts)
+    end
+
+    # Idempotency key to send with request and all associated retries. Will only be
+    # sent for write requests.
+    sig { returns(T.nilable(String)) }
+    attr_accessor :idempotency_key
+
+    # Extra query params to send with the request. These are `.merge`’d into any
+    # `query` given at the client level.
+    sig do
+      returns(
+        T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])
+      )
+    end
+    attr_accessor :extra_query
+
+    # Extra headers to send with the request. These are `.merged`’d into any
+    # `extra_headers` given at the client level.
+    sig { returns(T.nilable(T::Hash[String, T.nilable(String)])) }
+    attr_accessor :extra_headers
+
+    # Extra data to send with the request. These are deep merged into any data
+    # generated as part of the normal request.
+    sig { returns(T.nilable(T.anything)) }
+    attr_accessor :extra_body
+
+    # Maximum number of retries to attempt after a failed initial request.
+    sig { returns(T.nilable(Integer)) }
+    attr_accessor :max_retries
+
+    # Request timeout in seconds.
+    sig { returns(T.nilable(Float)) }
+    attr_accessor :timeout
+
+    # Returns a new instance of RequestOptions.
+    sig do
+      params(values: CloudpaymentsRuby::Internal::AnyHash).returns(
+        T.attached_class
+      )
+    end
+    def self.new(values = {})
+    end
+  end
+end

data/rbi/cloudpayments_ruby/resources/orders.rbi

@@ -0,0 +1,95 @@
+# typed: strong
+
+module CloudpaymentsRuby
+  module Resources
+    class Orders
+      # Создание счёта для отправки по почте
+      #
+      # Создаёт ссылку на оплату и при необходимости отправляет уведомление плательщику
+      # по email, SMS или Viber.
+      sig do
+        params(
+          amount: Float,
+          description: String,
+          account_id: String,
+          culture_name: String,
+          currency: String,
+          email: String,
+          fail_redirect_url: String,
+          invoice_id: String,
+          json_data: T.anything,
+          offer_uri: String,
+          phone: String,
+          require_confirmation: T::Boolean,
+          send_email: T::Boolean,
+          send_sms: T::Boolean,
+          send_viber: T::Boolean,
+          subscription_behavior: String,
+          success_redirect_url: String,
+          request_options: CloudpaymentsRuby::RequestOptions::OrHash
+        ).returns(CloudpaymentsRuby::Models::OrderCreateResponse)
+      end
+      def create(
+        # Сумма платежа
+        amount:,
+        # Описание платежа
+        description:,
+        # Идентификатор пользователя
+        account_id: nil,
+        # Язык уведомлений (ru-RU, en-US)
+        culture_name: nil,
+        # Валюта (RUB по умолчанию)
+        currency: nil,
+        # Email плательщика
+        email: nil,
+        # URL редиректа при неуспешной оплате
+        fail_redirect_url: nil,
+        # Номер заказа в системе мерчанта
+        invoice_id: nil,
+        # Дополнительные данные (JSON)
+        json_data: nil,
+        # Ссылка на оферту
+        offer_uri: nil,
+        # Телефон плательщика
+        phone: nil,
+        # Требуется подтверждение (двухстадийная схема)
+        require_confirmation: nil,
+        # Отправить ссылку на email
+        send_email: nil,
+        # Отправить ссылку по SMS
+        send_sms: nil,
+        # Отправить ссылку через Viber
+        send_viber: nil,
+        # Поведение подписки: CreateWeekly, CreateMonthly
+        subscription_behavior: nil,
+        # URL редиректа при успешной оплате
+        success_redirect_url: nil,
+        request_options: {}
+      )
+      end
+
+      # Отмена созданного счёта
+      #
+      # Отменяет ранее созданный счёт. После отмены оплата по ссылке невозможна.
+      sig do
+        params(
+          id: String,
+          request_options: CloudpaymentsRuby::RequestOptions::OrHash
+        ).returns(CloudpaymentsRuby::Models::OrderCancelResponse)
+      end
+      def cancel(
+        # Идентификатор заказа
+        id:,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig do
+        params(client: CloudpaymentsRuby::Client).returns(T.attached_class)
+      end
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/cloudpayments_ruby/resources/payments/tokens.rbi

@@ -0,0 +1,117 @@
+# typed: strong
+
+module CloudpaymentsRuby
+  module Resources
+    class Payments
+      class Tokens
+        # Двухстадийная оплата по токену (рекарринг)
+        #
+        # Выполняет авторизацию (холдирование средств) по сохранённому токену карты. Для
+        # списания необходимо вызвать метод confirm.
+        sig do
+          params(
+            account_id: String,
+            amount: Float,
+            token: String,
+            tr_initiator_code: Integer,
+            currency: String,
+            description: String,
+            email: String,
+            invoice_id: String,
+            ip_address: String,
+            json_data: T.anything,
+            payer: CloudpaymentsRuby::Payments::TokenAuthParams::Payer::OrHash,
+            payment_scheduled: Integer,
+            request_options: CloudpaymentsRuby::RequestOptions::OrHash
+          ).returns(CloudpaymentsRuby::Models::Payments::TokenAuthResponse)
+        end
+        def auth(
+          # Идентификатор пользователя
+          account_id:,
+          # Сумма платежа (до 2 знаков после точки)
+          amount:,
+          # Токен карты
+          token:,
+          # Признак инициатора транзакции: 0 — мерчант, 1 — держатель карты
+          tr_initiator_code:,
+          # Валюта (RUB по умолчанию)
+          currency: nil,
+          # Описание платежа
+          description: nil,
+          # Email плательщика
+          email: nil,
+          # Номер заказа
+          invoice_id: nil,
+          # IP-адрес плательщика
+          ip_address: nil,
+          # Дополнительные данные (JSON)
+          json_data: nil,
+          # Информация о плательщике
+          payer: nil,
+          # Признак регулярного платежа: 0 — нет, 1 — да
+          payment_scheduled: nil,
+          request_options: {}
+        )
+        end
+
+        # Одностадийная оплата по токену (рекарринг)
+        #
+        # Выполняет оплату в одну стадию по сохранённому токену карты. Токен выдаётся
+        # системой после первой оплаты по криптограмме.
+        sig do
+          params(
+            account_id: String,
+            amount: Float,
+            token: String,
+            tr_initiator_code: Integer,
+            currency: String,
+            description: String,
+            email: String,
+            invoice_id: String,
+            ip_address: String,
+            json_data: T.anything,
+            payer:
+              CloudpaymentsRuby::Payments::TokenChargeParams::Payer::OrHash,
+            payment_scheduled: Integer,
+            request_options: CloudpaymentsRuby::RequestOptions::OrHash
+          ).returns(CloudpaymentsRuby::Models::Payments::TokenChargeResponse)
+        end
+        def charge(
+          # Идентификатор пользователя
+          account_id:,
+          # Сумма платежа (до 2 знаков после точки)
+          amount:,
+          # Токен карты
+          token:,
+          # Признак инициатора транзакции: 0 — мерчант, 1 — держатель карты
+          tr_initiator_code:,
+          # Валюта (RUB по умолчанию)
+          currency: nil,
+          # Описание платежа
+          description: nil,
+          # Email плательщика
+          email: nil,
+          # Номер заказа
+          invoice_id: nil,
+          # IP-адрес плательщика
+          ip_address: nil,
+          # Дополнительные данные (JSON)
+          json_data: nil,
+          # Информация о плательщике
+          payer: nil,
+          # Признак регулярного платежа: 0 — нет, 1 — да
+          payment_scheduled: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig do
+          params(client: CloudpaymentsRuby::Client).returns(T.attached_class)
+        end
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/cloudpayments_ruby/resources/payments.rbi

@@ -0,0 +1,214 @@
+# typed: strong
+
+module CloudpaymentsRuby
+  module Resources
+    class Payments
+      sig { returns(CloudpaymentsRuby::Resources::Payments::Tokens) }
+      attr_reader :tokens
+
+      # Двухстадийная оплата по криптограмме
+      #
+      # Выполняет только авторизацию (холдирование средств). Для списания необходимо
+      # вызвать метод confirm. При необходимости 3-D Secure аутентификации возвращает
+      # данные для перенаправления на ACS.
+      sig do
+        params(
+          amount: Float,
+          card_cryptogram_packet: String,
+          ip_address: String,
+          account_id: String,
+          culture_name: String,
+          currency: String,
+          description: String,
+          email: String,
+          invoice_id: String,
+          json_data: T.anything,
+          name: String,
+          payer: CloudpaymentsRuby::PaymentAuthParams::Payer::OrHash,
+          payment_url: String,
+          save_card: T::Boolean,
+          request_options: CloudpaymentsRuby::RequestOptions::OrHash
+        ).returns(CloudpaymentsRuby::Models::PaymentAuthResponse::Variants)
+      end
+      def auth(
+        # Сумма платежа (до 2 знаков после точки)
+        amount:,
+        # Криптограмма платежных данных
+        card_cryptogram_packet:,
+        # IP-адрес плательщика
+        ip_address:,
+        # Идентификатор пользователя
+        account_id: nil,
+        # Язык уведомлений (ru-RU, en-US)
+        culture_name: nil,
+        # Валюта (RUB по умолчанию)
+        currency: nil,
+        # Описание платежа
+        description: nil,
+        # Email плательщика
+        email: nil,
+        # Номер заказа
+        invoice_id: nil,
+        # Дополнительные данные (JSON)
+        json_data: nil,
+        # Имя держателя карты (латиница)
+        name: nil,
+        # Информация о плательщике
+        payer: nil,
+        # URL сайта, с которого выполняется оплата
+        payment_url: nil,
+        # Сохранить токен карты для повторных платежей
+        save_card: nil,
+        request_options: {}
+      )
+      end
+
+      # Одностадийная оплата по криптограмме
+      #
+      # Выполняет оплату в одну стадию - авторизация и списание происходят одновременно.
+      # При необходимости 3-D Secure аутентификации возвращает данные для
+      # перенаправления на ACS.
+      sig do
+        params(
+          amount: Float,
+          card_cryptogram_packet: String,
+          ip_address: String,
+          account_id: String,
+          culture_name: String,
+          currency: String,
+          description: String,
+          email: String,
+          invoice_id: String,
+          json_data: T.anything,
+          name: String,
+          payer: CloudpaymentsRuby::PaymentChargeParams::Payer::OrHash,
+          payment_url: String,
+          save_card: T::Boolean,
+          request_options: CloudpaymentsRuby::RequestOptions::OrHash
+        ).returns(CloudpaymentsRuby::Models::PaymentChargeResponse::Variants)
+      end
+      def charge(
+        # Сумма платежа (до 2 знаков после точки)
+        amount:,
+        # Криптограмма платежных данных
+        card_cryptogram_packet:,
+        # IP-адрес плательщика
+        ip_address:,
+        # Идентификатор пользователя
+        account_id: nil,
+        # Язык уведомлений (ru-RU, en-US)
+        culture_name: nil,
+        # Валюта (RUB по умолчанию)
+        currency: nil,
+        # Описание платежа
+        description: nil,
+        # Email плательщика
+        email: nil,
+        # Номер заказа
+        invoice_id: nil,
+        # Дополнительные данные (JSON)
+        json_data: nil,
+        # Имя держателя карты (латиница)
+        name: nil,
+        # Информация о плательщике
+        payer: nil,
+        # URL сайта, с которого выполняется оплата
+        payment_url: nil,
+        # Сохранить токен карты для повторных платежей
+        save_card: nil,
+        request_options: {}
+      )
+      end
+
+      # Подтверждение двухстадийного платежа
+      #
+      # Подтверждает ранее авторизованный платеж и инициирует списание средств. Сумма
+      # подтверждения может быть меньше или равна сумме авторизации.
+      sig do
+        params(
+          amount: Float,
+          transaction_id: Integer,
+          json_data: T.anything,
+          request_options: CloudpaymentsRuby::RequestOptions::OrHash
+        ).returns(CloudpaymentsRuby::Models::PaymentConfirmResponse)
+      end
+      def confirm(
+        # Сумма подтверждения
+        amount:,
+        # ID транзакции
+        transaction_id:,
+        # Дополнительные данные (JSON)
+        json_data: nil,
+        request_options: {}
+      )
+      end
+
+      # Завершение 3-D Secure аутентификации
+      #
+      # Вызывается после возврата плательщика с ACS. Параметр TransactionId
+      # соответствует MD, PaRes получается от ACS.
+      sig do
+        params(
+          pa_res: String,
+          transaction_id: Integer,
+          request_options: CloudpaymentsRuby::RequestOptions::OrHash
+        ).returns(CloudpaymentsRuby::Models::PaymentPost3dsResponse)
+      end
+      def post3ds(
+        # Результат 3-D Secure аутентификации
+        pa_res:,
+        # ID транзакции (значение параметра MD)
+        transaction_id:,
+        request_options: {}
+      )
+      end
+
+      # Возврат средств
+      #
+      # Возвращает средства по завершенному платежу. Сумма возврата может быть меньше
+      # или равна сумме платежа. Возможны частичные возвраты.
+      sig do
+        params(
+          amount: Float,
+          transaction_id: Integer,
+          json_data: T.anything,
+          request_options: CloudpaymentsRuby::RequestOptions::OrHash
+        ).returns(CloudpaymentsRuby::Models::PaymentRefundResponse)
+      end
+      def refund(
+        # Сумма возврата
+        amount:,
+        # ID транзакции оплаты
+        transaction_id:,
+        # Дополнительные данные (JSON)
+        json_data: nil,
+        request_options: {}
+      )
+      end
+
+      # Отмена платежа
+      #
+      # Отменяет авторизованный платеж до его подтверждения. Применимо только для
+      # двухстадийных платежей.
+      sig do
+        params(
+          transaction_id: Integer,
+          request_options: CloudpaymentsRuby::RequestOptions::OrHash
+        ).returns(CloudpaymentsRuby::Models::PaymentVoidResponse)
+      end
+      def void(
+        # ID транзакции
+        transaction_id:,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig do
+        params(client: CloudpaymentsRuby::Client).returns(T.attached_class)
+      end
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/cloudpayments_ruby/resources/subscriptions.rbi

@@ -0,0 +1,159 @@
+# typed: strong
+
+module CloudpaymentsRuby
+  module Resources
+    class Subscriptions
+      # Создание подписки на рекуррентные платежи
+      #
+      # Создаёт план подписки для автоматического списания средств по указанному
+      # расписанию с использованием токена карты.
+      sig do
+        params(
+          account_id: String,
+          amount: Float,
+          currency: String,
+          description: String,
+          interval: String,
+          period: Integer,
+          require_confirmation: T::Boolean,
+          start_date: Time,
+          token: String,
+          customer_receipt: T.anything,
+          email: String,
+          max_periods: Integer,
+          request_options: CloudpaymentsRuby::RequestOptions::OrHash
+        ).returns(CloudpaymentsRuby::Models::SubscriptionCreateResponse)
+      end
+      def create(
+        # Идентификатор пользователя
+        account_id:,
+        # Сумма платежа
+        amount:,
+        # Валюта
+        currency:,
+        # Описание платежа
+        description:,
+        # Интервал: Day, Week, Month
+        interval:,
+        # Период (в сочетании с Interval)
+        period:,
+        # Требуется подтверждение (двухстадийная схема)
+        require_confirmation:,
+        # Дата и время первого платежа (UTC)
+        start_date:,
+        # Токен карты
+        token:,
+        # Данные для онлайн-чека
+        customer_receipt: nil,
+        # Email плательщика
+        email: nil,
+        # Максимальное количество платежей
+        max_periods: nil,
+        request_options: {}
+      )
+      end
+
+      # Изменение подписки на рекуррентные платежи
+      #
+      # Изменяет параметры существующей подписки. Если подписка была отменена или
+      # завершена, изменение любого атрибута приведёт к её реактивации.
+      sig do
+        params(
+          id: String,
+          amount: Float,
+          culture_name: String,
+          currency: String,
+          customer_receipt: T.anything,
+          description: String,
+          interval: String,
+          max_periods: Integer,
+          period: Integer,
+          require_confirmation: T::Boolean,
+          start_date: Time,
+          request_options: CloudpaymentsRuby::RequestOptions::OrHash
+        ).returns(CloudpaymentsRuby::Models::SubscriptionUpdateResponse)
+      end
+      def update(
+        # Идентификатор подписки
+        id:,
+        # Сумма платежа
+        amount: nil,
+        # Язык уведомлений (ru-RU, en-US)
+        culture_name: nil,
+        # Валюта
+        currency: nil,
+        # Данные для онлайн-чека
+        customer_receipt: nil,
+        # Описание платежа
+        description: nil,
+        # Интервал: Day, Week, Month
+        interval: nil,
+        # Максимальное количество платежей
+        max_periods: nil,
+        # Период
+        period: nil,
+        # Требуется подтверждение
+        require_confirmation: nil,
+        # Дата и время следующего платежа (UTC)
+        start_date: nil,
+        request_options: {}
+      )
+      end
+
+      # Отмена подписки на рекуррентные платежи
+      #
+      # Отменяет активную подписку. Дальнейшие автоматические списания прекращаются.
+      sig do
+        params(
+          id: String,
+          request_options: CloudpaymentsRuby::RequestOptions::OrHash
+        ).returns(CloudpaymentsRuby::Models::SubscriptionCancelResponse)
+      end
+      def cancel(
+        # Идентификатор подписки
+        id:,
+        request_options: {}
+      )
+      end
+
+      # Поиск подписок
+      #
+      # Возвращает список подписок для указанного пользователя.
+      sig do
+        params(
+          account_id: String,
+          request_options: CloudpaymentsRuby::RequestOptions::OrHash
+        ).returns(CloudpaymentsRuby::Models::SubscriptionFindResponse)
+      end
+      def find(
+        # Идентификатор пользователя
+        account_id:,
+        request_options: {}
+      )
+      end
+
+      # Запрос информации о подписке
+      #
+      # Возвращает текущий статус и параметры подписки.
+      sig do
+        params(
+          id: String,
+          request_options: CloudpaymentsRuby::RequestOptions::OrHash
+        ).returns(CloudpaymentsRuby::Models::SubscriptionGetResponse)
+      end
+      def get(
+        # Идентификатор подписки
+        id:,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig do
+        params(client: CloudpaymentsRuby::Client).returns(T.attached_class)
+      end
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/cloudpayments_ruby/version.rbi

@@ -0,0 +1,5 @@
+# typed: strong
+
+module CloudpaymentsRuby
+  VERSION = T.let(T.unsafe(nil), String)
+end

data/sig/cloudpayments_ruby/client.rbs

@@ -0,0 +1,33 @@
+module CloudpaymentsRuby
+  class Client < CloudpaymentsRuby::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES: 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS: Float
+
+    DEFAULT_INITIAL_RETRY_DELAY: Float
+
+    DEFAULT_MAX_RETRY_DELAY: Float
+
+    attr_reader public_id: String
+
+    attr_reader api_secret: String
+
+    attr_reader payments: CloudpaymentsRuby::Resources::Payments
+
+    attr_reader subscriptions: CloudpaymentsRuby::Resources::Subscriptions
+
+    attr_reader orders: CloudpaymentsRuby::Resources::Orders
+
+    private def auth_headers: -> ::Hash[String, String]
+
+    def initialize: (
+      ?public_id: String?,
+      ?api_secret: String?,
+      ?base_url: String?,
+      ?max_retries: Integer,
+      ?timeout: Float,
+      ?initial_retry_delay: Float,
+      ?max_retry_delay: Float
+    ) -> void
+  end
+end