cloud-airlines-java

Airline API

• API version: v1.1
  • Generator version: 7.10.0

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.8+
2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.hopper.cloud</groupId>
  <artifactId>cloud-airlines-java</artifactId>
  <version>1.5.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'cloud-airlines-java' jar has been published to maven central.
    mavenLocal()       // Needed if the 'cloud-airlines-java' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "com.hopper.cloud:cloud-airlines-java:1.4.3"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/cloud-airlines-java-1.4.3.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import com.hopper.cloud.airlines.ApiClient;
import com.hopper.cloud.airlines.ApiException;
import com.hopper.cloud.airlines.Configuration;
import com.hopper.cloud.airlines.auth.*;
import com.hopper.cloud.airlines.model.*;
import com.hopper.cloud.airlines.api.AnalyticsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://airlines-api.hopper.com/airline/v1.1");
    
    // Configure API key authorization: SessionAuth
    ApiKeyAuth SessionAuth = (ApiKeyAuth) defaultClient.getAuthentication("SessionAuth");
    SessionAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //SessionAuth.setApiKeyPrefix("Token");

    AnalyticsApi apiInstance = new AnalyticsApi(defaultClient);
    CfarEvent cfarEvent = new CfarEvent(); // CfarEvent | 
    try {
      apiInstance.postCustomerEvents(cfarEvent);
    } catch (ApiException e) {
      System.err.println("Exception when calling AnalyticsApi#postCustomerEvents");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

All URIs are relative to https://airlines-api.hopper.com/airline/v1.1

Class	Method	HTTP request	Description
AnalyticsApi	postCustomerEvents	POST /customer/events	Send a Frontend Event
AnalyticsApi	postEvents	POST /events	Send a Backend Event
AuthenticationApi	postAuth	POST /auth	Create an authentication token
CancelForAnyReasonCfarApi	getCfarContractsId	GET /cfar_contracts/{id}	Get a CFAR Contract
CancelForAnyReasonCfarApi	postCfarContractExercises	POST /cfar_contract_exercises	Create CFAR Exercise
CancelForAnyReasonCfarApi	postCfarContracts	POST /cfar_contracts	Create a CFAR Contract
CancelForAnyReasonCfarApi	postCfarContractsIdPayment	POST /cfar_contracts/{id}/payment	Process CFAR Payment
CancelForAnyReasonCfarApi	postCfarOffers	POST /cfar_offers	Create CFAR Offers
CancelForAnyReasonCfarApi	putCfarContractExercisesIdMarkCompleted	PUT /cfar_contract_exercises/{id}/mark_completed	Complete CFAR Exercise
CancelForAnyReasonCfarApi	putCfarContractsIdFormsOfPayment	PUT /cfar_contracts/{id}/forms_of_payment	Update forms of payment of a CFAR Contract
CancelForAnyReasonCfarApi	putCfarContractsIdUpdateStatus	PUT /cfar_contracts/{id}/update_status	Update CFAR Contract Status
DisruptionGuaranteeDgApi	getDgContractsId	GET /dg_contracts/{id}	Get a DG contract
DisruptionGuaranteeDgApi	postCustomerDgEvents	POST /customer/dg/events	Create an Event
DisruptionGuaranteeDgApi	postDgContractExercises	POST /dg_contract_exercises	Create DG Exercise
DisruptionGuaranteeDgApi	postDgContracts	POST /dg_contracts	Create a DG Contract
DisruptionGuaranteeDgApi	postDgContractsIdPayment	POST /dg_contracts/{id}/payment	Process DG payment
DisruptionGuaranteeDgApi	postDgOffers	POST /dg_offers	Create DG Offers
DisruptionGuaranteeDgApi	putDgContractsIdItinerarySlices	PUT /dg_contracts/{id}/itinerary_slices	Update DG Contract Itinerary Slices
DisruptionGuaranteeDgApi	putDgContractsIdUpdateStatus	PUT /dg_contracts/{id}/update_status	Update DG Contract Status
SessionsApi	postSessions	POST /sessions	Create a Session

Documentation for Models

• AirlineRefundMethod
• AirlineSession
• Ancillary
• AncillaryType
• Android
• App
• AuthRequest
• AuthResponse
• BadRequest
• BookingConfirmed
• BookingConfirmed1
• BookingConfirmed2
• Browser
• Cabin
• Cash
• CfarContents
• CfarContract
• CfarContractExercise
• CfarCreateExerciseItinerary
• CfarCreateExerciseItinerarySlice
• CfarCreateExercisePassengerPricing
• CfarCreateExerciseSliceSegment
• CfarDenyPurchase
• CfarEvent
• CfarEventWithContract
• CfarExerciseCallbackLaunched
• CfarExerciseCustomerDataComplete
• CfarExercisePortalComplete
• CfarExercisePortalDisplay
• CfarExerciseVerificationComplete
• CfarExerciseVerificationSent
• CfarForcedChoiceWarning
• CfarItinerary
• CfarItinerarySlice
• CfarItinerarySliceSegment
• CfarOffer
• CfarOfferItinerary
• CfarOfferPassenger
• CfarOffersBannerDisplay
• CfarOffersTakeoverDisplay
• CfarPassenger
• CfarPassengerTax
• CfarPayment
• CfarStatus
• CfarTax
• CfarViewInfo
• Chrome
• ChromeOs
• CreateAirlineCfarSessionRequest
• CreateAirlineDgSessionRequest
• CreateAirlineSessionRequest
• CreateCfarContractExerciseRequest
• CreateCfarContractRequest
• CreateCfarOfferRequest
• CreateDgContractExerciseRequest
• CreateDgContractExerciseResponse
• CreateDgContractRequest
• CreateDgOfferItemResponse
• CreateDgOffersRequest
• Desktop
• Device
• DgAncillary
• DgAncillaryType
• DgContents
• DgContract
• DgEvent
• DgExerciseCallbackLaunched
• DgExerciseCustomerDataComplete
• DgExerciseItinerary
• DgExerciseItinerarySlice
• DgExerciseItinerarySliceSegment
• DgExercisePortalComplete
• DgExerciseVerificationComplete
• DgItinerary
• DgItinerarySlice
• DgItinerarySliceSegment
• DgOffer
• DgPassenger
• DgPassengerCount
• DgPassengerPricing
• DgPassengerTax
• DgPassengerType
• DgPayment
• DgRequestType
• DgStatus
• DgTax
• Edge
• Error
• Event
• ExerciseStepResult
• Fare
• FareClass
• FareRule
• Firefox
• FlightStatus
• FlowType
• FormOfPayment
• Gender
• IOs
• InternetExplorer
• Linux
• MacOs
• MarkCfarContractExerciseCompleteRequest
• Mobile
• ModificationTime
• ModificationType
• NonCash
• OffersDisplayed
• OffersDisplayed1
• Opera
• OperatingSystem
• OtherBrowser
• OtherOs
• PassengerCount
• PassengerPricing
• PassengerType
• PaymentCard
• Platform
• Points
• ProcessCfarPaymentRequest
• ProcessDgPaymentRequest
• Product
• RequestType
• Safari
• Tablet
• TokenType
• UiSource
• UiVariant
• UnprocessableEntity
• UpdateCfarContractRequest
• UpdateCfarFormOfPaymentRequest
• UpdateDgContractStatusRequest
• UserInfo
• Web
• Windows

Documentation for Authorization

Authentication schemes defined for the API:

PartnerAuth

• Type: HTTP Bearer Token authentication

SessionAuth

• Type: API key
• API key parameter name: HC-Session-ID
• Location: HTTP header

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author