cloudpayments-ruby 0.4.1

data/lib/cloudpayments_ruby/models/subscription.rb

@@ -0,0 +1,212 @@
+# frozen_string_literal: true
+
+module CloudpaymentsRuby
+  module Models
+    class Subscription < CloudpaymentsRuby::Internal::Type::BaseModel
+      # @!attribute account_id
+      #   Идентификатор пользователя
+      #
+      #   @return [String]
+      required :account_id, String, api_name: :AccountId
+
+      # @!attribute amount
+      #   Сумма платежа
+      #
+      #   @return [Float]
+      required :amount, Float, api_name: :Amount
+
+      # @!attribute culture_name
+      #   Язык
+      #
+      #   @return [String]
+      required :culture_name, String, api_name: :CultureName
+
+      # @!attribute currency
+      #   Валюта
+      #
+      #   @return [String]
+      required :currency, String, api_name: :Currency
+
+      # @!attribute currency_code
+      #   Код валюты
+      #
+      #   @return [Integer]
+      required :currency_code, Integer, api_name: :CurrencyCode
+
+      # @!attribute failed_transactions_number
+      #   Количество неуспешных транзакций
+      #
+      #   @return [Integer]
+      required :failed_transactions_number, Integer, api_name: :FailedTransactionsNumber
+
+      # @!attribute id
+      #   Идентификатор подписки
+      #
+      #   @return [String]
+      required :id, String, api_name: :Id
+
+      # @!attribute interval
+      #   Интервал
+      #
+      #   @return [String]
+      required :interval, String, api_name: :Interval
+
+      # @!attribute interval_code
+      #   Код интервала
+      #
+      #   @return [Integer]
+      required :interval_code, Integer, api_name: :IntervalCode
+
+      # @!attribute period
+      #   Период
+      #
+      #   @return [Integer]
+      required :period, Integer, api_name: :Period
+
+      # @!attribute require_confirmation
+      #   Требуется подтверждение (двухстадийная схема)
+      #
+      #   @return [Boolean]
+      required :require_confirmation,
+               CloudpaymentsRuby::Internal::Type::Boolean,
+               api_name: :RequireConfirmation
+
+      # @!attribute start_date
+      #   Дата начала (формат /Date(...)/)
+      #
+      #   @return [String]
+      required :start_date, String, api_name: :StartDate
+
+      # @!attribute start_date_iso
+      #   Дата начала ISO
+      #
+      #   @return [String]
+      required :start_date_iso, String, api_name: :StartDateIso
+
+      # @!attribute status
+      #   Статус
+      #
+      #   @return [String]
+      required :status, String, api_name: :Status
+
+      # @!attribute status_code
+      #   Код статуса
+      #
+      #   @return [Integer]
+      required :status_code, Integer, api_name: :StatusCode
+
+      # @!attribute successful_transactions_number
+      #   Количество успешных транзакций
+      #
+      #   @return [Integer]
+      required :successful_transactions_number, Integer, api_name: :SuccessfulTransactionsNumber
+
+      # @!attribute description
+      #   Описание платежа
+      #
+      #   @return [String, nil]
+      optional :description, String, api_name: :Description
+
+      # @!attribute email
+      #   Email плательщика
+      #
+      #   @return [String, nil]
+      optional :email, String, api_name: :Email
+
+      # @!attribute failover_scheme_id
+      #   ID схемы фейловера
+      #
+      #   @return [String, nil]
+      optional :failover_scheme_id, String, api_name: :FailoverSchemeId
+
+      # @!attribute last_transaction_date
+      #   Дата последней транзакции
+      #
+      #   @return [String, nil]
+      optional :last_transaction_date, String, api_name: :LastTransactionDate
+
+      # @!attribute last_transaction_date_iso
+      #   Дата последней транзакции ISO
+      #
+      #   @return [String, nil]
+      optional :last_transaction_date_iso, String, api_name: :LastTransactionDateIso
+
+      # @!attribute max_periods
+      #   Максимальное количество платежей
+      #
+      #   @return [Integer, nil]
+      optional :max_periods, Integer, api_name: :MaxPeriods
+
+      # @!attribute next_transaction_date
+      #   Дата следующей транзакции
+      #
+      #   @return [String, nil]
+      optional :next_transaction_date, String, api_name: :NextTransactionDate
+
+      # @!attribute next_transaction_date_iso
+      #   Дата следующей транзакции ISO
+      #
+      #   @return [String, nil]
+      optional :next_transaction_date_iso, String, api_name: :NextTransactionDateIso
+
+      # @!attribute receipt
+      #   Данные чека
+      #
+      #   @return [Object, nil]
+      optional :receipt, CloudpaymentsRuby::Internal::Type::Unknown, api_name: :Receipt
+
+      # @!method initialize(account_id:, amount:, culture_name:, currency:, currency_code:, failed_transactions_number:, id:, interval:, interval_code:, period:, require_confirmation:, start_date:, start_date_iso:, status:, status_code:, successful_transactions_number:, description: nil, email: nil, failover_scheme_id: nil, last_transaction_date: nil, last_transaction_date_iso: nil, max_periods: nil, next_transaction_date: nil, next_transaction_date_iso: nil, receipt: nil)
+      #   Модель подписки на рекуррентные платежи
+      #
+      #   @param account_id [String] Идентификатор пользователя
+      #
+      #   @param amount [Float] Сумма платежа
+      #
+      #   @param culture_name [String] Язык
+      #
+      #   @param currency [String] Валюта
+      #
+      #   @param currency_code [Integer] Код валюты
+      #
+      #   @param failed_transactions_number [Integer] Количество неуспешных транзакций
+      #
+      #   @param id [String] Идентификатор подписки
+      #
+      #   @param interval [String] Интервал
+      #
+      #   @param interval_code [Integer] Код интервала
+      #
+      #   @param period [Integer] Период
+      #
+      #   @param require_confirmation [Boolean] Требуется подтверждение (двухстадийная схема)
+      #
+      #   @param start_date [String] Дата начала (формат /Date(...)/)
+      #
+      #   @param start_date_iso [String] Дата начала ISO
+      #
+      #   @param status [String] Статус
+      #
+      #   @param status_code [Integer] Код статуса
+      #
+      #   @param successful_transactions_number [Integer] Количество успешных транзакций
+      #
+      #   @param description [String] Описание платежа
+      #
+      #   @param email [String] Email плательщика
+      #
+      #   @param failover_scheme_id [String] ID схемы фейловера
+      #
+      #   @param last_transaction_date [String] Дата последней транзакции
+      #
+      #   @param last_transaction_date_iso [String] Дата последней транзакции ISO
+      #
+      #   @param max_periods [Integer] Максимальное количество платежей
+      #
+      #   @param next_transaction_date [String] Дата следующей транзакции
+      #
+      #   @param next_transaction_date_iso [String] Дата следующей транзакции ISO
+      #
+      #   @param receipt [Object] Данные чека
+    end
+  end
+end

