hotels

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 4, 2026 License: MIT Imports: 2 Imported by: 0

Documentation

Overview

Package hotels provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.6.0 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BoardType

type BoardType string

BoardType The included Breakfast/Meals

const (
	BoardTypeALLINCLUSIVE          BoardType = "ALL_INCLUSIVE"
	BoardTypeAMERICAN              BoardType = "AMERICAN"
	BoardTypeASBROCHURED           BoardType = "AS_BROCHURED"
	BoardTypeBERMUDA               BoardType = "BERMUDA"
	BoardTypeBREAKFAST             BoardType = "BREAKFAST"
	BoardTypeBUFFETBREAKFAST       BoardType = "BUFFET_BREAKFAST"
	BoardTypeCARIBBEANBREAKFAST    BoardType = "CARIBBEAN_BREAKFAST"
	BoardTypeCONTINENTALBREAKFAST  BoardType = "CONTINENTAL_BREAKFAST"
	BoardTypeDINNER                BoardType = "DINNER"
	BoardTypeDINNERBEDANDBREAKFAST BoardType = "DINNER_BED_AND_BREAKFAST"
	BoardTypeENGLISHBREAKFAST      BoardType = "ENGLISH_BREAKFAST"
	BoardTypeFAMILYAMERICAN        BoardType = "FAMILY_AMERICAN"
	BoardTypeFAMILYPLAN            BoardType = "FAMILY_PLAN"
	BoardTypeFULLBOARD             BoardType = "FULL_BOARD"
	BoardTypeFULLBREAKFAST         BoardType = "FULL_BREAKFAST"
	BoardTypeHALFBOARD             BoardType = "HALF_BOARD"
	BoardTypeLUNCH                 BoardType = "LUNCH"
	BoardTypeMODIFIED              BoardType = "MODIFIED"
	BoardTypeROOMONLY              BoardType = "ROOM_ONLY"
	BoardTypeSELFCATERING          BoardType = "SELF_CATERING"
)

Defines values for BoardType.

func (BoardType) Valid

func (e BoardType) Valid() bool

Valid indicates whether the value is a known member of the BoardType enum.

type CancellationType

type CancellationType string

CancellationType * FULL_STAY: the Penalty amount equals the `total` price.

const (
	FULLSTAY CancellationType = "FULL_STAY"
)

Defines values for CancellationType.

func (CancellationType) Valid

func (e CancellationType) Valid() bool

Valid indicates whether the value is a known member of the CancellationType enum.

type Error

type Error struct {
	// Code A machine-readable error code from the Amadeus Canned Messages table, that will enable the API Consumers code to handle this type of error
	Code *int32 `json:"code,omitempty"`

	// Detail An easy-to-read explanation specific to this occurrence of the problem. It should give the API consumer an idea of what went wrong and how to recover from it. Like the title, this field’s value can be localized.
	Detail *string `json:"detail,omitempty"`

	// Documentation A link to a web page or file with further documentation to help the API consumer resolve this error
	Documentation *string      `json:"documentation,omitempty"`
	Source        *ErrorSource `json:"source,omitempty"`

	// Status The [HTTP status code](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml) of this response. This is present only in terminal errors which cause an unsuccessful response. In the case of multiple errors, they must all have the same status.
	Status *int32 `json:"status,omitempty"`

	// Title An error title from the Canned Messages table with a 1:1 correspondence to the error code. This may be localized
	Title *string `json:"title,omitempty"`
}

Error The Error Definition

type ErrorSource

type ErrorSource struct {
	// Example A sample input to guide the user when resolving this issue
	Example *string `json:"example,omitempty"`

	// Parameter The key of the URI path or query parameter that caused the error
	Parameter *string `json:"parameter,omitempty"`

	// Pointer A JSON Pointer [RFC6901] to the associated entity in the request body that caused this error
	Pointer *string `json:"pointer,omitempty"`
}

