Ballerina library

amadeus.flightoffersprice

Module amadeus.flightoffersprice

OverviewPrerequisites

API

Client

Definitions

AdditionalService
AdditionalServicesRequest
Address
AircraftEntry
AircraftEquipment
AllotmentDetails
BaggageAllowance
Bags
BaseName
BookingRequirements
CarrierEntry
ClientHttp1Settings
Co2Emission
ConnectionConfig
Contact
ContactDictionary
CreditCardFee
CurrencyEntry
Description
DetailedFareRules
Dictionaries
Discount
Document
ElementaryPrice
EmergencyContact
Error400
Error500
ExtendedPrice
FareDetailsBySegment
FareRules
Fee
FlightEndPoint
FlightOffer
FlightOfferPricingIn
FlightOfferPricingOut
FlightSegment
FlightStop
GetPriceQuery
IdentityDocument
IncludedResourcesMap
Issue
IssueSource
Itineraries
LocationEntry
LocationValue
LoyaltyProgram
Name
OAuth2ClientCredentialsGrantConfig
OperatingFlight
OriginalFlightEndPoint
OriginalFlightStop
OtherServices
PassengerConditions
Payment
Phone
Price
PricingOptions
ProxyConfig
Segment
Stakeholder
SuccessPricing
Tax
TermAndCondition
Traveler
TravelerPricing

AdditionalServiceType
ContactPurpose
DiscountTravelerType
DiscountType
DocumentType
FeeType
FlightOfferSource
PaymentBrand
PhoneDeviceType
ServiceName
SliceDiceIndicator
StakeholderGender
TravelClass
TravelerPricingFareOption
TravelerType

ballerinax/amadeus.flightoffersprice Ballerina library

1.3.1

Overview

This is a generated connector for Amadeus Flight Offers Price API OpenAPI specification.

This Amadeus Flight Offers Price API provides the capability to confirm the availability and final price (including taxes and fees) of flights returned by the Flight Offers Search API.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Clients

amadeus.flightoffersprice: Client

Isolated

This is a generated connector for Amadeus Flight Offers Price API OpenAPI specification. This Amadeus Flight Offers Price API provides the capability to confirm the availability and final price (including taxes and fees) of flights returned by the Flight Offers Search API.

Constructor

Gets invoked to initialize the connector. The connector initialization requires clientId and clientSecret. Please create Amadeus account and Obtain clientId and clientSecret following this guide

init (ConnectionConfig config, string serviceUrl)
  • config ConnectionConfig - The configurations to be used when initializing the connector
  • serviceUrl string "https://test.api.amadeus.com/v1" - URL of the target service

quoteAirOffers

Isolated FunctionRemote Function
function quoteAirOffers(string xHttpMethodOverride, GetPriceQuery payload, string[]? include, boolean forceClass) returns SuccessPricing|error

Confirm pricing of given flightOffers.

Parameters
  • xHttpMethodOverride string - the HTTP method to apply
  • payload GetPriceQuery - list of criteria to confirm the price of a dedicated flight-offers
  • include string[]? (default ()) - Sub-resources to be included: * credit-card-fees to get the credit card fee applied on the booking * bags to get extra bag options * other-services to get services options * detailed-fare-rules to get detailed fare rules options
  • forceClass boolean (default false) - parameter to force the usage of booking class for pricing - true, to for pricing with the specified booking class - false, to get the best available price
Return Type

Records

amadeus.flightoffersprice: AdditionalService

Fields

amadeus.flightoffersprice: AdditionalServicesRequest

Fields
  • chargeableSeatNumber string? - seat number

amadeus.flightoffersprice: Address

address information

Fields
  • lines string[]? - Line 1 = Street address, Line 2 = Apartment, suite, unit, building, floor, etc
  • postalCode string? - Example: 74130
  • cityName string? - Full city name. Example: Dublin
  • stateName string? - Full state name
  • postalBox string? - E.g. BP 220

amadeus.flightoffersprice: AircraftEntry

Fields

amadeus.flightoffersprice: AircraftEquipment

information related to the aircraft

