Class: Yoomoney::Models::SafeDeal

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

Overview

See Also:

  • Yoomoney::Resources::Deals#create

Defined Under Namespace

Modules: Status

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(id:, balance:, created_at:, expires_at:, fee_moment:, payout_balance:, status:, test_:, type:, description: nil, metadata: nil) ⇒ Object

Some parameter documentations has been truncated, see Yoomoney::Models::SafeDeal for more details.

Parameters:

  • id (String) —

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

  • balance (Yoomoney::Models::MonetaryAmount) —

    Баланс сделки.

  • created_at (Time) —

    Время создания сделки.

  • expires_at (Time) —

    Время автоматического закрытия сделки.

  • fee_moment (Symbol, Yoomoney::Models::FeeMoment) —

    Момент удержания вознаграждения.

  • payout_balance (Yoomoney::Models::MonetaryAmount) —

    Сумма вознаграждения продавца.

  • status (Symbol, Yoomoney::Models::SafeDeal::Status) —

    Статус сделки.

  • test_ (Boolean) —

    Признак тестовой операции.

  • type (Symbol, Yoomoney::Models::DealType) —

    Тип сделки.

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

    Описание сделки.

  • metadata (Hash{Symbol=>String}) (defaults to: nil) —

    Любые дополнительные данные, которые нужны вам для работы (например, номер заказ




# File 'lib/yoomoney/models/safe_deal.rb', line 76

Instance Attribute Details

#balance ⇒ Yoomoney::Models::MonetaryAmount

Баланс сделки.

Parameters:

Returns:



17
 
# File 'lib/yoomoney/models/safe_deal.rb', line 17

required :balance, -> { Yoomoney::MonetaryAmount }

#created_at ⇒ Time

Время создания сделки.

Parameters:

  • value (Time)

Returns:

  • (Time) 


23
 
# File 'lib/yoomoney/models/safe_deal.rb', line 23

required :created_at, Time

#description ⇒ String?

Описание сделки.

Parameters:

  • (String)

Returns:

  • (String, nil) 


65
 
# File 'lib/yoomoney/models/safe_deal.rb', line 65

optional :description, String

#expires_at ⇒ Time

Время автоматического закрытия сделки.

Parameters:

  • value (Time)

Returns:

  • (Time) 


29
 
# File 'lib/yoomoney/models/safe_deal.rb', line 29

required :expires_at, Time

#fee_moment ⇒ Symbol, Yoomoney::Models::FeeMoment

Момент удержания вознаграждения.

Parameters:

  • value (Yoomoney::Models::fee_moment)

Returns:



35
 
# File 'lib/yoomoney/models/safe_deal.rb', line 35

required :fee_moment, enum: -> { Yoomoney::FeeMoment }

#id ⇒ String

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

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/yoomoney/models/safe_deal.rb', line 11

required :id, String

#metadata ⇒ Hash{Symbol=>String}?

Любые дополнительные данные, которые нужны вам для работы (например, номер заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.

Parameters:

  • (::Hash[Symbol, String])

Returns:

  • (Hash{Symbol=>String}, nil) 


74
 
# File 'lib/yoomoney/models/safe_deal.rb', line 74

optional :metadata, Yoomoney::Internal::Type::HashOf[String]

#payout_balance ⇒ Yoomoney::Models::MonetaryAmount

Сумма вознаграждения продавца.

Parameters:

Returns:



41
 
# File 'lib/yoomoney/models/safe_deal.rb', line 41

required :payout_balance, -> { Yoomoney::MonetaryAmount }

#status ⇒ Symbol, Yoomoney::Models::SafeDeal::Status

Статус сделки.

Parameters:

  • value (Yoomoney::Models::SafeDeal::status)

Returns:



47
 
# File 'lib/yoomoney/models/safe_deal.rb', line 47

required :status, enum: -> { Yoomoney::SafeDeal::Status }

#test_ ⇒ Boolean

Признак тестовой операции.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


53
 
# File 'lib/yoomoney/models/safe_deal.rb', line 53

required :test_, Yoomoney::Internal::Type::Boolean, api_name: :test

#type ⇒ Symbol, Yoomoney::Models::DealType

Тип сделки.

Parameters:

  • value (Yoomoney::Models::deal_type)

Returns:



59
 
# File 'lib/yoomoney/models/safe_deal.rb', line 59

required :type, enum: -> { Yoomoney::DealType }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


59
 
# File 'sig/yoomoney/models/safe_deal.rbs', line 59

def to_hash: -> {