ErrorSource defines model for Error_Source.

type Errors

type Errors struct {
	Errors *[]Error `json:"errors,omitempty"`
}

Errors A set of errors

type GetMultiHotelOffersParams

type GetMultiHotelOffersParams struct {
	// HotelIds Amadeus property codes on 8 chars. Mandatory parameter for a search by predefined list of hotels.
	HotelIds []string `form:"hotelIds" json:"hotelIds"`

	// Adults Number of adult guests (1-9) per room.
	Adults *int32 `form:"adults,omitempty" json:"adults,omitempty"`

	// CheckInDate Check-in date of the stay (hotel local date). Format YYYY-MM-DD. The lowest accepted value is the present date (no dates in the past). If not present, the default value will be today's date in the GMT time zone.
	CheckInDate *openapi_types.Date `form:"checkInDate,omitempty" json:"checkInDate,omitempty"`

	// CheckOutDate Check-out date of the stay (hotel local date). Format YYYY-MM-DD. The lowest accepted value is checkInDate+1. If not present, it will default to checkInDate +1.
	CheckOutDate *openapi_types.Date `form:"checkOutDate,omitempty" json:"checkOutDate,omitempty"`

	// CountryOfResidence Code of the country of residence of the traveler expressed using ISO 3166-1 format.
	CountryOfResidence *string `form:"countryOfResidence,omitempty" json:"countryOfResidence,omitempty"`

	// RoomQuantity Number of rooms requested (1-9).
	RoomQuantity *int32 `form:"roomQuantity,omitempty" json:"roomQuantity,omitempty"`

	// PriceRange Filter hotel offers by price per night interval (ex: 200-300 or -300 or 100).
	// It is mandatory to include a currency when this field is set.
	PriceRange *string `form:"priceRange,omitempty" json:"priceRange,omitempty"`

	// Currency Use this parameter to request a specific currency. ISO currency code (http://www.iso.org/iso/home/standards/currency_codes.htm).
	// If a hotel does not support the requested currency, the prices for the hotel will be returned in the local currency of the hotel.
	Currency *string `form:"currency,omitempty" json:"currency,omitempty"`

	// PaymentPolicy Filter the response based on a specific payment type. NONE means all types (default).
	PaymentPolicy *GetMultiHotelOffersParamsPaymentPolicy `form:"paymentPolicy,omitempty" json:"paymentPolicy,omitempty"`

	// BoardType Filter response based on available meals:
	//         * ROOM_ONLY = Room Only
	//         * BREAKFAST = Breakfast
	//         * HALF_BOARD = Diner & Breakfast (only for Aggregators)
	//         * FULL_BOARD = Full Board (only for Aggregators)
	//         * ALL_INCLUSIVE = All Inclusive (only for Aggregators)
	BoardType *GetMultiHotelOffersParamsBoardType `form:"boardType,omitempty" json:"boardType,omitempty"`

	// IncludeClosed Show all properties (include sold out) or available only. For sold out properties, please check availability on other dates.
	IncludeClosed *bool `form:"includeClosed,omitempty" json:"includeClosed,omitempty"`

	// BestRateOnly Used to return only the cheapest offer per hotel or all available offers.
	BestRateOnly *bool `form:"bestRateOnly,omitempty" json:"bestRateOnly,omitempty"`

	// Lang Requested language of descriptive texts.
	// Examples: FR , fr , fr-FR.
	// If a language is not available the text will be returned in english.
	// ISO language code (https://www.iso.org/iso-639-language-codes.html).
	Lang *string `form:"lang,omitempty" json:"lang,omitempty"`
}

GetMultiHotelOffersParams defines parameters for GetMultiHotelOffers.

type GetMultiHotelOffersParamsBoardType

type GetMultiHotelOffersParamsBoardType string

GetMultiHotelOffersParamsBoardType defines parameters for GetMultiHotelOffers.

