Class: CloudpaymentsRuby::Models::Subscription

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/cloudpayments_ruby/models/subscription.rb,
sig/cloudpayments_ruby/models/subscription.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#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) ⇒ Object

Модель подписки на рекуррентные платежи

Parameters:

  • account_id (String) —

    Идентификатор пользователя

  • amount (Float) —

    Сумма платежа

  • culture_name (String) —

    Язык

  • currency (String) —

    Валюта

  • currency_code (Integer) —

    Код валюты

  • failed_transactions_number (Integer) —

    Количество неуспешных транзакций

  • id (String) —

    Идентификатор подписки

  • interval (String) —

    Интервал

  • interval_code (Integer) —

    Код интервала

  • period (Integer) —

    Период

  • require_confirmation (Boolean) —

    Требуется подтверждение (двухстадийная схема)

  • start_date (String) —

    Дата начала (формат /Date(...)/)

  • start_date_iso (String) —

    Дата начала ISO

  • status (String) —

    Статус

  • status_code (Integer) —

    Код статуса

  • successful_transactions_number (Integer) —

    Количество успешных транзакций

  • description (String) (defaults to: nil) —

    Описание платежа

  • email (String) (defaults to: nil) —

    Email плательщика

  • failover_scheme_id (String) (defaults to: nil) —

    ID схемы фейловера

  • last_transaction_date (String) (defaults to: nil) —

    Дата последней транзакции

  • last_transaction_date_iso (String) (defaults to: nil) —

    Дата последней транзакции ISO

  • max_periods (Integer, nil) (defaults to: nil) —

    Максимальное количество платежей

  • next_transaction_date (String) (defaults to: nil) —

    Дата следующей транзакции

  • next_transaction_date_iso (String) (defaults to: nil) —

    Дата следующей транзакции ISO

  • receipt (Object) (defaults to: nil) —

    Данные чека




# File 'lib/cloudpayments_ruby/models/subscription.rb', line 158

Instance Attribute Details

#account_id ⇒ String

Идентификатор пользователя

Parameters:

  • value (String)

Returns:

  • (String) 


10
 
# File 'lib/cloudpayments_ruby/models/subscription.rb', line 10

required :account_id, String, api_name: :AccountId

#amount ⇒ Float

Сумма платежа

Parameters:

  • value (Float)

Returns:

  • (Float) 


16
 
# File 'lib/cloudpayments_ruby/models/subscription.rb', line 16

required :amount, Float, api_name: :Amount

#culture_name ⇒ String

Язык

Parameters:

  • value (String)

Returns:

  • (String) 


22
 
# File 'lib/cloudpayments_ruby/models/subscription.rb', line 22

required :culture_name, String, api_name: :CultureName

#currency ⇒ String

Валюта

Parameters:

  • value (String)

Returns:

  • (String) 


28
 
# File 'lib/cloudpayments_ruby/models/subscription.rb', line 28

required :currency, String, api_name: :Currency

#currency_code ⇒ Integer

Код валюты

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


34
 
# File 'lib/cloudpayments_ruby/models/subscription.rb', line 34

required :currency_code, Integer, api_name: :CurrencyCode

#description ⇒ String?

Описание платежа

Parameters:

  • (String)

Returns:

  • (String, nil) 


108
 
# File 'lib/cloudpayments_ruby/models/subscription.rb', line 108

optional :description, String, api_name: :Description

#email ⇒ String?

Email плательщика

Parameters:

  • (String)

Returns:

  • (String, nil) 


114
 
# File 'lib/cloudpayments_ruby/models/subscription.rb', line 114

optional :email, String, api_name: :Email

#failed_transactions_number ⇒ Integer

Количество неуспешных транзакций

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


40
 
# File 'lib/cloudpayments_ruby/models/subscription.rb', line 40

required :failed_transactions_number, Integer, api_name: :FailedTransactionsNumber

#failover_scheme_id ⇒ String?

ID схемы фейловера

Parameters:

  • (String)

Returns:

  • (String, nil) 


120
 
# File 'lib/cloudpayments_ruby/models/subscription.rb', line 120

optional :failover_scheme_id, String, api_name: :FailoverSchemeId

#id ⇒ String

Идентификатор подписки

Parameters:

  • value (String)

