@gojinko/api-client 2.14.0 → 2.16.0

package/dist/types/generated.d.ts

@@ -3,6 +3,232 @@
  * Do not make direct changes to the file.
  */
 export interface paths {
+    "/v1/destination": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Top destinations by search demand
+         * @description Most-searched destinations by de-sampled request share. `destination` is optional (omit to rank all destinations); set `origin_market` to scope to one source market.
+         */
+        get: {
+            parameters: {
+                query: {
+                    /** @description Analysis mode. `trend` is accepted but currently returns snapshot-shaped data. */
+                    analysis: components["parameters"]["analysis"];
+                    /** @description Origin market filter as <Level>:<Code>, e.g. Country:US or City:NYC. */
+                    origin_market?: components["parameters"]["originMarket"];
+                    /** @description Optional destination filter as <Level>:<Code>, e.g. Country:TH. */
+                    destination?: components["parameters"]["destinationFilter"];
+                    /** @description Named departure window (defaults to Next90Days server-side). */
+                    travel_period?: components["parameters"]["travelPeriod"];
+                    /** @description Start of departure window (YYYY-MM-DD). Required when travel_period=Custom. */
+                    departure_date_from?: components["parameters"]["departureDateFrom"];
+                    /** @description End of departure window (YYYY-MM-DD). Required when travel_period=Custom. */
+                    departure_date_to?: components["parameters"]["departureDateTo"];
+                    /** @description Optional traveler-type filter. */
+                    traveler_type?: components["parameters"]["travelerType"];
+                    /** @description Optional trip-type filter. */
+                    trip_type?: components["parameters"]["tripType"];
+                    /** @description Max rows (1-200, default 20). */
+                    limit?: components["parameters"]["limit"];
+                };
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description OK */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["DestinationResponse"];
+                    };
+                };
+                /** @description Authentication required */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description Validation error */
+                422: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/market": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Top source markets for a destination
+         * @description Which source markets generate the most demand for a given destination.
+         */
+        get: {
+            parameters: {
+                query: {
+                    /** @description Analysis mode. `trend` is accepted but currently returns snapshot-shaped data. */
+                    analysis: components["parameters"]["analysis"];
+                    /** @description Destination as <Level>:<Code>, e.g. Country:TH. Required for this endpoint. */
+                    destination: components["parameters"]["destinationRequired"];
+                    /** @description Origin market filter as <Level>:<Code>, e.g. Country:US or City:NYC. */
+                    origin_market?: components["parameters"]["originMarket"];
+                    /** @description Named departure window (defaults to Next90Days server-side). */
+                    travel_period?: components["parameters"]["travelPeriod"];
+                    /** @description Start of departure window (YYYY-MM-DD). Required when travel_period=Custom. */
+                    departure_date_from?: components["parameters"]["departureDateFrom"];
+                    /** @description End of departure window (YYYY-MM-DD). Required when travel_period=Custom. */
+                    departure_date_to?: components["parameters"]["departureDateTo"];
+                    /** @description Optional traveler-type filter. */
+                    traveler_type?: components["parameters"]["travelerType"];
+                    /** @description Optional trip-type filter. */
+                    trip_type?: components["parameters"]["tripType"];
+                    /** @description Max rows (1-200, default 20). */
+                    limit?: components["parameters"]["limit"];
+                };
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description OK */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["MarketResponse"];
+                    };
+                };
+                /** @description Authentication required */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description Validation error */
+                422: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/audience": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Traveler-type mix for a destination
+         * @description Traveler-type composition (Solo / Couple / Family / Group) of demand for a destination. `traveler_type` is not a valid filter here — this endpoint buckets by it.
+         */
+        get: {
+            parameters: {
+                query: {
+                    /** @description Analysis mode. `trend` is accepted but currently returns snapshot-shaped data. */
+                    analysis: components["parameters"]["analysis"];
+                    /** @description Destination as <Level>:<Code>, e.g. Country:TH. Required for this endpoint. */
+                    destination: components["parameters"]["destinationRequired"];
+                    /** @description Origin market filter as <Level>:<Code>, e.g. Country:US or City:NYC. */
+                    origin_market?: components["parameters"]["originMarket"];
+                    /** @description Named departure window (defaults to Next90Days server-side). */
+                    travel_period?: components["parameters"]["travelPeriod"];
+                    /** @description Start of departure window (YYYY-MM-DD). Required when travel_period=Custom. */
+                    departure_date_from?: components["parameters"]["departureDateFrom"];
+                    /** @description End of departure window (YYYY-MM-DD). Required when travel_period=Custom. */
+                    departure_date_to?: components["parameters"]["departureDateTo"];
+                    /** @description Optional trip-type filter. */
+                    trip_type?: components["parameters"]["tripType"];
+                    /** @description Max rows (1-200, default 20). */
+                    limit?: components["parameters"]["limit"];
+                };
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description OK */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["AudienceResponse"];
+                    };
+                };
+                /** @description Authentication required */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description Validation error */
+                422: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/health": {
         parameters: {
             query?: never;
@@ -39,6 +265,266 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/agent_payment/submit": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Submit an agent payment — present trip_id + a Shared Payment Token to schedule + authorize the booking; returns a checkout_url fallback if customer action (3DS) is required */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: {
+                content: {
+                    "application/json": components["schemas"]["AgentPaymentSubmitRequest"];
+                };
+            };
+            responses: {
+                /** @description Authorization result */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["AgentPaymentSubmitResponse"];
+                    };
+                };
+                /** @description Bad request */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": {
+                         *         "code": "BAD_REQUEST",
+                         *         "message": "Malformed JSON in request body.",
+                         *         "doc_url": "https://docs.gojinko.com/concepts/errors"
+                         *       }
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description Authentication required */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": {
+                         *         "code": "AUTH_REQUIRED",
+                         *         "message": "Invalid or expired API key.",
+                         *         "doc_url": "https://docs.gojinko.com/api-reference/authentication"
+                         *       }
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description Validation error */
+                422: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": {
+                         *         "code": "BAD_REQUEST",
+                         *         "message": "origins: origins is required; trip_type: trip_type is required",
+                         *         "doc_url": "https://docs.gojinko.com/concepts/errors"
+                         *       }
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description Rate limit or quota exceeded */
+                429: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": {
+                         *         "code": "RATE_LIMITED",
+                         *         "message": "Rate limit or quota exceeded.",
+                         *         "doc_url": "https://docs.gojinko.com/concepts/errors"
+                         *       }
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description Upstream service error */
+                502: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": {
+                         *         "code": "UPSTREAM_ERROR",
+                         *         "message": "Upstream travel provider returned an error. Please retry.",
+                         *         "doc_url": "https://docs.gojinko.com/concepts/errors"
+                         *       }
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/checkout": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Checkout a trip — returns a checkout URL the user opens to pay, plus the Shared Payment Token params an agent can use to pay programmatically */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: {
+                content: {
+                    "application/json": components["schemas"]["CheckoutRequest"];
+                };
+            };
+            responses: {
+                /** @description Checkout session */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["CheckoutResponse"];
+                    };
+                };
+                /** @description Bad request */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": {
+                         *         "code": "BAD_REQUEST",
+                         *         "message": "Malformed JSON in request body.",
+                         *         "doc_url": "https://docs.gojinko.com/concepts/errors"
+                         *       }
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description Authentication required */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": {
+                         *         "code": "AUTH_REQUIRED",
+                         *         "message": "Invalid or expired API key.",
+                         *         "doc_url": "https://docs.gojinko.com/api-reference/authentication"
+                         *       }
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description Validation error */
+                422: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": {
+                         *         "code": "BAD_REQUEST",
+                         *         "message": "origins: origins is required; trip_type: trip_type is required",
+                         *         "doc_url": "https://docs.gojinko.com/concepts/errors"
+                         *       }
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description Rate limit or quota exceeded */
+                429: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": {
+                         *         "code": "RATE_LIMITED",
+                         *         "message": "Rate limit or quota exceeded.",
+                         *         "doc_url": "https://docs.gojinko.com/concepts/errors"
+                         *       }
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description Upstream service error */
+                502: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": {
+                         *         "code": "UPSTREAM_ERROR",
+                         *         "message": "Upstream travel provider returned an error. Please retry.",
+                         *         "doc_url": "https://docs.gojinko.com/concepts/errors"
+                         *       }
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/find_destination": {
         parameters: {
             query?: never;
@@ -903,7 +1389,10 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** Checkout a trip (returns a payment/checkout URL) */
+        /**
+         * DEPRECATED — use /checkout. Alias retained for backward compatibility.
+         * @deprecated
+         */
         post: {
             parameters: {
                 query?: never;
@@ -913,7 +1402,7 @@ export interface paths {
             };
             requestBody?: {
                 content: {
-                    "application/json": components["schemas"]["BookRequest"];
+                    "application/json": components["schemas"]["CheckoutRequest"];
                 };
             };
             responses: {
@@ -923,7 +1412,7 @@ export interface paths {
                         [name: string]: unknown;
                     };
                     content: {
-                        "application/json": components["schemas"]["BookResponse"];
+                        "application/json": components["schemas"]["CheckoutResponse"];
                     };
                 };
                 /** @description Bad request */
@@ -932,6 +1421,15 @@ export interface paths {
                         [name: string]: unknown;
                     };
                     content: {
+                        /**
+                         * @example {
+                         *       "error": {
+                         *         "code": "BAD_REQUEST",
+                         *         "message": "Malformed JSON in request body.",
+                         *         "doc_url": "https://docs.gojinko.com/concepts/errors"
+                         *       }
+                         *     }
+                         */
                         "application/json": components["schemas"]["ErrorResponse"];
                     };
                 };
@@ -941,6 +1439,15 @@ export interface paths {
                         [name: string]: unknown;
                     };
                     content: {
+                        /**
+                         * @example {
+                         *       "error": {
+                         *         "code": "AUTH_REQUIRED",
+                         *         "message": "Invalid or expired API key.",
+                         *         "doc_url": "https://docs.gojinko.com/api-reference/authentication"
+                         *       }
+                         *     }
+                         */
                         "application/json": components["schemas"]["ErrorResponse"];
                     };
                 };
@@ -950,6 +1457,15 @@ export interface paths {
                         [name: string]: unknown;
                     };
                     content: {
+                        /**
+                         * @example {
+                         *       "error": {
+                         *         "code": "BAD_REQUEST",
+                         *         "message": "origins: origins is required; trip_type: trip_type is required",
+                         *         "doc_url": "https://docs.gojinko.com/concepts/errors"
+                         *       }
+                         *     }
+                         */
                         "application/json": components["schemas"]["ErrorResponse"];
                     };
                 };
