cloudpayments-ruby 0.4.1

data/lib/cloudpayments_ruby/resources/orders.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module CloudpaymentsRuby
+  module Resources
+    class Orders
+      # Создание счёта для отправки по почте
+      #
+      # Создаёт ссылку на оплату и при необходимости отправляет уведомление плательщику
+      # по email, SMS или Viber.
+      #
+      # @overload create(amount:, description:, account_id: nil, culture_name: nil, currency: nil, email: nil, fail_redirect_url: nil, invoice_id: nil, json_data: nil, offer_uri: nil, phone: nil, require_confirmation: nil, send_email: nil, send_sms: nil, send_viber: nil, subscription_behavior: nil, success_redirect_url: nil, request_options: {})
+      #
+      # @param amount [Float] Сумма платежа
+      #
+      # @param description [String] Описание платежа
+      #
+      # @param account_id [String] Идентификатор пользователя
+      #
+      # @param culture_name [String] Язык уведомлений (ru-RU, en-US)
+      #
+      # @param currency [String] Валюта (RUB по умолчанию)
+      #
+      # @param email [String] Email плательщика
+      #
+      # @param fail_redirect_url [String] URL редиректа при неуспешной оплате
+      #
+      # @param invoice_id [String] Номер заказа в системе мерчанта
+      #
+      # @param json_data [Object] Дополнительные данные (JSON)
+      #
+      # @param offer_uri [String] Ссылка на оферту
+      #
+      # @param phone [String] Телефон плательщика
+      #
+      # @param require_confirmation [Boolean] Требуется подтверждение (двухстадийная схема)
+      #
+      # @param send_email [Boolean] Отправить ссылку на email
+      #
+      # @param send_sms [Boolean] Отправить ссылку по SMS
+      #
+      # @param send_viber [Boolean] Отправить ссылку через Viber
+      #
+      # @param subscription_behavior [String] Поведение подписки: CreateWeekly, CreateMonthly
+      #
+      # @param success_redirect_url [String] URL редиректа при успешной оплате
+      #
+      # @param request_options [CloudpaymentsRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [CloudpaymentsRuby::Models::OrderCreateResponse]
+      #
+      # @see CloudpaymentsRuby::Models::OrderCreateParams
+      def create(params)
+        parsed, options = CloudpaymentsRuby::OrderCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "orders/create",
+          body: parsed,
+          model: CloudpaymentsRuby::Models::OrderCreateResponse,
+          options: options
+        )
+      end
+
+      # Отмена созданного счёта
+      #
+      # Отменяет ранее созданный счёт. После отмены оплата по ссылке невозможна.
+      #
+      # @overload cancel(id:, request_options: {})
+      #
+      # @param id [String] Идентификатор заказа
+      #
+      # @param request_options [CloudpaymentsRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [CloudpaymentsRuby::Models::OrderCancelResponse]
+      #
+      # @see CloudpaymentsRuby::Models::OrderCancelParams
+      def cancel(params)
+        parsed, options = CloudpaymentsRuby::OrderCancelParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "orders/cancel",
+          body: parsed,
+          model: CloudpaymentsRuby::Models::OrderCancelResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [CloudpaymentsRuby::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/cloudpayments_ruby/resources/payments/tokens.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module CloudpaymentsRuby
+  module Resources
+    class Payments
+      class Tokens
+        # Двухстадийная оплата по токену (рекарринг)
+        #
+        # Выполняет авторизацию (холдирование средств) по сохранённому токену карты. Для
+        # списания необходимо вызвать метод confirm.
+        #
+        # @overload auth(account_id:, amount:, token:, tr_initiator_code:, currency: nil, description: nil, email: nil, invoice_id: nil, ip_address: nil, json_data: nil, payer: nil, payment_scheduled: nil, request_options: {})
+        #
+        # @param account_id [String] Идентификатор пользователя
+        #
+        # @param amount [Float] Сумма платежа (до 2 знаков после точки)
+        #
+        # @param token [String] Токен карты
+        #
+        # @param tr_initiator_code [Integer] Признак инициатора транзакции: 0 — мерчант, 1 — держатель карты
+        #
+        # @param currency [String] Валюта (RUB по умолчанию)
+        #
+        # @param description [String] Описание платежа
+        #
+        # @param email [String] Email плательщика
+        #
+        # @param invoice_id [String] Номер заказа
+        #
+        # @param ip_address [String] IP-адрес плательщика
+        #
+        # @param json_data [Object] Дополнительные данные (JSON)
+        #
+        # @param payer [CloudpaymentsRuby::Models::Payments::TokenAuthParams::Payer] Информация о плательщике
+        #
+        # @param payment_scheduled [Integer] Признак регулярного платежа: 0 — нет, 1 — да
+        #
+        # @param request_options [CloudpaymentsRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [CloudpaymentsRuby::Models::Payments::TokenAuthResponse]
+        #
+        # @see CloudpaymentsRuby::Models::Payments::TokenAuthParams
+        def auth(params)
+          parsed, options = CloudpaymentsRuby::Payments::TokenAuthParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "payments/tokens/auth",
+            body: parsed,
+            model: CloudpaymentsRuby::Models::Payments::TokenAuthResponse,
+            options: options
+          )
+        end
+
+        # Одностадийная оплата по токену (рекарринг)
+        #
+        # Выполняет оплату в одну стадию по сохранённому токену карты. Токен выдаётся
+        # системой после первой оплаты по криптограмме.
+        #
+        # @overload charge(account_id:, amount:, token:, tr_initiator_code:, currency: nil, description: nil, email: nil, invoice_id: nil, ip_address: nil, json_data: nil, payer: nil, payment_scheduled: nil, request_options: {})
+        #
+        # @param account_id [String] Идентификатор пользователя
+        #
+        # @param amount [Float] Сумма платежа (до 2 знаков после точки)
+        #
+        # @param token [String] Токен карты
+        #
+        # @param tr_initiator_code [Integer] Признак инициатора транзакции: 0 — мерчант, 1 — держатель карты
+        #
+        # @param currency [String] Валюта (RUB по умолчанию)
+        #
+        # @param description [String] Описание платежа
+        #
+        # @param email [String] Email плательщика
+        #
+        # @param invoice_id [String] Номер заказа
+        #
+        # @param ip_address [String] IP-адрес плательщика
+        #
+        # @param json_data [Object] Дополнительные данные (JSON)
+        #
+        # @param payer [CloudpaymentsRuby::Models::Payments::TokenChargeParams::Payer] Информация о плательщике
+        #
+        # @param payment_scheduled [Integer] Признак регулярного платежа: 0 — нет, 1 — да
+        #
+        # @param request_options [CloudpaymentsRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [CloudpaymentsRuby::Models::Payments::TokenChargeResponse]
+        #
+        # @see CloudpaymentsRuby::Models::Payments::TokenChargeParams
+        def charge(params)
+          parsed, options = CloudpaymentsRuby::Payments::TokenChargeParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "payments/tokens/charge",
+            body: parsed,
+            model: CloudpaymentsRuby::Models::Payments::TokenChargeResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [CloudpaymentsRuby::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/cloudpayments_ruby/resources/payments.rb

@@ -0,0 +1,232 @@
+# frozen_string_literal: true
+
+module CloudpaymentsRuby
+  module Resources
+    class Payments
+      # @return [CloudpaymentsRuby::Resources::Payments::Tokens]
+      attr_reader :tokens
+
+      # Двухстадийная оплата по криптограмме
+      #
+      # Выполняет только авторизацию (холдирование средств). Для списания необходимо
+      # вызвать метод confirm. При необходимости 3-D Secure аутентификации возвращает
+      # данные для перенаправления на ACS.
+      #
+      # @overload auth(amount:, card_cryptogram_packet:, ip_address:, account_id: nil, culture_name: nil, currency: nil, description: nil, email: nil, invoice_id: nil, json_data: nil, name: nil, payer: nil, payment_url: nil, save_card: nil, request_options: {})
+      #
+      # @param amount [Float] Сумма платежа (до 2 знаков после точки)
+      #
+      # @param card_cryptogram_packet [String] Криптограмма платежных данных
+      #
+      # @param ip_address [String] IP-адрес плательщика
+      #
+      # @param account_id [String] Идентификатор пользователя
+      #
+      # @param culture_name [String] Язык уведомлений (ru-RU, en-US)
+      #
+      # @param currency [String] Валюта (RUB по умолчанию)
+      #
+      # @param description [String] Описание платежа
+      #
+      # @param email [String] Email плательщика
+      #
+      # @param invoice_id [String] Номер заказа
+      #
+      # @param json_data [Object] Дополнительные данные (JSON)
+      #
+      # @param name [String] Имя держателя карты (латиница)
+      #
+      # @param payer [CloudpaymentsRuby::Models::PaymentAuthParams::Payer] Информация о плательщике
+      #
+      # @param payment_url [String] URL сайта, с которого выполняется оплата
+      #
+      # @param save_card [Boolean] Сохранить токен карты для повторных платежей
+      #
+      # @param request_options [CloudpaymentsRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [CloudpaymentsRuby::Models::PaymentAuthResponse::UnionMember0, CloudpaymentsRuby::Models::PaymentAuthResponse::UnionMember1]
+      #
+      # @see CloudpaymentsRuby::Models::PaymentAuthParams
+      def auth(params)
+        parsed, options = CloudpaymentsRuby::PaymentAuthParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "payments/cards/auth",
+          body: parsed,
+          model: CloudpaymentsRuby::Models::PaymentAuthResponse,
+          options: options
+        )
+      end
+
+      # Одностадийная оплата по криптограмме
+      #
+      # Выполняет оплату в одну стадию - авторизация и списание происходят одновременно.
+      # При необходимости 3-D Secure аутентификации возвращает данные для
+      # перенаправления на ACS.
+      #
+      # @overload charge(amount:, card_cryptogram_packet:, ip_address:, account_id: nil, culture_name: nil, currency: nil, description: nil, email: nil, invoice_id: nil, json_data: nil, name: nil, payer: nil, payment_url: nil, save_card: nil, request_options: {})
+      #
+      # @param amount [Float] Сумма платежа (до 2 знаков после точки)
+      #
+      # @param card_cryptogram_packet [String] Криптограмма платежных данных
+      #
+      # @param ip_address [String] IP-адрес плательщика
+      #
+      # @param account_id [String] Идентификатор пользователя
+      #
+      # @param culture_name [String] Язык уведомлений (ru-RU, en-US)
+      #
+      # @param currency [String] Валюта (RUB по умолчанию)
+      #
+      # @param description [String] Описание платежа
+      #
+      # @param email [String] Email плательщика
+      #
+      # @param invoice_id [String] Номер заказа
+      #
+      # @param json_data [Object] Дополнительные данные (JSON)
+      #
+      # @param name [String] Имя держателя карты (латиница)
+      #
+      # @param payer [CloudpaymentsRuby::Models::PaymentChargeParams::Payer] Информация о плательщике
+      #
+      # @param payment_url [String] URL сайта, с которого выполняется оплата
+      #
+      # @param save_card [Boolean] Сохранить токен карты для повторных платежей
+      #
+      # @param request_options [CloudpaymentsRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [CloudpaymentsRuby::Models::PaymentChargeResponse::UnionMember0, CloudpaymentsRuby::Models::PaymentChargeResponse::UnionMember1]
+      #
+      # @see CloudpaymentsRuby::Models::PaymentChargeParams
+      def charge(params)
+        parsed, options = CloudpaymentsRuby::PaymentChargeParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "payments/cards/charge",
+          body: parsed,
+          model: CloudpaymentsRuby::Models::PaymentChargeResponse,
+          options: options
+        )
+      end
+
+      # Подтверждение двухстадийного платежа
+      #
+      # Подтверждает ранее авторизованный платеж и инициирует списание средств. Сумма
+      # подтверждения может быть меньше или равна сумме авторизации.
+      #
+      # @overload confirm(amount:, transaction_id:, json_data: nil, request_options: {})
+      #
+      # @param amount [Float] Сумма подтверждения
+      #
+      # @param transaction_id [Integer] ID транзакции
+      #
+      # @param json_data [Object] Дополнительные данные (JSON)
+      #
+      # @param request_options [CloudpaymentsRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [CloudpaymentsRuby::Models::PaymentConfirmResponse]
+      #
+      # @see CloudpaymentsRuby::Models::PaymentConfirmParams
+      def confirm(params)
+        parsed, options = CloudpaymentsRuby::PaymentConfirmParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "payments/confirm",
+          body: parsed,
+          model: CloudpaymentsRuby::Models::PaymentConfirmResponse,
+          options: options
+        )
+      end
+
+      # Завершение 3-D Secure аутентификации
+      #
+      # Вызывается после возврата плательщика с ACS. Параметр TransactionId
+      # соответствует MD, PaRes получается от ACS.
+      #
+      # @overload post3ds(pa_res:, transaction_id:, request_options: {})
+      #
+      # @param pa_res [String] Результат 3-D Secure аутентификации
+      #
+      # @param transaction_id [Integer] ID транзакции (значение параметра MD)
+      #
+      # @param request_options [CloudpaymentsRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [CloudpaymentsRuby::Models::PaymentPost3dsResponse]
+      #
+      # @see CloudpaymentsRuby::Models::PaymentPost3dsParams
+      def post3ds(params)
+        parsed, options = CloudpaymentsRuby::PaymentPost3dsParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "payments/cards/post3ds",
+          body: parsed,
+          model: CloudpaymentsRuby::Models::PaymentPost3dsResponse,
+          options: options
+        )
+      end
+
+      # Возврат средств
+      #
+      # Возвращает средства по завершенному платежу. Сумма возврата может быть меньше
+      # или равна сумме платежа. Возможны частичные возвраты.
+      #
+      # @overload refund(amount:, transaction_id:, json_data: nil, request_options: {})
+      #
+      # @param amount [Float] Сумма возврата
+      #
+      # @param transaction_id [Integer] ID транзакции оплаты
+      #
+      # @param json_data [Object] Дополнительные данные (JSON)
+      #
+      # @param request_options [CloudpaymentsRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [CloudpaymentsRuby::Models::PaymentRefundResponse]
+      #
+      # @see CloudpaymentsRuby::Models::PaymentRefundParams
+      def refund(params)
+        parsed, options = CloudpaymentsRuby::PaymentRefundParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "payments/refund",
+          body: parsed,
+          model: CloudpaymentsRuby::Models::PaymentRefundResponse,
+          options: options
+        )
+      end
+
+      # Отмена платежа
+      #
+      # Отменяет авторизованный платеж до его подтверждения. Применимо только для
+      # двухстадийных платежей.
+      #
+      # @overload void(transaction_id:, request_options: {})
+      #
+      # @param transaction_id [Integer] ID транзакции
+      #
+      # @param request_options [CloudpaymentsRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [CloudpaymentsRuby::Models::PaymentVoidResponse]
+      #
+      # @see CloudpaymentsRuby::Models::PaymentVoidParams
+      def void(params)
+        parsed, options = CloudpaymentsRuby::PaymentVoidParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "payments/void",
+          body: parsed,
+          model: CloudpaymentsRuby::Models::PaymentVoidResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [CloudpaymentsRuby::Client]
+      def initialize(client:)
+        @client = client
+        @tokens = CloudpaymentsRuby::Resources::Payments::Tokens.new(client: client)
+      end
+    end
+  end
+end