const (
	GetMultiHotelOffersParamsBoardTypeALLINCLUSIVE GetMultiHotelOffersParamsBoardType = "ALL_INCLUSIVE"
	GetMultiHotelOffersParamsBoardTypeBREAKFAST    GetMultiHotelOffersParamsBoardType = "BREAKFAST"
	GetMultiHotelOffersParamsBoardTypeFULLBOARD    GetMultiHotelOffersParamsBoardType = "FULL_BOARD"
	GetMultiHotelOffersParamsBoardTypeHALFBOARD    GetMultiHotelOffersParamsBoardType = "HALF_BOARD"
	GetMultiHotelOffersParamsBoardTypeROOMONLY     GetMultiHotelOffersParamsBoardType = "ROOM_ONLY"
)

Defines values for GetMultiHotelOffersParamsBoardType.

func (GetMultiHotelOffersParamsBoardType) Valid

Valid indicates whether the value is a known member of the GetMultiHotelOffersParamsBoardType enum.

type GetMultiHotelOffersParamsPaymentPolicy

type GetMultiHotelOffersParamsPaymentPolicy string

GetMultiHotelOffersParamsPaymentPolicy defines parameters for GetMultiHotelOffers.

const (
	GetMultiHotelOffersParamsPaymentPolicyDEPOSIT   GetMultiHotelOffersParamsPaymentPolicy = "DEPOSIT"
	GetMultiHotelOffersParamsPaymentPolicyGUARANTEE GetMultiHotelOffersParamsPaymentPolicy = "GUARANTEE"
	GetMultiHotelOffersParamsPaymentPolicyNONE      GetMultiHotelOffersParamsPaymentPolicy = "NONE"
)

Defines values for GetMultiHotelOffersParamsPaymentPolicy.

func (GetMultiHotelOffersParamsPaymentPolicy) Valid

Valid indicates whether the value is a known member of the GetMultiHotelOffersParamsPaymentPolicy enum.

type GetOfferPricingParams

type GetOfferPricingParams struct {
	// Lang Requested language of descriptive texts.
	// Examples: FR , fr , fr-FR.
	// If a language is not available the text will be returned in english.
	// ISO language code (https://www.iso.org/iso-639-language-codes.html).
	Lang *string `form:"lang,omitempty" json:"lang,omitempty"`
}

GetOfferPricingParams defines parameters for GetOfferPricing.

type Hotel

type Hotel struct {
	// BrandCode Brand (RT...) (Amadeus 2 chars Code). Small Properties distributed by Merchants may not have a Brand.
	// Example - AD (Value Hotels) is the Provider/Merchant, and RT (Accor) is the Brand of the Property
	BrandCode *string `json:"brandCode,omitempty"`

	// ChainCode Brand (RT...) or Merchant (AD...) (Amadeus 2 chars Code)
	ChainCode *string `json:"chainCode,omitempty"`

	// CityCode Warning: The IATA city code associated to the hotel (not necessary the real Hotel City)
	CityCode *string `json:"cityCode,omitempty"`

	// DupeId Unique Property identifier of the physical hotel.
	// One physical hotel can be represented by different Providers, each one having its own `hotelID`.
	// This attribute allows a client application to group together hotels that are actually the same.
	DupeId *string `json:"dupeId,omitempty"`

	// HotelId Amadeus Property Code (8 chars)
	HotelId *string `json:"hotelId,omitempty"`

	// Name Hotel Name
	Name *string `json:"name,omitempty"`
}

Hotel Hotel Content

type HotelOffer

