@gojinko/api-client 2.25.0 → 2.26.0

package/public-api.yaml

@@ -1,10 +1,10 @@
-# synced from jinko-api@c46664fb52f2597644c841a14abe5a1eb80cee21 (c46664fb)
+# synced from jinko-api@558277d11f0dc4707c3e6bf121a97ddf60b12a77 (558277d1)
 # Vendored copy of the canonical public contract. Do not hand-edit: change it in
 # jinko-api, then `pnpm sync:api-spec <ref>` here, which also runs `pnpm generate:api-types`.
 openapi: 3.0.0
 info:
   title: Jinko Public API
-  version: 0.10.0
+  version: 0.11.0
   description: >-
     Curated public REST surface for Jinko. Authenticated with jnk_ API keys. See
     https://docs.gojinko.com for guides.
@@ -458,6 +458,26 @@ components:
         direct_only:
           type: boolean
           example: false
+        include_carriers:
+          type: array
+          items:
+            type: string
+            pattern: ^[A-Za-z0-9]{2,3}$
+          description: Keep only itineraries whose VALIDATING (ticketing) carrier is in
+            this list — the only carrier field the flight cache carries, unlike
+            the marketing-carrier match on flight_search. 2-3 character
+            IATA/ICAO codes. Must not overlap `exclude_carriers`.
+          example: &a8
+            - UA
+        exclude_carriers:
+          type: array
+          items:
+            type: string
+            pattern: ^[A-Za-z0-9]{2,3}$
+          description: Drop itineraries whose VALIDATING (ticketing) carrier is in this
+            list. Same semantics as `include_carriers`; must not overlap it.
+          example: &a9
+            - NK
         adults:
           type: integer
           minimum: 0
@@ -508,7 +528,7 @@ components:
           default: 0
         sort_by:
           type: string
-          enum: &a8
+          enum: &a10
             - lowest
             - recommendation
           default: lowest
@@ -545,6 +565,19 @@ components:
         next_page_token:
           type: string
           example: eyJvZmZzZXQiOjIwfQ==
+        available_airlines:
+          type: array
+          items:
+            type: string
+          description: VALIDATING (ticketing) carrier codes present across the WHOLE
+            cached match set — not just this page — ordered by itinerary count
+            descending. Lets a caller discover which airlines are available
+            (e.g. to retry with `include_carriers`) without paging through every
+            result. Absent when the platform reports no facet data.
+          example:
+            - UA
+            - DL
+            - AA
       required:
         - itineraries
     FlightDiscoveryRequest:
@@ -615,6 +648,24 @@ components:
         direct_only:
           type: boolean
           example: false
+        include_carriers:
+          type: array
+          items:
+            type: string
+            pattern: ^[A-Za-z0-9]{2,3}$
+          description: Keep only itineraries whose VALIDATING (ticketing) carrier is in
+            this list — the only carrier field the flight cache carries, unlike
+            the marketing-carrier match on flight_search. 2-3 character
+            IATA/ICAO codes. Must not overlap `exclude_carriers`.
+          example: *a8
+        exclude_carriers:
+          type: array
+          items:
+            type: string
+            pattern: ^[A-Za-z0-9]{2,3}$
+          description: Drop itineraries whose VALIDATING (ticketing) carrier is in this
+            list. Same semantics as `include_carriers`; must not overlap it.
+          example: *a9
         adults:
           type: integer
           minimum: 0
@@ -665,7 +716,7 @@ components:
           default: 0
         sort_by:
           type: string
-          enum: *a8
+          enum: *a10
           default: lowest
         intent:
           $ref: "#/components/schemas/IntentInput"
@@ -1507,12 +1558,12 @@ components:
           pattern: ^\d{4}-\d{2}-\d{2}$
         origin_type:
           type: string
-          enum: &a9
+          enum: &a11
             - city
             - airport
         destination_type:
           type: string
-          enum: *a9
+          enum: *a11
         cabin_class:
           type: string
           enum: *a7
@@ -1929,7 +1980,7 @@ components:
           example: trip_1048576
         status:
           type: string
-          enum: &a10
+          enum: &a12
             - draft
             - quoting
             - quoted
@@ -2009,7 +2060,7 @@ components:
             - message
         status:
           type: string
-          enum: *a10
+          enum: *a12
           description: The trip state that refused the write. `expired` on TRIP_EXPIRED;
             on TRIP_STATE_CONFLICT it is whichever state the trip is actually
             in. Nothing was changed, so re-reading the trip returns this same
