sabre-legacy-client 0.1.0 → 0.1.2

package/README.md

@@ -1,15 +1,30 @@
 # Sabre Node.js SDK
 
-Node.js library for the Sabre API.
+Node.js library for the Sabre API (SOAP).
 
 ## Install
 
 ```bash
-npm install @sabre/legacy-client
-# or
-yarn add @sabre/legacy-client
+npm install sabre-legacy-client
 ```
 
+## Setup
+
+First, you need to get an username, password and pcc which is available in the [DEV STUDIO - Applications](https://developer.sabre.com/my-account/applications).
+
+```js
+import { SabreLegacy } from 'sabre-legacy-client';
+const sabre = new SabreLegacy({
+  username: '773400', 
+  password: 'PASSWORD_GOES_HERE',
+  organization: '7TZA', // pcc
+});
+```
+
+## Documentation
+
+See http://developer.sabre.com
+
 ## License
 
 MIT License

package/dist/index.d.mts

@@ -0,0 +1,366 @@
+declare enum ActionsRQ {
+    SESSION_CREATE = "SessionCreateRQ",
+    SESSION_CLOSE = "SessionCloseRQ",
+    TOKEN_CREATE = "TokenCreateRQ",
+    QUEUE_COUNT = "QueueCountLLSRQ",
+    QUEUE_ACCESS = "QueueAccessLLSRQ",
+    QUEUE_PLACE = "QueuePlaceLLSRQ",
+    AGENCY_REPORT = "TKT_TravelAgencyReportsRQ",
+    DAILY_SALES_REPORT = "DailySalesReportLLSRQ",
+    PING = "OTA_PingRQ",
+    ENCODE_DECODE = "EncodeDecodeLLSRQ"
+}
+declare enum ActionsRS {
+    SESSION_CLOSE = "SessionCloseRS",
+    QUEUE_ACCESS = "QueueAccessLLSRS"
+}
+
+type Actions = ActionsRQ | ActionsRS;
+interface SabreOptions {
+    username?: string;
+    password?: string;
+    organization?: string;
+}
+
+interface PostOptions {
+    query?: {
+        [key: string]: unknown;
+    };
+}
+
+interface HeadersRequestOptions {
+    authorization: string;
+    conversationId: string;
+}
+
+declare class Authentication {
+    private readonly sabre;
+    constructor(sabre: Sabre);
+    sessionCreate(): Promise<string>;
+    sessionClose(): Promise<unknown>;
+    ping(): Promise<unknown>;
+    tokenCreate(): Promise<string>;
+}
+
+interface ApplicationResults {
+    success: {
+        systemSpecificResults?: {
+            hostCommad: {
+                content: string;
+                lNIATA: string;
+            };
+        };
+        timeStamp: string;
+    };
+    status: string;
+}
+
+interface QueueCountRS {
+    applicationResults: ApplicationResults;
+    queueInfo: QueueInfo;
+    total: QueueTotal[];
+}
+interface QueueInfo {
+    queueIdentifier: QueueIdentifier[];
+    dateTime: string;
+    pseudoCityCode: string;
+}
+interface QueueIdentifier {
+    count: string;
+    number: string;
+}
+interface QueueTotal {
+    count: string;
+    type: 'MESSAGE' | 'SPECIALS' | 'PNRS';
+}
+
+interface Warning {
+    code: string;
+    message: string;
+}
+
+interface Notification {
+    queue: string;
+    warning: Warning;
+}
+
+interface FormatQueueResponse {
+    bookingId: string;
+    notifications: Array<Notification>;
+}
+
+interface QueueAccessOptions {
+    number: string;
+    pcc?: string;
+}
+interface QueueAccessResponse extends FormatQueueResponse {
+}
+
+interface QueueCountResponse extends QueueCountRS {
+}
+
+interface QueueIgnoreResponse extends QueueAccessResponse {
+}
+
+interface QueuePlaceOptions extends QueueAccessOptions {
+}
+interface QueuePlaceResponse extends QueueAccessResponse {
+}
+
+interface QueueRemoveResponse extends QueueAccessResponse {
+}
+
+declare class Queue {
+    private readonly sabre;
+    private readonly meta;
+    constructor(sabre: Sabre);
+    count(pcc?: string): Promise<QueueCountResponse>;
+    access(payload: QueueAccessOptions): Promise<QueueAccessResponse>;
+    ignore(): Promise<QueueIgnoreResponse>;
+    remove(): Promise<QueueRemoveResponse>;
+    exit(): Promise<void>;
+    place(payload: QueuePlaceOptions): Promise<QueuePlaceResponse>;
+}
+
+declare const CUPON_TYPE: {
+    readonly F: "F";
+    readonly P: "P";
+    readonly E: "E";
+};
+type CuponType = keyof typeof CUPON_TYPE;
+
+declare const DOCUMENT_TYPE: {
+    readonly TKT: "TKT";
+    readonly EMD: "EMD";
+    readonly RFEMD: "RFEMD";
+    readonly RFND: "RFND";
+    readonly MCO: "MCO";
+};
+type DocumentType = keyof typeof DOCUMENT_TYPE;
+
+declare const SETTLEMENT_TYPE: {
+    readonly TAT: "TAT";
+    readonly TCH: "TCH";
+    readonly TKT: "TKT";
+};
+type SettlementType = keyof typeof SETTLEMENT_TYPE;
+
+declare const TRANSACTION_TYPE: {
+    readonly SALE: "SALE";
+    readonly CNCL: "CNCL";
+    readonly RFND: "RFND";
+    readonly VOID: "VOID";
+};
+type TransactionType = keyof typeof TRANSACTION_TYPE;
+
+interface SummaryOptions {
+    date: string;
+    pcc?: string;
+    airline?: {
+        code?: string;
+        number?: string;
+    };
+    settlementType?: SettlementType;
+    documentType?: DocumentType;
+    documentNumber?: string;
+}
+interface DailySalesSummaryResponseSuccess {
+    dailySalesSummaryRS: DailySalesSummaryRS;
+}
+interface DailySalesSummaryRS {
+    header: Header;
+    dSHeader: DSHeader;
+    dailySalesReport: DailySalesReport;
+    version: string;
+    isQueryStillRunning: string;
+}
+interface Header {
+    orchestrationID: {
+        content: string;
+        seq: string;
+    };
+    results: {
+        success: {
+            system: string;
+        };
+    };
+    messageID: string;
+}
+interface DSHeader {
+    pseudoCityCode: string;
+    agencyName: string;
+}
+interface DailySalesReport {
+    reportDate: string;
+    transaction?: Array<Transaction>;
+    totalDailySales: TotalDailySales;
+}
+interface Transaction {
+    documentType: DocumentType;
+    settlementType: SettlementType;
+    pnrLocator?: string;
+    passengerName?: string;
+    documentDetails: {
+        documentNumber: string;
+        stockType?: string;
+        documentStatusCode?: string;
+        stockDetails?: {
+            cuponType: CuponType;
+        };
+        transactionCode: TransactionType;
+    };
+    airlineCode: {
+        content: string;
+        airlineNumber: string;
+    };
+    commission?: {
+        amount: string;
+        percent: string;
+    };
+    payments?: {
+        currencyCode: {
+            value: string;
+            decimalPlace: string;
+        };
+        documentPayment: {
+            paymentTotal: string;
+            paymentDetail: {
+                fop: string;
+                category: string;
+                cardType?: string;
+                paymentAmount: string;
+            };
+        };
+    };
+    agentSine: string;
+    agentPseudoCity: string;
+    transactionDateTime: string;
+}
+interface TotalDailySales {
+    transactionType: TransactionType;
+    salesBySettlement: {
+        settlementType: SettlementType;
+        saleTotals: {
+            currencyCode: string;
+            cashTotals: {
+                content: number;
+                count: string;
+            };
+            creditTotals: {
+                content: number;
+                count: string;
+            };
+            commissionTotals: {
+                content: number;
+                count: string;
+            };
+        };
+    };
+}
+
+interface ReportOptions {
+    date: string;
+    pcc?: string;
+}
+interface DailySalesReportResponseSuccess {
+    dailySalesReportRS: DailySalesReportRS;
+}
+interface DailySalesReportRS {
+    applicationResults: ApplicationResults;
+    salesReport?: SalesReport;
+}
+interface SalesReport {
+    creationDetails: {
+        source: {
+            agencyName: string;
+            createDateTime: string;
+            pseudoCityCode: string;
+        };
+    };
+    issuanceData?: IssuanceData[];
+}
+interface IssuanceData {
+    agentSine: string;
+    commission: string;
+    documentType: string;
+    domesticInternational: string;
+    indicatorOne: string;
+    indicatorTwo: string;
+    issueTime: string;
+    itineraryRef: string;
+    stockItemCount: string;
+    ticketPrinter: string;
+    ticketStock: string;
+    payment: Payment[];
+    personName?: string;
+    ticketingInfo?: TicketingInfo;
+    ticketingFees?: TicketingFees;
+}
+interface Payment {
+    form: {
+        content: string;
+        amount: string;
+        currencyCode: string;
+    };
+}
+interface TicketingInfo {
+    ticketing?: {
+        conjunctiveCount: string;
+        eTicketNumber: string;
+        ind: string;
+        invoiceNumber: string;
+        statusCode: string;
+        usedCount: string;
+    };
+}
+interface TicketingFees {
+    feeInformation?: {
+        amount: string;
+        guaranteeType: string;
+    };
+}
+
+declare class DailySales {
+    private readonly sabre;
+    constructor(sabre: Sabre);
+    report(payload: ReportOptions): Promise<DailySalesReportRS>;
+    summary(payload: SummaryOptions): Promise<DailySalesSummaryRS>;
+}
+
+interface UsernameTokenOptions {
+    username: string;
+    password: string;
+    pcc: string;
+    domain?: string;
+    clientId?: string;
+    clientSecret?: string;
+}
+
+interface SessionCreateOptions {
+    authorization: UsernameTokenOptions;
+    conversationId: string;
+}
+
+declare class Sabre {
+    private readonly headers;
+    private readonly headersRequest;
+    private readonly options;
+    readonly authentication: Authentication;
+    readonly queue: Queue;
+    readonly dailySales: DailySales;
+    constructor(options: SabreOptions);
+    setAction(action: Actions): void;
+    fetchRequest<T>(options?: {}): Promise<T>;
+    post<T>(handlerRequest: (payload: HeadersRequestOptions) => string, options?: PostOptions): Promise<T>;
+    auth<T>(handlerRequest: (payload: SessionCreateOptions) => string, options?: PostOptions): Promise<T>;
+}
+
+declare class ErrorInResponse extends Error {
+    constructor(message: string);
+}
+
+declare class FaultError extends Error {
+    constructor(message: string);
+}
+
+export { type DailySalesReportRS, type DailySalesReportResponseSuccess, type DailySalesSummaryRS, type DailySalesSummaryResponseSuccess, ErrorInResponse, FaultError, type QueueAccessOptions, type QueueAccessResponse, type QueueCountResponse, type QueueIgnoreResponse, type QueuePlaceOptions, type QueuePlaceResponse, type QueueRemoveResponse, type ReportOptions, Sabre as SabreLegacy, type SummaryOptions };