type HotelOffer struct {
	// BoardType The included Breakfast/Meals
	BoardType *BoardType `json:"boardType,omitempty"`

	// Category Special Rate Category
	// Examples:
	//   ASSOCIATION
	//   FAMILY_PLAN
	Category *string `json:"category,omitempty"`

	// CheckInDate check-in date of the stay (hotel local date). Format YYYY-MM-DD
	// The lowest accepted value is today date (no dates in the past).
	CheckInDate *openapi_types.Date `json:"checkInDate,omitempty"`

	// CheckOutDate check-out date of the stay (hotel local date). Format YYYY-MM-DD
	// The lowest accepted value is `checkInDate`+1.
	CheckOutDate *openapi_types.Date     `json:"checkOutDate,omitempty"`
	Commission   *HotelProductCommission `json:"commission,omitempty"`

	// Description Specific type to convey a list of string for specific information type ( via qualifier) in specific character set, or language
	Description *QualifiedFreeText  `json:"description,omitempty"`
	Guests      *HotelProductGuests `json:"guests,omitempty"`

	// Id Unique identifier of this offer. Might be valid for a temporary period only.
	Id string `json:"id"`

	// Policies Booking Rules
	Policies *HotelProductPolicyDetails `json:"policies,omitempty"`

	// Price price information
	Price HotelProductHotelPrice `json:"price"`

	// RateCode Special Rate - Provider Response Code (3 chars)
	// Examples
	//
	//   * RAC - Rack
	//
	//   * BAR - Best Available Rate
	//
	//   * PRO - Promotional
	//
	//   * COR - Corporate
	//
	//   * GOV - Government (qualified)
	//
	//   * AAA - AAA (qualified)
	//
	//   * BNB - Bed and Breakfast
	//
	//   * PKG - Package
	//
	//   * TVL - Travel Industry
	//
	//   * SPC - Special Promo Rate
	//
	//   * WKD - Weekend
	//
	//   * CON - Convention
	//
	//   * SNR - Senior (Europe) (qualified)
	//
	//   * ARP - AARP - American Association of Retired People (50+) (qualified)
	//
	//   * SRS - Senior (qualified)
	//
	//   * ROR - Room Only Rate (no breakfast)
	//
	//   * FAM - Family
	//
	//   * DAY - Day rate
	RateCode string `json:"rateCode"`

	// RateFamilyEstimated The estimated rate code family of the offer. Grouping various rate plan codes that belongs to the same family and indicates the type of the rate
	RateFamilyEstimated *HotelProductRateFamily `json:"rateFamilyEstimated,omitempty"`
	Room                HotelProductRoomDetails `json:"room"`

	// RoomQuantity number of rooms (1-9)
	RoomQuantity *string `json:"roomQuantity,omitempty"`

	// Self A self link to the object. Use this to refresh the Offer price
	Self *string `json:"self,omitempty"`

	// Type data type
	Type *Type `json:"type,omitempty"`
}

HotelOffer Hotel Offer

type HotelOffers

type HotelOffers struct {
	Available *bool `json:"available,omitempty"`

	// Hotel Hotel Content
	Hotel  *Hotel        `json:"hotel,omitempty"`
	Offers *[]HotelOffer `json:"offers,omitempty"`
	Self   *string       `json:"self,omitempty"`

	// Type the type of the object (hotel-offers)
	Type *string `json:"type,omitempty"`
}

HotelOffers defines model for HotelOffers.

type HotelProductCancellationPolicy

type HotelProductCancellationPolicy struct {
	// Amount Amount of the cancellation fee.
	Amount *string `json:"amount,omitempty"`

	// Deadline Represents the deadline after which the penalty applies. DateTime is in ISO 8601 [https://www.w3.org/TR/NOTE-datetime].
	// Example: 2010-08-14T12:00:00+01:00
	// Example: 2010-08-14T12:00:00Z
	// Example: 2010-08-14T12:00:00-01:00
	// The value is expressed in the hotel local time zone, with the added time zone difference. So you can compute the deadline in UTC(GMT) if desired.
	Deadline *time.Time `json:"deadline,omitempty"`

	// Description Specific type to convey a list of string for specific information type ( via qualifier) in specific character set, or language
	Description *QualifiedFreeText `json:"description,omitempty"`

	// NumberOfNights Number of nights due as fee in case of cancellation.
	NumberOfNights *int32 `json:"numberOfNights,omitempty"`

	// Percentage Percentage of the total stay amount to be paid in case of cancellation. Value is between 0 and 100.
	Percentage *string `json:"percentage,omitempty"`

	// Type * FULL_STAY: the Penalty amount equals the `total` price.
	Type *CancellationType `json:"type,omitempty"`
}