@@ -2214,7 +2265,7 @@ components:
           example: trip_1048576
         status:
           type: string
-          enum: *a10
+          enum: *a12
           description: "Where the trip is in its lifecycle. `expired` is the 24-hour
             lapse: it is evaluated LAZILY, on the read that first observes it,
             so this call is where a dead trip becomes visible. Once a trip is
@@ -3663,7 +3714,7 @@ components:
       required:
         - booking_ref
         - last_name
-      example: &a11
+      example: &a13
         booking_ref: JNK-8PT9VS
         last_name: Carrard
     CarCancelCommitResponse:
@@ -3768,7 +3819,7 @@ components:
       required:
         - booking_ref
         - last_name
-      example: *a11
+      example: *a13
     CarExchangeVehicle:
       type: object
       properties:
@@ -4122,7 +4173,7 @@ components:
       required:
         - booking_ref
         - last_name
-      example: *a11
+      example: *a13
     DestinationSnapshotRow:
       type: object
       properties:
@@ -4448,7 +4499,7 @@ components:
       required:
         - booking_ref
         - last_name
-      example: &a12
+      example: &a14
         booking_ref: JNK-A0AUR2
         last_name: Carrard
     ServicingState:
@@ -4581,7 +4632,7 @@ components:
       required:
         - booking_ref
         - last_name
-      example: *a12
+      example: *a14
     RefundStatusResponse:
       type: object
       properties:
@@ -4642,7 +4693,7 @@ components:
       required:
         - booking_ref
         - last_name
-      example: *a12
+      example: *a14
     ExchangeOffer:
       type: object
       properties:
@@ -4703,7 +4754,7 @@ components:
       required:
         - booking_ref
         - last_name
-      example: *a12
+      example: *a14
     ExchangePriceResponse:
       type: object
       properties:
@@ -4850,7 +4901,7 @@ components:
       required:
         - booking_ref
         - last_name
-      example: *a12
+      example: *a14
     ProviderFigures:
       type: object
       properties:
@@ -5619,7 +5670,7 @@ components:
           example: Carrard
         intent:
           $ref: "#/components/schemas/IntentInput"
-      example: *a12
+      example: *a14
     FlightRefundCommitResponse:
       type: object
       properties:
@@ -6261,7 +6312,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: &a13
+          headers: &a15
             Retry-After:
               description: Seconds to wait before retrying, forwarded verbatim from the
                 upstream service. Absent when the upstream named no interval.
@@ -6402,7 +6453,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -6544,7 +6595,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -6685,7 +6736,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -6825,7 +6876,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -6961,7 +7012,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -7114,7 +7165,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -7252,7 +7303,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -7400,7 +7451,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -7536,7 +7587,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -7638,7 +7689,7 @@ paths:
                 anyOf:
                   - $ref: "#/components/schemas/TripStateResponse"
                   - $ref: "#/components/schemas/ErrorResponse"
-              example: &a14
+              example: &a16
                 error:
                   code: CONFLICT
                   message: This trip is already being checked out; no second checkout was started.
@@ -7690,7 +7741,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -7799,7 +7850,7 @@ paths:
                 anyOf:
                   - $ref: "#/components/schemas/TripStateResponse"
                   - $ref: "#/components/schemas/ErrorResponse"
-              example: *a14
+              example: *a16
         "410":
           description: The resource this request names no longer exists
           content:
@@ -7847,7 +7898,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -7999,7 +8050,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -8135,7 +8186,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -8283,7 +8334,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -8424,7 +8475,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -8570,7 +8621,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -8723,7 +8774,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -8876,7 +8927,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -9028,7 +9079,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -9188,7 +9239,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -9347,7 +9398,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -9501,7 +9552,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -9567,7 +9618,7 @@ paths:
           in: query
         - schema:
             type: string
-            enum: &a15
+            enum: &a17
               - Solo
               - Couple
               - Group
@@ -9578,7 +9629,7 @@ paths:
           in: query
         - schema:
             type: string
-            enum: &a16
+            enum: &a18
               - One-Way
               - Round-Trip
             example: Round-Trip
@@ -9648,7 +9699,7 @@ paths:
           in: query
         - schema:
             type: string
-            enum: &a17
+            enum: &a19
               - country
               - city
             description: "Ranked output granularity: country (default) or city. Applies to
@@ -9767,7 +9818,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -9833,14 +9884,14 @@ paths:
           in: query
         - schema:
             type: string
