Changelog

All OpenRoam SDKs share one version and one changelog. Entries are written by the release process from the changes in the Partner API description.

0.1.0-rc.6

Breaking: type names. The API now publishes its types under the names partners read, and every SDK uses them as they are, so a type has the same name in the API reference and in each SDK. The names are shorter. Nothing on the wire changes: the routes, the JSON and the client methods are the same. Code that names a type (an import, a type annotation, new HotelRoomGuestsInput(...)) needs the new name. So does code that reads a union by its variant's name: in Java getOfferFixedPrice() is now getFixedPrice() (C#: GetFixedPrice()), and in Go the field OfferFixedPrice is FixedPrice and EsimOrderFulfillmentUpdatedWebhookItem is EsimFulfillmentUpdate. Dart's fixed and range stay.

Every renamed type:

Before Now
AirtimeFulfillmentRedemption AirtimeRedemption
AirtimeFulfillmentResultDetails AirtimeFulfillmentDetails
AirtimeNumberCarrier NumberCarrier
AirtimeNumberLookup NumberLookup
AirtimeOrderFulfillmentUpdatedWebhookItem AirtimeFulfillmentUpdate
AirtimePhoneLookup CarrierDetection
AirtimePurchasedProductDetails AirtimePurchasedDetails
AirtimePurchasedProductInputs AirtimePurchasedInputs
AmendmentListItem Amendment
BookingTermsCancellation CancellationTerms
BookingTermsCancellationStep CancellationStep
BookingTermsChangeFee ChangeFee
BookingTermsChanges ChangeTerms
BookingTermsPayment PaymentTerms
CancellationPenaltyDetail CancellationPenalty
CompatibleDevice EsimCompatibleDevice
EsimFulfillmentInstallation EsimInstallation
EsimFulfillmentResultDetails EsimFulfillmentDetails
EsimOfferData EsimDataAllowance
EsimOrderFulfillmentUpdatedWebhookItem EsimFulfillmentUpdate
EsimProductOptionApn EsimApn
EsimProductOptionData EsimProfileData
EsimProductOptionProperties EsimFeatures
EsimProductOptionRestriction EsimRestrictions
EsimProductOptionSms EsimSmsAllowance
EsimProductOptionVoice EsimVoiceAllowance
EsimProvisionRequest EsimProvisioningRequest
EsimPurchasedProductDestination EsimPurchasedDestination
EsimPurchasedProductDetails EsimPurchasedDetails
EsimPurchasedProductInputs EsimPurchasedInputs
EsimSendSmsRequest EsimSmsRequest
EsimSendSmsResult EsimSmsResult
EsimSim SimCard
FlightAircraft Aircraft
FlightAirline Airline
FlightAirport Airport
FlightAvailableService AvailableService
FlightBaggage Baggage
FlightBookedAirline BookedAirline
FlightBookedAirport BookedAirport
FlightBookedBaggage BookedBaggage
FlightBookedSegment BookedSegment
FlightBookedSlice BookedSlice
FlightBookedStop BookedStop
FlightFare Fare
FlightFareOption FareOption
FlightFareSegment SegmentFare
FlightFulfillmentBooking FlightBooking
FlightFulfillmentResultDetails FlightFulfillmentDetails
FlightIdentityDocument IdentityDocument
FlightIdentityDocumentInput IdentityDocumentInput
FlightItinerary Itinerary
FlightItineraryDetails ItineraryDetails
FlightOfferPassenger OfferPassenger
FlightOrderFulfillmentUpdatedWebhookItem FlightFulfillmentUpdate
FlightPassenger Passenger
FlightPassengerInput PassengerInput
FlightPassengerPricing PassengerPricing
FlightPriceBreakdown PriceBreakdown
FlightPriceLine PriceLine
FlightPurchasedProductDetails FlightPurchasedDetails
FlightPurchasedProductInputs FlightPurchasedInputs
FlightSeatMap SeatMap
FlightSeatMapAvailability SeatAvailability
FlightSeatMapElement SeatMapElement
FlightSeatMapRow SeatMapRow
FlightSeatMapSection SeatMapSection
FlightSeatMapSegment SeatMapSegment
FlightSegment Segment
FlightSegmentReference SegmentPosition
FlightSelectedSeat SelectedSeat
FlightSelectedSeatInput SelectedSeatInput
FlightSelectedService SelectedService
FlightSelectedServiceInput SelectedServiceInput
FlightServiceBaggage BaggageLimits
FlightSlice Slice
FlightStop Stop
FlightTicketDocument TicketDocument
GeoCoordinates Coordinates
GiftCardFulfillmentDelivery GiftCardDelivery
GiftCardFulfillmentResultDetails GiftCardFulfillmentDetails
GiftCardIssuedCode GiftCardCode
GiftCardOrderFulfillmentUpdatedWebhookItem GiftCardFulfillmentUpdate
GiftCardPurchasedProductDetails GiftCardPurchasedDetails
GiftCardPurchasedProductInputs GiftCardPurchasedInputs
HotelAddress Address
HotelAmenity Amenity
HotelAmenityCatalog AmenityCatalog
HotelAmenityFacet AmenityFacet
HotelAmenityGroupFacet AmenityGroup
HotelBed Bed
HotelBoardType MealPlan
HotelBookingGuestInput GuestInput
HotelCatalogProperty CatalogHotel
HotelDestinationSummary HotelDestination
HotelDisplayGroup UnitAvailability
HotelFulfillmentBooking HotelBooking
HotelFulfillmentResultDetails HotelFulfillmentDetails
HotelGuestCapabilities GuestAmendmentCapabilities
HotelGuestNameRules GuestNameRules
HotelHolderInput LeadGuestInput
HotelLocationSearch HotelSearchArea
HotelNightlyPrice NightlyPrice
HotelOrderFulfillmentUpdatedWebhookItem HotelFulfillmentUpdate
HotelProperty Hotel
HotelPropertyDetails HotelDetails
HotelPropertySearchDetails HotelSearchDetails
HotelPropertySearchResult HotelSearchResult
HotelPurchasedProductDetails HotelPurchasedDetails
HotelPurchasedProductGuest Guest
HotelPurchasedProductHolder LeadGuest
HotelPurchasedProductHotel BookedHotel
HotelPurchasedProductInputs HotelPurchasedInputs
HotelPurchasedProductRoomGuests RoomGuests
HotelQuotedRate QuotedRate
HotelRoom Room
HotelRoomCapabilities RoomAmendmentCapabilities
HotelRoomGuestsInput RoomGuestsInput
HotelRoomOccupancy RoomOccupancy
HotelSearchCoordinates CoordinatesInput
HotelSearchRoom RoomOccupancyInput
HotelSpecialRequestOption SpecialRequestOption
HotelSurcharge Surcharge
HotelTaxBreakdown TaxBreakdown
HotelTaxItem Tax
MoneyAmount Money
MoneyAmountInput MoneyInput
OfferFixedPrice FixedPrice
OfferFixedValue FixedValue
OfferRangePrice PriceRange
OfferRangeValue ValueRange
OrderFulfillmentUpdatedWebhook OrderFulfillmentWebhook
OrderFulfillmentUpdatedWebhookData OrderFulfillmentWebhookData
OrderFulfillmentUpdatedWebhookItem FulfillmentUpdate
OrderItemManualAmendmentStatusWebhook ManualAmendmentStatusWebhook
OrderItemManualAmendmentStatusWebhookData ManualAmendmentStatusWebhookData
OrderQuote MixedQuote
OrderQuoteItem MixedQuoteItem
OrderRequest MixedOrderRequest
OrderRequestItem MixedOrderRequestItem
RequiredInput InputField
UtilityBiller Biller
UtilityBillerDetails BillerDetails
UtilityFulfillmentResultDetails UtilityFulfillmentDetails
UtilityOrderFulfillmentUpdatedWebhookItem UtilityFulfillmentUpdate
UtilityPurchasedProductDetails UtilityPurchasedDetails
UtilityPurchasedProductInputs UtilityPurchasedInputs