HotelProductCancellationPolicy defines model for HotelProduct_CancellationPolicy.

type HotelProductCheckInOutPolicy

type HotelProductCheckInOutPolicy struct {
	// CheckIn Check-in From time limit in ISO-8601 format [http://www.w3.org/TR/xmlschema-2/#time]
	CheckIn *string `json:"checkIn,omitempty"`

	// CheckInDescription Specific type to convey a list of string for specific information type ( via qualifier) in specific character set, or language
	CheckInDescription *QualifiedFreeText `json:"checkInDescription,omitempty"`

	// CheckOut Check-out Until time limit in ISO-8601 format [http://www.w3.org/TR/xmlschema-2/#time]
	CheckOut *string `json:"checkOut,omitempty"`

	// CheckOutDescription Specific type to convey a list of string for specific information type ( via qualifier) in specific character set, or language
	CheckOutDescription *QualifiedFreeText `json:"checkOutDescription,omitempty"`
}

HotelProductCheckInOutPolicy defines model for HotelProduct_CheckInOutPolicy.

type HotelProductCommission

type HotelProductCommission struct {
	// Amount Amount of the commission paid to the travel seller. The amount is always linked to the currency code of the offer
	Amount *string `json:"amount,omitempty"`

	// Description Specific type to convey a list of string for specific information type ( via qualifier) in specific character set, or language
	Description *QualifiedFreeText `json:"description,omitempty"`

	// Percentage Percentage of the commission paid to the travel seller. Value is between 0 and 100
	Percentage *string `json:"percentage,omitempty"`
}

HotelProductCommission defines model for HotelProduct_Commission.

type HotelProductDepositPolicy

type HotelProductDepositPolicy struct {
	// AcceptedPayments Accepted Payment Methods and Card Types. Several Payment Methods and Card Types may be available.
	AcceptedPayments *HotelProductPaymentPolicy `json:"acceptedPayments,omitempty"`

	// Amount Deposit-Prepay amount
	Amount *string `json:"amount,omitempty"`

	// Deadline The date and time of the deadline in ISO 8601[https://www.w3.org/TR/NOTE-datetime].
	//  Example: 2010-08-14T13:00:00
	//  Please note that this value is expressed in the hotels local time zone
	Deadline *time.Time `json:"deadline,omitempty"`

	// Description Specific type to convey a list of string for specific information type ( via qualifier) in specific character set, or language
	Description *QualifiedFreeText `json:"description,omitempty"`
}

HotelProductDepositPolicy the deposit/prepay policy information applicable to the offer. It includes accepted payments, deadline and the amount due

type HotelProductEstimatedRoomType

type HotelProductEstimatedRoomType struct {
	// BedType Type of the bed
	BedType *string `json:"bedType,omitempty"`

	// Beds Number of beds in the room (1-9)
	Beds *int32 `json:"beds,omitempty"`

	// Category Category code
	Category *string `json:"category,omitempty"`
}

HotelProductEstimatedRoomType estimated room category, bed type and number of beds in the room. This information has been parsed from the room description, and is thus only provided for informational purposes

type HotelProductGuaranteePolicy

type HotelProductGuaranteePolicy struct {
	// AcceptedPayments Accepted Payment Methods and Card Types. Several Payment Methods and Card Types may be available.
	AcceptedPayments *HotelProductPaymentPolicy `json:"acceptedPayments,omitempty"`

	// Description Specific type to convey a list of string for specific information type ( via qualifier) in specific character set, or language
	Description *QualifiedFreeText `json:"description,omitempty"`
}