-            enum: *a15
+            enum: *a17
             example: Couple
           required: false
           name: traveler_type
           in: query
         - schema:
             type: string
-            enum: *a16
+            enum: *a18
             example: Round-Trip
           required: false
           name: trip_type
@@ -9908,7 +9959,7 @@ paths:
           in: query
         - schema:
             type: string
-            enum: *a17
+            enum: *a19
             description: "Ranked output granularity: country (default) or city. Applies to
               destination/market (not audience)."
             example: city
@@ -10025,7 +10076,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -10097,14 +10148,14 @@ paths:
           in: query
         - schema:
             type: string
-            enum: *a15
+            enum: *a17
             example: Couple
           required: false
           name: traveler_type
           in: query
         - schema:
             type: string
-            enum: *a16
+            enum: *a18
             example: Round-Trip
           required: false
           name: trip_type
@@ -10270,7 +10321,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -10348,14 +10399,14 @@ paths:
           in: query
         - schema:
             type: string
-            enum: *a15
+            enum: *a17
             example: Couple
           required: false
           name: traveler_type
           in: query
         - schema:
             type: string
-            enum: *a16
+            enum: *a18
             example: Round-Trip
           required: false
           name: trip_type
@@ -10407,7 +10458,7 @@ paths:
           in: query
         - schema:
             type: string
-            enum: &a18
+            enum: &a20
               - day
               - week
               - month
@@ -10517,7 +10568,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -10585,14 +10636,14 @@ paths:
           in: query
         - schema:
             type: string
-            enum: *a15
+            enum: *a17
             example: Couple
           required: false
           name: traveler_type
           in: query
         - schema:
             type: string
-            enum: *a16
+            enum: *a18
             example: Round-Trip
           required: false
           name: trip_type
@@ -10644,7 +10695,7 @@ paths:
           in: query
         - schema:
             type: string
-            enum: *a18
+            enum: *a20
             description: "Bucket size for the returned series: week (default), day, or
               month."
             example: week
@@ -10653,7 +10704,7 @@ paths:
           in: query
         - schema:
             type: string
-            enum: *a17
+            enum: *a19
             description: "Ranked output granularity: country (default) or city. Applies to
               destination/market (not audience)."
             example: city
@@ -10780,7 +10831,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -10848,14 +10899,14 @@ paths:
           in: query
         - schema:
             type: string
-            enum: *a15
+            enum: *a17
             example: Couple
           required: false
           name: traveler_type
           in: query
         - schema:
             type: string
-            enum: *a16
+            enum: *a18
             example: Round-Trip
           required: false
           name: trip_type
@@ -10907,7 +10958,7 @@ paths:
           in: query
         - schema:
             type: string
-            enum: *a18
+            enum: *a20
             description: "Bucket size for the returned series: week (default), day, or
               month."
             example: week
@@ -10916,7 +10967,7 @@ paths:
           in: query
         - schema:
             type: string
-            enum: *a17
+            enum: *a19
             description: "Ranked output granularity: country (default) or city. Applies to
               destination/market (not audience)."
             example: city
@@ -11043,7 +11094,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -11117,14 +11168,14 @@ paths:
           in: query
         - schema:
             type: string
-            enum: *a15
+            enum: *a17
             example: Couple
           required: false
           name: traveler_type
           in: query
         - schema:
             type: string
-            enum: *a16
+            enum: *a18
             example: Round-Trip
           required: false
           name: trip_type
@@ -11176,7 +11227,7 @@ paths:
           in: query
         - schema:
             type: string
-            enum: *a18
+            enum: *a20
             description: "Bucket size for the returned series: week (default), day, or
               month."
             example: week
@@ -11293,7 +11344,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -11431,7 +11482,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -11567,7 +11618,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -11703,7 +11754,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -11850,7 +11901,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -11986,7 +12037,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -12122,7 +12173,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -12258,7 +12309,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -12394,7 +12445,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -12552,7 +12603,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -12710,7 +12761,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -12885,7 +12936,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -13040,7 +13091,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -13207,7 +13258,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -13388,7 +13439,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -13547,7 +13598,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -13687,7 +13738,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -13817,7 +13868,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -13955,7 +14006,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -14092,7 +14143,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema:
@@ -14232,7 +14283,7 @@ paths:
                   doc_url: https://docs.gojinko.com/concepts/errors
         "503":
           description: No travel provider can serve the request right now
-          headers: *a13
+          headers: *a15
           content:
             application/json:
               schema: