kiwicom_mmb_api
v0.1.0
Published
An_API_for_Kiwi_coms_manage_my_booking_section_
Downloads
4
Readme
kiwicom_mmb_api
KiwicomMmbApi - JavaScript client for kiwicom_mmb_api An API for Kiwi.com's manage my booking section. This SDK is automatically generated by the Swagger Codegen project:
- API version: 0.1.0
- Package version: 0.1.0
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install kiwicom_mmb_api --save
Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing
into the directory containing package.json
(and this README). Let's call this JAVASCRIPT_CLIENT_DIR
. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
Finally, switch to the directory you want to use your kiwicom_mmb_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('kiwicom_mmb_api')
in javascript files from the directory you ran the last
command above from.
git
If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --save
For browser
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually
use this library):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Webpack Configuration
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Getting Started
Please follow the installation instruction and execute the following JS code:
var KiwicomMmbApi = require('kiwicom_mmb_api');
var defaultClient = KiwicomMmbApi.ApiClient.instance;
// Configure API key authorization: UserTokenAuth
var UserTokenAuth = defaultClient.authentications['UserTokenAuth'];
UserTokenAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//UserTokenAuth.apiKeyPrefix['KW-User-Token'] = "Token"
var api = new KiwicomMmbApi.DefaultApi()
var bookingId = 56; // {Number} ID of the booking.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.kwMamboHandlersAlternativesGet(bookingId, , callback);
Documentation for API Endpoints
All URIs are relative to https://localhost/mmb/v1
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- KiwicomMmbApi.DefaultApi | kwMamboHandlersAlternativesGet | GET /bookings/{booking_id}/alternatives | Show alternatives for booking. KiwicomMmbApi.DefaultApi | kwMamboHandlersBagsBagsPaymentRequest | POST /bookings/{booking_id}/bags/{extra_id}/payments | Request new payment for bags KiwicomMmbApi.DefaultApi | kwMamboHandlersBagsBagsPaymentUpdate | PATCH /bookings/{booking_id}/bags/{extra_id}/payments | Finish or confirm the payment for bag extra KiwicomMmbApi.DefaultApi | kwMamboHandlersBagsDelete | DELETE /bookings/{booking_id}/bags/{extra_id} | Delete bag extra for booking at id KiwicomMmbApi.DefaultApi | kwMamboHandlersBagsPost | POST /bookings/{booking_id}/bags | Create new bag extra for booking at id KiwicomMmbApi.DefaultApi | kwMamboHandlersBookingDeleteBooking | DELETE /bookings/{booking_id} | Cancel booking for user KiwicomMmbApi.DefaultApi | kwMamboHandlersContactsDelete | DELETE /bookings/{booking_id}/contacts/{contact_id} | Delete contact KiwicomMmbApi.DefaultApi | kwMamboHandlersContactsGet | GET /bookings/{booking_id}/contacts/{contact_id} | Get contact for booking by ID KiwicomMmbApi.DefaultApi | kwMamboHandlersContactsPost | POST /bookings/{booking_id}/contacts | Create a new group of contacts for booking KiwicomMmbApi.DefaultApi | kwMamboHandlersContactsPut | PUT /bookings/{booking_id}/contacts/{contact_id} | Update contact for booking by ID KiwicomMmbApi.DefaultApi | kwMamboHandlersContactsSearch | GET /bookings/{booking_id}/contacts | Get all contacts for booking KiwicomMmbApi.DefaultApi | kwMamboHandlersFlightChangesPost | POST /bookings/{booking_id}/flight_changes | Create new flights extra for booking at id KiwicomMmbApi.DefaultApi | kwMamboHandlersFlightEventsPatch | PATCH /bookings/{booking_id}/flight_events/{event_id} | React to schedule change with following options: Refund - customer requested refund for booking affected by flight event. Acknowledge - customer acknowledges minor flight event e.g. minor schedule change. KiwicomMmbApi.DefaultApi | kwMamboHandlersFlightEventsPostOrder | POST /bookings/{booking_id}/flight_events/{event_id}/orders | Creates order for alternative KiwicomMmbApi.DefaultApi | kwMamboHandlersPassengerChangeCreateRequest | POST /bookings/{booking_id}/passengers/change_requests | Post name correction request KiwicomMmbApi.DefaultApi | kwMamboHandlersPriceChangesDelete | DELETE /bookings/{booking_id}/price_changes/{extra_id} | Delete price_change extra for booking at id KiwicomMmbApi.DefaultApi | kwMamboHandlersPriceChangesPost | POST /bookings/{booking_id}/price_changes | Create new price_change extra for booking at id KiwicomMmbApi.DefaultApi | kwMamboHandlersPriceChangesPriceChangePaymentRequest | POST /bookings/{booking_id}/price_changes/{extra_id}/payments | Request new payment for price_change KiwicomMmbApi.DefaultApi | kwMamboHandlersPriceChangesPriceChangePaymentUpdate | PATCH /bookings/{booking_id}/price_changes/{extra_id}/payments | Finish or confirm the payment for price_change extra KiwicomMmbApi.DefaultApi | kwMamboHandlersReferralsDelete | DELETE /referrals/friends/{email} | Delete an invitation KiwicomMmbApi.DefaultApi | kwMamboHandlersReferralsEmailGet | GET /referrals/email_check | Check invitee's email KiwicomMmbApi.DefaultApi | kwMamboHandlersReferralsPost | POST /referrals/friends/{email} | Create an invitation KiwicomMmbApi.DefaultApi | kwMamboHandlersReferralsPostMultiple | POST /referrals/friends | Create an invitation KiwicomMmbApi.DefaultApi | kwMamboHandlersReferralsSearch | GET /referrals/friends | List of invitations KiwicomMmbApi.DefaultApi | kwMamboHandlersRefundApplicationsGet | GET /bookings/{booking_id}/refund-applications | Get submitted refund applications for booking KiwicomMmbApi.DefaultApi | kwMamboHandlersRefundsGet | GET /bookings/{booking_id}/cancellations | Get refund options for booking KiwicomMmbApi.DefaultApi | kwMamboHandlersRefundsPost | POST /bookings/{booking_id}/cancellations | Refund the booking. KiwicomMmbApi.DefaultApi | kwMamboHandlersSeatOrderCancelSeatReservation | DELETE /bookings/{booking_id}/seat_orders/{seat_reservation_id} | Cancel seat reservation KiwicomMmbApi.DefaultApi | kwMamboHandlersSeatOrderRequestSeatReservation | POST /bookings/{booking_id}/seat_orders | Request seats reservation KiwicomMmbApi.DefaultApi | kwMamboHandlersSeatmapsSearch | GET /bookings/{booking_id}/seatmaps | Get seatmaps for flight KiwicomMmbApi.DefaultApi | kwMamboHandlersTicketsGet | GET /bookings/{booking_id}/tickets | Get ticketing KiwicomMmbApi.DefaultApi | kwMamboHandlersTicketsPost | POST /bookings/{booking_id}/tickets | Send ticket via email KiwicomMmbApi.DefaultApi | pingGet | GET /ping | Return a simple JSON payload for health check purposes KiwicomMmbApi.DefaultApi | storedPassengersGet | GET /stored_passengers | Return all stored passengers of user KiwicomMmbApi.DefaultApi | storedPassengersPost | POST /stored_passengers | Save new stored passenger for user
Documentation for Models
- KiwicomMmbApi.Alternative
- KiwicomMmbApi.Alternative1
- KiwicomMmbApi.AmountInCurrency
- KiwicomMmbApi.BagOrder
- KiwicomMmbApi.BookingsbookingIdbagsextraIdpaymentsFinish
- KiwicomMmbApi.Contact
- KiwicomMmbApi.Email
- KiwicomMmbApi.EmailData
- KiwicomMmbApi.EmailValidityObject
- KiwicomMmbApi.Error
- KiwicomMmbApi.FinishPaymentArgs
- KiwicomMmbApi.Flight
- KiwicomMmbApi.FlightChangeOrder
- KiwicomMmbApi.FlightChangeOrderFlights
- KiwicomMmbApi.FlightSeat
- KiwicomMmbApi.InlineResponse200
- KiwicomMmbApi.InlineResponse2001
- KiwicomMmbApi.InlineResponse2002
- KiwicomMmbApi.InlineResponse2003
- KiwicomMmbApi.InlineResponse201
- KiwicomMmbApi.InvalidEmails
- KiwicomMmbApi.Invitation
- KiwicomMmbApi.NameCorrectionRequest
- KiwicomMmbApi.NewContact
- KiwicomMmbApi.NewStoredPassenger
- KiwicomMmbApi.PassengerChange
- KiwicomMmbApi.PatchPaymentArgs
- KiwicomMmbApi.PaymentData
- KiwicomMmbApi.Pong
- KiwicomMmbApi.PriceChangeOrder
- KiwicomMmbApi.RefundApplication
- KiwicomMmbApi.RefundApplications
- KiwicomMmbApi.RefundData
- KiwicomMmbApi.RefundOptions
- KiwicomMmbApi.RefundOptionsCancellationFee
- KiwicomMmbApi.RefundOptionsRefundableOptions
- KiwicomMmbApi.RefundOptionsRefundableOptionsCredits
- KiwicomMmbApi.RefundOptionsRefundableOptionsCreditsCredits
- KiwicomMmbApi.RefundOptionsRefundableOptionsOrigin
- KiwicomMmbApi.ScheduleAlternative
- KiwicomMmbApi.ScheduleAlternativeAlternative
- KiwicomMmbApi.ScheduleAlternativeAlternativeExtra
- KiwicomMmbApi.ScheduleChange
- KiwicomMmbApi.ScheduleChangeAllowedGates
- KiwicomMmbApi.ScheduleChangeAlternatives
- KiwicomMmbApi.ScheduleChangePrice
- KiwicomMmbApi.ScheduleChangeRefund
- KiwicomMmbApi.ScheduleChangeResolved
- KiwicomMmbApi.ScheduleFlight
- KiwicomMmbApi.ScheduleFlightAirline
- KiwicomMmbApi.ScheduleLocation
- KiwicomMmbApi.ScheduleLocationWhen
- KiwicomMmbApi.ScheduleLocationWhere
- KiwicomMmbApi.SeatDescription
- KiwicomMmbApi.SeatOrder
- KiwicomMmbApi.Segments
- KiwicomMmbApi.SimpleExtraRecord
- KiwicomMmbApi.TicketData
- KiwicomMmbApi.StoredPassenger
Documentation for Authorization
AdminAuth
- Type: HTTP basic authentication
PartnerTokenAuth
- Type: API key
- API key parameter name: KW-Partner-Token
- Location: HTTP header
SimpleTokenAuth
- Type: API key
- API key parameter name: KW-Simple-Token
- Location: HTTP header
UserTokenAuth
- Type: API key
- API key parameter name: KW-User-Token
- Location: HTTP header