data/lib/cloudpayments_ruby/models/subscription_cancel_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module CloudpaymentsRuby
+  module Models
+    # @see CloudpaymentsRuby::Resources::Subscriptions#cancel
+    class SubscriptionCancelParams < CloudpaymentsRuby::Internal::Type::BaseModel
+      extend CloudpaymentsRuby::Internal::Type::RequestParameters::Converter
+      include CloudpaymentsRuby::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #   Идентификатор подписки
+      #
+      #   @return [String]
+      required :id, String, api_name: :Id
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String] Идентификатор подписки
+      #
+      #   @param request_options [CloudpaymentsRuby::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/cloudpayments_ruby/models/subscription_cancel_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module CloudpaymentsRuby
+  module Models
+    # @see CloudpaymentsRuby::Resources::Subscriptions#cancel
+    class SubscriptionCancelResponse < CloudpaymentsRuby::Internal::Type::BaseModel
+      # @!attribute success
+      #   Результат выполнения запроса
+      #
+      #   @return [Boolean]
+      required :success, CloudpaymentsRuby::Internal::Type::Boolean, api_name: :Success
+
+      # @!attribute message
+      #   Описание ошибки (при наличии)
+      #
+      #   @return [String, nil]
+      optional :message, String, api_name: :Message
+
+      # @!method initialize(success:, message: nil)
+      #   Пустой ответ API (только Success и Message)
+      #
+      #   @param success [Boolean] Результат выполнения запроса
+      #
+      #   @param message [String] Описание ошибки (при наличии)
+    end
+  end
+end

