Package com.duffel.sdk.api

Class OrdersApi

java.lang.Object
com.duffel.sdk.api.OrdersApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2022-08-28T15:13:42.592945+07:00[Asia/Bangkok]") public class OrdersApi extends Object

  • Constructor Details

    • OrdersApi

      public OrdersApi()

    • OrdersApi

      @Autowired public OrdersApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • createOrder

      public reactor.core.publisher.Mono<GetOrderById200Response> createOrder(String accept, String duffelVersion, CreateOrderRequest createOrderRequest, String acceptEncoding, String contentType) throws org.springframework.web.reactive.function.client.WebClientResponseException
      Create an order Creates a booking with an airline based on an offer. Orders are usually paid at the time of creation, but can be held and paid for at a later date if the offer supports it (see `offer.payment_requirements.requires_instant_payment`). To create an order and pay for it at the same time, specify a `payments` key. To hold the order and pay for it later, specify the type as `hold`, omit the `payments` and `services` keys, and complete payment after creating the order through the [Create a payment endpoint](/docs/api/payments/create-payment). When presenting an order confirmation to your customers (e.g. on screen or in an email), you should include the `booking_reference` and details of the full itinerary and show the full name of the operating carrier of each segment (`slices[].segments[].operating_carrier.name`) in order to comply with [US regulations](https://www.ecfr.gov/cgi-bin/text-idx?SID=8e736a5c813a737a5c2f6700a4c9006d&mc=true&node=pt14.4.257&rgn=div5). ### Validation errors | Field | Code | Description | | ---------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | | `payments` | `payments_not_allowed_for_order_type` | You’ve included a `payments` key for a `hold` order, but the key should be omitted. | | `services` | `services_not_allowed_for_order_type` | You’ve included `services` for a `hold` order, but they’re not currently supported. | | `type` | `not_valid_with_selected_offer` | The type is not valid with selected offer because either `requires_instant_payment` is `true` or the `payment_required_by` is in the past. |

      201 - An order

      Parameters:
      accept - All responses from the API are in JSON format with UTF-8 encoding. An `Accept` header is required with every request.
      duffelVersion - You'll need to send a `Duffel-Version` header with each request so we know which version of the API you want to use. Currently, the only available API version is `beta`.
      createOrderRequest - The createOrderRequest parameter
      acceptEncoding - We recommend enabling compression for responses returned by the API, since they can be very large. To enable compression, send an `Accept-Encoding` header. You'll need to configure your HTTP client to decompress responses. Most clients will have this functionality built-in.
      contentType - All request bodies sent to the API should be in JSON format. A `Content-Type` header is required whenever you're sending a request body (i.e. for POST and PUT requests).
      Returns:
      GetOrderById200Response
      Throws:
      org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

    • createOrderWithHttpInfo

      public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<GetOrderById200Response>> createOrderWithHttpInfo(String accept, String duffelVersion, CreateOrderRequest createOrderRequest, String acceptEncoding, String contentType) throws org.springframework.web.reactive.function.client.WebClientResponseException
      Throws:
      org.springframework.web.reactive.function.client.WebClientResponseException

    • getOrderById

      public reactor.core.publisher.Mono<GetOrderById200Response> getOrderById(String accept, String duffelVersion, String id, String acceptEncoding) throws org.springframework.web.reactive.function.client.WebClientResponseException
      Get a single order Retrieves an order by its ID

      200 - A single order

      Parameters:
      accept - All responses from the API are in JSON format with UTF-8 encoding. An `Accept` header is required with every request.
      duffelVersion - You'll need to send a `Duffel-Version` header with each request so we know which version of the API you want to use. Currently, the only available API version is `beta`.
      id - Duffel's unique identifier for the order
      acceptEncoding - We recommend enabling compression for responses returned by the API, since they can be very large. To enable compression, send an `Accept-Encoding` header. You'll need to configure your HTTP client to decompress responses. Most clients will have this functionality built-in.
      Returns:
      GetOrderById200Response
      Throws:
      org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

    • getOrderByIdWithHttpInfo

      public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<GetOrderById200Response>> getOrderByIdWithHttpInfo(String accept, String duffelVersion, String id, String acceptEncoding) throws org.springframework.web.reactive.function.client.WebClientResponseException
      Throws:
      org.springframework.web.reactive.function.client.WebClientResponseException

    • getOrders

      public reactor.core.publisher.Mono<GetOrders200Response> getOrders(String accept, String duffelVersion, String acceptEncoding, String after, String before, Integer limit, String bookingReference, Boolean awaitingPayment, String sort, List<String> ownerId, List<String> originId, List<String> destinationId, GetOrdersDepartingAtParameter departingAt, GetOrdersArrivingAtParameter arrivingAt, GetOrdersCreatedAtParameter createdAt, List<String> passengerName, Boolean requiresAction) throws org.springframework.web.reactive.function.client.WebClientResponseException
      List orders Retrieves a paginated list of all orders. The results may be returned in any order, unless a sorting parameter is provided.

      200 - A paginated list of orders

      Parameters:
      accept - All responses from the API are in JSON format with UTF-8 encoding. An `Accept` header is required with every request.
      duffelVersion - You'll need to send a `Duffel-Version` header with each request so we know which version of the API you want to use. Currently, the only available API version is `beta`.
      acceptEncoding - We recommend enabling compression for responses returned by the API, since they can be very large. To enable compression, send an `Accept-Encoding` header. You'll need to configure your HTTP client to decompress responses. Most clients will have this functionality built-in.
      after - A cursor pointing to the previous page of records. For more information on how to paginate through records, see the [Pagination](/docs/api/overview/pagination) section.
      before - A cursor pointing to the next page of records. For more information on how to paginate through records, see the [Pagination](/docs/api/overview/pagination) section.
      limit - The maximum number of records to return per page. Defaults to `50`. May be set to any integer between `1` and `200`. For more information on how to paginate through records, see the [Pagination](/docs/api/overview/pagination) section.
      bookingReference - Filters orders by their `booking reference`. The filter requires an exact match but is case insensitive.
      awaitingPayment - Whether to filter orders that are awaiting payment or not. If not specified, all orders regardless of their payment state will be returned.
      sort - By default, orders aren't returned in any specific order. This parameter allows you to sort the list of orders by the `payment_required_by`, `total_amount`, `created_at`, or `next_departure`. If you wish to sort in descending order, a `-` prefix will be needed (e.g. `-payment_required_by`). When sorting by next departure (`next_departure`), flown orders will be last.
      ownerId - Filters the returned orders by `owner.id`. Values must be valid `airline.id`s. Check the [Airline schema](/docs/api/airlines/schema#id) for details.
      originId - Filters the returned orders by `origin`. Values must be valid origin identifiers. Check the [Order schema](/docs/api/orders#slices-origin-id) for details. Orders will be included if **any** of their slices matches the given criteria.
      destinationId - Filters the returned orders by `destination`. Values must be valid destination identifiers. Check the [Order schema](/docs/api/orders#slices-destination-id) for details. Orders will be included if **any** of their slices matches the given criteria.
      departingAt - Filters the returned orders by [departure datetime](/docs/api/orders/schema#slices-segments-departing_at). Orders will be included if **any** of their segments matches the given criteria.
      arrivingAt - Filters the returned orders by [arrival datetime](/docs/api/orders/schema#slices-segments-arriving_at). Orders will be included if **any** of their segments matches the given criteria.
      createdAt - Filters the returned orders by [creation datetime](docs/api/orders#created_at).
      passengerName - Filters the returned orders by passengers' `family_name` and `given_name`. Orders will be included if **any** of their passengers matches **any** of the given names. Matches are case insensitive, and include partial matches. For example, `?passenger_name[]=roger` will return orders for both `Anna Rogers` and `Roger Smith`.
      requiresAction - Orders will be included if they have any Airline-Inititated Changes that are unactioned.
      Returns:
      GetOrders200Response
      Throws:
      org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

    • getOrdersWithHttpInfo

      public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<GetOrders200Response>> getOrdersWithHttpInfo(String accept, String duffelVersion, String acceptEncoding, String after, String before, Integer limit, String bookingReference, Boolean awaitingPayment, String sort, List<String> ownerId, List<String> originId, List<String> destinationId, GetOrdersDepartingAtParameter departingAt, GetOrdersArrivingAtParameter arrivingAt, GetOrdersCreatedAtParameter createdAt, List<String> passengerName, Boolean requiresAction) throws org.springframework.web.reactive.function.client.WebClientResponseException
      Throws:
      org.springframework.web.reactive.function.client.WebClientResponseException

    • updateOrderById

      public reactor.core.publisher.Mono<GetOrderById200Response> updateOrderById(String accept, String duffelVersion, String id, String acceptEncoding, UpdateOrderByIdRequest updateOrderByIdRequest) throws org.springframework.web.reactive.function.client.WebClientResponseException
      Update a single order Some order fields are updateable. Each field that can be updated is detailed in the request object.

      200 - A single order

      Parameters:
      accept - All responses from the API are in JSON format with UTF-8 encoding. An `Accept` header is required with every request.
      duffelVersion - You'll need to send a `Duffel-Version` header with each request so we know which version of the API you want to use. Currently, the only available API version is `beta`.
      id - Duffel's unique identifier for the order
      acceptEncoding - We recommend enabling compression for responses returned by the API, since they can be very large. To enable compression, send an `Accept-Encoding` header. You'll need to configure your HTTP client to decompress responses. Most clients will have this functionality built-in.
      updateOrderByIdRequest - The updateOrderByIdRequest parameter
      Returns:
      GetOrderById200Response
      Throws:
      org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

    • updateOrderByIdWithHttpInfo

      public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<GetOrderById200Response>> updateOrderByIdWithHttpInfo(String accept, String duffelVersion, String id, String acceptEncoding, UpdateOrderByIdRequest updateOrderByIdRequest) throws org.springframework.web.reactive.function.client.WebClientResponseException
      Throws:
      org.springframework.web.reactive.function.client.WebClientResponseException