Class: Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging

Defined in:

lib/increase/models/transaction.rb

Overview

See Also:

• #lodging

Defined Under Namespace

Modules: ExtraCharges, NoShowIndicator

Instance Attribute Summary

• #check_in_date ⇒ Date^?

  Date the customer checked in.

• #daily_room_rate_amount ⇒ Integer^?

  Daily rate being charged for the room.

• #daily_room_rate_currency ⇒ String^?

  The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the daily room rate.

• #extra_charges ⇒ Symbol, ...

  Additional charges (phone, late check-out, etc.) being billed.

• #folio_cash_advances_amount ⇒ Integer^?

  Folio cash advances for the room.

• #folio_cash_advances_currency ⇒ String^?

  The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the folio cash advances.

• #food_beverage_charges_amount ⇒ Integer^?

  Food and beverage charges for the room.

• #food_beverage_charges_currency ⇒ String^?

  The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the food and beverage charges.

• #no_show_indicator ⇒ Symbol, ...

  Indicator that the cardholder is being billed for a reserved room that was not actually used.

• #prepaid_expenses_amount ⇒ Integer^?

  Prepaid expenses being charged for the room.

• #prepaid_expenses_currency ⇒ String^?

  The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the prepaid expenses.

• #room_nights ⇒ Integer^?

  Number of nights the room was rented.

• #total_room_tax_amount ⇒ Integer^?

  Total room tax being charged.

• #total_room_tax_currency ⇒ String^?

  The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the total room tax.

• #total_tax_amount ⇒ Integer^?

  Total tax being charged for the room.

• #total_tax_currency ⇒ String^?

  The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the total tax assessed.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(check_in_date: , daily_room_rate_amount: , daily_room_rate_currency: , extra_charges: , folio_cash_advances_amount: , folio_cash_advances_currency: , food_beverage_charges_amount: , food_beverage_charges_currency: , no_show_indicator: , prepaid_expenses_amount: , prepaid_expenses_currency: , room_nights: , total_room_tax_amount: , total_room_tax_currency: , total_tax_amount: , total_tax_currency: ) ⇒ Object constructor

  Some parameter documentations has been truncated, see Lodging for more details.

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(check_in_date: , daily_room_rate_amount: , daily_room_rate_currency: , extra_charges: , folio_cash_advances_amount: , folio_cash_advances_currency: , food_beverage_charges_amount: , food_beverage_charges_currency: , no_show_indicator: , prepaid_expenses_amount: , prepaid_expenses_currency: , room_nights: , total_room_tax_amount: , total_room_tax_currency: , total_tax_amount: , total_tax_currency: ) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging for more details.

Fields specific to lodging.

Parameters:

• check_in_date (Date, nil) (defaults to: ) —

  Date the customer checked in.

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

  Daily rate being charged for the room.

• daily_room_rate_currency (String, nil) (defaults to: ) —

  The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the daily room r

• extra_charges (Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging::ExtraCharges, nil) (defaults to: ) —

  Additional charges (phone, late check-out, etc.) being billed.

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

  Folio cash advances for the room.

• folio_cash_advances_currency (String, nil) (defaults to: ) —

  The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the folio cash a

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

  Food and beverage charges for the room.

• food_beverage_charges_currency (String, nil) (defaults to: ) —

  The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the food and bev

• no_show_indicator (Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging::NoShowIndicator, nil) (defaults to: ) —

  Indicator that the cardholder is being billed for a reserved room that was not a

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

  Prepaid expenses being charged for the room.

• prepaid_expenses_currency (String, nil) (defaults to: ) —

  The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the prepaid expe

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

  Number of nights the room was rented.

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

  Total room tax being charged.

• total_room_tax_currency (String, nil) (defaults to: ) —

  The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the total room t

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

  Total tax being charged for the room.

• total_tax_currency (String, nil) (defaults to: ) —

  The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the total tax as

# File 'lib/increase/models/transaction.rb', line 4623

Instance Attribute Details

#check_in_date ⇒ Date^?

