Class: Yoomoney::Models::DealCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/yoomoney/models/deal_create_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(fee_moment:, type:, idempotence_key:, description: nil, metadata: nil, request_options: {}) ⇒ Object

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

Parameters:

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

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

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

    Тип сделки.

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

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

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

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

  • request_options (Yoomoney::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/yoomoney/models/deal_create_params.rb', line 42

Instance Attribute Details

#description ⇒ String?

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

Returns:

  • (String, nil) 


31
 
# File 'lib/yoomoney/models/deal_create_params.rb', line 31

optional :description, String

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

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

Returns:



14
 
# File 'lib/yoomoney/models/deal_create_params.rb', line 14

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

#idempotence_key ⇒ String

Returns:

  • (String) 


25
 
# File 'lib/yoomoney/models/deal_create_params.rb', line 25

required :idempotence_key, String

#metadata ⇒ Hash{Symbol=>String}?

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

Returns:

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


40
 
# File 'lib/yoomoney/models/deal_create_params.rb', line 40

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

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

Тип сделки.

Returns:



20
 
# File 'lib/yoomoney/models/deal_create_params.rb', line 20

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