@gojinko/api-client 2.20.0 → 2.22.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +19 -0
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +44 -0
- package/dist/client.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/tools.d.ts +9 -9
- package/dist/tools.d.ts.map +1 -1
- package/dist/tools.js +4 -4
- package/dist/tools.js.map +1 -1
- package/dist/types/devplatform.d.ts +42 -30
- package/dist/types/devplatform.d.ts.map +1 -1
- package/dist/types/generated.d.ts +89 -141
- package/dist/types/generated.d.ts.map +1 -1
- package/package.json +1 -1
- package/public-api.yaml +79 -116
|
@@ -12,22 +12,16 @@ export interface paths {
|
|
|
12
12
|
};
|
|
13
13
|
/**
|
|
14
14
|
* Top destinations by search demand
|
|
15
|
-
* @description Most-searched destinations by de-sampled request share. `
|
|
15
|
+
* @description Most-searched destinations by de-sampled request share. Set `origin` to scope to one source market. Optional `destination_country` (a Country selector, allowed only with `level=city`) narrows the ranking to that country's destination cities.
|
|
16
16
|
*/
|
|
17
17
|
get: {
|
|
18
18
|
parameters: {
|
|
19
|
-
query
|
|
20
|
-
/** @description
|
|
21
|
-
|
|
22
|
-
/** @description
|
|
23
|
-
origin_market?: components["parameters"]["originMarket"];
|
|
24
|
-
/** @description Optional destination filter as <Level>:<Code>, e.g. Country:TH. */
|
|
25
|
-
destination?: components["parameters"]["destinationFilter"];
|
|
26
|
-
/** @description Named departure window (defaults to Next90Days server-side). */
|
|
27
|
-
travel_period?: components["parameters"]["travelPeriod"];
|
|
28
|
-
/** @description Start of departure window (YYYY-MM-DD). Required when travel_period=Custom. */
|
|
19
|
+
query?: {
|
|
20
|
+
/** @description Origin filter as <Level>:<Code>, e.g. Country:US or City:NYC, or 'global' for all origins. */
|
|
21
|
+
origin?: components["parameters"]["origin"];
|
|
22
|
+
/** @description Start of the departure window (YYYY-MM-DD). Supply together with departure_date_to; omit both for no departure-date filter (all departure dates). */
|
|
29
23
|
departure_date_from?: components["parameters"]["departureDateFrom"];
|
|
30
|
-
/** @description End of departure window (YYYY-MM-DD).
|
|
24
|
+
/** @description End of the departure window (YYYY-MM-DD). Supply together with departure_date_from; omit both for no departure-date filter (all departure dates). */
|
|
31
25
|
departure_date_to?: components["parameters"]["departureDateTo"];
|
|
32
26
|
/** @description Optional traveler-type filter. */
|
|
33
27
|
traveler_type?: components["parameters"]["travelerType"];
|
|
@@ -41,12 +35,12 @@ export interface paths {
|
|
|
41
35
|
search_window_min?: components["parameters"]["searchWindowMin"];
|
|
42
36
|
/** @description Maximum advance-purchase window in days (must be >= search_window_min). */
|
|
43
37
|
search_window_max?: components["parameters"]["searchWindowMax"];
|
|
44
|
-
/** @description
|
|
38
|
+
/** @description Number of most-recent days of search activity aggregated into the demand level (min 2, default 7, max 90 — a 1-day window is the current day, whose data is incomplete; the cube retains 90 days). */
|
|
45
39
|
snapshot_window_days?: components["parameters"]["snapshotWindowDays"];
|
|
46
|
-
/** @description Trend mode only: size in days of each of the two adjacent windows compared for growth (min 2, default 7, max 45 — a 1-day window's recent period is the current day, whose data is incomplete; a trend spans 2x the window within the cube's 90-day retention). Rejected when analysis=snapshot. */
|
|
47
|
-
trend_window_days?: components["parameters"]["trendWindowDays"];
|
|
48
40
|
/** @description Max rows (1-200, default 20). */
|
|
49
41
|
limit?: components["parameters"]["limit"];
|
|
42
|
+
/** @description Destination country to rank cities within, as a Country selector Country:<code> (e.g. Country:FR). Destination rankings only, and allowed ONLY together with level=city: it scopes the ranked destinations to a single country so that country's cities are ranked. Must be a country — a City selector is rejected. */
|
|
43
|
+
destination_country?: components["parameters"]["destinationCountry"];
|
|
50
44
|
};
|
|
51
45
|
header?: never;
|
|
52
46
|
path?: never;
|
|
@@ -105,17 +99,11 @@ export interface paths {
|
|
|
105
99
|
get: {
|
|
106
100
|
parameters: {
|
|
107
101
|
query: {
|
|
108
|
-
/** @description Analysis mode. `trend` is accepted but currently returns snapshot-shaped data. */
|
|
109
|
-
analysis: components["parameters"]["analysis"];
|
|
110
102
|
/** @description Destination as <Level>:<Code>, e.g. Country:TH. Required for this endpoint. */
|
|
111
103
|
destination: components["parameters"]["destinationRequired"];
|
|
112
|
-
/** @description
|
|
113
|
-
origin_market?: components["parameters"]["originMarket"];
|
|
114
|
-
/** @description Named departure window (defaults to Next90Days server-side). */
|
|
115
|
-
travel_period?: components["parameters"]["travelPeriod"];
|
|
116
|
-
/** @description Start of departure window (YYYY-MM-DD). Required when travel_period=Custom. */
|
|
104
|
+
/** @description Start of the departure window (YYYY-MM-DD). Supply together with departure_date_to; omit both for no departure-date filter (all departure dates). */
|
|
117
105
|
departure_date_from?: components["parameters"]["departureDateFrom"];
|
|
118
|
-
/** @description End of departure window (YYYY-MM-DD).
|
|
106
|
+
/** @description End of the departure window (YYYY-MM-DD). Supply together with departure_date_from; omit both for no departure-date filter (all departure dates). */
|
|
119
107
|
departure_date_to?: components["parameters"]["departureDateTo"];
|
|
120
108
|
/** @description Optional traveler-type filter. */
|
|
121
109
|
traveler_type?: components["parameters"]["travelerType"];
|
|
@@ -129,12 +117,12 @@ export interface paths {
|
|
|
129
117
|
search_window_min?: components["parameters"]["searchWindowMin"];
|
|
130
118
|
/** @description Maximum advance-purchase window in days (must be >= search_window_min). */
|
|
131
119
|
search_window_max?: components["parameters"]["searchWindowMax"];
|
|
132
|
-
/** @description
|
|
120
|
+
/** @description Number of most-recent days of search activity aggregated into the demand level (min 2, default 7, max 90 — a 1-day window is the current day, whose data is incomplete; the cube retains 90 days). */
|
|
133
121
|
snapshot_window_days?: components["parameters"]["snapshotWindowDays"];
|
|
134
|
-
/** @description Trend mode only: size in days of each of the two adjacent windows compared for growth (min 2, default 7, max 45 — a 1-day window's recent period is the current day, whose data is incomplete; a trend spans 2x the window within the cube's 90-day retention). Rejected when analysis=snapshot. */
|
|
135
|
-
trend_window_days?: components["parameters"]["trendWindowDays"];
|
|
136
122
|
/** @description Max rows (1-200, default 20). */
|
|
137
123
|
limit?: components["parameters"]["limit"];
|
|
124
|
+
/** @description Origin country to rank cities within, as a Country selector Country:<code> (e.g. Country:US). Market rankings only, and allowed ONLY together with level=city: it scopes the ranked origin markets to a single country so that country's cities are ranked. Must be a country — a City selector is rejected. */
|
|
125
|
+
origin_country?: components["parameters"]["originCountry"];
|
|
138
126
|
};
|
|
139
127
|
header?: never;
|
|
140
128
|
path?: never;
|
|
@@ -193,17 +181,13 @@ export interface paths {
|
|
|
193
181
|
get: {
|
|
194
182
|
parameters: {
|
|
195
183
|
query: {
|
|
196
|
-
/** @description Analysis mode. `trend` is accepted but currently returns snapshot-shaped data. */
|
|
197
|
-
analysis: components["parameters"]["analysis"];
|
|
198
184
|
/** @description Destination as <Level>:<Code>, e.g. Country:TH. Required for this endpoint. */
|
|
199
185
|
destination: components["parameters"]["destinationRequired"];
|
|
200
|
-
/** @description Origin
|
|
201
|
-
|
|
202
|
-
/** @description
|
|
203
|
-
travel_period?: components["parameters"]["travelPeriod"];
|
|
204
|
-
/** @description Start of departure window (YYYY-MM-DD). Required when travel_period=Custom. */
|
|
186
|
+
/** @description Origin filter as <Level>:<Code>, e.g. Country:US or City:NYC, or 'global' for all origins. */
|
|
187
|
+
origin?: components["parameters"]["origin"];
|
|
188
|
+
/** @description Start of the departure window (YYYY-MM-DD). Supply together with departure_date_to; omit both for no departure-date filter (all departure dates). */
|
|
205
189
|
departure_date_from?: components["parameters"]["departureDateFrom"];
|
|
206
|
-
/** @description End of departure window (YYYY-MM-DD).
|
|
190
|
+
/** @description End of the departure window (YYYY-MM-DD). Supply together with departure_date_from; omit both for no departure-date filter (all departure dates). */
|
|
207
191
|
departure_date_to?: components["parameters"]["departureDateTo"];
|
|
208
192
|
/** @description Optional trip-type filter. */
|
|
209
193
|
trip_type?: components["parameters"]["tripType"];
|
|
@@ -215,10 +199,8 @@ export interface paths {
|
|
|
215
199
|
search_window_min?: components["parameters"]["searchWindowMin"];
|
|
216
200
|
/** @description Maximum advance-purchase window in days (must be >= search_window_min). */
|
|
217
201
|
search_window_max?: components["parameters"]["searchWindowMax"];
|
|
218
|
-
/** @description
|
|
202
|
+
/** @description Number of most-recent days of search activity aggregated into the demand level (min 2, default 7, max 90 — a 1-day window is the current day, whose data is incomplete; the cube retains 90 days). */
|
|
219
203
|
snapshot_window_days?: components["parameters"]["snapshotWindowDays"];
|
|
220
|
-
/** @description Trend mode only: size in days of each of the two adjacent windows compared for growth (min 2, default 7, max 45 — a 1-day window's recent period is the current day, whose data is incomplete; a trend spans 2x the window within the cube's 90-day retention). Rejected when analysis=snapshot. */
|
|
221
|
-
trend_window_days?: components["parameters"]["trendWindowDays"];
|
|
222
204
|
/** @description Max rows (1-200, default 20). */
|
|
223
205
|
limit?: components["parameters"]["limit"];
|
|
224
206
|
};
|
|
@@ -265,7 +247,7 @@ export interface paths {
|
|
|
265
247
|
patch?: never;
|
|
266
248
|
trace?: never;
|
|
267
249
|
};
|
|
268
|
-
"/v1/
|
|
250
|
+
"/v1/trend": {
|
|
269
251
|
parameters: {
|
|
270
252
|
query?: never;
|
|
271
253
|
header?: never;
|
|
@@ -273,8 +255,8 @@ export interface paths {
|
|
|
273
255
|
cookie?: never;
|
|
274
256
|
};
|
|
275
257
|
/**
|
|
276
|
-
*
|
|
277
|
-
* @description Deep dive: returns one
|
|
258
|
+
* Demand time series for explicit origin/destination pairs
|
|
259
|
+
* @description Deep dive: returns one de-sampled search-volume series per (origin, destination) pair. v1 allows a list on only one side — a single origin with many destinations, or many origins with a single destination.
|
|
278
260
|
*/
|
|
279
261
|
get: {
|
|
280
262
|
parameters: {
|
|
@@ -283,11 +265,9 @@ export interface paths {
|
|
|
283
265
|
origins: components["parameters"]["origins"];
|
|
284
266
|
/** @description Pairs endpoint: comma-separated destination selectors `<Level>:<Code>` (e.g. `Country:FR,Country:DE`). */
|
|
285
267
|
destinations: components["parameters"]["destinations"];
|
|
286
|
-
/** @description
|
|
287
|
-
travel_period?: components["parameters"]["travelPeriod"];
|
|
288
|
-
/** @description Start of departure window (YYYY-MM-DD). Required when travel_period=Custom. */
|
|
268
|
+
/** @description Start of the departure window (YYYY-MM-DD). Supply together with departure_date_to; omit both for no departure-date filter (all departure dates). */
|
|
289
269
|
departure_date_from?: components["parameters"]["departureDateFrom"];
|
|
290
|
-
/** @description End of departure window (YYYY-MM-DD).
|
|
270
|
+
/** @description End of the departure window (YYYY-MM-DD). Supply together with departure_date_from; omit both for no departure-date filter (all departure dates). */
|
|
291
271
|
departure_date_to?: components["parameters"]["departureDateTo"];
|
|
292
272
|
/** @description Optional traveler-type filter. */
|
|
293
273
|
traveler_type?: components["parameters"]["travelerType"];
|
|
@@ -301,9 +281,9 @@ export interface paths {
|
|
|
301
281
|
search_window_min?: components["parameters"]["searchWindowMin"];
|
|
302
282
|
/** @description Maximum advance-purchase window in days (must be >= search_window_min). */
|
|
303
283
|
search_window_max?: components["parameters"]["searchWindowMax"];
|
|
304
|
-
/** @description
|
|
305
|
-
|
|
306
|
-
/** @description Bucket size for the returned series:
|
|
284
|
+
/** @description Number of buckets N in the chosen granularity's own unit (min 2; max depends on granularity: day <= 60, week <= 52, month <= 12; default 12 applied server-side). The series spans the last N complete buckets, excluding the in-progress one. */
|
|
285
|
+
trend_window?: components["parameters"]["trendWindow"];
|
|
286
|
+
/** @description Bucket size for the returned series: week (default), day, or month. */
|
|
307
287
|
granularity?: components["parameters"]["granularity"];
|
|
308
288
|
};
|
|
309
289
|
header?: never;
|
|
@@ -318,7 +298,7 @@ export interface paths {
|
|
|
318
298
|
[name: string]: unknown;
|
|
319
299
|
};
|
|
320
300
|
content: {
|
|
321
|
-
"application/json": components["schemas"]["
|
|
301
|
+
"application/json": components["schemas"]["TrendResponse"];
|
|
322
302
|
};
|
|
323
303
|
};
|
|
324
304
|
/** @description Authentication required */
|
|
@@ -349,7 +329,7 @@ export interface paths {
|
|
|
349
329
|
patch?: never;
|
|
350
330
|
trace?: never;
|
|
351
331
|
};
|
|
352
|
-
"/v1/destination/
|
|
332
|
+
"/v1/destination/trend": {
|
|
353
333
|
parameters: {
|
|
354
334
|
query?: never;
|
|
355
335
|
header?: never;
|
|
@@ -357,21 +337,17 @@ export interface paths {
|
|
|
357
337
|
cookie?: never;
|
|
358
338
|
};
|
|
359
339
|
/**
|
|
360
|
-
*
|
|
361
|
-
* @description Ranks destinations (optionally reachable from
|
|
340
|
+
* Demand time series for the top-N destinations
|
|
341
|
+
* @description Ranks destinations (optionally reachable from origin) by within-window growth, then returns each top-N destination's series. Optional destination_country (a Country selector, allowed only with level=city) narrows the ranking to that country's destination cities.
|
|
362
342
|
*/
|
|
363
343
|
get: {
|
|
364
344
|
parameters: {
|
|
365
345
|
query?: {
|
|
366
|
-
/** @description Origin
|
|
367
|
-
|
|
368
|
-
/** @description
|
|
369
|
-
destination?: components["parameters"]["destinationFilter"];
|
|
370
|
-
/** @description Named departure window (defaults to Next90Days server-side). */
|
|
371
|
-
travel_period?: components["parameters"]["travelPeriod"];
|
|
372
|
-
/** @description Start of departure window (YYYY-MM-DD). Required when travel_period=Custom. */
|
|
346
|
+
/** @description Origin filter as <Level>:<Code>, e.g. Country:US or City:NYC, or 'global' for all origins. */
|
|
347
|
+
origin?: components["parameters"]["origin"];
|
|
348
|
+
/** @description Start of the departure window (YYYY-MM-DD). Supply together with departure_date_to; omit both for no departure-date filter (all departure dates). */
|
|
373
349
|
departure_date_from?: components["parameters"]["departureDateFrom"];
|
|
374
|
-
/** @description End of departure window (YYYY-MM-DD).
|
|
350
|
+
/** @description End of the departure window (YYYY-MM-DD). Supply together with departure_date_from; omit both for no departure-date filter (all departure dates). */
|
|
375
351
|
departure_date_to?: components["parameters"]["departureDateTo"];
|
|
376
352
|
/** @description Optional traveler-type filter. */
|
|
377
353
|
traveler_type?: components["parameters"]["travelerType"];
|
|
@@ -385,12 +361,14 @@ export interface paths {
|
|
|
385
361
|
search_window_min?: components["parameters"]["searchWindowMin"];
|
|
386
362
|
/** @description Maximum advance-purchase window in days (must be >= search_window_min). */
|
|
387
363
|
search_window_max?: components["parameters"]["searchWindowMax"];
|
|
388
|
-
/** @description
|
|
389
|
-
|
|
390
|
-
/** @description Bucket size for the returned series:
|
|
364
|
+
/** @description Number of buckets N in the chosen granularity's own unit (min 2; max depends on granularity: day <= 60, week <= 52, month <= 12; default 12 applied server-side). The series spans the last N complete buckets, excluding the in-progress one. */
|
|
365
|
+
trend_window?: components["parameters"]["trendWindow"];
|
|
366
|
+
/** @description Bucket size for the returned series: week (default), day, or month. */
|
|
391
367
|
granularity?: components["parameters"]["granularity"];
|
|
392
|
-
/** @description
|
|
393
|
-
limit?: components["parameters"]["
|
|
368
|
+
/** @description Trend endpoints: maximum number of series (top-N keys). Default 10, max 50. */
|
|
369
|
+
limit?: components["parameters"]["trendLimit"];
|
|
370
|
+
/** @description Destination country to rank cities within, as a Country selector Country:<code> (e.g. Country:FR). Destination rankings only, and allowed ONLY together with level=city: it scopes the ranked destinations to a single country so that country's cities are ranked. Must be a country — a City selector is rejected. */
|
|
371
|
+
destination_country?: components["parameters"]["destinationCountry"];
|
|
394
372
|
};
|
|
395
373
|
header?: never;
|
|
396
374
|
path?: never;
|
|
@@ -404,7 +382,7 @@ export interface paths {
|
|
|
404
382
|
[name: string]: unknown;
|
|
405
383
|
};
|
|
406
384
|
content: {
|
|
407
|
-
"application/json": components["schemas"]["
|
|
385
|
+
"application/json": components["schemas"]["TrendResponse"];
|
|
408
386
|
};
|
|
409
387
|
};
|
|
410
388
|
/** @description Authentication required */
|
|
@@ -435,7 +413,7 @@ export interface paths {
|
|
|
435
413
|
patch?: never;
|
|
436
414
|
trace?: never;
|
|
437
415
|
};
|
|
438
|
-
"/v1/market/
|
|
416
|
+
"/v1/market/trend": {
|
|
439
417
|
parameters: {
|
|
440
418
|
query?: never;
|
|
441
419
|
header?: never;
|
|
@@ -443,21 +421,17 @@ export interface paths {
|
|
|
443
421
|
cookie?: never;
|
|
444
422
|
};
|
|
445
423
|
/**
|
|
446
|
-
*
|
|
447
|
-
* @description Ranks source markets for a destination by within-window growth, then returns each top-N market's
|
|
424
|
+
* Demand time series for the top-N source markets
|
|
425
|
+
* @description Ranks source markets for a destination by within-window growth, then returns each top-N market's series. `destination` is required.
|
|
448
426
|
*/
|
|
449
427
|
get: {
|
|
450
428
|
parameters: {
|
|
451
429
|
query: {
|
|
452
430
|
/** @description Destination as <Level>:<Code>, e.g. Country:TH. Required for this endpoint. */
|
|
453
431
|
destination: components["parameters"]["destinationRequired"];
|
|
454
|
-
/** @description
|
|
455
|
-
origin_market?: components["parameters"]["originMarket"];
|
|
456
|
-
/** @description Named departure window (defaults to Next90Days server-side). */
|
|
457
|
-
travel_period?: components["parameters"]["travelPeriod"];
|
|
458
|
-
/** @description Start of departure window (YYYY-MM-DD). Required when travel_period=Custom. */
|
|
432
|
+
/** @description Start of the departure window (YYYY-MM-DD). Supply together with departure_date_to; omit both for no departure-date filter (all departure dates). */
|
|
459
433
|
departure_date_from?: components["parameters"]["departureDateFrom"];
|
|
460
|
-
/** @description End of departure window (YYYY-MM-DD).
|
|
434
|
+
/** @description End of the departure window (YYYY-MM-DD). Supply together with departure_date_from; omit both for no departure-date filter (all departure dates). */
|
|
461
435
|
departure_date_to?: components["parameters"]["departureDateTo"];
|
|
462
436
|
/** @description Optional traveler-type filter. */
|
|
463
437
|
traveler_type?: components["parameters"]["travelerType"];
|
|
@@ -471,12 +445,14 @@ export interface paths {
|
|
|
471
445
|
search_window_min?: components["parameters"]["searchWindowMin"];
|
|
472
446
|
/** @description Maximum advance-purchase window in days (must be >= search_window_min). */
|
|
473
447
|
search_window_max?: components["parameters"]["searchWindowMax"];
|
|
474
|
-
/** @description
|
|
475
|
-
|
|
476
|
-
/** @description Bucket size for the returned series:
|
|
448
|
+
/** @description Number of buckets N in the chosen granularity's own unit (min 2; max depends on granularity: day <= 60, week <= 52, month <= 12; default 12 applied server-side). The series spans the last N complete buckets, excluding the in-progress one. */
|
|
449
|
+
trend_window?: components["parameters"]["trendWindow"];
|
|
450
|
+
/** @description Bucket size for the returned series: week (default), day, or month. */
|
|
477
451
|
granularity?: components["parameters"]["granularity"];
|
|
478
|
-
/** @description
|
|
479
|
-
limit?: components["parameters"]["
|
|
452
|
+
/** @description Trend endpoints: maximum number of series (top-N keys). Default 10, max 50. */
|
|
453
|
+
limit?: components["parameters"]["trendLimit"];
|
|
454
|
+
/** @description Origin country to rank cities within, as a Country selector Country:<code> (e.g. Country:US). Market rankings only, and allowed ONLY together with level=city: it scopes the ranked origin markets to a single country so that country's cities are ranked. Must be a country — a City selector is rejected. */
|
|
455
|
+
origin_country?: components["parameters"]["originCountry"];
|
|
480
456
|
};
|
|
481
457
|
header?: never;
|
|
482
458
|
path?: never;
|
|
@@ -490,7 +466,7 @@ export interface paths {
|
|
|
490
466
|
[name: string]: unknown;
|
|
491
467
|
};
|
|
492
468
|
content: {
|
|
493
|
-
"application/json": components["schemas"]["
|
|
469
|
+
"application/json": components["schemas"]["TrendResponse"];
|
|
494
470
|
};
|
|
495
471
|
};
|
|
496
472
|
/** @description Authentication required */
|
|
@@ -521,7 +497,7 @@ export interface paths {
|
|
|
521
497
|
patch?: never;
|
|
522
498
|
trace?: never;
|
|
523
499
|
};
|
|
524
|
-
"/v1/audience/
|
|
500
|
+
"/v1/audience/trend": {
|
|
525
501
|
parameters: {
|
|
526
502
|
query?: never;
|
|
527
503
|
header?: never;
|
|
@@ -529,21 +505,19 @@ export interface paths {
|
|
|
529
505
|
cookie?: never;
|
|
530
506
|
};
|
|
531
507
|
/**
|
|
532
|
-
*
|
|
533
|
-
* @description Returns a
|
|
508
|
+
* Demand time series for the traveler-type mix
|
|
509
|
+
* @description Returns a series per traveler-type segment (Solo / Couple / Family / Group) of demand for a destination. `destination` is required; `traveler_type` is not a filter here — this endpoint buckets by it.
|
|
534
510
|
*/
|
|
535
511
|
get: {
|
|
536
512
|
parameters: {
|
|
537
513
|
query: {
|
|
538
514
|
/** @description Destination as <Level>:<Code>, e.g. Country:TH. Required for this endpoint. */
|
|
539
515
|
destination: components["parameters"]["destinationRequired"];
|
|
540
|
-
/** @description Origin
|
|
541
|
-
|
|
542
|
-
/** @description
|
|
543
|
-
travel_period?: components["parameters"]["travelPeriod"];
|
|
544
|
-
/** @description Start of departure window (YYYY-MM-DD). Required when travel_period=Custom. */
|
|
516
|
+
/** @description Origin filter as <Level>:<Code>, e.g. Country:US or City:NYC, or 'global' for all origins. */
|
|
517
|
+
origin?: components["parameters"]["origin"];
|
|
518
|
+
/** @description Start of the departure window (YYYY-MM-DD). Supply together with departure_date_to; omit both for no departure-date filter (all departure dates). */
|
|
545
519
|
departure_date_from?: components["parameters"]["departureDateFrom"];
|
|
546
|
-
/** @description End of departure window (YYYY-MM-DD).
|
|
520
|
+
/** @description End of the departure window (YYYY-MM-DD). Supply together with departure_date_from; omit both for no departure-date filter (all departure dates). */
|
|
547
521
|
departure_date_to?: components["parameters"]["departureDateTo"];
|
|
548
522
|
/** @description Optional trip-type filter. */
|
|
549
523
|
trip_type?: components["parameters"]["tripType"];
|
|
@@ -555,12 +529,12 @@ export interface paths {
|
|
|
555
529
|
search_window_min?: components["parameters"]["searchWindowMin"];
|
|
556
530
|
/** @description Maximum advance-purchase window in days (must be >= search_window_min). */
|
|
557
531
|
search_window_max?: components["parameters"]["searchWindowMax"];
|
|
558
|
-
/** @description
|
|
559
|
-
|
|
560
|
-
/** @description Bucket size for the returned series:
|
|
532
|
+
/** @description Number of buckets N in the chosen granularity's own unit (min 2; max depends on granularity: day <= 60, week <= 52, month <= 12; default 12 applied server-side). The series spans the last N complete buckets, excluding the in-progress one. */
|
|
533
|
+
trend_window?: components["parameters"]["trendWindow"];
|
|
534
|
+
/** @description Bucket size for the returned series: week (default), day, or month. */
|
|
561
535
|
granularity?: components["parameters"]["granularity"];
|
|
562
|
-
/** @description
|
|
563
|
-
limit?: components["parameters"]["
|
|
536
|
+
/** @description Trend endpoints: maximum number of series (top-N keys). Default 10, max 50. */
|
|
537
|
+
limit?: components["parameters"]["trendLimit"];
|
|
564
538
|
};
|
|
565
539
|
header?: never;
|
|
566
540
|
path?: never;
|
|
@@ -574,7 +548,7 @@ export interface paths {
|
|
|
574
548
|
[name: string]: unknown;
|
|
575
549
|
};
|
|
576
550
|
content: {
|
|
577
|
-
"application/json": components["schemas"]["
|
|
551
|
+
"application/json": components["schemas"]["TrendResponse"];
|
|
578
552
|
};
|
|
579
553
|
};
|
|
580
554
|
/** @description Authentication required */
|
|
@@ -3544,10 +3518,6 @@ export interface components {
|
|
|
3544
3518
|
last_name?: string;
|
|
3545
3519
|
};
|
|
3546
3520
|
/** @enum {string} */
|
|
3547
|
-
AnalysisType: "snapshot" | "trend";
|
|
3548
|
-
/** @enum {string} */
|
|
3549
|
-
TravelPeriod: "Summer" | "Winter" | "Christmas" | "Easter" | "Next30Days" | "Next90Days" | "Custom";
|
|
3550
|
-
/** @enum {string} */
|
|
3551
3521
|
TravelerType: "Solo" | "Couple" | "Group" | "Family";
|
|
3552
3522
|
/** @enum {string} */
|
|
3553
3523
|
TripType: "One-Way" | "Round-Trip";
|
|
@@ -3556,52 +3526,34 @@ export interface components {
|
|
|
3556
3526
|
destination: string;
|
|
3557
3527
|
/** Format: double */
|
|
3558
3528
|
share?: number;
|
|
3559
|
-
/**
|
|
3560
|
-
* Format: double
|
|
3561
|
-
* @description Growth % in trend mode (analysis=trend); omitted in snapshot.
|
|
3562
|
-
*/
|
|
3563
|
-
growth?: number;
|
|
3564
3529
|
};
|
|
3565
3530
|
MarketRow: {
|
|
3566
3531
|
rank?: number;
|
|
3567
3532
|
market: string;
|
|
3568
3533
|
/** Format: double */
|
|
3569
3534
|
share?: number;
|
|
3570
|
-
/**
|
|
3571
|
-
* Format: double
|
|
3572
|
-
* @description Growth % in trend mode (analysis=trend); omitted in snapshot.
|
|
3573
|
-
*/
|
|
3574
|
-
growth?: number;
|
|
3575
3535
|
};
|
|
3576
3536
|
AudienceRow: {
|
|
3577
3537
|
rank?: number;
|
|
3578
3538
|
audience: string;
|
|
3579
3539
|
/** Format: double */
|
|
3580
3540
|
share?: number;
|
|
3581
|
-
/**
|
|
3582
|
-
* Format: double
|
|
3583
|
-
* @description Growth % in trend mode (analysis=trend); omitted in snapshot.
|
|
3584
|
-
*/
|
|
3585
|
-
growth?: number;
|
|
3586
3541
|
};
|
|
3587
3542
|
DestinationResponse: {
|
|
3588
|
-
analysis_type: components["schemas"]["AnalysisType"];
|
|
3589
3543
|
rows: components["schemas"]["DestinationRow"][];
|
|
3590
3544
|
};
|
|
3591
3545
|
MarketResponse: {
|
|
3592
|
-
analysis_type: components["schemas"]["AnalysisType"];
|
|
3593
3546
|
rows: components["schemas"]["MarketRow"][];
|
|
3594
3547
|
};
|
|
3595
3548
|
AudienceResponse: {
|
|
3596
|
-
analysis_type: components["schemas"]["AnalysisType"];
|
|
3597
3549
|
rows: components["schemas"]["AudienceRow"][];
|
|
3598
3550
|
};
|
|
3599
3551
|
/**
|
|
3600
|
-
* @description Bucket size for
|
|
3552
|
+
* @description Bucket size for a trend series: week (default), day, or month.
|
|
3601
3553
|
* @enum {string}
|
|
3602
3554
|
*/
|
|
3603
3555
|
Granularity: "day" | "week" | "month";
|
|
3604
|
-
|
|
3556
|
+
TrendPoint: {
|
|
3605
3557
|
/**
|
|
3606
3558
|
* Format: date
|
|
3607
3559
|
* @description Bucket start date (YYYY-MM-DD).
|
|
@@ -3644,7 +3596,7 @@ export interface components {
|
|
|
3644
3596
|
*/
|
|
3645
3597
|
peak_value?: number;
|
|
3646
3598
|
};
|
|
3647
|
-
|
|
3599
|
+
TrendSeries: {
|
|
3648
3600
|
/**
|
|
3649
3601
|
* @description Ranked dimension value (destination/market/audience endpoints); omitted for the pairs endpoint.
|
|
3650
3602
|
* @example Country:FR
|
|
@@ -3660,10 +3612,10 @@ export interface components {
|
|
|
3660
3612
|
* @example Country:FR
|
|
3661
3613
|
*/
|
|
3662
3614
|
destination?: string;
|
|
3663
|
-
series: components["schemas"]["
|
|
3615
|
+
series: components["schemas"]["TrendPoint"][];
|
|
3664
3616
|
summary?: components["schemas"]["SeriesSummary"];
|
|
3665
3617
|
};
|
|
3666
|
-
|
|
3618
|
+
TrendResponse: {
|
|
3667
3619
|
granularity: components["schemas"]["Granularity"];
|
|
3668
3620
|
/**
|
|
3669
3621
|
* Format: date
|
|
@@ -3677,24 +3629,22 @@ export interface components {
|
|
|
3677
3629
|
* @example 2026-06-25
|
|
3678
3630
|
*/
|
|
3679
3631
|
to: string;
|
|
3680
|
-
series: components["schemas"]["
|
|
3632
|
+
series: components["schemas"]["TrendSeries"][];
|
|
3681
3633
|
};
|
|
3682
3634
|
};
|
|
3683
3635
|
responses: never;
|
|
3684
3636
|
parameters: {
|
|
3685
|
-
/** @description
|
|
3686
|
-
|
|
3687
|
-
/** @description Origin
|
|
3688
|
-
|
|
3689
|
-
/** @description Optional destination filter as <Level>:<Code>, e.g. Country:TH. */
|
|
3690
|
-
destinationFilter: string;
|
|
3637
|
+
/** @description Origin filter as <Level>:<Code>, e.g. Country:US or City:NYC, or 'global' for all origins. */
|
|
3638
|
+
origin: string;
|
|
3639
|
+
/** @description Origin country to rank cities within, as a Country selector Country:<code> (e.g. Country:US). Market rankings only, and allowed ONLY together with level=city: it scopes the ranked origin markets to a single country so that country's cities are ranked. Must be a country — a City selector is rejected. */
|
|
3640
|
+
originCountry: string;
|
|
3691
3641
|
/** @description Destination as <Level>:<Code>, e.g. Country:TH. Required for this endpoint. */
|
|
3692
3642
|
destinationRequired: string;
|
|
3693
|
-
/** @description
|
|
3694
|
-
|
|
3695
|
-
/** @description Start of departure window (YYYY-MM-DD).
|
|
3643
|
+
/** @description Destination country to rank cities within, as a Country selector Country:<code> (e.g. Country:FR). Destination rankings only, and allowed ONLY together with level=city: it scopes the ranked destinations to a single country so that country's cities are ranked. Must be a country — a City selector is rejected. */
|
|
3644
|
+
destinationCountry: string;
|
|
3645
|
+
/** @description Start of the departure window (YYYY-MM-DD). Supply together with departure_date_to; omit both for no departure-date filter (all departure dates). */
|
|
3696
3646
|
departureDateFrom: string;
|
|
3697
|
-
/** @description End of departure window (YYYY-MM-DD).
|
|
3647
|
+
/** @description End of the departure window (YYYY-MM-DD). Supply together with departure_date_from; omit both for no departure-date filter (all departure dates). */
|
|
3698
3648
|
departureDateTo: string;
|
|
3699
3649
|
/** @description Optional traveler-type filter. */
|
|
3700
3650
|
travelerType: components["schemas"]["TravelerType"];
|
|
@@ -3708,22 +3658,20 @@ export interface components {
|
|
|
3708
3658
|
searchWindowMin: number;
|
|
3709
3659
|
/** @description Maximum advance-purchase window in days (must be >= search_window_min). */
|
|
3710
3660
|
searchWindowMax: number;
|
|
3711
|
-
/** @description
|
|
3661
|
+
/** @description Number of most-recent days of search activity aggregated into the demand level (min 2, default 7, max 90 — a 1-day window is the current day, whose data is incomplete; the cube retains 90 days). */
|
|
3712
3662
|
snapshotWindowDays: number;
|
|
3713
|
-
/** @description Trend mode only: size in days of each of the two adjacent windows compared for growth (min 2, default 7, max 45 — a 1-day window's recent period is the current day, whose data is incomplete; a trend spans 2x the window within the cube's 90-day retention). Rejected when analysis=snapshot. */
|
|
3714
|
-
trendWindowDays: number;
|
|
3715
3663
|
/** @description Max rows (1-200, default 20). */
|
|
3716
3664
|
limit: number;
|
|
3717
3665
|
/** @description Pairs endpoint: comma-separated origin selectors `<Level>:<Code>` (e.g. `Country:US,Country:CA`). v1: at most one of origins/destinations may have more than one entry. */
|
|
3718
3666
|
origins: string;
|
|
3719
3667
|
/** @description Pairs endpoint: comma-separated destination selectors `<Level>:<Code>` (e.g. `Country:FR,Country:DE`). */
|
|
3720
3668
|
destinations: string;
|
|
3721
|
-
/** @description
|
|
3722
|
-
|
|
3723
|
-
/** @description Bucket size for the returned series:
|
|
3669
|
+
/** @description Number of buckets N in the chosen granularity's own unit (min 2; max depends on granularity: day <= 60, week <= 52, month <= 12; default 12 applied server-side). The series spans the last N complete buckets, excluding the in-progress one. */
|
|
3670
|
+
trendWindow: number;
|
|
3671
|
+
/** @description Bucket size for the returned series: week (default), day, or month. */
|
|
3724
3672
|
granularity: components["schemas"]["Granularity"];
|
|
3725
|
-
/** @description
|
|
3726
|
-
|
|
3673
|
+
/** @description Trend endpoints: maximum number of series (top-N keys). Default 10, max 50. */
|
|
3674
|
+
trendLimit: number;
|
|
3727
3675
|
};
|
|
3728
3676
|
requestBodies: never;
|
|
3729
3677
|
headers: never;
|