@gojinko/api-client 2.20.0 → 2.21.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 +23 -16
- package/dist/types/devplatform.d.ts.map +1 -1
- package/dist/types/generated.d.ts +50 -86
- package/dist/types/generated.d.ts.map +1 -1
- package/package.json +1 -1
- package/public-api.yaml +39 -83
package/public-api.yaml
CHANGED
|
@@ -1570,9 +1570,6 @@ components:
|
|
|
1570
1570
|
type: string
|
|
1571
1571
|
last_name:
|
|
1572
1572
|
type: string
|
|
1573
|
-
AnalysisType:
|
|
1574
|
-
type: string
|
|
1575
|
-
enum: [snapshot, trend]
|
|
1576
1573
|
TravelPeriod:
|
|
1577
1574
|
type: string
|
|
1578
1575
|
enum: [Summer, Winter, Christmas, Easter, Next30Days, Next90Days, Custom]
|
|
@@ -1593,10 +1590,6 @@ components:
|
|
|
1593
1590
|
share:
|
|
1594
1591
|
type: number
|
|
1595
1592
|
format: double
|
|
1596
|
-
growth:
|
|
1597
|
-
type: number
|
|
1598
|
-
format: double
|
|
1599
|
-
description: "Growth % in trend mode (analysis=trend); omitted in snapshot."
|
|
1600
1593
|
MarketRow:
|
|
1601
1594
|
type: object
|
|
1602
1595
|
required: [market]
|
|
@@ -1608,10 +1601,6 @@ components:
|
|
|
1608
1601
|
share:
|
|
1609
1602
|
type: number
|
|
1610
1603
|
format: double
|
|
1611
|
-
growth:
|
|
1612
|
-
type: number
|
|
1613
|
-
format: double
|
|
1614
|
-
description: "Growth % in trend mode (analysis=trend); omitted in snapshot."
|
|
1615
1604
|
AudienceRow:
|
|
1616
1605
|
type: object
|
|
1617
1606
|
required: [audience]
|
|
@@ -1623,36 +1612,26 @@ components:
|
|
|
1623
1612
|
share:
|
|
1624
1613
|
type: number
|
|
1625
1614
|
format: double
|
|
1626
|
-
growth:
|
|
1627
|
-
type: number
|
|
1628
|
-
format: double
|
|
1629
|
-
description: "Growth % in trend mode (analysis=trend); omitted in snapshot."
|
|
1630
1615
|
DestinationResponse:
|
|
1631
1616
|
type: object
|
|
1632
|
-
required: [
|
|
1617
|
+
required: [rows]
|
|
1633
1618
|
properties:
|
|
1634
|
-
analysis_type:
|
|
1635
|
-
$ref: "#/components/schemas/AnalysisType"
|
|
1636
1619
|
rows:
|
|
1637
1620
|
type: array
|
|
1638
1621
|
items:
|
|
1639
1622
|
$ref: "#/components/schemas/DestinationRow"
|
|
1640
1623
|
MarketResponse:
|
|
1641
1624
|
type: object
|
|
1642
|
-
required: [
|
|
1625
|
+
required: [rows]
|
|
1643
1626
|
properties:
|
|
1644
|
-
analysis_type:
|
|
1645
|
-
$ref: "#/components/schemas/AnalysisType"
|
|
1646
1627
|
rows:
|
|
1647
1628
|
type: array
|
|
1648
1629
|
items:
|
|
1649
1630
|
$ref: "#/components/schemas/MarketRow"
|
|
1650
1631
|
AudienceResponse:
|
|
1651
1632
|
type: object
|
|
1652
|
-
required: [
|
|
1633
|
+
required: [rows]
|
|
1653
1634
|
properties:
|
|
1654
|
-
analysis_type:
|
|
1655
|
-
$ref: "#/components/schemas/AnalysisType"
|
|
1656
1635
|
rows:
|
|
1657
1636
|
type: array
|
|
1658
1637
|
items:
|
|
@@ -1660,8 +1639,8 @@ components:
|
|
|
1660
1639
|
Granularity:
|
|
1661
1640
|
type: string
|
|
1662
1641
|
enum: [day, week, month]
|
|
1663
|
-
description: "Bucket size for
|
|
1664
|
-
|
|
1642
|
+
description: "Bucket size for a trend series: week (default), day, or month."
|
|
1643
|
+
TrendPoint:
|
|
1665
1644
|
type: object
|
|
1666
1645
|
required: [date, value]
|
|
1667
1646
|
properties:
|
|
@@ -1701,7 +1680,7 @@ components:
|
|
|
1701
1680
|
type: number
|
|
1702
1681
|
format: double
|
|
1703
1682
|
example: 1890
|
|
1704
|
-
|
|
1683
|
+
TrendSeries:
|
|
1705
1684
|
type: object
|
|
1706
1685
|
required: [series]
|
|
1707
1686
|
properties:
|
|
@@ -1720,10 +1699,10 @@ components:
|
|
|
1720
1699
|
series:
|
|
1721
1700
|
type: array
|
|
1722
1701
|
items:
|
|
1723
|
-
$ref: "#/components/schemas/
|
|
1702
|
+
$ref: "#/components/schemas/TrendPoint"
|
|
1724
1703
|
summary:
|
|
1725
1704
|
$ref: "#/components/schemas/SeriesSummary"
|
|
1726
|
-
|
|
1705
|
+
TrendResponse:
|
|
1727
1706
|
type: object
|
|
1728
1707
|
required: [granularity, from, to, series]
|
|
1729
1708
|
properties:
|
|
@@ -1742,15 +1721,8 @@ components:
|
|
|
1742
1721
|
series:
|
|
1743
1722
|
type: array
|
|
1744
1723
|
items:
|
|
1745
|
-
$ref: "#/components/schemas/
|
|
1724
|
+
$ref: "#/components/schemas/TrendSeries"
|
|
1746
1725
|
parameters:
|
|
1747
|
-
analysis:
|
|
1748
|
-
name: analysis
|
|
1749
|
-
in: query
|
|
1750
|
-
required: true
|
|
1751
|
-
description: Analysis mode. `trend` is accepted but currently returns snapshot-shaped data.
|
|
1752
|
-
schema:
|
|
1753
|
-
$ref: "#/components/schemas/AnalysisType"
|
|
1754
1726
|
originMarket:
|
|
1755
1727
|
name: origin_market
|
|
1756
1728
|
in: query
|
|
@@ -1845,20 +1817,11 @@ components:
|
|
|
1845
1817
|
name: snapshot_window_days
|
|
1846
1818
|
in: query
|
|
1847
1819
|
required: false
|
|
1848
|
-
description: "
|
|
1820
|
+
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)."
|
|
1849
1821
|
schema:
|
|
1850
1822
|
type: integer
|
|
1851
1823
|
minimum: 2
|
|
1852
1824
|
maximum: 90
|
|
1853
|
-
trendWindowDays:
|
|
1854
|
-
name: trend_window_days
|
|
1855
|
-
in: query
|
|
1856
|
-
required: false
|
|
1857
|
-
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."
|
|
1858
|
-
schema:
|
|
1859
|
-
type: integer
|
|
1860
|
-
minimum: 2
|
|
1861
|
-
maximum: 45
|
|
1862
1825
|
limit:
|
|
1863
1826
|
name: limit
|
|
1864
1827
|
in: query
|
|
@@ -1885,27 +1848,26 @@ components:
|
|
|
1885
1848
|
schema:
|
|
1886
1849
|
type: string
|
|
1887
1850
|
minLength: 1
|
|
1888
|
-
|
|
1889
|
-
name:
|
|
1851
|
+
trendWindow:
|
|
1852
|
+
name: trend_window
|
|
1890
1853
|
in: query
|
|
1891
1854
|
required: false
|
|
1892
|
-
description: "
|
|
1855
|
+
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."
|
|
1893
1856
|
schema:
|
|
1894
1857
|
type: integer
|
|
1895
1858
|
minimum: 2
|
|
1896
|
-
maximum: 45
|
|
1897
1859
|
granularity:
|
|
1898
1860
|
name: granularity
|
|
1899
1861
|
in: query
|
|
1900
1862
|
required: false
|
|
1901
|
-
description: "Bucket size for the returned series:
|
|
1863
|
+
description: "Bucket size for the returned series: week (default), day, or month."
|
|
1902
1864
|
schema:
|
|
1903
1865
|
$ref: "#/components/schemas/Granularity"
|
|
1904
|
-
|
|
1866
|
+
trendLimit:
|
|
1905
1867
|
name: limit
|
|
1906
1868
|
in: query
|
|
1907
1869
|
required: false
|
|
1908
|
-
description: "
|
|
1870
|
+
description: "Trend endpoints: maximum number of series (top-N keys). Default 10, max 50."
|
|
1909
1871
|
schema:
|
|
1910
1872
|
type: integer
|
|
1911
1873
|
minimum: 1
|
|
@@ -1924,7 +1886,6 @@ paths:
|
|
|
1924
1886
|
- ApiKeyAuth: []
|
|
1925
1887
|
- BearerAuth: []
|
|
1926
1888
|
parameters:
|
|
1927
|
-
- $ref: "#/components/parameters/analysis"
|
|
1928
1889
|
- $ref: "#/components/parameters/originMarket"
|
|
1929
1890
|
- $ref: "#/components/parameters/destinationFilter"
|
|
1930
1891
|
- $ref: "#/components/parameters/travelPeriod"
|
|
@@ -1937,7 +1898,6 @@ paths:
|
|
|
1937
1898
|
- $ref: "#/components/parameters/searchWindowMin"
|
|
1938
1899
|
- $ref: "#/components/parameters/searchWindowMax"
|
|
1939
1900
|
- $ref: "#/components/parameters/snapshotWindowDays"
|
|
1940
|
-
- $ref: "#/components/parameters/trendWindowDays"
|
|
1941
1901
|
- $ref: "#/components/parameters/limit"
|
|
1942
1902
|
responses:
|
|
1943
1903
|
"200":
|
|
@@ -1968,7 +1928,6 @@ paths:
|
|
|
1968
1928
|
- ApiKeyAuth: []
|
|
1969
1929
|
- BearerAuth: []
|
|
1970
1930
|
parameters:
|
|
1971
|
-
- $ref: "#/components/parameters/analysis"
|
|
1972
1931
|
- $ref: "#/components/parameters/destinationRequired"
|
|
1973
1932
|
- $ref: "#/components/parameters/originMarket"
|
|
1974
1933
|
- $ref: "#/components/parameters/travelPeriod"
|
|
@@ -1981,7 +1940,6 @@ paths:
|
|
|
1981
1940
|
- $ref: "#/components/parameters/searchWindowMin"
|
|
1982
1941
|
- $ref: "#/components/parameters/searchWindowMax"
|
|
1983
1942
|
- $ref: "#/components/parameters/snapshotWindowDays"
|
|
1984
|
-
- $ref: "#/components/parameters/trendWindowDays"
|
|
1985
1943
|
- $ref: "#/components/parameters/limit"
|
|
1986
1944
|
responses:
|
|
1987
1945
|
"200":
|
|
@@ -2014,7 +1972,6 @@ paths:
|
|
|
2014
1972
|
- ApiKeyAuth: []
|
|
2015
1973
|
- BearerAuth: []
|
|
2016
1974
|
parameters:
|
|
2017
|
-
- $ref: "#/components/parameters/analysis"
|
|
2018
1975
|
- $ref: "#/components/parameters/destinationRequired"
|
|
2019
1976
|
- $ref: "#/components/parameters/originMarket"
|
|
2020
1977
|
- $ref: "#/components/parameters/travelPeriod"
|
|
@@ -2026,7 +1983,6 @@ paths:
|
|
|
2026
1983
|
- $ref: "#/components/parameters/searchWindowMin"
|
|
2027
1984
|
- $ref: "#/components/parameters/searchWindowMax"
|
|
2028
1985
|
- $ref: "#/components/parameters/snapshotWindowDays"
|
|
2029
|
-
- $ref: "#/components/parameters/trendWindowDays"
|
|
2030
1986
|
- $ref: "#/components/parameters/limit"
|
|
2031
1987
|
responses:
|
|
2032
1988
|
"200":
|
|
@@ -2047,13 +2003,13 @@ paths:
|
|
|
2047
2003
|
application/json:
|
|
2048
2004
|
schema:
|
|
2049
2005
|
$ref: "#/components/schemas/ErrorResponse"
|
|
2050
|
-
/v1/
|
|
2006
|
+
/v1/trend:
|
|
2051
2007
|
get:
|
|
2052
2008
|
tags:
|
|
2053
2009
|
- demand
|
|
2054
|
-
summary:
|
|
2010
|
+
summary: Demand time series for explicit origin/destination pairs
|
|
2055
2011
|
description: >-
|
|
2056
|
-
Deep dive: returns one
|
|
2012
|
+
Deep dive: returns one de-sampled search-volume series per
|
|
2057
2013
|
(origin, destination) pair. v1 allows a list on only one side — a single
|
|
2058
2014
|
origin with many destinations, or many origins with a single destination.
|
|
2059
2015
|
security:
|
|
@@ -2071,7 +2027,7 @@ paths:
|
|
|
2071
2027
|
- $ref: "#/components/parameters/tripDurationMax"
|
|
2072
2028
|
- $ref: "#/components/parameters/searchWindowMin"
|
|
2073
2029
|
- $ref: "#/components/parameters/searchWindowMax"
|
|
2074
|
-
- $ref: "#/components/parameters/
|
|
2030
|
+
- $ref: "#/components/parameters/trendWindow"
|
|
2075
2031
|
- $ref: "#/components/parameters/granularity"
|
|
2076
2032
|
responses:
|
|
2077
2033
|
"200":
|
|
@@ -2079,7 +2035,7 @@ paths:
|
|
|
2079
2035
|
content:
|
|
2080
2036
|
application/json:
|
|
2081
2037
|
schema:
|
|
2082
|
-
$ref: "#/components/schemas/
|
|
2038
|
+
$ref: "#/components/schemas/TrendResponse"
|
|
2083
2039
|
"401":
|
|
2084
2040
|
description: Authentication required
|
|
2085
2041
|
content:
|
|
@@ -2092,14 +2048,14 @@ paths:
|
|
|
2092
2048
|
application/json:
|
|
2093
2049
|
schema:
|
|
2094
2050
|
$ref: "#/components/schemas/ErrorResponse"
|
|
2095
|
-
/v1/destination/
|
|
2051
|
+
/v1/destination/trend:
|
|
2096
2052
|
get:
|
|
2097
2053
|
tags:
|
|
2098
2054
|
- demand
|
|
2099
|
-
summary:
|
|
2055
|
+
summary: Demand time series for the top-N destinations
|
|
2100
2056
|
description: >-
|
|
2101
2057
|
Ranks destinations (optionally reachable from origin_market) by
|
|
2102
|
-
within-window growth, then returns each top-N destination's
|
|
2058
|
+
within-window growth, then returns each top-N destination's series.
|
|
2103
2059
|
security:
|
|
2104
2060
|
- ApiKeyAuth: []
|
|
2105
2061
|
- BearerAuth: []
|
|
@@ -2115,16 +2071,16 @@ paths:
|
|
|
2115
2071
|
- $ref: "#/components/parameters/tripDurationMax"
|
|
2116
2072
|
- $ref: "#/components/parameters/searchWindowMin"
|
|
2117
2073
|
- $ref: "#/components/parameters/searchWindowMax"
|
|
2118
|
-
- $ref: "#/components/parameters/
|
|
2074
|
+
- $ref: "#/components/parameters/trendWindow"
|
|
2119
2075
|
- $ref: "#/components/parameters/granularity"
|
|
2120
|
-
- $ref: "#/components/parameters/
|
|
2076
|
+
- $ref: "#/components/parameters/trendLimit"
|
|
2121
2077
|
responses:
|
|
2122
2078
|
"200":
|
|
2123
2079
|
description: Top-N destination time series
|
|
2124
2080
|
content:
|
|
2125
2081
|
application/json:
|
|
2126
2082
|
schema:
|
|
2127
|
-
$ref: "#/components/schemas/
|
|
2083
|
+
$ref: "#/components/schemas/TrendResponse"
|
|
2128
2084
|
"401":
|
|
2129
2085
|
description: Authentication required
|
|
2130
2086
|
content:
|
|
@@ -2137,14 +2093,14 @@ paths:
|
|
|
2137
2093
|
application/json:
|
|
2138
2094
|
schema:
|
|
2139
2095
|
$ref: "#/components/schemas/ErrorResponse"
|
|
2140
|
-
/v1/market/
|
|
2096
|
+
/v1/market/trend:
|
|
2141
2097
|
get:
|
|
2142
2098
|
tags:
|
|
2143
2099
|
- demand
|
|
2144
|
-
summary:
|
|
2100
|
+
summary: Demand time series for the top-N source markets
|
|
2145
2101
|
description: >-
|
|
2146
2102
|
Ranks source markets for a destination by within-window growth, then
|
|
2147
|
-
returns each top-N market's
|
|
2103
|
+
returns each top-N market's series. `destination` is required.
|
|
2148
2104
|
security:
|
|
2149
2105
|
- ApiKeyAuth: []
|
|
2150
2106
|
- BearerAuth: []
|
|
@@ -2160,16 +2116,16 @@ paths:
|
|
|
2160
2116
|
- $ref: "#/components/parameters/tripDurationMax"
|
|
2161
2117
|
- $ref: "#/components/parameters/searchWindowMin"
|
|
2162
2118
|
- $ref: "#/components/parameters/searchWindowMax"
|
|
2163
|
-
- $ref: "#/components/parameters/
|
|
2119
|
+
- $ref: "#/components/parameters/trendWindow"
|
|
2164
2120
|
- $ref: "#/components/parameters/granularity"
|
|
2165
|
-
- $ref: "#/components/parameters/
|
|
2121
|
+
- $ref: "#/components/parameters/trendLimit"
|
|
2166
2122
|
responses:
|
|
2167
2123
|
"200":
|
|
2168
2124
|
description: Top-N market time series
|
|
2169
2125
|
content:
|
|
2170
2126
|
application/json:
|
|
2171
2127
|
schema:
|
|
2172
|
-
$ref: "#/components/schemas/
|
|
2128
|
+
$ref: "#/components/schemas/TrendResponse"
|
|
2173
2129
|
"401":
|
|
2174
2130
|
description: Authentication required
|
|
2175
2131
|
content:
|
|
@@ -2182,13 +2138,13 @@ paths:
|
|
|
2182
2138
|
application/json:
|
|
2183
2139
|
schema:
|
|
2184
2140
|
$ref: "#/components/schemas/ErrorResponse"
|
|
2185
|
-
/v1/audience/
|
|
2141
|
+
/v1/audience/trend:
|
|
2186
2142
|
get:
|
|
2187
2143
|
tags:
|
|
2188
2144
|
- demand
|
|
2189
|
-
summary:
|
|
2145
|
+
summary: Demand time series for the traveler-type mix
|
|
2190
2146
|
description: >-
|
|
2191
|
-
Returns a
|
|
2147
|
+
Returns a series per traveler-type segment (Solo / Couple / Family /
|
|
2192
2148
|
Group) of demand for a destination. `destination` is required;
|
|
2193
2149
|
`traveler_type` is not a filter here — this endpoint buckets by it.
|
|
2194
2150
|
security:
|
|
@@ -2205,16 +2161,16 @@ paths:
|
|
|
2205
2161
|
- $ref: "#/components/parameters/tripDurationMax"
|
|
2206
2162
|
- $ref: "#/components/parameters/searchWindowMin"
|
|
2207
2163
|
- $ref: "#/components/parameters/searchWindowMax"
|
|
2208
|
-
- $ref: "#/components/parameters/
|
|
2164
|
+
- $ref: "#/components/parameters/trendWindow"
|
|
2209
2165
|
- $ref: "#/components/parameters/granularity"
|
|
2210
|
-
- $ref: "#/components/parameters/
|
|
2166
|
+
- $ref: "#/components/parameters/trendLimit"
|
|
2211
2167
|
responses:
|
|
2212
2168
|
"200":
|
|
2213
2169
|
description: Per-segment time series
|
|
2214
2170
|
content:
|
|
2215
2171
|
application/json:
|
|
2216
2172
|
schema:
|
|
2217
|
-
$ref: "#/components/schemas/
|
|
2173
|
+
$ref: "#/components/schemas/TrendResponse"
|
|
2218
2174
|
"401":
|
|
2219
2175
|
description: Authentication required
|
|
2220
2176
|
content:
|