Class: Yoomoney::Models::Invoice

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Yoomoney::Models::Invoice

Defined in:

lib/yoomoney/models/invoice.rb

Overview

See Also:

• Resources::Invoices#create

Defined Under Namespace

Modules: DeliveryMethod, Status Classes: CancellationDetails, PaymentDetails

Instance Attribute Summary

• #cancellation_details ⇒ Yoomoney::Models::Invoice::CancellationDetails^?

  Комментарий к статусу canceled.

• #cart ⇒ Array<Yoomoney::Models::LineItem>

  Корзина заказа — список товаров или услуг.

• #created_at ⇒ Time

  Время создания счета.

• #delivery_method ⇒ Yoomoney::Models::Invoice::DeliveryMethod::DeliveryMethodSelf, ...

  Способ доставки ссылки на счет.

• #description ⇒ String^?

  Описание счета.

• #expires_at ⇒ Time^?

  Срок действия счета.

• #id ⇒ String

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

• #metadata ⇒ Hash{Symbol=>String}^?

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

• #payment_details ⇒ Yoomoney::Models::Invoice::PaymentDetails^?

  Данные о платеже по счету.

• #status ⇒ Symbol, Yoomoney::Models::Invoice::Status

  Статус счета.

Class Method Summary

• .values ⇒ Array<Symbol>
• .variants ⇒ Array(Yoomoney::Models::Invoice::DeliveryMethod::DeliveryMethodSelf, Yoomoney::Models::DeliveryMethod, Yoomoney::Models::DeliveryMethod)

Instance Method Summary

• #initialize(url: nil) ⇒ Object constructor

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(url: nil) ⇒ Object

Parameters:

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

  URL страницы счета.

# File 'lib/yoomoney/models/invoice.rb', line 70

Instance Attribute Details

#cancellation_details ⇒ Yoomoney::Models::Invoice::CancellationDetails^?

Комментарий к статусу canceled.

Returns:

• (Yoomoney::Models::Invoice::CancellationDetails, nil)

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

optional :cancellation_details, -> { Yoomoney::Invoice::CancellationDetails }

#cart ⇒ Array<Yoomoney::Models::LineItem>

Корзина заказа — список товаров или услуг.

Returns:

• (Array<Yoomoney::Models::LineItem>)

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

required :cart, -> { Yoomoney::Internal::Type::ArrayOf[Yoomoney::LineItem] }

#created_at ⇒ Time

Время создания счета.

Returns:

• (Time)

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

required :created_at, Time

#delivery_method ⇒ Yoomoney::Models::Invoice::DeliveryMethod::DeliveryMethodSelf, ...

Способ доставки ссылки на счет.

Returns:

• (Yoomoney::Models::Invoice::DeliveryMethod::DeliveryMethodSelf, Yoomoney::Models::DeliveryMethod, nil)

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

optional :delivery_method, union: -> { Yoomoney::Invoice::DeliveryMethod }

#description ⇒ String^?

Описание счета.

Returns:

• (String, nil)

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

optional :description, String

#expires_at ⇒ Time^?

Срок действия счета.

Returns:

• (Time, nil)

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

optional :expires_at, Time

#id ⇒ String

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

Returns:

• (String)

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

required :id, String

#metadata ⇒ Hash{Symbol=>String}^?

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

Returns:

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

# File 'lib/yoomoney/models/invoice.rb', line 62

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

#payment_details ⇒ Yoomoney::Models::Invoice::PaymentDetails^?

Данные о платеже по счету.

Returns:

• (Yoomoney::Models::Invoice::PaymentDetails, nil)

# File 'lib/yoomoney/models/invoice.rb', line 68

optional :payment_details, -> { Yoomoney::Invoice::PaymentDetails }

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

Статус счета.

Returns:

• (Symbol, Yoomoney::Models::Invoice::Status)

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

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/yoomoney/models/invoice.rb', line 104

.variants ⇒ Array(Yoomoney::Models::Invoice::DeliveryMethod::DeliveryMethodSelf, Yoomoney::Models::DeliveryMethod, Yoomoney::Models::DeliveryMethod)

Returns:

• (Array(Yoomoney::Models::Invoice::DeliveryMethod::DeliveryMethodSelf, Yoomoney::Models::DeliveryMethod, Yoomoney::Models::DeliveryMethod))

# File 'lib/yoomoney/models/invoice.rb', line 150