Returns:

  • (String) 


46
 
# File 'lib/cloudpayments_ruby/models/subscription.rb', line 46

required :id, String, api_name: :Id

#interval ⇒ String

Интервал

Parameters:

  • value (String)

Returns:

  • (String) 


52
 
# File 'lib/cloudpayments_ruby/models/subscription.rb', line 52

required :interval, String, api_name: :Interval

#interval_code ⇒ Integer

Код интервала

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


58
 
# File 'lib/cloudpayments_ruby/models/subscription.rb', line 58

required :interval_code, Integer, api_name: :IntervalCode

#last_transaction_date ⇒ String?

Дата последней транзакции

Parameters:

  • (String)

Returns:

  • (String, nil) 


126
 
# File 'lib/cloudpayments_ruby/models/subscription.rb', line 126

optional :last_transaction_date, String, api_name: :LastTransactionDate

#last_transaction_date_iso ⇒ String?

Дата последней транзакции ISO

Parameters:

  • (String)

Returns:

  • (String, nil) 


132
 
# File 'lib/cloudpayments_ruby/models/subscription.rb', line 132

optional :last_transaction_date_iso, String, api_name: :LastTransactionDateIso

#max_periods ⇒ Integer?

Максимальное количество платежей

Parameters:

  • (Integer, nil)

Returns:

  • (Integer, nil) 


138
 
# File 'lib/cloudpayments_ruby/models/subscription.rb', line 138

optional :max_periods, Integer, api_name: :MaxPeriods, nil?: true

#next_transaction_date ⇒ String?

Дата следующей транзакции

Parameters:

  • (String)

Returns:

  • (String, nil) 


144
 
# File 'lib/cloudpayments_ruby/models/subscription.rb', line 144

optional :next_transaction_date, String, api_name: :NextTransactionDate

#next_transaction_date_iso ⇒ String?

Дата следующей транзакции ISO

Parameters:

  • (String)

Returns:

  • (String, nil) 


150
 
# File 'lib/cloudpayments_ruby/models/subscription.rb', line 150

optional :next_transaction_date_iso, String, api_name: :NextTransactionDateIso

#period ⇒ Integer

Период

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


64
 
# File 'lib/cloudpayments_ruby/models/subscription.rb', line 64

required :period, Integer, api_name: :Period

#receipt ⇒ Object?

Данные чека

Parameters:

  • (top)

Returns:

  • (Object, nil) 


156
 
# File 'lib/cloudpayments_ruby/models/subscription.rb', line 156

optional :receipt, CloudpaymentsRuby::Internal::Type::Unknown, api_name: :Receipt

#require_confirmation ⇒ Boolean

Требуется подтверждение (двухстадийная схема)

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


70
71
72
 
# File 'lib/cloudpayments_ruby/models/subscription.rb', line 70

required :require_confirmation,
CloudpaymentsRuby::Internal::Type::Boolean,
api_name: :RequireConfirmation

#start_date ⇒ String

Дата начала (формат /Date(...)/)

Parameters:

  • value (String)

Returns:

  • (String) 


78
 
# File 'lib/cloudpayments_ruby/models/subscription.rb', line 78

required :start_date, String, api_name: :StartDate

#start_date_iso ⇒ String

Дата начала ISO

Parameters:

  • value (String)

Returns:

  • (String) 


84
 
# File 'lib/cloudpayments_ruby/models/subscription.rb', line 84

required :start_date_iso, String, api_name: :StartDateIso

#status ⇒ String

Статус

Parameters:

  • value (String)

Returns:

  • (String) 


90
 
# File 'lib/cloudpayments_ruby/models/subscription.rb', line 90

required :status, String, api_name: :Status

#status_code ⇒ Integer

Код статуса

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


96
 
# File 'lib/cloudpayments_ruby/models/subscription.rb', line 96

required :status_code, Integer, api_name: :StatusCode

#successful_transactions_number ⇒ Integer

Количество успешных транзакций

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


102
 
# File 'lib/cloudpayments_ruby/models/subscription.rb', line 102

required :successful_transactions_number, Integer, api_name: :SuccessfulTransactionsNumber

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


129
 
# File 'sig/cloudpayments_ruby/models/subscription.rbs', line 129

def to_hash: -> {