sabre-client
Version:
Sabre Node.js SDK
807 lines (806 loc) • 1.73 MB
TypeScript
interface components$5 {
schemas: {
EnhancedAirTicketRequest: {
/** @description Orchestrated Air Ticket API request. */
AirTicketRQ?: {
/** @description Used to control printer designation process. */
DesignatePrinter?: {
/** @description Used to designate printers. */
Printers?: {
/** @description Used to specify bag tag printer. */
BagTag?: {
/**
* @description Used to specify a bag tag printer address.
* @example XXXXX9
*/
LNIATA?: string;
};
/** @description Used to specify boarding pass of printer. */
BoardingPass?: {
/**
* @description If `true`, indicates a request for an airline-based boarding pass printer. Used by airline customers.
* @example true
*/
HostedCarrier?: boolean;
/**
* @description Used to specify a boarding pass printer address.
* @example XXXXX9
*/
LNIATA?: string;
};
/** @description Used to specify the hardcopy printer. */
Hardcopy?: {
/**
* @description Used to specify the spacing, either 1, or 2.
* @example 1
* @enum {string}
*/
Spacing?: "1" | "2";
/**
* @description Used to specify a hardcopy printer address.
* @example XXXXX9
*/
LNIATA?: string;
};
/** @description Used to specify invoice/itinerary printer. */
InvoiceItinerary?: {
/**
* @description Used to specify an invoice/itinerary printer address.
* @example XXXXX9
*/
LNIATA?: string;
};
/** @description Used to specify list/label printer. */
ListLabel?: {
/**
* @description Used to specify a list/label printer address.
* @example XXXXX9
*/
LNIATA?: string;
};
/** @description Used to specify mini itinerary printer. */
MiniItinerary?: {
/**
* @description Used to specify a mini itinerary printer address.
* @example XXXXX9
*/
LNIATA?: string;
};
/** @description Used to specify report printer. */
Report?: {
/**
* @description Used to specify a report printer address.
* The user account attempting to designate to a report printer must be signed in under duty code `9`.
* To set duty code `9`, the client application can utilize the ContextChangeLLSRQ service.
* @example XXXXX9
*/
LNIATA?: string;
};
/** @description Used to specify ticket printer. */
Ticket?: {
/** @description Used by ATB1 or ATB2 customers to also designate a mini itinerary printer at the same time they're designating their ticket printer. */
MiniItinerary?: {
/**
* @description Used by ATB1 or ATB2 customers to also designate a mini itinerary printer at the same time they're designating their ticket printer.
* @example XXXXX9
*/
LNIATA?: string;
};
/** @description Used by customers to designate an ATB or ATB2 ticket printer along with a remote printer. */
Remote?: {
/**
* @description Used by customers to designate an ATB or ATB2 ticket printer along with a remote printer.
* @example XXXXX9
*/
LNIATA?: string;
};
/**
* @description Used to specify country code associated with the airport code.
* @example AB
*/
CountryCode?: string;
/**
* @description Used to specify a ticket printer address.
* Clients should only associate 255 sessions to a single printer address.
* Additional sessions beyond the initial 255 need to be designated to a different printer address.
* @example XXXXX9
*/
LNIATA?: string;
};
};
/** @description Used to pass printer profile information. */
Profile?: {
/**
* Format: int32
* @description Used to specify a previously established printer number.
* @example 1
*/
Number?: number;
};
};
/** @description Used to pass record locator of the reservation to issue tickets from. */
Itinerary: {
/**
* @description Used to specify a record locator.
* @example YYABHF
*/
ID: string;
};
/**
* @description Used to control accounting line deletion prior ticketing.
*
* As a default logic, the API will always attempt to delete all accounting lines prior ticketing.
*
* However, if you wish the system to behave differently you may request to delete specific accounting line numbers only (`Number`, `EndNumber`) or prevent the deletion altogether: (`None`).
*/
AccountingLines?: {
/** @description Used to specify accounting line numbers to be deleted. */
Delete?: {
/**
* Format: int32
* @description Used with @Number to specify a range of accounting lines to delete.
* @example 2
*/
EndNumber?: number;
/**
* Format: int32
* @description Used to specify particular accounting lines.
* @example 1
*/
Number: number;
}[];
/**
* @description If `true`, deletes all accounting lines. Can't be combined with `None`.
* @example true
*/
All?: boolean;
/**
* @description If `true`, doesn't delete any of the accounting lines. Can't be combined with `All`.
* @example false
*/
None?: boolean;
};
/** @description Used to repeat the node as many times as many tickets/ ticket types/EMDs are to be issued. */
Ticketing: {
/** @description Used to pass flight related qualifiers. */
FlightQualifiers?: {
/** @description Used to pass an airline code to issue tickets for - optional. */
VendorPrefs?: {
/** @description Used to specify the airline. */
Airline: {
/**
* @description Used to specify a particular vendor code.
* @example XX
*/
Code: string;
};
};
};
/** @description Used to pass form of payment related qualifiers. */
FOP_Qualifiers?: {
/** @description Can't be combined with `.../BSP_Ticketing`, `.../SabreSonicTicketing`, or `.../Multiple CC_FOP`. */
BasicFOP?: {
/** @description Used to specify payment card details. */
CC_Info?: {
/** @description Used to specify payment card details. */
PaymentCard: {
/**
* @description Used to specify the credit card vendor code.
* @example VI
*/
Code?: string;
/**
* @description Used to specify the credit card security code.
* @example 123
*/
CardSecurityCode?: string;
/**
* @description ExpireDate is used to specify the credit card expiration date, follows this format: YYYY-MM.
* @example 2012-12
*/
ExpireDate?: string;
/**
* Format: int32
* @description Used to specify extended payment if applicable.
* @example 12
*/
ExtendedPayment?: number;
/**
* @description Used to specify a manual credit card approval code if applicable.
* @example 1234
*/
ManualApprovalCode?: string;
/**
* @description Used to indicate that the manual OB fee should be associated with the card.
* @example 10.00
*/
ManualOBFee?: string;
/**
* Format: int64
* @description Used to specify the credit card number.
* @example 4123412341234123
*/
Number?: number;
};
/**
* @description If `true`, suppresses credit card information on an itinerary.
* @example true
*/
Suppress?: boolean;
};
/**
* @description Used to pass cost center information. Can't be combined with `Reference` and `Virtual`.
* @example 123456789123
*/
CostCenter?: string;
/**
* Format: int32
* @description Used to refer a line number from PNR Form of Payment (FOP) field.
* This capability is only available once the agency has activated Sabre's new FOP functionality in the corresponding PCC (TJR setting: PNAPNR),
* for additional information please contact your Sabre Account Team.
* @example 1
*/
Reference?: number;
/**
* @description Used to specify the payment type.
* Acceptable values are `CA` (cash), `CK` (check), `CQ` (cheque).
* If utilizing a credit card please omit @Type, and populate the .../CC_Info child node.
* @example CK
*/
Type?: string;
/**
* @description Used to pass virtual form of payment information.
* @example SABREAIRONETWOFOUR
*/
Virtual?: string;
};
/** @description Used to specify valid for BSP-based clients. */
BSP_Ticketing?: {
/** @description Can't be combined with `.../MultipleMiscFOP` or `.../PayLaterPlan`. */
MultipleFOP?: {
/** @description Used to specify the amount to be applied to the second FOP. */
Fare: {
/**
* @description Used to specify the amount to be applied to the second FOP.
* @example 100.00
*/
Amount: string;
};
/** @description Used to specify form of payment. */
FOP_One: {
/** @description Used to specify payment card details. */
CC_Info?: {
/** @description Used to specify payment card details. */
PaymentCard: {
/**
* @description Used to specify the credit card vendor code.
* @example AX
*/
Code?: string;
/**
* @description Used to specify the credit card security code.
* @example 123
*/
CardSecurityCode?: string;
/**
* @description ExpireDate is used to specify the credit card expiration date, follows this format: YYYY-MM.
* @example 2012-11
*/
ExpireDate?: string;
/**
* Format: int32
* @description Used to specify extended payment if applicable.
* @example 12
*/
ExtendedPayment?: number;
/**
* @description Used to specify a manual credit card approval code if applicable.
* @example 1234
*/
ManualApprovalCode?: string;
/**
* @description Used to indicate that the manual OB fee should be associated with the card.
* A manual OB fee can ONLY be added to a ticketing entry that references a PQ that has the PRICE-MANUAL tag at the bottom of the *PQ.
* @example 10.00
*/
ManualOBFee?: string;
/**
* Format: int64
* @description Used to specify the credit card number.
* @example 373912345621003
*/
Number?: number;
};
/**
* @description If `true`, suppresses credit card information on an itinerary.
* @example true
*/
Suppress?: boolean;
};
/**
* @description Used to specify the payment type. Can be `CA`, `CK`, or `CQ`.
* If utilizing a credit card, omit `Type` and populate the `.../CC_Info` child node.
* @example CA
*/
Type?: string;
/**
* Format: int32
* @description Used to refer a line number from PNR FOP field.
* @example 1
*/
Reference?: number;
};
/** @description Used to specify second form of payment. */
FOP_Two: {
/** @description Used to specify payment card details. */
CC_Info?: {
/** @description Used to specify payment card details. */
PaymentCard: {
/**
* @description Used to specify the credit card vendor code.
* @example AX
*/
Code?: string;
/**
* @description Used to specify the credit card security code.
* @example 123
*/
CardSecurityCode?: string;
/**
* @description ExpireDate is used to specify the credit card expiration date, follows this format: YYYY-MM.
* @example 2012-11
*/
ExpireDate?: string;
/**
* Format: int32
* @description Used to specify extended payment if applicable.
* @example 12
*/
ExtendedPayment?: number;
/**
* @description Used to specify a manual credit card approval code if applicable.
* @example 5678
*/
ManualApprovalCode?: string;
/**
* @description Used to indicate that the manual OB fee should be associated with the card.
* A manual OB fee can ONLY be added to a ticketing entry that references a PQ that has the PRICE-MANUAL tag at the bottom of the *PQ.
* @example 5.00
*/
ManualOBFee?: string;
/**
* Format: int64
* @description Used to specify the credit card number.
* @example 373912345621003
*/
Number?: number;
};
/**
* @description If `true`, suppresses credit card information on an itinerary.
* @example true
*/
Suppress?: boolean;
};
/**
* @description Used to specify the payment type. Can be `CA`, `CK`, or `CQ`.
* If utilizing a credit card, omit `Type` and populate the `.../CC_Info` child node.
* @example CK
*/
Type?: string;
/**
* Format: int32
* @description Used to refer a line number from PNR FOP field.
* @example 1
*/
Reference?: number;
};
/** @description Used to pass tax details. */
Taxes?: {
/** @description Used to specify individual tax details. */
Tax: {
/**
* @description Used to specify the tax amount.
* @example 5.00
*/
Amount: string;
/**
* @description Used to specify the tax code.
* @example GB
*/
TaxCode: string;
}[];
};
};
/** @description Can't be combined with `.../MultipleFOP` or `.../PayLaterPlan`. */
MultipleMiscFOP?: {
/** @description Used to specify the amount to be applied to the second FOP. */
Fare: {
/**
* @description Used to specify the fare amount to be applied to the second FOP.
* @example 300.00
*/
Amount: string;
};
/** @description Used to specify form of payment. */
FOP_One: {
/** @description Used to specify payment card details. */
CC_Info?: {
/** @description Used to specify payment card details. */
PaymentCard: {
/**
* @description Used to specify the credit card vendor code.
* @example MC
*/
Code: string;
/**
* @description ExpireDate is used to specify the credit card expiration date, follows this format: YYYY-MM.
* @example 2012-11
*/
ExpireDate: string;
/**
* Format: int32
* @description Used to specify extended payment if applicable.
* @example 12
*/
ExtendedPayment?: number;
/**
* @description Used to specify a manual credit card approval code if applicable.
* @example 1234
*/
ManualApprovalCode?: string;
/**
* Format: int64
* @description Used to specify the credit card number.
* @example 12345678999001
*/
Number: number;
};
/**
* @description If `true`, suppresses credit card information on an itinerary.
* @example true
*/
Suppress?: boolean;
};
/**
* @description Used to specify the payment type. Can be `CA`, `CK`, or `CQ`.
* If utilizing a credit card, omit `Type` and populate the `.../CC_Info` child node.
* @example CK
*/
Type?: string;
/**
* Format: int32
* @description Used to refer a line number from PNR FOP field.
* @example 1
*/
Reference?: number;
};
/** @description Used to specify second form of payment. */
FOP_Two: {
/** @description Used to pass number of months for extended payment. */
ExtendedPayment?: {
/**
* Format: int32
* @description Used to pass number of months.
* @example 11
*/
NumMonths: number;
};
/**
* @description Used to specify the misc payment.
* @example PL189947
*/
Type?: string;
/**
* Format: int32
* @description Used to reference a line number from PNR FOP field.
* @example 1
*/
Reference?: number;
};
/** @description Used to pass tax details. */
Taxes?: {
/** @description Used to specify individual tax details. */
Tax: {
/**
* @description Used to specify the tax amount.
* @example 30.00
*/
Amount: string;
/**
* @description Used to specify the tax code.
* @example XT
*/
TaxCode: string;
}[];
};
};
/** @description Only applicable to Brazil. Can't be combined with `MultipleFOP` or `MultipleMiscFOP`. */
PayLaterPlan?: {
/** @description Used to specify the amount to be applied to the second FOP. */
Fare: {
/**
* @description Used to specify the remaining fare amount.
* @example 200.00
*/
Amount: string;
};
/** @description Used to specify form of payment. */
FOP: {
/** @description Used to specify payment card details. */
CC_Info?: {
/** @description Used to specify payment card details. */
PaymentCard: {
/**
* @description Used to specify the credit card vendor code.
* @example AX
*/
Code: string;
/**
* @description ExpireDate is used to specify the credit card expiration date, follows this format: YYYY-MM.
* @example 2012-11
*/
ExpireDate: string;
/**
* @description Used to specify a manual credit card approval code if applicable.
* @example 23
*/
ManualApprovalCode?: string;
/**
* Format: int64
* @description Used to specify the credit card number.
* @example 376422221000
*/
Number: number;
};
};
/**
* @description Used to specify the payment type. Can be `CA`, `CK`, or `CQ`.
* If utilizing a credit card, omit `Type` and populate the `.../CC_Info` child node.
* @example CA
*/
Type?: string;
/**
* Format: int32
* @description Used to refer a line number from PNR FOP field.
* @example 1
*/
Reference?: number;
};
/** @description Used to specify the number of installments. */
Installment: {
/**
* @description Used to specify the number of installments.
* @example 03
*/
Count: string;
/**
* @description Used to specify the pay later reference number.
* @example XRG065
*/
PayLaterReferenceNumber: string;
/**
* @description Used to specify the value of the installments. Decimals aren't permitted.
* @example 10000
*/
Value: string;
};
};
};
/** @description Can't be combined with `.../BSP_Ticketing` or `.../SabreSonicTicketing`. */
MultipleCC_FOP?: {
/** @description Used to specify the amount to be applied to the second FOP. */
Fare: {
/**
* @description Used to specify the amount to be applied to the second CC.
* @example 100.00
*/
Amount: string;
};
/** @description Used to specify first payment card details. */
CC_One: {
/** @description Used to specify payment card details. */
CC_Info?: {
/** @description Used to specify payment card details. */
PaymentCard: {
/**
* @description Used to specify the credit card vendor code.
* @example AX
*/
Code: string;
/**
* @description Used to specify the credit card security code.
* @example 123
*/
CardSecurityCode?: string;
/**
* @description ExpireDate is used to specify the credit card expiration date, follows this format: YYYY-MM.
* @example 2012-11
*/
ExpireDate: string;
/**
* Format: int32
* @description Used to specify extended payment if applicable.
* @example 12
*/
ExtendedPayment?: number;
/**
* @description Used to specify a manual credit card if applicable.
* @example 1234
*/
ManualApprovalCode?: string;
/**
* @description Used to indicate that the manual OB fee should be associated with the card.
* A manual OB fee can ONLY be added to a ticketing entry that references a PQ that has the PRICE-MANUAL tag at the bottom of the *PQ.
* @example 10.00
*/
ManualOBFee?: string;
/**
* Format: int64
* @description Used to specify the credit card number.
* @example 373912345621003
*/
Number: number;
};
/**
* @description If `true`, suppresses credit card information on an itinerary.
* @example true
*/
Suppress?: boolean;
};
};
/** @description Used to specify second payment card details. */
CC_Two: {
/** @description Used to specify payment card details. */
CC_Info?: {
/** @description Used to specify payment card details. */
PaymentCard: {
/**
* @description Used to specify the credit card vendor code.
* @example VI
*/
Code: string;
/**
* @description Used to specify the credit card security code.
* @example 123
*/
CardSecurityCode?: string;
/**
* @description ExpireDate is used to specify the credit card expiration date, follows this format: YYYY-MM.
* @example 2016-12
*/
ExpireDate: string;
/**
* Format: int32
* @description Used to specify extended payment if applicable.
* @example 12
*/
ExtendedPayment?: number;
/**
* @description Used to specify a manual credit card if applicable.
* @example 5678
*/
ManualApprovalCode?: string;
/**
* @description Used to indicate that the manual OB fee should be associated with the card.
* A manual OB fee can ONLY be added to a ticketing entry that references a PQ that has the ''PRICE-MANUAL'' tag at the bottom of the *PQ.
* @example 5.00
*/
ManualOBFee?: string;
/**
* Format: int64
* @description Used to specify the credit card number.
* @example 4537156488578956
*/
Number: number;
};
/**
* @description If `true`, suppresses credit card information on an itinerary.
* @example true
*/
Suppress?: boolean;
};
};
};
/** @description Only valid for SabreSonic-based airlines. Can't be combined with `.../BSP_Ticketing` or `.../Multiple CC_FOP`. */
SabreSonicTicketing?: {
/** @description Can't be combined with `.../EnhancedMultipleFOP` or `.../MultipleFOP`. */
BasicFOP?: {
/** @description Used to specify payment card details. */
CC_Info?: {
/** @description Used to specify payment card details. */
PaymentCard: {
/**
* Format: int32
* @description Used to specify the credit card security code.
* @example 123
*/
CardSecurityCode?: number;
/**
* @description Used to specify the credit card vendor code.
* @example VI
*/
Code: string;
/**
* @description ExpireDate is used to specify the credit card expiration date, follows this format: YYYY-MM.
* @example 2012-12
*/
ExpireDate: string;
/**
* Format: int32
* @description Used to specify extended payment if applicable.
* @example 12
*/
ExtendedPayment?: number;
/**
* @description Used to specify a manual credit card approval code if applicable.
* @example 1234
*/
ManualApprovalCode?: string;
/**
* Format: int64
* @description Used to specify the credit card number.
* @example 4123412341234123
*/
Number: number;
};
/**
* @description If `true`, suppresses credit card information on an itinerary.
* @example true
*/
Suppress?: boolean;
};
/**
* @description Used to specify a manual approval code for non-credit card forms of payment.
* @example 1234
*/
ManualApprovalCode?: string;
/**
* @description Used to specify the payment type. Can be `CA` (cash), `CK` (check), `CQ` (cheque), `PT`, `PTACA` (PTA cash), `PTAGTCK` (PTA agency check), or `PTCK` (PTA check).
* If utilizing a credit card, omit `Type` and populate the `.../CC_Info` child node, unless you need to specify a PTA credit card form of payment.
* To use a `PTA` credit card please pass `Type` as `PT` and populate the `../CC_Info` child object with the relevant credit card information.
* @example CK
*/
Type?: string;
};
/** @description Only valid for SabreSonic-based airlines who have activated the enhanced multiple form of payment option. Can't be combined with `.../MultipleFOP`. */
EnhancedMultipleFOP?: {
/** @description Used to specify the amount to be applied to the second FOP. */
Fare: {
/**
* @description Used to specify the fare amount to be applied to the second FOP.
* @example 90.00
*/
Amount: string;
};
/** @description Used to specify form of payment. */
FOP_One: {
/** @description Used to specify payment card details. */
CC_Info?: {
/** @description Used to specify payment card details. */
PaymentCard: {
/**
* @description Used to specify the credit card security code.
* @example 123
*/
CardSecurityCode?: string;
/**
* @description Used to specify the credit card vendor code.
* @example VI
*/
Code: string;
/**
* @description ExpireDate is used to specify the credit card expiration date, follows this format: YYYY-MM.
* @example 2012-12
*/
ExpireDate: string;
/**
* Format: int32
* @description Used to specify extended payment if applicable.
* @example 12
*/
ExtendedPayment?: number;
/**
* @description Used to specify a manual credit card approval code if applicable.
* @example 1234
*/
ManualApprovalCode?: string;