data/lib/cloudpayments_ruby/models/subscription_create_params.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module CloudpaymentsRuby
+  module Models
+    # @see CloudpaymentsRuby::Resources::Subscriptions#create
+    class SubscriptionCreateParams < CloudpaymentsRuby::Internal::Type::BaseModel
+      extend CloudpaymentsRuby::Internal::Type::RequestParameters::Converter
+      include CloudpaymentsRuby::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   Идентификатор пользователя
+      #
+      #   @return [String]
+      required :account_id, String, api_name: :AccountId
+
+      # @!attribute amount
+      #   Сумма платежа
+      #
+      #   @return [Float]
+      required :amount, Float, api_name: :Amount
+
+      # @!attribute currency
+      #   Валюта
+      #
+      #   @return [String]
+      required :currency, String, api_name: :Currency
+
+      # @!attribute description
+      #   Описание платежа
+      #
+      #   @return [String]
+      required :description, String, api_name: :Description
+
+      # @!attribute interval
+      #   Интервал: Day, Week, Month
+      #
+      #   @return [String]
+      required :interval, String, api_name: :Interval
+
+      # @!attribute period
+      #   Период (в сочетании с Interval)
+      #
+      #   @return [Integer]
+      required :period, Integer, api_name: :Period
+
+      # @!attribute require_confirmation
+      #   Требуется подтверждение (двухстадийная схема)
+      #
+      #   @return [Boolean]
+      required :require_confirmation,
+               CloudpaymentsRuby::Internal::Type::Boolean,
+               api_name: :RequireConfirmation
+
+      # @!attribute start_date
+      #   Дата и время первого платежа (UTC)
+      #
+      #   @return [Time]
+      required :start_date, Time, api_name: :StartDate
+
+      # @!attribute token
+      #   Токен карты
+      #
+      #   @return [String]
+      required :token, String, api_name: :Token
+
+      # @!attribute customer_receipt
+      #   Данные для онлайн-чека
+      #
+      #   @return [Object, nil]
+      optional :customer_receipt, CloudpaymentsRuby::Internal::Type::Unknown, api_name: :CustomerReceipt
+
+      # @!attribute email
+      #   Email плательщика
+      #
+      #   @return [String, nil]
+      optional :email, String, api_name: :Email
+
+      # @!attribute max_periods
+      #   Максимальное количество платежей
+      #
+      #   @return [Integer, nil]
+      optional :max_periods, Integer, api_name: :MaxPeriods
+
+      # @!method initialize(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}]
+    end
+  end
+end

data/lib/cloudpayments_ruby/models/subscription_create_response.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module CloudpaymentsRuby
+  module Models
+    # @see CloudpaymentsRuby::Resources::Subscriptions#create
+    class SubscriptionCreateResponse < CloudpaymentsRuby::Internal::Type::BaseModel
+      # @!attribute success
+      #   Результат выполнения запроса
+      #
+      #   @return [Boolean]
+      required :success, CloudpaymentsRuby::Internal::Type::Boolean, api_name: :Success
+
+      # @!attribute message
+      #   Описание ошибки (при наличии)
+      #
+      #   @return [String, nil]
+      optional :message, String, api_name: :Message
+
+      # @!attribute model
+      #   Модель подписки на рекуррентные платежи
+      #
+      #   @return [CloudpaymentsRuby::Models::Subscription, nil]
+      optional :model, -> { CloudpaymentsRuby::Subscription }, api_name: :Model
+
+      # @!method initialize(success:, message: nil, model: nil)
+      #   Базовый ответ API
+      #
+      #   @param success [Boolean] Результат выполнения запроса
+      #
+      #   @param message [String] Описание ошибки (при наличии)
+      #
+      #   @param model [CloudpaymentsRuby::Models::Subscription] Модель подписки на рекуррентные платежи
+    end
+  end
+end