Breaking (108)

Other API changes (649)

0.1.0-rc.5

Fifth release candidate. The API, its routes, its JSON and the client methods are the same as 0.1.0-rc.4; the type names change (below). Use the exact version (a release candidate is not picked up by a plain install); report problems to support@openroam.com.

Breaking: type names. The request and response types now have names that say what they are, in every SDK. Nothing on the wire changes: the API, its routes and its JSON are the same, and so are the client methods. Code that names a type (an import, a type annotation, new SearchHotelQuery(...)) needs the new name.

Before Now
B2BOrderResponse, B2BOrderAcceptedResponse Order
AirtimeCreateOrder200Response (and the five other products) AirtimeOrder (EsimOrder, FlightOrder...)
B2BOrderListResponse, B2BOrderSummaryResponse OrderList, OrderSummary
PartnerOrderItem, PartnerOrderItemHotel OrderItem, HotelOrderItem
ItemHotelFulfillment HotelFulfillment
CreateB2BOrderCommand, CreateB2BOrderItemCommand OrderRequest, OrderRequestItem
CreateB2BOrderItemCommandHotel HotelMixedOrderRequestItem
B2BMixedQuoteResponse, B2BMixedQuoteItem, B2BMixedQuoteItemHotel OrderQuote, OrderQuoteItem, HotelMixedQuoteItem
HotelPartnerQuoteResponse, HotelPartnerQuoteItem; AirtimeQuoteResponse HotelQuote, HotelQuoteItem; AirtimeQuote
AirtimeSearchResponse, HotelPropertySearchResponse, FlightSearchApiResponse AirtimeSearchResult, HotelPropertySearchResult, FlightSearchResult
SearchHotelQuery, SearchB2BFlightsQuery HotelSearchRequest, FlightSearchRequest
HotelCartInputs (and the other products) HotelInputs
FlightFareOfferApi and every other …Api flight type FlightOffer, and the name without Api
FlightPartnerSlice, FlightPartnerSegment (as booked) FlightBookedSlice, FlightBookedSegment
AirtimeCatalogResponse (and the other products) AirtimeCatalogPage
GiftCardItem, AirtimeOperatorItem GiftCard, AirtimeOperator
B2BOrderItemAmendment, QuoteB2BAmendmentQuery, ConfirmB2BAmendmentRequest OrderItemAmendment, AmendmentQuoteRequest, AmendmentConfirmRequest
CreateB2BManualAmendmentCommand ManualAmendmentCreateRequest
RefundOrderItemRequest, UpdateB2BOrderItemRequest OrderItemCancelRequest, OrderItemUpdateRequest
B2BEsimProfile, B2BEsimUsageResponse, B2BEsimUsageHistoryResponse EsimProfile, EsimCurrentUsage, EsimUsageReadingList
GetWalletItem, GetWalletWithStatistics WalletSummary, Wallet
CreateB2BWalletCommand, TransferB2BWalletsCommand WalletCreateRequest, WalletTransferRequest
GetB2BAllCurrenciesCommandResponse CurrencyList
PartnerErrorResponse, PartnerErrorDetail ErrorResponse, ErrorDetail
B2BOrderItemRefundedWebhook, B2BPartnerBalanceLowWebhook OrderItemRefundedWebhook, BalanceLowWebhook

