Class: TD::Types::Invoice

Inherits:
Base
  • Object
show all
Defined in:
lib/tdlib/types/invoice.rb

Overview

Product invoice.

Instance Attribute Summary collapse

Method Summary

Methods inherited from Base

#to_hash, #to_json

Instance Attribute Details

#currency ⇒ TD::Types::String

ISO 4217 currency code.

Returns:

  • (TD::Types::String) —

    the current value of currency



23
24
25
 
# File 'lib/tdlib/types/invoice.rb', line 23

def currency
  @currency
end

#is_flexible ⇒ Boolean

True, if the total price depends on the shipping method.

Returns:

  • (Boolean) —

    the current value of is_flexible



23
24
25
 
# File 'lib/tdlib/types/invoice.rb', line 23

def is_flexible
  @is_flexible
end

#is_test ⇒ Boolean

True, if the payment is a test payment.

Returns:

  • (Boolean) —

    the current value of is_test



23
24
25
 
# File 'lib/tdlib/types/invoice.rb', line 23

def is_test
  @is_test
end

#max_tip_amount ⇒ Integer

The maximum allowed amount of tip in the smallest units of the currency.

Returns:

  • (Integer) —

    the current value of max_tip_amount



23
24
25
 
# File 'lib/tdlib/types/invoice.rb', line 23

def max_tip_amount
  @max_tip_amount
end

#need_email_address ⇒ Boolean

True, if the user’s email address is needed for payment.

Returns:

  • (Boolean) —

    the current value of need_email_address



23
24
25
 
# File 'lib/tdlib/types/invoice.rb', line 23

def need_email_address
  @need_email_address
end

#need_name ⇒ Boolean

True, if the user’s name is needed for payment.

Returns:

  • (Boolean) —

    the current value of need_name



23
24
25
 
# File 'lib/tdlib/types/invoice.rb', line 23

def need_name
  @need_name
end

#need_phone_number ⇒ Boolean

True, if the user’s phone number is needed for payment.

Returns:

  • (Boolean) —

    the current value of need_phone_number



23
24
25
 
# File 'lib/tdlib/types/invoice.rb', line 23

def need_phone_number
  @need_phone_number
end

#need_shipping_address ⇒ Boolean

True, if the user’s shipping address is needed for payment.

Returns:

  • (Boolean) —

    the current value of need_shipping_address



23
24
25
 
# File 'lib/tdlib/types/invoice.rb', line 23

def need_shipping_address
  @need_shipping_address
end

#price_parts ⇒ Array<TD::Types::LabeledPricePart>

A list of objects used to calculate the total price of the product.

Returns:



23
24
25
 
# File 'lib/tdlib/types/invoice.rb', line 23

def price_parts
  @price_parts
end

#recurring_payment_terms_of_service_url ⇒ TD::Types::String

An HTTP URL with terms of service for recurring payments. If non-empty, the invoice payment will result in recurring payments and the user must accept the terms of service before allowed to pay.

Returns:

  • (TD::Types::String) —

    the current value of recurring_payment_terms_of_service_url



23
24
25
 
# File 'lib/tdlib/types/invoice.rb', line 23

def recurring_payment_terms_of_service_url
  @recurring_payment_terms_of_service_url
end

#send_email_address_to_provider ⇒ Boolean

True, if the user’s email address will be sent to the provider.

Returns:

  • (Boolean) —

    the current value of send_email_address_to_provider



23
24
25
 
# File 'lib/tdlib/types/invoice.rb', line 23

def send_email_address_to_provider
  @send_email_address_to_provider
end

#send_phone_number_to_provider ⇒ Boolean

True, if the user’s phone number will be sent to the provider.

Returns:

  • (Boolean) —

    the current value of send_phone_number_to_provider



23
24
25
 
# File 'lib/tdlib/types/invoice.rb', line 23

def send_phone_number_to_provider
  @send_phone_number_to_provider
end

#suggested_tip_amounts ⇒ Array<Integer>

Suggested amounts of tip in the smallest units of the currency.

Returns:

  • (Array<Integer>) —

    the current value of suggested_tip_amounts



23
24
25
 
# File 'lib/tdlib/types/invoice.rb', line 23

def suggested_tip_amounts
  @suggested_tip_amounts
end

#terms_of_service_url ⇒ TD::Types::String

An HTTP URL with terms of service for non-recurring payments. If non-empty, then the user must accept the terms of service before allowed to pay.

Returns:

  • (TD::Types::String) —

    the current value of terms_of_service_url



23
24
25
 
# File 'lib/tdlib/types/invoice.rb', line 23

def terms_of_service_url
  @terms_of_service_url
end