data/lib/cloudpayments_ruby/models/subscription_find_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module CloudpaymentsRuby
+  module Models
+    # @see CloudpaymentsRuby::Resources::Subscriptions#find
+    class SubscriptionFindParams < CloudpaymentsRuby::Internal::Type::BaseModel
+      extend CloudpaymentsRuby::Internal::Type::RequestParameters::Converter
+      include CloudpaymentsRuby::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   Идентификатор пользователя
+      #
+      #   @return [String]
+      required :account_id, String, api_name: :AccountId
+
+      # @!method initialize(account_id:, request_options: {})
+      #   @param account_id [String] Идентификатор пользователя
+      #
+      #   @param request_options [CloudpaymentsRuby::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/cloudpayments_ruby/models/subscription_find_response.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module CloudpaymentsRuby
+  module Models
+    # @see CloudpaymentsRuby::Resources::Subscriptions#find
+    class SubscriptionFindResponse < CloudpaymentsRuby::Internal::Type::BaseModel
+      # @!attribute success
+      #   Результат выполнения запроса
+      #
+      #   @return [Boolean]
+      required :success, CloudpaymentsRuby::Internal::Type::Boolean, api_name: :Success
+
+      # @!attribute message
+      #   Описание ошибки (при наличии)
+      #
+      #   @return [String, nil]
+      optional :message, String, api_name: :Message
+
+      # @!attribute model
+      #   Данные ответа
+      #
+      #   @return [Array<CloudpaymentsRuby::Models::Subscription>, nil]
+      optional :model,
+               -> { CloudpaymentsRuby::Internal::Type::ArrayOf[CloudpaymentsRuby::Subscription] },
+               api_name: :Model
+
+      # @!method initialize(success:, message: nil, model: nil)
+      #   Базовый ответ API
+      #
+      #   @param success [Boolean] Результат выполнения запроса
+      #
+      #   @param message [String] Описание ошибки (при наличии)
+      #
+      #   @param model [Array<CloudpaymentsRuby::Models::Subscription>] Данные ответа
+    end
+  end
+end

data/lib/cloudpayments_ruby/models/subscription_get_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module CloudpaymentsRuby
+  module Models
+    # @see CloudpaymentsRuby::Resources::Subscriptions#get
+    class SubscriptionGetParams < CloudpaymentsRuby::Internal::Type::BaseModel
+      extend CloudpaymentsRuby::Internal::Type::RequestParameters::Converter
+      include CloudpaymentsRuby::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #   Идентификатор подписки
+      #
+      #   @return [String]
+      required :id, String, api_name: :Id
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String] Идентификатор подписки
+      #
+      #   @param request_options [CloudpaymentsRuby::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/cloudpayments_ruby/models/subscription_get_response.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module CloudpaymentsRuby
+  module Models
+    # @see CloudpaymentsRuby::Resources::Subscriptions#get
+    class SubscriptionGetResponse < CloudpaymentsRuby::Internal::Type::BaseModel
+      # @!attribute success
+      #   Результат выполнения запроса
+      #
+      #   @return [Boolean]
+      required :success, CloudpaymentsRuby::Internal::Type::Boolean, api_name: :Success
+
+      # @!attribute message
+      #   Описание ошибки (при наличии)
+      #
+      #   @return [String, nil]
+      optional :message, String, api_name: :Message
+
+      # @!attribute model
+      #   Модель подписки на рекуррентные платежи
+      #
+      #   @return [CloudpaymentsRuby::Models::Subscription, nil]
+      optional :model, -> { CloudpaymentsRuby::Subscription }, api_name: :Model
+
+      # @!method initialize(success:, message: nil, model: nil)
+      #   Базовый ответ API
+      #
+      #   @param success [Boolean] Результат выполнения запроса
+      #
+      #   @param message [String] Описание ошибки (при наличии)
+      #
+      #   @param model [CloudpaymentsRuby::Models::Subscription] Модель подписки на рекуррентные платежи
+    end
+  end
+end