data/lib/cloudpayments_ruby/resources/subscriptions.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+module CloudpaymentsRuby
+  module Resources
+    class Subscriptions
+      # Создание подписки на рекуррентные платежи
+      #
+      # Создаёт план подписки для автоматического списания средств по указанному
+      # расписанию с использованием токена карты.
+      #
+      # @overload create(account_id:, amount:, currency:, description:, interval:, period:, require_confirmation:, start_date:, token:, customer_receipt: nil, email: nil, max_periods: nil, request_options: {})
+      #
+      # @param account_id [String] Идентификатор пользователя
+      #
+      # @param amount [Float] Сумма платежа
+      #
+      # @param currency [String] Валюта
+      #
+      # @param description [String] Описание платежа
+      #
+      # @param interval [String] Интервал: Day, Week, Month
+      #
+      # @param period [Integer] Период (в сочетании с Interval)
+      #
+      # @param require_confirmation [Boolean] Требуется подтверждение (двухстадийная схема)
+      #
+      # @param start_date [Time] Дата и время первого платежа (UTC)
+      #
+      # @param token [String] Токен карты
+      #
+      # @param customer_receipt [Object] Данные для онлайн-чека
+      #
+      # @param email [String] Email плательщика
+      #
+      # @param max_periods [Integer] Максимальное количество платежей
+      #
+      # @param request_options [CloudpaymentsRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [CloudpaymentsRuby::Models::SubscriptionCreateResponse]
+      #
+      # @see CloudpaymentsRuby::Models::SubscriptionCreateParams
+      def create(params)
+        parsed, options = CloudpaymentsRuby::SubscriptionCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "subscriptions/create",
+          body: parsed,
+          model: CloudpaymentsRuby::Models::SubscriptionCreateResponse,
+          options: options
+        )
+      end
+
+      # Изменение подписки на рекуррентные платежи
+      #
+      # Изменяет параметры существующей подписки. Если подписка была отменена или
+      # завершена, изменение любого атрибута приведёт к её реактивации.
+      #
+      # @overload update(id:, amount: nil, culture_name: nil, currency: nil, customer_receipt: nil, description: nil, interval: nil, max_periods: nil, period: nil, require_confirmation: nil, start_date: nil, request_options: {})
+      #
+      # @param id [String] Идентификатор подписки
+      #
+      # @param amount [Float] Сумма платежа
+      #
+      # @param culture_name [String] Язык уведомлений (ru-RU, en-US)
+      #
+      # @param currency [String] Валюта
+      #
+      # @param customer_receipt [Object] Данные для онлайн-чека
+      #
+      # @param description [String] Описание платежа
+      #
+      # @param interval [String] Интервал: Day, Week, Month
+      #
+      # @param max_periods [Integer] Максимальное количество платежей
+      #
+      # @param period [Integer] Период
+      #
+      # @param require_confirmation [Boolean] Требуется подтверждение
+      #
+      # @param start_date [Time] Дата и время следующего платежа (UTC)
+      #
+      # @param request_options [CloudpaymentsRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [CloudpaymentsRuby::Models::SubscriptionUpdateResponse]
+      #
+      # @see CloudpaymentsRuby::Models::SubscriptionUpdateParams
+      def update(params)
+        parsed, options = CloudpaymentsRuby::SubscriptionUpdateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "subscriptions/update",
+          body: parsed,
+          model: CloudpaymentsRuby::Models::SubscriptionUpdateResponse,
+          options: options
+        )
+      end
+
+      # Отмена подписки на рекуррентные платежи
+      #
+      # Отменяет активную подписку. Дальнейшие автоматические списания прекращаются.
+      #
+      # @overload cancel(id:, request_options: {})
+      #
+      # @param id [String] Идентификатор подписки
+      #
+      # @param request_options [CloudpaymentsRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [CloudpaymentsRuby::Models::SubscriptionCancelResponse]
+      #
+      # @see CloudpaymentsRuby::Models::SubscriptionCancelParams
+      def cancel(params)
+        parsed, options = CloudpaymentsRuby::SubscriptionCancelParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "subscriptions/cancel",
+          body: parsed,
+          model: CloudpaymentsRuby::Models::SubscriptionCancelResponse,
+          options: options
+        )
+      end
+
+      # Поиск подписок
+      #
+      # Возвращает список подписок для указанного пользователя.
+      #
+      # @overload find(account_id:, request_options: {})
+      #
+      # @param account_id [String] Идентификатор пользователя
+      #
+      # @param request_options [CloudpaymentsRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [CloudpaymentsRuby::Models::SubscriptionFindResponse]
+      #
+      # @see CloudpaymentsRuby::Models::SubscriptionFindParams
+      def find(params)
+        parsed, options = CloudpaymentsRuby::SubscriptionFindParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "subscriptions/find",
+          body: parsed,
+          model: CloudpaymentsRuby::Models::SubscriptionFindResponse,
+          options: options
+        )
+      end
+
+      # Запрос информации о подписке
+      #
+      # Возвращает текущий статус и параметры подписки.
+      #
+      # @overload get(id:, request_options: {})
+      #
+      # @param id [String] Идентификатор подписки
+      #
+      # @param request_options [CloudpaymentsRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [CloudpaymentsRuby::Models::SubscriptionGetResponse]
+      #
+      # @see CloudpaymentsRuby::Models::SubscriptionGetParams
+      def get(params)
+        parsed, options = CloudpaymentsRuby::SubscriptionGetParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "subscriptions/get",
+          body: parsed,
+          model: CloudpaymentsRuby::Models::SubscriptionGetResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [CloudpaymentsRuby::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/cloudpayments_ruby/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CloudpaymentsRuby
+  VERSION = "0.4.1"
+end