Skip to content

Commit 76ba71d

Browse files
author
scrapebadger-bot
committed
chore: regenerate SDK from OpenAPI spec
1 parent 4f87485 commit 76ba71d

4 files changed

Lines changed: 2193 additions & 111 deletions

File tree

‎README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -445,8 +445,13 @@ Class | Method | HTTP request | Description
445445
*TikTokApi* | [**tiktokSearchHashtags**](docs/Api/TikTokApi.md#tiktoksearchhashtags) | **GET** /v1/tiktok/search/hashtags | Search hashtags
446446
*TikTokApi* | [**tiktokSearchTheTiktokAdLibrary**](docs/Api/TikTokApi.md#tiktoksearchthetiktokadlibrary) | **GET** /v1/tiktok/ads/search | Search the TikTok Ad Library
447447
*TikTokApi* | [**tiktokSearchTiktokAdvertisers**](docs/Api/TikTokApi.md#tiktoksearchtiktokadvertisers) | **GET** /v1/tiktok/ads/advertisers | Search TikTok advertisers
448+
*TikTokApi* | [**tiktokSearchTiktokShopProducts**](docs/Api/TikTokApi.md#tiktoksearchtiktokshopproducts) | **GET** /v1/tiktok/shop/search | Search TikTok Shop products
448449
*TikTokApi* | [**tiktokSearchUsers**](docs/Api/TikTokApi.md#tiktoksearchusers) | **GET** /v1/tiktok/search/users | Search users
449450
*TikTokApi* | [**tiktokSearchVideos**](docs/Api/TikTokApi.md#tiktoksearchvideos) | **GET** /v1/tiktok/search/videos | Search videos
451+
*TikTokApi* | [**tiktokTiktokShopBestSellers**](docs/Api/TikTokApi.md#tiktoktiktokshopbestsellers) | **GET** /v1/tiktok/shop/ranking | TikTok Shop best sellers
452+
*TikTokApi* | [**tiktokTiktokShopCategorySubcategoriesTopProducts**](docs/Api/TikTokApi.md#tiktoktiktokshopcategorysubcategoriestopproducts) | **GET** /v1/tiktok/shop/categories/{category_id} | TikTok Shop category: subcategories + top products
453+
*TikTokApi* | [**tiktokTiktokShopProductDetail**](docs/Api/TikTokApi.md#tiktoktiktokshopproductdetail) | **GET** /v1/tiktok/shop/products/{product_id} | TikTok Shop product detail
454+
*TikTokApi* | [**tiktokTiktokShopRootCategories**](docs/Api/TikTokApi.md#tiktoktiktokshoprootcategories) | **GET** /v1/tiktok/shop/categories | TikTok Shop root categories
450455
*TikTokApi* | [**tiktokTrendingHashtags**](docs/Api/TikTokApi.md#tiktoktrendinghashtags) | **GET** /v1/tiktok/trending/hashtags | Trending hashtags
451456
*TikTokApi* | [**tiktokTrendingSongs**](docs/Api/TikTokApi.md#tiktoktrendingsongs) | **GET** /v1/tiktok/trending/songs | Trending songs
452457
*TikTokApi* | [**tiktokTrendingVideos**](docs/Api/TikTokApi.md#tiktoktrendingvideos) | **GET** /v1/tiktok/trending/videos | Trending videos

‎docs/Api/TikTokApi.md‎

Lines changed: 312 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,13 @@ All URIs are relative to https://scrapebadger.com, except if the operation defin
2828
| [**tiktokSearchHashtags()**](TikTokApi.md#tiktokSearchHashtags) | **GET** /v1/tiktok/search/hashtags | Search hashtags |
2929
| [**tiktokSearchTheTiktokAdLibrary()**](TikTokApi.md#tiktokSearchTheTiktokAdLibrary) | **GET** /v1/tiktok/ads/search | Search the TikTok Ad Library |
3030
| [**tiktokSearchTiktokAdvertisers()**](TikTokApi.md#tiktokSearchTiktokAdvertisers) | **GET** /v1/tiktok/ads/advertisers | Search TikTok advertisers |
31+
| [**tiktokSearchTiktokShopProducts()**](TikTokApi.md#tiktokSearchTiktokShopProducts) | **GET** /v1/tiktok/shop/search | Search TikTok Shop products |
3132
| [**tiktokSearchUsers()**](TikTokApi.md#tiktokSearchUsers) | **GET** /v1/tiktok/search/users | Search users |
3233
| [**tiktokSearchVideos()**](TikTokApi.md#tiktokSearchVideos) | **GET** /v1/tiktok/search/videos | Search videos |
34+
| [**tiktokTiktokShopBestSellers()**](TikTokApi.md#tiktokTiktokShopBestSellers) | **GET** /v1/tiktok/shop/ranking | TikTok Shop best sellers |
35+
| [**tiktokTiktokShopCategorySubcategoriesTopProducts()**](TikTokApi.md#tiktokTiktokShopCategorySubcategoriesTopProducts) | **GET** /v1/tiktok/shop/categories/{category_id} | TikTok Shop category: subcategories + top products |
36+
| [**tiktokTiktokShopProductDetail()**](TikTokApi.md#tiktokTiktokShopProductDetail) | **GET** /v1/tiktok/shop/products/{product_id} | TikTok Shop product detail |
37+
| [**tiktokTiktokShopRootCategories()**](TikTokApi.md#tiktokTiktokShopRootCategories) | **GET** /v1/tiktok/shop/categories | TikTok Shop root categories |
3338
| [**tiktokTrendingHashtags()**](TikTokApi.md#tiktokTrendingHashtags) | **GET** /v1/tiktok/trending/hashtags | Trending hashtags |
3439
| [**tiktokTrendingSongs()**](TikTokApi.md#tiktokTrendingSongs) | **GET** /v1/tiktok/trending/songs | Trending songs |
3540
| [**tiktokTrendingVideos()**](TikTokApi.md#tiktokTrendingVideos) | **GET** /v1/tiktok/trending/videos | Trending videos |
@@ -1612,6 +1617,68 @@ try {
16121617
[[Back to Model list]](../../README.md#models)
16131618
[[Back to README]](../../README.md)
16141619

1620+
## `tiktokSearchTiktokShopProducts()`
1621+
1622+
```php
1623+
tiktokSearchTiktokShopProducts($q): mixed
1624+
```
1625+
1626+
Search TikTok Shop products
1627+
1628+
Keyword search over TikTok Shop products (US): products with their bound video, matching shops, related searches and categories.
1629+
1630+
### Example
1631+
1632+
```php
1633+
<?php
1634+
require_once(__DIR__ . '/vendor/autoload.php');
1635+
1636+
1637+
// Configure API key authorization: ApiKeyAuth
1638+
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
1639+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
1640+
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');
1641+
1642+
1643+
$apiInstance = new ScrapeBadger\Api\TikTokApi(
1644+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
1645+
// This is optional, `GuzzleHttp\Client` will be used as default.
1646+
new GuzzleHttp\Client(),
1647+
$config
1648+
);
1649+
$q = 'q_example'; // string | Keyword, e.g. 'wireless earbuds'
1650+
1651+
try {
1652+
$result = $apiInstance->tiktokSearchTiktokShopProducts($q);
1653+
print_r($result);
1654+
} catch (Exception $e) {
1655+
echo 'Exception when calling TikTokApi->tiktokSearchTiktokShopProducts: ', $e->getMessage(), PHP_EOL;
1656+
}
1657+
```
1658+
1659+
### Parameters
1660+
1661+
| Name | Type | Description | Notes |
1662+
| ------------- | ------------- | ------------- | ------------- |
1663+
| **q** | **string**| Keyword, e.g. &#39;wireless earbuds&#39; | |
1664+
1665+
### Return type
1666+
1667+
**mixed**
1668+
1669+
### Authorization
1670+
1671+
[ApiKeyAuth](../../README.md#ApiKeyAuth)
1672+
1673+
### HTTP request headers
1674+
1675+
- **Content-Type**: Not defined
1676+
- **Accept**: `application/json`
1677+
1678+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
1679+
[[Back to Model list]](../../README.md#models)
1680+
[[Back to README]](../../README.md)
1681+
16151682
## `tiktokSearchUsers()`
16161683

16171684
```php
@@ -1748,6 +1815,251 @@ try {
17481815
[[Back to Model list]](../../README.md#models)
17491816
[[Back to README]](../../README.md)
17501817

1818+
## `tiktokTiktokShopBestSellers()`
1819+
1820+
```php
1821+
tiktokTiktokShopBestSellers($count): mixed
1822+
```
1823+
1824+
TikTok Shop best sellers
1825+
1826+
TikTok Shop's own ranking of the best-selling products of the past 30 days (US).
1827+
1828+
### Example
1829+
1830+
```php
1831+
<?php
1832+
require_once(__DIR__ . '/vendor/autoload.php');
1833+
1834+
1835+
// Configure API key authorization: ApiKeyAuth
1836+
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
1837+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
1838+
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');
1839+
1840+
1841+
$apiInstance = new ScrapeBadger\Api\TikTokApi(
1842+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
1843+
// This is optional, `GuzzleHttp\Client` will be used as default.
1844+
new GuzzleHttp\Client(),
1845+
$config
1846+
);
1847+
$count = 20; // int | Max products to return
1848+
1849+
try {
1850+
$result = $apiInstance->tiktokTiktokShopBestSellers($count);
1851+
print_r($result);
1852+
} catch (Exception $e) {
1853+
echo 'Exception when calling TikTokApi->tiktokTiktokShopBestSellers: ', $e->getMessage(), PHP_EOL;
1854+
}
1855+
```
1856+
1857+
### Parameters
1858+
1859+
| Name | Type | Description | Notes |
1860+
| ------------- | ------------- | ------------- | ------------- |
1861+
| **count** | **int**| Max products to return | [optional] [default to 20] |
1862+
1863+
### Return type
1864+
1865+
**mixed**
1866+
1867+
### Authorization
1868+
1869+
[ApiKeyAuth](../../README.md#ApiKeyAuth)
1870+
1871+
### HTTP request headers
1872+
1873+
- **Content-Type**: Not defined
1874+
- **Accept**: `application/json`
1875+
1876+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
1877+
[[Back to Model list]](../../README.md#models)
1878+
[[Back to README]](../../README.md)
1879+
1880+
## `tiktokTiktokShopCategorySubcategoriesTopProducts()`
1881+
1882+
```php
1883+
tiktokTiktokShopCategorySubcategoriesTopProducts($category_id): mixed
1884+
```
1885+
1886+
TikTok Shop category: subcategories + top products
1887+
1888+
A category's subcategories and its top products as TikTok Shop ranks them (US).
1889+
1890+
### Example
1891+
1892+
```php
1893+
<?php
1894+
require_once(__DIR__ . '/vendor/autoload.php');
1895+
1896+
1897+
// Configure API key authorization: ApiKeyAuth
1898+
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
1899+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
1900+
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');
1901+
1902+
1903+
$apiInstance = new ScrapeBadger\Api\TikTokApi(
1904+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
1905+
// This is optional, `GuzzleHttp\Client` will be used as default.
1906+
new GuzzleHttp\Client(),
1907+
$config
1908+
);
1909+
$category_id = 'category_id_example'; // string
1910+
1911+
try {
1912+
$result = $apiInstance->tiktokTiktokShopCategorySubcategoriesTopProducts($category_id);
1913+
print_r($result);
1914+
} catch (Exception $e) {
1915+
echo 'Exception when calling TikTokApi->tiktokTiktokShopCategorySubcategoriesTopProducts: ', $e->getMessage(), PHP_EOL;
1916+
}
1917+
```
1918+
1919+
### Parameters
1920+
1921+
| Name | Type | Description | Notes |
1922+
| ------------- | ------------- | ------------- | ------------- |
1923+
| **category_id** | **string**| | |
1924+
1925+
### Return type
1926+
1927+
**mixed**
1928+
1929+
### Authorization
1930+
1931+
[ApiKeyAuth](../../README.md#ApiKeyAuth)
1932+
1933+
### HTTP request headers
1934+
1935+
- **Content-Type**: Not defined
1936+
- **Accept**: `application/json`
1937+
1938+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
1939+
[[Back to Model list]](../../README.md#models)
1940+
[[Back to README]](../../README.md)
1941+
1942+
## `tiktokTiktokShopProductDetail()`
1943+
1944+
```php
1945+
tiktokTiktokShopProductDetail($product_id): mixed
1946+
```
1947+
1948+
TikTok Shop product detail
1949+
1950+
Full TikTok Shop product page (US): description, images, price, SKUs with stock, reviews, shop and TikTok's AI summary.
1951+
1952+
### Example
1953+
1954+
```php
1955+
<?php
1956+
require_once(__DIR__ . '/vendor/autoload.php');
1957+
1958+
1959+
// Configure API key authorization: ApiKeyAuth
1960+
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
1961+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
1962+
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');
1963+
1964+
1965+
$apiInstance = new ScrapeBadger\Api\TikTokApi(
1966+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
1967+
// This is optional, `GuzzleHttp\Client` will be used as default.
1968+
new GuzzleHttp\Client(),
1969+
$config
1970+
);
1971+
$product_id = 'product_id_example'; // string
1972+
1973+
try {
1974+
$result = $apiInstance->tiktokTiktokShopProductDetail($product_id);
1975+
print_r($result);
1976+
} catch (Exception $e) {
1977+
echo 'Exception when calling TikTokApi->tiktokTiktokShopProductDetail: ', $e->getMessage(), PHP_EOL;
1978+
}
1979+
```
1980+
1981+
### Parameters
1982+
1983+
| Name | Type | Description | Notes |
1984+
| ------------- | ------------- | ------------- | ------------- |
1985+
| **product_id** | **string**| | |
1986+
1987+
### Return type
1988+
1989+
**mixed**
1990+
1991+
### Authorization
1992+
1993+
[ApiKeyAuth](../../README.md#ApiKeyAuth)
1994+
1995+
### HTTP request headers
1996+
1997+
- **Content-Type**: Not defined
1998+
- **Accept**: `application/json`
1999+
2000+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
2001+
[[Back to Model list]](../../README.md#models)
2002+
[[Back to README]](../../README.md)
2003+
2004+
## `tiktokTiktokShopRootCategories()`
2005+
2006+
```php
2007+
tiktokTiktokShopRootCategories(): mixed
2008+
```
2009+
2010+
TikTok Shop root categories
2011+
2012+
Top-level TikTok Shop categories (US). Drill down with /shop/categories/{category_id}.
2013+
2014+
### Example
2015+
2016+
```php
2017+
<?php
2018+
require_once(__DIR__ . '/vendor/autoload.php');
2019+
2020+
2021+
// Configure API key authorization: ApiKeyAuth
2022+
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
2023+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
2024+
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');
2025+
2026+
2027+
$apiInstance = new ScrapeBadger\Api\TikTokApi(
2028+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
2029+
// This is optional, `GuzzleHttp\Client` will be used as default.
2030+
new GuzzleHttp\Client(),
2031+
$config
2032+
);
2033+
2034+
try {
2035+
$result = $apiInstance->tiktokTiktokShopRootCategories();
2036+
print_r($result);
2037+
} catch (Exception $e) {
2038+
echo 'Exception when calling TikTokApi->tiktokTiktokShopRootCategories: ', $e->getMessage(), PHP_EOL;
2039+
}
2040+
```
2041+
2042+
### Parameters
2043+
2044+
This endpoint does not need any parameter.
2045+
2046+
### Return type
2047+
2048+
**mixed**
2049+
2050+
### Authorization
2051+
2052+
[ApiKeyAuth](../../README.md#ApiKeyAuth)
2053+
2054+
### HTTP request headers
2055+
2056+
- **Content-Type**: Not defined
2057+
- **Accept**: `application/json`
2058+
2059+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
2060+
[[Back to Model list]](../../README.md#models)
2061+
[[Back to README]](../../README.md)
2062+
17512063
## `tiktokTrendingHashtags()`
17522064

17532065
```php

0 commit comments

Comments
 (0)