HotelProductGuaranteePolicy the guarantee policy information applicable to the offer. It includes accepted payments

type HotelProductGuests

type HotelProductGuests struct {
	// Adults number of adult guests (1-9) per room
	Adults *int32 `json:"adults,omitempty"`

	// ChildAges Comma separated list of ages of each child at the time of check-out from the hotel. If several children have the same age, the ages will be repeated.
	ChildAges *[]int32 `json:"childAges,omitempty"`
}

HotelProductGuests defines model for HotelProduct_Guests.

type HotelProductHoldPolicy

type HotelProductHoldPolicy struct {
	// Deadline The date and time of the deadline in ISO 8601[https://www.w3.org/TR/NOTE-datetime].
	//  Example: 2010-08-14T13:00:00
	//  Please note that this value is expressed in the hotels local time zone
	Deadline time.Time `json:"deadline"`
}

HotelProductHoldPolicy the hold policy

type HotelProductHotelPrice

type HotelProductHotelPrice struct {
	Base *string `json:"base,omitempty"`

	// Currency currency Code apply to all elements of the price
	Currency *string   `json:"currency,omitempty"`
	Markups  *[]Markup `json:"markups,omitempty"`

	// SellingTotal sellingTotal = Total + margins + markup + totalFees - discounts
	SellingTotal *string `json:"sellingTotal,omitempty"`
	Taxes        *[]Tax  `json:"taxes,omitempty"`

	// Total total = base + totalTaxes
	Total *string `json:"total,omitempty"`

	// Variations Daily price variations and the average daily price (when available) is shown here
	Variations *HotelProductPriceVariations `json:"variations,omitempty"`
}

HotelProductHotelPrice price information

type HotelProductPaymentPolicy

type HotelProductPaymentPolicy struct {
	// CreditCards Accepted Payment Card Types for the `method` CREDIT_CARD
	CreditCards *[]string `json:"creditCards,omitempty"`

	// Methods Accepted Payment Methods
	Methods *[]Method `json:"methods,omitempty"`
}

HotelProductPaymentPolicy Accepted Payment Methods and Card Types. Several Payment Methods and Card Types may be available.

type HotelProductPolicyDetails

type HotelProductPolicyDetails struct {
	Cancellations *[]HotelProductCancellationPolicy `json:"cancellations,omitempty"`
	CheckInOut    *HotelProductCheckInOutPolicy     `json:"checkInOut,omitempty"`

	// Deposit the deposit/prepay policy information applicable to the offer. It includes accepted payments, deadline and the amount due
	Deposit *HotelProductDepositPolicy `json:"deposit,omitempty"`

	// Guarantee the guarantee policy information applicable to the offer. It includes accepted payments
	Guarantee *HotelProductGuaranteePolicy `json:"guarantee,omitempty"`

	// HoldTime the hold policy
	HoldTime *HotelProductHoldPolicy `json:"holdTime,omitempty"`

	// PaymentType payment type. Guarantee means Pay at Check Out. Check the `methods` in `guarantee` or `deposit` or `prepay`.
	PaymentType *PaymentType `json:"paymentType,omitempty"`

	// Prepay the deposit/prepay policy information applicable to the offer. It includes accepted payments, deadline and the amount due
	Prepay *HotelProductDepositPolicy `json:"prepay,omitempty"`
}

HotelProductPolicyDetails Booking Rules

type HotelProductPriceVariation