Date the customer checked in.

Returns:

• (Date, nil)

# File 'lib/increase/models/transaction.rb', line 4516

required :check_in_date, Date, nil?: true

#daily_room_rate_amount ⇒ Integer^?

Daily rate being charged for the room.

Returns:

• (Integer, nil)

# File 'lib/increase/models/transaction.rb', line 4522

required :daily_room_rate_amount, Integer, nil?: true

#daily_room_rate_currency ⇒ String^?

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the daily room rate.

Returns:

• (String, nil)

# File 'lib/increase/models/transaction.rb', line 4529

required :daily_room_rate_currency, String, nil?: true

#extra_charges ⇒ Symbol, ...

Additional charges (phone, late check-out, etc.) being billed.

Returns:

• (Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging::ExtraCharges, nil)

# File 'lib/increase/models/transaction.rb', line 4535

required :extra_charges,
enum: -> {
  Increase::Transaction::Source::CardSettlement::PurchaseDetails::Lodging::ExtraCharges
},
nil?: true

#folio_cash_advances_amount ⇒ Integer^?

Folio cash advances for the room.

Returns:

• (Integer, nil)

# File 'lib/increase/models/transaction.rb', line 4545

required :folio_cash_advances_amount, Integer, nil?: true

#folio_cash_advances_currency ⇒ String^?

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the folio cash advances.

Returns:

• (String, nil)

# File 'lib/increase/models/transaction.rb', line 4552

required :folio_cash_advances_currency, String, nil?: true

#food_beverage_charges_amount ⇒ Integer^?

Food and beverage charges for the room.

Returns:

• (Integer, nil)

# File 'lib/increase/models/transaction.rb', line 4558

required :food_beverage_charges_amount, Integer, nil?: true

#food_beverage_charges_currency ⇒ String^?

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the food and beverage charges.

Returns:

• (String, nil)

# File 'lib/increase/models/transaction.rb', line 4565

required :food_beverage_charges_currency, String, nil?: true

#no_show_indicator ⇒ Symbol, ...

Indicator that the cardholder is being billed for a reserved room that was not actually used.

Returns:

• (Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging::NoShowIndicator, nil)

# File 'lib/increase/models/transaction.rb', line 4572

required :no_show_indicator,
enum: -> {
  Increase::Transaction::Source::CardSettlement::PurchaseDetails::Lodging::NoShowIndicator
},
nil?: true

#prepaid_expenses_amount ⇒ Integer^?

Prepaid expenses being charged for the room.

Returns:

• (Integer, nil)

# File 'lib/increase/models/transaction.rb', line 4582

required :prepaid_expenses_amount, Integer, nil?: true

#prepaid_expenses_currency ⇒ String^?

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the prepaid expenses.

Returns:

• (String, nil)

# File 'lib/increase/models/transaction.rb', line 4589

required :prepaid_expenses_currency, String, nil?: true

#room_nights ⇒ Integer^?

Number of nights the room was rented.

Returns:

• (Integer, nil)

# File 'lib/increase/models/transaction.rb', line 4595

required :room_nights, Integer, nil?: true

#total_room_tax_amount ⇒ Integer^?

Total room tax being charged.

Returns:

• (Integer, nil)

# File 'lib/increase/models/transaction.rb', line 4601

required :total_room_tax_amount, Integer, nil?: true

#total_room_tax_currency ⇒ String^?

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the total room tax.

Returns:

• (String, nil)

# File 'lib/increase/models/transaction.rb', line 4608

required :total_room_tax_currency, String, nil?: true

#total_tax_amount ⇒ Integer^?

Total tax being charged for the room.

Returns:

• (Integer, nil)

# File 'lib/increase/models/transaction.rb', line 4614

required :total_tax_amount, Integer, nil?: true

#total_tax_currency ⇒ String^?

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the total tax assessed.

Returns:

• (String, nil)

# File 'lib/increase/models/transaction.rb', line 4621

required :total_tax_currency, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/increase/models/transaction.rb', line 4689