@@ -959,6 +1475,15 @@ export interface paths {
                         [name: string]: unknown;
                     };
                     content: {
+                        /**
+                         * @example {
+                         *       "error": {
+                         *         "code": "RATE_LIMITED",
+                         *         "message": "Rate limit or quota exceeded.",
+                         *         "doc_url": "https://docs.gojinko.com/concepts/errors"
+                         *       }
+                         *     }
+                         */
                         "application/json": components["schemas"]["ErrorResponse"];
                     };
                 };
@@ -968,6 +1493,15 @@ export interface paths {
                         [name: string]: unknown;
                     };
                     content: {
+                        /**
+                         * @example {
+                         *       "error": {
+                         *         "code": "UPSTREAM_ERROR",
+                         *         "message": "Upstream travel provider returned an error. Please retry.",
+                         *         "doc_url": "https://docs.gojinko.com/concepts/errors"
+                         *       }
+                         *     }
+                         */
                         "application/json": components["schemas"]["ErrorResponse"];
                     };
                 };
@@ -1919,6 +2453,35 @@ export interface paths {
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
+        AgentPaymentSubmitRequest: {
+            /** @example trip_1048576 */
+            trip_id: string;
+            /** @example spt_1Nq8L2eZvKYlo2C0 */
+            shared_payment_token: string;
+        };
+        AgentPaymentSubmitResponse: {
+            fulfillment_cart_id?: number;
+            /** @example processing */
+            status?: string;
+            payment_verified?: boolean;
+            message?: string;
+            /** @description Hosted-checkout fallback, present only on a 3DS step-up / decline. */
+            checkout_url?: string;
+            recap_token?: string;
+        };
+        AgentSPTParams: {
+            /**
+             * @description Locked cart total in the smallest currency unit — scope the Shared Payment Token to at most this.
+             * @example 259449
+             */
+            max_amount: number;
+            /** @example EUR */
+            currency: string;
+            /** @description Stripe Agentic Commerce network_business_profile id the SPT is granted against. Empty until the preview account is provisioned. */
+            stripe_profile?: string;
+            /** @example 2026-06-10T13:04:56Z */
+            expires_at?: string;
+        };
         /** @description A purchasable ancillary (bag, seat, bundle, ...) offered on a trip item. */
         AncillaryOffer: {
             /** @description Stable id used to select this ancillary. */
@@ -1939,6 +2502,31 @@ export interface components {
             per_pax?: boolean;
             max_quantity?: number;
         };
+        CheckoutRequest: {
+            /** @example trip_1048576 */
+            trip_id: string;
+        };
+        CheckoutResponse: {
+            /** @example cs_1048576 */
+            session_id?: string;
+            /** @example https://book.gojinko.com/checkout?sid=1048576 */
+            checkout_url?: string;
+            /** @example pending_payment */
+            status?: string;
+            /** @example 2026-06-01T13:04:56Z */
+            expires_at?: string;
+            total_amount?: {
+                /** @example 318.4 */
+                amount?: number;
+                value?: number;
+                /** @example USD */
+                currency?: string;
+                /** @example 2 */
+                decimal_places?: number;
+            };
+            items?: unknown[];
+            agent_spt_params?: components["schemas"]["AgentSPTParams"];
+        };
         HealthResponse: {
             /** @enum {string} */
             status: "ok";
@@ -2325,22 +2913,6 @@ export interface components {
                 };
             }[];
         };
-        BookResponse: {
-            session_id?: string;
-            checkout_url?: string;
-            status?: string;
-            expires_at?: string;
-            total_amount?: {
-                amount?: number;
-                value?: number;
-                currency?: string;
-                decimal_places?: number;
-            };
-            items?: unknown[];
-        };
-        BookRequest: {
-            trip_id: string;
-        };
         HotelSearchResponse: {
             hotels?: {
                 hotel_id?: string;
@@ -2595,9 +3167,68 @@ export interface components {
             booking_ref?: string;
             last_name?: string;
         };
+        /** @enum {string} */
+        AnalysisType: "snapshot" | "trend";
+        /** @enum {string} */
+        TravelPeriod: "Summer" | "Winter" | "Christmas" | "Easter" | "Next30Days" | "Next90Days" | "Custom";
+        /** @enum {string} */
+        TravelerType: "Solo" | "Couple" | "Group" | "Family";
+        /** @enum {string} */
+        TripType: "One-Way" | "Round-Trip";
+        DestinationRow: {
+            rank?: number;
+            destination: string;
+            /** Format: double */
+            share?: number;
+        };
+        MarketRow: {
+            rank?: number;
+            market: string;
+            /** Format: double */
+            share?: number;
+        };
+        AudienceRow: {
+            rank?: number;
+            audience: string;
+            /** Format: double */
+            share?: number;
+        };
+        DestinationResponse: {
+            analysis_type: components["schemas"]["AnalysisType"];
+            rows: components["schemas"]["DestinationRow"][];
+        };
+        MarketResponse: {
+            analysis_type: components["schemas"]["AnalysisType"];
+            rows: components["schemas"]["MarketRow"][];
+        };
+        AudienceResponse: {
+            analysis_type: components["schemas"]["AnalysisType"];
+            rows: components["schemas"]["AudienceRow"][];
+        };
     };
     responses: never;
-    parameters: never;
+    parameters: {
+        /** @description Analysis mode. `trend` is accepted but currently returns snapshot-shaped data. */
+        analysis: components["schemas"]["AnalysisType"];
+        /** @description Origin market filter as <Level>:<Code>, e.g. Country:US or City:NYC. */
+        originMarket: string;
+        /** @description Optional destination filter as <Level>:<Code>, e.g. Country:TH. */
+        destinationFilter: string;
+        /** @description Destination as <Level>:<Code>, e.g. Country:TH. Required for this endpoint. */
+        destinationRequired: string;
+        /** @description Named departure window (defaults to Next90Days server-side). */
+        travelPeriod: components["schemas"]["TravelPeriod"];
+        /** @description Start of departure window (YYYY-MM-DD). Required when travel_period=Custom. */
+        departureDateFrom: string;
+        /** @description End of departure window (YYYY-MM-DD). Required when travel_period=Custom. */
+        departureDateTo: string;
+        /** @description Optional traveler-type filter. */
+        travelerType: components["schemas"]["TravelerType"];
+        /** @description Optional trip-type filter. */
+        tripType: components["schemas"]["TripType"];
+        /** @description Max rows (1-200, default 20). */
+        limit: number;
+    };
     requestBodies: never;
     headers: never;
     pathItems: never;