Fields
  • code string? - IATA aircraft code (http://www.flugzeuginfo.net/table_accodes_iata_en.php)

amadeus.flightoffersprice: AllotmentDetails

Fields

amadeus.flightoffersprice: BaggageAllowance

baggageAllowance

Fields
  • quantity int? - Total number of units
  • weight int? - Weight of the baggage allowance
  • weightUnit string? - Code to qualify unit as pounds or kilos

amadeus.flightoffersprice: Bags

checked bag

Fields
  • name string? - Type of service
  • bookableByItinerary boolean? - Specify if the service is bookable by itinerary or for all itineraries
  • segmentIds string[]? - Id of the segment concerned by the service
  • travelerIds string[]? - Id of the traveler concerned by the service

amadeus.flightoffersprice: BaseName

description of the name of a physical person

Fields
  • firstName string? - First name.
  • middleName string? - Middle name(s), for example "Lee" in "John Lee Smith".

amadeus.flightoffersprice: BookingRequirements

pricing condition at booking level

Fields
  • invoiceAddressRequired boolean? - If true, an invoice address is required for the creation of the flight-order
  • mailingAddressRequired boolean? - If true, a postal address is required for the creation of the flight-order
  • emailAddressRequired boolean? - If true, an email address is required for the creation of the flight-order
  • phoneCountryCodeRequired boolean? - If true, the phone country code (e.g. '33') associated for each phone number is required for the creation of the flight-order
  • mobilePhoneNumberRequired boolean? - If true, a mobile phone number is required for the creation of the flight-order
  • phoneNumberRequired boolean? - If true, a phone number is required for the creation of the flight-order
  • postalCodeRequired boolean? - If true, a postal code is required for the creation of the flight-order

amadeus.flightoffersprice: CarrierEntry

Fields

amadeus.flightoffersprice: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields
  • keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
  • chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

amadeus.flightoffersprice: Co2Emission

Fields
  • weight int? - Weight of Co2 emitted for the concerned segment
  • weightUnit string? - Code to qualify unit as pounds or kilos
  • cabin TravelClass? - quality of service offered in the cabin where the seat is located in this flight. Economy, premium economy, business or first class

amadeus.flightoffersprice: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields
  • httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
  • timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
  • forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header
  • cache CacheConfig? - HTTP caching related configurations
  • compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header
  • circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
  • retryConfig RetryConfig? - Configurations associated with retrying
  • validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

amadeus.flightoffersprice: Contact

contact information

Fields
  • phones Phone[]? - Phone numbers
  • companyName string? - Name of the company
  • emailAddress string? - Email address (e.g. john@smith.com)

amadeus.flightoffersprice: ContactDictionary

represents a contact

Fields
  • addresseeName Name? - name
  • address Address? - address information
  • language string? - the preferred language of communication with this Contact
  • purpose ContactPurpose? - the purpose for which this contact is to be used

amadeus.flightoffersprice: CreditCardFee

Fields
  • flightOfferId string? - Id of the flightOffer concerned by the credit card fee

amadeus.flightoffersprice: CurrencyEntry

Fields

amadeus.flightoffersprice: Description

Fields

amadeus.flightoffersprice: DetailedFareRules

Fields
  • segmentId string? - Id of the segment concerned by the fare rule

amadeus.flightoffersprice: Dictionaries

Fields

amadeus.flightoffersprice: Discount

traveler discount

Fields
  • cityName string? - city of residence
  • cardNumber string? - resident card number
  • certificateNumber string? - resident certificate number

amadeus.flightoffersprice: Document

the information that are found on an ID document

Fields
  • number string? - The document number (shown on the document) . E.g. QFU514563221J
  • issuanceDate string? - Date at which the document has been issued.
  • expiryDate string? - Date after which the document is not valid anymore.
  • issuanceLocation string? - A more precise information concerning the place where the document has been issued, when available. It may be a country, a state, a city or any other type of location. e.g. New-York
  • birthPlace string? - Birth place as indicated on the document

amadeus.flightoffersprice: ElementaryPrice

elementaryPrice

Fields
  • amount string? - Amount of the fare. could be alpha numeric. Ex- 500.20 or 514.13A, 'A'signifies additional collection.
  • currencyCode string? - Currency type of the fare.

amadeus.flightoffersprice: EmergencyContact

emergency contact number

Fields
  • addresseeName string? - Adressee name (e.g. in case of emergency purpose it corresponds to name of the person to be contacted).
  • countryCode string? - Country code of the country (ISO3166-1). E.g. "US" for the United States
  • number string? - Phone number. Composed of digits only. The number of digits depends on the country.
  • text string? - additional details

amadeus.flightoffersprice: Error400

Fields

amadeus.flightoffersprice: Error500

Fields

amadeus.flightoffersprice: ExtendedPrice

price information

Fields
  • margin string? - BOOK step ONLY - The price margin percentage (plus or minus) that the booking can tolerate. When set to 0, then no price magin is tolerated.
  • grandTotal string? - Total amount paid by the user (including fees and selected additional services).
  • billingCurrency string? - Currency of the payment. It may be different than the requested currency
  • Fields Included from * Price

amadeus.flightoffersprice: FareDetailsBySegment

Fare details of the segment

Fields
  • segmentId string - Id of the segment
  • cabin TravelClass? - quality of service offered in the cabin where the seat is located in this flight. Economy, premium economy, business or first class
  • fareBasis string? - Fare basis specifying the rules of a fare. Usually, though not always, is composed of the booking class code followed by a set of letters and digits representing other characteristics of the ticket, such as refundability, minimum stay requirements, discounts or special promotional elements.
  • brandedFare string? - The name of the Fare Family corresponding to the fares. Only for the GDS provider and if the airline has fare families filled
  • 'class string? - The code of the booking class, a.k.a. class of service or Reservations/Booking Designator (RBD)
  • isAllotment boolean? - True if the corresponding booking class is in an allotment
  • sliceDiceIndicator SliceDiceIndicator? - slice and Dice indicator, such as Local Availability, Sub OnD(Origin and Destination) 1 Availability and Sub OnD 2 Availability

amadeus.flightoffersprice: FareRules

Fields
  • currency string? - The currency of the penalties

amadeus.flightoffersprice: Fee

a fee

Fields

amadeus.flightoffersprice: FlightEndPoint

departure or arrival information

Fields
  • at string? - local date and time in ISO8601 YYYY-MM-ddThh:mm:ss format, e.g. 2017-02-10T20:40:00

amadeus.flightoffersprice: FlightOffer

Fields
  • 'type string - the resource name
  • id string - Id of the flight offer
  • instantTicketingRequired boolean? - If true, inform that a ticketing will be required at booking step.
  • disablePricing boolean? - BOOK step ONLY - If true, allows to book a PNR without pricing. Only for the source "GDS"
  • nonHomogeneous boolean? - If true, upon completion of the booking, this pricing solution is expected to yield multiple records (a record contains booking information confirmed and stored, typically a Passenger Name Record (PNR), in the provider GDS or system)
  • oneWay boolean? - If true, the flight offer fulfills only one originDestination and has to be combined with other oneWays to complete the whole journey.
  • paymentCardRequired boolean? - If true, a payment card is mandatory to book this flight offer
  • lastTicketingDate string? - If booked on the same day as the search (with respect to timezone), this flight offer is guaranteed to be thereafter valid for ticketing until this date (included). Unspecified when it does not make sense for this flight offer (e.g. no control over ticketing once booked). YYYY-MM-DD format, e.g. 2019-06-07
  • numberOfBookableSeats decimal? - Number of seats bookable in a single request. Can not be higher than 9.
  • validatingAirlineCodes string[]? - This option ensures that the system will only consider these airlines.
  • travelerPricings TravelerPricing[]? - Fare information for each traveler/segment

amadeus.flightoffersprice: FlightOfferPricingIn

input parameter to price flight offers element

Fields
  • 'type string - the resource name
  • flightOffers FlightOffer[] - list of flight offer to price
  • payments Payment[]? - payment information for retrieve eventual credit card fees
  • travelers Traveler[]? - list of travelers

amadeus.flightoffersprice: FlightOfferPricingOut

priced flight Offers and conditions

Fields
  • 'type string - the resource name
  • flightOffers FlightOffer[] - list of flight offer to price

amadeus.flightoffersprice: FlightSegment

defining a flight segment; including both operating and marketing details when applicable

Fields
  • carrierCode string? - providing the airline / carrier code
  • number string? - the flight number as assigned by the carrier
  • duration string? - stop duration in ISO8601 PnYnMnDTnHnMnS format, e.g. PT2H10M
  • stops FlightStop[]? - information regarding the different stops composing the flight segment. E.g. technical stop, change of gauge...

amadeus.flightoffersprice: FlightStop

details of stops for direct or change of gauge flights

Fields
  • arrivalAt string? - arrival at the stop in ISO8601 YYYY-MM-ddThh:mm:ss format, e.g. 2017-02-10T20:40:00
  • departureAt string? - departure from the stop in ISO8601 YYYY-MM-ddThh:mm:ss format, e.g. 2017-02-10T20:40:00

amadeus.flightoffersprice: GetPriceQuery

Fields

amadeus.flightoffersprice: IdentityDocument

documents of the traveler

Fields
  • documentType DocumentType? - the nature/type of the document
  • holder boolean? - boolean to specify if the traveler is the holder of the document

amadeus.flightoffersprice: IncludedResourcesMap

Fields
  • 'credit\-card\-fees record {}? - Map of fee applied by credit card brand
  • bags record {}? - Map of fee applied by bag option
  • 'other\-services record {}? - Map of fee applied by service
  • 'detailed\-fare\-rules record {}? - Map of fare rules applied by farebasis

amadeus.flightoffersprice: Issue

Fields
  • status int? - the HTTP status code applicable to this error
  • code int? - an application-specific error code
  • title string? - a short summary of the error
  • detail string? - explanation of the error
  • 'source IssueSource? - an object containing references to the source of the error

amadeus.flightoffersprice: IssueSource

an object containing references to the source of the error

Fields
  • pointer string? - a JSON Pointer [RFC6901] to the associated entity in the request document
  • 'parameter string? - a string indicating which URI query parameter caused the issue
  • example string? - a string indicating an example of the right value

amadeus.flightoffersprice: Itineraries

Fields
  • duration string? - duration in ISO8601 PnYnMnDTnHnMnS format, e.g. PT2H10M for a duration of 2h10m

amadeus.flightoffersprice: LocationEntry

Fields

amadeus.flightoffersprice: LocationValue

Fields
  • cityCode string? - City code associated to the airport
  • countryCode string? - Country code of the airport

amadeus.flightoffersprice: LoyaltyProgram

loyalty program information

Fields
  • programOwner string? - loyalty program airline code
  • id string? - loyalty program number

amadeus.flightoffersprice: Name

name

Fields
  • secondLastName string? - second last name

amadeus.flightoffersprice: OAuth2ClientCredentialsGrantConfig

Closed record

OAuth2 Client Credentials Grant Configs

Fields
  • tokenUrl string(default "https://test.api.amadeus.com/v1/security/oauth2/token") - Token URL

amadeus.flightoffersprice: OperatingFlight

information about the operating flight

Fields
  • carrierCode string? - providing the airline / carrier code

amadeus.flightoffersprice: OriginalFlightEndPoint

departure or arrival information

Fields
  • terminal string? - terminal name / number

amadeus.flightoffersprice: OriginalFlightStop

details of stops for direct or change of gauge flights

Fields
  • duration string? - stop duration in ISO8601 PnYnMnDTnHnMnS format, e.g. PT2H10M

amadeus.flightoffersprice: OtherServices

Fields
  • bookableByTraveler boolean? - Specify if the service is bookable by traveler or for all travelers
  • bookableByItinerary boolean? - Specify if the service is bookable by itinerary or for all itineraries
  • segmentIds string[]? - Id of the segment concerned by the service
  • travelerIds string[]? - Id of the traveler concerned by the service

amadeus.flightoffersprice: PassengerConditions

Fields
  • travelerId string? - Id of the traveler
  • genderRequired boolean? - If true, the gender is required for the concerned traveler for the creation of the flight-order
  • documentRequired boolean? - If true, a document is required for the concerned traveler for the creation of the flight-order
  • documentIssuanceCityRequired boolean? - If true, the isuance city of the document is required for the concerned traveler for the creation of the flight-order
  • dateOfBirthRequired boolean? - If true, the date of bitrth is required for the concerned traveler for the creation of the flight-order
  • redressRequiredIfAny boolean? - If true, the redress is required if any for the concerned traveler for the creation of the flight-order
  • airFranceDiscountRequired boolean? - If true, the Air France discount is required for the concerned traveler for the creation of the flight-order
  • spanishResidentDiscountRequired boolean? - If true, the Spanish resident discount is required for the concerned traveler for the creation of the flight-order
  • residenceRequired boolean? - If true, the address is required for the concerned traveler for the creation of the flight-order

amadeus.flightoffersprice: Payment

Fields
  • binNumber int? - The first 6 digits of the credit card
  • flightOfferIds string[]? - Id of the flightOffers to pay

amadeus.flightoffersprice: Phone

phone information

Fields
  • countryCallingCode string? - Country calling code of the phone number, as defined by the International Communication Union. Examples - "1" for US, "371" for Latvia.
  • number string? - Phone number. Composed of digits only. The number of digits depends on the country.

amadeus.flightoffersprice: Price

Fields
  • total string? - Total amount paid by the user
  • base string? - Amount without taxes
  • fees Fee[]? - List of applicable fees
  • taxes Tax[]? -
  • refundableTaxes string? - The amount of taxes which are refundable

amadeus.flightoffersprice: PricingOptions

Fields
  • fareType PricingOptionsFareType? - type of fare of the flight-offer
  • includedCheckedBagsOnly boolean? - If true, returns the flight-offers with included checked bags only
  • refundableFare boolean? - If true, returns the flight-offers with refundable fares only
  • noRestrictionFare boolean? - If true, returns the flight-offers with no restriction fares only
  • noPenaltyFare boolean? - If true, returns the flight-offers with no penalty fares only

amadeus.flightoffersprice: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields
  • host string(default "") - Host name of the proxy server
  • port int(default 0) - Proxy server port
  • userName string(default "") - Proxy server username
  • password string(default "") - Proxy server password

amadeus.flightoffersprice: Segment

Fields
  • id string? - Id of the segment
  • numberOfStops int? - Number of stops
  • blacklistedInEU boolean? - When the flight has a marketing or/and operating airline that is identified as blacklisted by the European Commission. To improve travel safety, the European Commission regularly updates the list of the banned carriers from operating in Europe. It allows any Travel Agency located in the European Union to easily identify and hide any travel recommendation based on some unsafe airlines. The list of the banned airlines is published in the Official Journal of the European Union, where they are included as annexes A and B to the Commission Regulation. The blacklist of an airline can concern all its flights or some specific aircraft types pertaining to the airline

amadeus.flightoffersprice: Stakeholder

stakeholder definition

Fields
  • dateOfBirth string? - The date of birth in ISO 8601 format (yyyy-mm-dd)
  • documents IdentityDocument[]? - Advanced Passenger Information - regulatory identity documents - SSR DOCS & DOCO elements

amadeus.flightoffersprice: SuccessPricing

Fields

amadeus.flightoffersprice: Tax

a tax

Fields

amadeus.flightoffersprice: TermAndCondition

Fields
  • category string? - This defines what type of modification is concerned in this rule.

amadeus.flightoffersprice: Traveler

the traveler of the trip

Fields
  • loyaltyPrograms LoyaltyProgram[]? - list of loyalty program followed by the traveler
  • discountEligibility Discount[]? - list of element that allow a discount.
  • contact Contact? - contact information

amadeus.flightoffersprice: TravelerPricing

Fields
  • travelerId string - Id of the traveler
  • fareOption TravelerPricingFareOption - option specifying a group of fares, which may be valid under certain conditons Can be used to specify special fare discount for a passenger
  • travelerType TravelerType - traveler type age restrictions : CHILD < 12y, HELD_INFANT < 2y, SEATED_INFANT < 2y, SENIOR >=60y
  • associatedAdultId string? - if type="HELD_INFANT", corresponds to the adult traveler's id who will share the seat

String types

amadeus.flightoffersprice: AdditionalServiceType

string

AdditionalServiceType

additional service type

amadeus.flightoffersprice: ContactPurpose

string

ContactPurpose

the purpose for which this contact is to be used

amadeus.flightoffersprice: DiscountTravelerType

string

DiscountTravelerType

type of discount applied

amadeus.flightoffersprice: DiscountType

string

DiscountType

type of discount applied

amadeus.flightoffersprice: DocumentType

string

DocumentType

the nature/type of the document

amadeus.flightoffersprice: FeeType

string

FeeType

type of fee

amadeus.flightoffersprice: FlightOfferSource

string

FlightOfferSource

source of the flight offer

amadeus.flightoffersprice: PaymentBrand

string

PaymentBrand

credit card brand

amadeus.flightoffersprice: PhoneDeviceType

string

PhoneDeviceType

Type of the device (Landline, Mobile or Fax)

amadeus.flightoffersprice: ServiceName

string

ServiceName

type of service

amadeus.flightoffersprice: SliceDiceIndicator

string

SliceDiceIndicator

slice and Dice indicator, such as Local Availability, Sub OnD(Origin and Destination) 1 Availability and Sub OnD 2 Availability

amadeus.flightoffersprice: StakeholderGender

string

StakeholderGender

The gender

amadeus.flightoffersprice: TravelClass

string

TravelClass

quality of service offered in the cabin where the seat is located in this flight. Economy, premium economy, business or first class

amadeus.flightoffersprice: TravelerPricingFareOption

string

TravelerPricingFareOption

option specifying a group of fares, which may be valid under certain conditons Can be used to specify special fare discount for a passenger

amadeus.flightoffersprice: TravelerType

string

TravelerType

traveler type age restrictions : CHILD < 12y, HELD_INFANT < 2y, SEATED_INFANT < 2y, SENIOR >=60y

Import

import ballerinax/amadeus.flightoffersprice;Copy

Metadata

Released date: 12 months ago

Version: 1.3.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 83

Current verison: 0

Weekly downloads

Source repository

Keywords

Sales & CRM/Scheduling & Booking

Cost/Freemium

Contributors

Other versions

1.3.1

1.3.01.2.01.0.00.2.0
See more...

Dependencies

ballerina/url/2.2.3ballerina/constraint/1.1.0ballerina/http/2.6.1

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2024 WSO2 LLC