data/lib/cloudpayments_ruby/models/subscription_update_params.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module CloudpaymentsRuby
+  module Models
+    # @see CloudpaymentsRuby::Resources::Subscriptions#update
+    class SubscriptionUpdateParams < CloudpaymentsRuby::Internal::Type::BaseModel
+      extend CloudpaymentsRuby::Internal::Type::RequestParameters::Converter
+      include CloudpaymentsRuby::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #   Идентификатор подписки
+      #
+      #   @return [String]
+      required :id, String, api_name: :Id
+
+      # @!attribute amount
+      #   Сумма платежа
+      #
+      #   @return [Float, nil]
+      optional :amount, Float, api_name: :Amount
+
+      # @!attribute culture_name
+      #   Язык уведомлений (ru-RU, en-US)
+      #
+      #   @return [String, nil]
+      optional :culture_name, String, api_name: :CultureName
+
+      # @!attribute currency
+      #   Валюта
+      #
+      #   @return [String, nil]
+      optional :currency, String, api_name: :Currency
+
+      # @!attribute customer_receipt
+      #   Данные для онлайн-чека
+      #
+      #   @return [Object, nil]
+      optional :customer_receipt, CloudpaymentsRuby::Internal::Type::Unknown, api_name: :CustomerReceipt
+
+      # @!attribute description
+      #   Описание платежа
+      #
+      #   @return [String, nil]
+      optional :description, String, api_name: :Description
+
+      # @!attribute interval
+      #   Интервал: Day, Week, Month
+      #
+      #   @return [String, nil]
+      optional :interval, String, api_name: :Interval
+
+      # @!attribute max_periods
+      #   Максимальное количество платежей
+      #
+      #   @return [Integer, nil]
+      optional :max_periods, Integer, api_name: :MaxPeriods
+
+      # @!attribute period
+      #   Период
+      #
+      #   @return [Integer, nil]
+      optional :period, Integer, api_name: :Period
+
+      # @!attribute require_confirmation
+      #   Требуется подтверждение
+      #
+      #   @return [Boolean, nil]
+      optional :require_confirmation,
+               CloudpaymentsRuby::Internal::Type::Boolean,
+               api_name: :RequireConfirmation
+
+      # @!attribute start_date
+      #   Дата и время следующего платежа (UTC)
+      #
+      #   @return [Time, nil]
+      optional :start_date, Time, api_name: :StartDate
+
+      # @!method initialize(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}]
+    end
+  end
+end

data/lib/cloudpayments_ruby/models/subscription_update_response.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module CloudpaymentsRuby
+  module Models
+    # @see CloudpaymentsRuby::Resources::Subscriptions#update
+    class SubscriptionUpdateResponse < CloudpaymentsRuby::Internal::Type::BaseModel
+      # @!attribute success
+      #   Результат выполнения запроса
+      #
+      #   @return [Boolean]
+      required :success, CloudpaymentsRuby::Internal::Type::Boolean, api_name: :Success
+
+      # @!attribute message
+      #   Описание ошибки (при наличии)
+      #
+      #   @return [String, nil]
+      optional :message, String, api_name: :Message
+
+      # @!attribute model
+      #   Модель подписки на рекуррентные платежи
+      #
+      #   @return [CloudpaymentsRuby::Models::Subscription, nil]
+      optional :model, -> { CloudpaymentsRuby::Subscription }, api_name: :Model
+
+      # @!method initialize(success:, message: nil, model: nil)
+      #   Базовый ответ API
+      #
+      #   @param success [Boolean] Результат выполнения запроса
+      #
+      #   @param message [String] Описание ошибки (при наличии)
+      #
+      #   @param model [CloudpaymentsRuby::Models::Subscription] Модель подписки на рекуррентные платежи
+    end
+  end
+end