type HotelProductPriceVariation struct {
	Base *string `json:"base,omitempty"`

	// Currency currency Code apply to all elements of the price
	Currency *string `json:"currency,omitempty"`

	// EndDate End date of the period
	// Format: YYYY-MM-DD
	EndDate openapi_types.Date `json:"endDate"`
	Markups *[]Markup          `json:"markups,omitempty"`

	// SellingTotal sellingTotal = Total + margins + markup + totalFees - discounts
	SellingTotal *string `json:"sellingTotal,omitempty"`

	// StartDate Begin date of the period
	// Format: YYYY-MM-DD
	StartDate openapi_types.Date `json:"startDate"`

	// Total total = base + totalTaxes
	Total *string `json:"total,omitempty"`
}

HotelProductPriceVariation Some prices may vary during a stay, thus here you can see the daily price per period of the stay

type HotelProductPriceVariations

type HotelProductPriceVariations struct {
	// Average Price valuation information
	Average *Price `json:"average,omitempty"`

	// Changes A collection of price periods if the daily price changes during the stay
	Changes *[]HotelProductPriceVariation `json:"changes,omitempty"`
}

HotelProductPriceVariations Daily price variations and the average daily price (when available) is shown here

type HotelProductRateFamily

type HotelProductRateFamily struct {
	// Code The estimated rate family (PRO,FAM,GOV)
	Code *string `json:"code,omitempty"`

	// Type The type of the rate (public=P, negotiated=N, conditional=C)
	Type *string `json:"type,omitempty"`
}

HotelProductRateFamily The estimated rate code family of the offer. Grouping various rate plan codes that belongs to the same family and indicates the type of the rate

type HotelProductRoomDetails

type HotelProductRoomDetails struct {
	// Description Specific type to convey a list of string for specific information type ( via qualifier) in specific character set, or language
	Description *QualifiedFreeText `json:"description,omitempty"`

	// Type Room type code, 3 character identifier of the room.
	// The first character identifies the room type category.
	// The second numeric character identifies the number of beds.
	// The third character identifies the bed type.
	// There is a special case where ROH is returned, this value stands for Run Of House.
	Type *string `json:"type,omitempty"`

	// TypeEstimated estimated room category, bed type and number of beds in the room. This information has been parsed from the room description, and is thus only provided for informational purposes
	TypeEstimated *HotelProductEstimatedRoomType `json:"typeEstimated,omitempty"`
}

HotelProductRoomDetails defines model for HotelProduct_RoomDetails.

type Markup

type Markup struct {
	// Amount Defines the monetary value with decimal position as a String.
	Amount *string `json:"amount,omitempty"`
}

Markup Markup applied to provide a service or a product to the client. The markup can be introduced by any stakeholder. Typical use case is to convey markup information set by the travel agent or in case of merchant mode.

type Method

type Method string

Method The Payment Methods

  • CREDIT_CARD (CC) - Payment Cards in `creditCards` are accepted
  • AGENCY_ACCOUNT - Agency Account (Credit Line) is accepted. Agency is Charged at CheckOut
  • TRAVEL_AGENT_ID - Agency IATA/ARC Number is accepted to Guarantee the booking
  • CORPORATE_ID (COR-ID) - Corporate Account is accepted to Guarantee the booking
  • HOTEL_GUEST_ID - Hotel Chain Rewards Card Number is accepted to Guarantee the booking
  • CHECK - Checks are accepted
  • MISC_CHARGE_ORDER - Miscellaneous Charge Order is accepted
  • ADVANCE_DEPOSIT - Cash is accepted for Deposit/PrePay
  • COMPANY_ADDRESS - Company Billing Address is accepted to Guarantee the booking
const (
	ADVANCEDEPOSIT       Method = "ADVANCE_DEPOSIT"
	AGENCYACCOUNT        Method = "AGENCY_ACCOUNT"
	CHECK                Method = "CHECK"
	COMPANYADDRESS       Method = "COMPANY_ADDRESS"
	CORPORATEID          Method = "CORPORATE_ID"
	CREDITCARD           Method = "CREDIT_CARD"
	DEFEREDPAYMENT       Method = "DEFERED_PAYMENT"
	HOTELGUESTID         Method = "HOTEL_GUEST_ID"
	MISCCHARGEORDER      Method = "MISC_CHARGE_ORDER"
	TRAVELAGENTID        Method = "TRAVEL_AGENT_ID"
	TRAVELAGENTIMMEDIATE Method = "TRAVEL_AGENT_IMMEDIATE"
	VCCB2BWALLET         Method = "VCC_B2B_WALLET"
	VCCBILLBACK          Method = "VCC_BILLBACK"
)