0.1.0-rc.4

Fourth release candidate. Every SDK now has a single client for all products, and the API changes in a few places that break calls made with 0.1.0-rc.2 (listed below). 0.1.0-rc.3 carried the same content but was never published: its GitHub release could not be created, so there is no package under that version; use 0.1.0-rc.4. Use the exact version (a release candidate is not picked up by a plain install); report problems to support@openroam.com.

New

Breaking, compared with 0.1.0-rc.2

0.1.0-rc.2

Second release candidate. The API is the same as 0.1.0-rc.1; this candidate fixes how the SDKs are published. 0.1.0-rc.1 reached PyPI, NuGet, pub.dev, Go and PHP but not npm (a workflow error) or Maven Central (its bundle was rejected: the Java SDK no longer ships a tests jar and the publishing plugin is newer). The NuGet package now carries a readme, copyright and release notes. Use the exact version (a release candidate is not picked up by a plain install); report problems to support@openroam.com.

0.1.0-rc.1

First release candidate of the OpenRoam Partner API SDKs for TypeScript/JavaScript, Python, Go, PHP, Java, .NET, Dart and Ruby, generated from the Partner API description. A release candidate is not picked up by a plain install: use the exact version (see each README). The stable 0.1.0 follows once the candidate has been tried; report problems to support@openroam.com.