Defines values for Method.

func (Method) Valid

func (e Method) Valid() bool

Valid indicates whether the value is a known member of the Method enum.

type MultiResponse

type MultiResponse struct {
	Data *HotelOffers `json:"data,omitempty"`
}

MultiResponse defines model for MultiResponse.

type PaymentType

type PaymentType string

PaymentType payment type. Guarantee means Pay at Check Out. Check the `methods` in `guarantee` or `deposit` or `prepay`.

const (
	PaymentTypeDEPOSIT   PaymentType = "DEPOSIT"
	PaymentTypeGUARANTEE PaymentType = "GUARANTEE"
	PaymentTypeHOLDTIME  PaymentType = "HOLDTIME"
	PaymentTypePREPAY    PaymentType = "PREPAY"
)

Defines values for PaymentType.

func (PaymentType) Valid

func (e PaymentType) Valid() bool

Valid indicates whether the value is a known member of the PaymentType enum.

type Price

type Price struct {
	Base *string `json:"base,omitempty"`

	// Currency currency Code apply to all elements of the price
	Currency *string   `json:"currency,omitempty"`
	Markups  *[]Markup `json:"markups,omitempty"`

	// SellingTotal sellingTotal = Total + margins + markup + totalFees - discounts
	SellingTotal *string `json:"sellingTotal,omitempty"`

	// Total total = base + totalTaxes
	Total *string `json:"total,omitempty"`
}

Price Price valuation information

type PricingResponse

type PricingResponse struct {
	Data *HotelOffers `json:"data,omitempty"`
}

PricingResponse defines model for PricingResponse.

type QualifiedFreeText

type QualifiedFreeText struct {
	// Lang see RFC 5646
	Lang *string `json:"lang,omitempty"`

	// Text Free Text
	Text *string `json:"text,omitempty"`
}

QualifiedFreeText Specific type to convey a list of string for specific information type ( via qualifier) in specific character set, or language

type Tax

type Tax struct {
	// Amount Defines amount with decimal separator.
	Amount *string `json:"amount,omitempty"`

	// Code International Standards Organization (ISO) Tax code.It is a two-letter country code.
	Code *string `json:"code,omitempty"`

	// Currency Defines a monetary unit. It is a three alpha code (iata code). Example: EUR for Euros, USD for US dollar, etc.
	Currency *string `json:"currency,omitempty"`

	// Description Example - "Governement tax"
	Description *string `json:"description,omitempty"`

	// Included Indicates if tax is included or not
	Included *bool `json:"included,omitempty"`

	// Percentage In the case of a tax on TST value, the percentage of the tax will be indicated in this field.
	Percentage *string `json:"percentage,omitempty"`

	// PricingFrequency Specifies if the tax applies per stay or per night
	//   - PER_STAY
	//   - PER_NIGHT
	PricingFrequency *string `json:"pricingFrequency,omitempty"`

	// PricingMode Specifies if the tax applies per occupant or per room
	//   - PER_OCCUPANT
	//   - PER_PRODUCT
	PricingMode *string `json:"pricingMode,omitempty"`
}

Tax IATA Tax definition: An impost for raising revenue for the general treasury and which will be used for general public purposes.

type Type

type Type string

Type data type

const (
	TypeHotelOffer Type = "hotel-offer"
)

Defines values for Type.

func (Type) Valid

func (e Type) Valid() bool

Valid indicates whether the value is a known member of the Type enum.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL