@teez-sdk/teez-b2c-api 1.0.0 → 2.0.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/README.md +0 -2
- package/dist/index.cjs +180 -50
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +254 -145
- package/dist/index.d.mts +254 -145
- package/dist/index.mjs +181 -50
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -18,35 +18,6 @@ declare const LANGUAGES: {
|
|
|
18
18
|
*/
|
|
19
19
|
readonly KZ: "kz";
|
|
20
20
|
};
|
|
21
|
-
/**
|
|
22
|
-
* Standard sort options for product and collection searches
|
|
23
|
-
*/
|
|
24
|
-
declare const SORT_OPTIONS: {
|
|
25
|
-
/**
|
|
26
|
-
* Sort by relevance (usually for search results)
|
|
27
|
-
*/
|
|
28
|
-
readonly BY_RELEVANCE: "byRelevance";
|
|
29
|
-
/**
|
|
30
|
-
* Sort by popularity descending
|
|
31
|
-
*/
|
|
32
|
-
readonly POPULARITY: "popularity";
|
|
33
|
-
/**
|
|
34
|
-
* Sort by user rating descending
|
|
35
|
-
*/
|
|
36
|
-
readonly HIGHEST_RATED: "highestRated";
|
|
37
|
-
/**
|
|
38
|
-
* Sort by creation date descending
|
|
39
|
-
*/
|
|
40
|
-
readonly NEW: "new";
|
|
41
|
-
/**
|
|
42
|
-
* Sort by price ascending
|
|
43
|
-
*/
|
|
44
|
-
readonly PRICE: "price";
|
|
45
|
-
/**
|
|
46
|
-
* Sort by price descending
|
|
47
|
-
*/
|
|
48
|
-
readonly PRICE_DESC: "priceDesc";
|
|
49
|
-
};
|
|
50
21
|
/**
|
|
51
22
|
* Default application version code.
|
|
52
23
|
*/
|
|
@@ -61,10 +32,6 @@ type Language = (typeof LANGUAGES)[keyof typeof LANGUAGES] | (string & {});
|
|
|
61
32
|
* Base parameters for API requests.
|
|
62
33
|
*/
|
|
63
34
|
type BaseParams = Record<string, unknown>;
|
|
64
|
-
/**
|
|
65
|
-
* Available sorting options for API listings.
|
|
66
|
-
*/
|
|
67
|
-
type SortOption = (typeof SORT_OPTIONS)[keyof typeof SORT_OPTIONS] | (string & {});
|
|
68
35
|
//#endregion
|
|
69
36
|
//#region src/config.d.ts
|
|
70
37
|
/**
|
|
@@ -191,9 +158,16 @@ declare class HttpClient {
|
|
|
191
158
|
* Request timeout in milliseconds.
|
|
192
159
|
*/
|
|
193
160
|
private readonly timeout;
|
|
161
|
+
/**
|
|
162
|
+
* Initializes a new instance of the HttpClient.
|
|
163
|
+
*
|
|
164
|
+
* @param config Resolved client configuration.
|
|
165
|
+
*/
|
|
194
166
|
constructor(config: ResolvedTeezClientConfig);
|
|
195
167
|
/**
|
|
196
168
|
* Performs a low-level HTTP request.
|
|
169
|
+
*
|
|
170
|
+
* @param options Request options.
|
|
197
171
|
*/
|
|
198
172
|
request(options: HttpRequestOptions): Promise<unknown>;
|
|
199
173
|
/**
|
|
@@ -281,9 +255,17 @@ interface BannersApiListParams extends BaseParams {
|
|
|
281
255
|
*/
|
|
282
256
|
declare class BannersApi {
|
|
283
257
|
private http;
|
|
258
|
+
/**
|
|
259
|
+
* Initializes a new instance of the BannersApi.
|
|
260
|
+
*
|
|
261
|
+
* @param http HTTP client instance.
|
|
262
|
+
*/
|
|
284
263
|
constructor(http: HttpClient);
|
|
285
264
|
/**
|
|
286
265
|
* Retrieves a list of active banners.
|
|
266
|
+
*
|
|
267
|
+
* @example
|
|
268
|
+
* const banners = await client.banners.list();
|
|
287
269
|
*/
|
|
288
270
|
list(params?: BannersApiListParams): Promise<BannersApiListResponse>;
|
|
289
271
|
}
|
|
@@ -426,17 +408,35 @@ interface CategoriesApiGetParentsParams extends BaseParams {
|
|
|
426
408
|
*/
|
|
427
409
|
declare class CategoriesApi {
|
|
428
410
|
private http;
|
|
411
|
+
/**
|
|
412
|
+
* Initializes a new instance of the CategoriesApi.
|
|
413
|
+
*
|
|
414
|
+
* @param http HTTP client instance.
|
|
415
|
+
*/
|
|
429
416
|
constructor(http: HttpClient);
|
|
430
417
|
/**
|
|
431
418
|
* Retrieves a list of all categories.
|
|
419
|
+
*
|
|
420
|
+
* @example
|
|
421
|
+
* const categories = await client.categories.list();
|
|
432
422
|
*/
|
|
433
423
|
list(params?: CategoriesApiListParams): Promise<CategoriesApiListResponse>;
|
|
434
424
|
/**
|
|
435
425
|
* Retrieves detailed information about a specific category by its ID.
|
|
426
|
+
*
|
|
427
|
+
* @example
|
|
428
|
+
* const category = await client.categories.get({
|
|
429
|
+
* categoryId: 1234
|
|
430
|
+
* });
|
|
436
431
|
*/
|
|
437
432
|
get(params: CategoriesApiGetParams): Promise<CategoriesApiGetResponse>;
|
|
438
433
|
/**
|
|
439
434
|
* Retrieves parent categories for specific category IDs.
|
|
435
|
+
*
|
|
436
|
+
* @example
|
|
437
|
+
* const parents = await client.categories.getParents({
|
|
438
|
+
* categoryId: [123, 456]
|
|
439
|
+
* });
|
|
440
440
|
*/
|
|
441
441
|
getParents(params: CategoriesApiGetParentsParams): Promise<CategoriesApiGetParentsResponse>;
|
|
442
442
|
}
|
|
@@ -649,115 +649,6 @@ interface CollectionsApiGetResponse {
|
|
|
649
649
|
priority: number;
|
|
650
650
|
}
|
|
651
651
|
//#endregion
|
|
652
|
-
//#region src/api/collections/types.d.ts
|
|
653
|
-
/**
|
|
654
|
-
* Parameters for fetching SKUs from a collection.
|
|
655
|
-
*/
|
|
656
|
-
interface CollectionsApiGetSkusParams extends BaseParams {
|
|
657
|
-
/**
|
|
658
|
-
* Number of the page to retrieve
|
|
659
|
-
*/
|
|
660
|
-
pageNumber?: number;
|
|
661
|
-
/**
|
|
662
|
-
* Number of items per page
|
|
663
|
-
*/
|
|
664
|
-
pageSize?: number;
|
|
665
|
-
/**
|
|
666
|
-
* Unique identifier of the collection
|
|
667
|
-
*/
|
|
668
|
-
collectionId: number;
|
|
669
|
-
/**
|
|
670
|
-
* Sorting option for the results
|
|
671
|
-
*/
|
|
672
|
-
sortBy?: SortOption;
|
|
673
|
-
}
|
|
674
|
-
/**
|
|
675
|
-
* Parameters for fetching the list of collections.
|
|
676
|
-
*/
|
|
677
|
-
interface CollectionsApiListParams extends BaseParams {
|
|
678
|
-
/**
|
|
679
|
-
* Type of collections to filter by
|
|
680
|
-
*/
|
|
681
|
-
type?: string;
|
|
682
|
-
/**
|
|
683
|
-
* Filter collections by shop ID
|
|
684
|
-
*/
|
|
685
|
-
shopId?: number;
|
|
686
|
-
}
|
|
687
|
-
/**
|
|
688
|
-
* Parameters for fetching a specific collection.
|
|
689
|
-
*/
|
|
690
|
-
interface CollectionsApiGetParams extends BaseParams {
|
|
691
|
-
/**
|
|
692
|
-
* Unique identifier of the collection
|
|
693
|
-
*/
|
|
694
|
-
collectionId: number;
|
|
695
|
-
}
|
|
696
|
-
//#endregion
|
|
697
|
-
//#region src/api/collections/api.d.ts
|
|
698
|
-
/**
|
|
699
|
-
* API for retrieving curated collections of products.
|
|
700
|
-
*/
|
|
701
|
-
declare class CollectionsApi {
|
|
702
|
-
private http;
|
|
703
|
-
constructor(http: HttpClient);
|
|
704
|
-
/**
|
|
705
|
-
* Retrieves a list of SKUs belonging to a specific collection with pagination and sorting.
|
|
706
|
-
*/
|
|
707
|
-
getSkus(params: CollectionsApiGetSkusParams): Promise<CollectionsApiGetSkusResponse>;
|
|
708
|
-
/**
|
|
709
|
-
* Retrieves a list of all collections.
|
|
710
|
-
*/
|
|
711
|
-
list(params?: CollectionsApiListParams): Promise<CollectionsApiListResponse>;
|
|
712
|
-
/**
|
|
713
|
-
* Retrieves detailed information about a specific collection by its ID.
|
|
714
|
-
*/
|
|
715
|
-
get(params: CollectionsApiGetParams): Promise<CollectionsApiGetResponse>;
|
|
716
|
-
}
|
|
717
|
-
//#endregion
|
|
718
|
-
//#region src/api/feature-flags/schema-types.d.ts
|
|
719
|
-
/**
|
|
720
|
-
* ⚠️ This file is auto-generated. Do not edit manually.
|
|
721
|
-
* Run `npm run generate:schema-types` to regenerate.
|
|
722
|
-
* Generated from: schemas.ts
|
|
723
|
-
*/
|
|
724
|
-
/**
|
|
725
|
-
* Schema for a feature flag item.
|
|
726
|
-
*/
|
|
727
|
-
interface FeatureFlagsApiItem {
|
|
728
|
-
/**
|
|
729
|
-
* Name of the feature flag
|
|
730
|
-
*/
|
|
731
|
-
name: string;
|
|
732
|
-
/**
|
|
733
|
-
* Indicates if the feature flag is currently active
|
|
734
|
-
*/
|
|
735
|
-
isActive: boolean;
|
|
736
|
-
}
|
|
737
|
-
/**
|
|
738
|
-
* Response schema for the list of feature flags.
|
|
739
|
-
*/
|
|
740
|
-
type FeatureFlagsApiListResponse = FeatureFlagsApiItem[];
|
|
741
|
-
//#endregion
|
|
742
|
-
//#region src/api/feature-flags/types.d.ts
|
|
743
|
-
/**
|
|
744
|
-
* Parameters for fetching feature flags.
|
|
745
|
-
*/
|
|
746
|
-
type FeatureFlagsApiListParams = BaseParams;
|
|
747
|
-
//#endregion
|
|
748
|
-
//#region src/api/feature-flags/api.d.ts
|
|
749
|
-
/**
|
|
750
|
-
* API for retrieving feature flags configuration.
|
|
751
|
-
*/
|
|
752
|
-
declare class FeatureFlagsApi {
|
|
753
|
-
private http;
|
|
754
|
-
constructor(http: HttpClient);
|
|
755
|
-
/**
|
|
756
|
-
* Retrieves all active feature flags.
|
|
757
|
-
*/
|
|
758
|
-
list(params?: FeatureFlagsApiListParams): Promise<FeatureFlagsApiListResponse>;
|
|
759
|
-
}
|
|
760
|
-
//#endregion
|
|
761
652
|
//#region src/api/products/schema-types.d.ts
|
|
762
653
|
/**
|
|
763
654
|
* ⚠️ This file is auto-generated. Do not edit manually.
|
|
@@ -1012,6 +903,142 @@ interface ProductsApiListResponse {
|
|
|
1012
903
|
hasNextPage: boolean;
|
|
1013
904
|
}
|
|
1014
905
|
//#endregion
|
|
906
|
+
//#region src/api/collections/types.d.ts
|
|
907
|
+
/**
|
|
908
|
+
* Parameters for fetching SKUs from a collection.
|
|
909
|
+
*/
|
|
910
|
+
interface CollectionsApiGetSkusParams extends BaseParams {
|
|
911
|
+
/**
|
|
912
|
+
* Number of the page to retrieve
|
|
913
|
+
*/
|
|
914
|
+
pageNumber?: number;
|
|
915
|
+
/**
|
|
916
|
+
* Number of items per page
|
|
917
|
+
*/
|
|
918
|
+
pageSize?: number;
|
|
919
|
+
/**
|
|
920
|
+
* Unique identifier of the collection
|
|
921
|
+
*/
|
|
922
|
+
collectionId: number;
|
|
923
|
+
/**
|
|
924
|
+
* Sorting option for the results
|
|
925
|
+
*/
|
|
926
|
+
sortBy?: ProductSortKey;
|
|
927
|
+
}
|
|
928
|
+
/**
|
|
929
|
+
* Parameters for fetching the list of collections.
|
|
930
|
+
*/
|
|
931
|
+
interface CollectionsApiListParams extends BaseParams {
|
|
932
|
+
/**
|
|
933
|
+
* Type of collections to filter by
|
|
934
|
+
*/
|
|
935
|
+
type?: string;
|
|
936
|
+
/**
|
|
937
|
+
* Filter collections by shop ID
|
|
938
|
+
*/
|
|
939
|
+
shopId?: number;
|
|
940
|
+
}
|
|
941
|
+
/**
|
|
942
|
+
* Parameters for fetching a specific collection.
|
|
943
|
+
*/
|
|
944
|
+
interface CollectionsApiGetParams extends BaseParams {
|
|
945
|
+
/**
|
|
946
|
+
* Unique identifier of the collection
|
|
947
|
+
*/
|
|
948
|
+
collectionId: number;
|
|
949
|
+
}
|
|
950
|
+
//#endregion
|
|
951
|
+
//#region src/api/collections/api.d.ts
|
|
952
|
+
/**
|
|
953
|
+
* API for retrieving curated collections of products.
|
|
954
|
+
*/
|
|
955
|
+
declare class CollectionsApi {
|
|
956
|
+
private http;
|
|
957
|
+
/**
|
|
958
|
+
* Initializes a new instance of the CollectionsApi.
|
|
959
|
+
*
|
|
960
|
+
* @param http HTTP client instance.
|
|
961
|
+
*/
|
|
962
|
+
constructor(http: HttpClient);
|
|
963
|
+
/**
|
|
964
|
+
* Retrieves a list of SKUs belonging to a specific collection with pagination and sorting.
|
|
965
|
+
*
|
|
966
|
+
* @example
|
|
967
|
+
* const skus = await client.collections.getSkus({
|
|
968
|
+
* collectionId: 123,
|
|
969
|
+
* pageSize: 10
|
|
970
|
+
* });
|
|
971
|
+
*/
|
|
972
|
+
getSkus(params: CollectionsApiGetSkusParams): Promise<CollectionsApiGetSkusResponse>;
|
|
973
|
+
/**
|
|
974
|
+
* Retrieves a list of all collections.
|
|
975
|
+
*
|
|
976
|
+
* @example
|
|
977
|
+
* const collections = await client.collections.list();
|
|
978
|
+
*/
|
|
979
|
+
list(params?: CollectionsApiListParams): Promise<CollectionsApiListResponse>;
|
|
980
|
+
/**
|
|
981
|
+
* Retrieves detailed information about a specific collection by its ID.
|
|
982
|
+
*
|
|
983
|
+
* @example
|
|
984
|
+
* const collection = await client.collections.get({
|
|
985
|
+
* collectionId: 123
|
|
986
|
+
* });
|
|
987
|
+
*/
|
|
988
|
+
get(params: CollectionsApiGetParams): Promise<CollectionsApiGetResponse>;
|
|
989
|
+
}
|
|
990
|
+
//#endregion
|
|
991
|
+
//#region src/api/feature-flags/schema-types.d.ts
|
|
992
|
+
/**
|
|
993
|
+
* ⚠️ This file is auto-generated. Do not edit manually.
|
|
994
|
+
* Run `npm run generate:schema-types` to regenerate.
|
|
995
|
+
* Generated from: schemas.ts
|
|
996
|
+
*/
|
|
997
|
+
/**
|
|
998
|
+
* Schema for a feature flag item.
|
|
999
|
+
*/
|
|
1000
|
+
interface FeatureFlagsApiItem {
|
|
1001
|
+
/**
|
|
1002
|
+
* Name of the feature flag
|
|
1003
|
+
*/
|
|
1004
|
+
name: string;
|
|
1005
|
+
/**
|
|
1006
|
+
* Indicates if the feature flag is currently active
|
|
1007
|
+
*/
|
|
1008
|
+
isActive: boolean;
|
|
1009
|
+
}
|
|
1010
|
+
/**
|
|
1011
|
+
* Response schema for the list of feature flags.
|
|
1012
|
+
*/
|
|
1013
|
+
type FeatureFlagsApiListResponse = FeatureFlagsApiItem[];
|
|
1014
|
+
//#endregion
|
|
1015
|
+
//#region src/api/feature-flags/types.d.ts
|
|
1016
|
+
/**
|
|
1017
|
+
* Parameters for fetching feature flags.
|
|
1018
|
+
*/
|
|
1019
|
+
type FeatureFlagsApiListParams = BaseParams;
|
|
1020
|
+
//#endregion
|
|
1021
|
+
//#region src/api/feature-flags/api.d.ts
|
|
1022
|
+
/**
|
|
1023
|
+
* API for retrieving feature flags configuration.
|
|
1024
|
+
*/
|
|
1025
|
+
declare class FeatureFlagsApi {
|
|
1026
|
+
private http;
|
|
1027
|
+
/**
|
|
1028
|
+
* Initializes a new instance of the FeatureFlagsApi.
|
|
1029
|
+
*
|
|
1030
|
+
* @param http HTTP client instance.
|
|
1031
|
+
*/
|
|
1032
|
+
constructor(http: HttpClient);
|
|
1033
|
+
/**
|
|
1034
|
+
* Retrieves all active feature flags.
|
|
1035
|
+
*
|
|
1036
|
+
* @example
|
|
1037
|
+
* const flags = await client.featureFlags.list();
|
|
1038
|
+
*/
|
|
1039
|
+
list(params?: FeatureFlagsApiListParams): Promise<FeatureFlagsApiListResponse>;
|
|
1040
|
+
}
|
|
1041
|
+
//#endregion
|
|
1015
1042
|
//#region src/api/products/types.d.ts
|
|
1016
1043
|
/**
|
|
1017
1044
|
* Parameters for fetching product sort options.
|
|
@@ -1066,7 +1093,7 @@ interface ProductsApiListParams extends BaseParams {
|
|
|
1066
1093
|
/**
|
|
1067
1094
|
* Criteria to sort products by
|
|
1068
1095
|
*/
|
|
1069
|
-
sortBy?:
|
|
1096
|
+
sortBy?: ProductSortKey;
|
|
1070
1097
|
/**
|
|
1071
1098
|
* Filter products by brand ID
|
|
1072
1099
|
*/
|
|
@@ -1087,17 +1114,36 @@ interface ProductsApiListParams extends BaseParams {
|
|
|
1087
1114
|
*/
|
|
1088
1115
|
declare class ProductsApi {
|
|
1089
1116
|
private http;
|
|
1117
|
+
/**
|
|
1118
|
+
* Initializes a new instance of the ProductsApi.
|
|
1119
|
+
*
|
|
1120
|
+
* @param http HTTP client instance.
|
|
1121
|
+
*/
|
|
1090
1122
|
constructor(http: HttpClient);
|
|
1091
1123
|
/**
|
|
1092
1124
|
* Retrieves available sorting options for product lists.
|
|
1125
|
+
*
|
|
1126
|
+
* @example
|
|
1127
|
+
* const sortOptions = await client.products.getSortOptions();
|
|
1093
1128
|
*/
|
|
1094
1129
|
getSortOptions(params?: ProductsApiGetSortOptionsParams): Promise<ProductsApiGetSortOptionsResponse>;
|
|
1095
1130
|
/**
|
|
1096
1131
|
* Retrieves a list of products with optional filtering and pagination.
|
|
1132
|
+
*
|
|
1133
|
+
* @example
|
|
1134
|
+
* const products = await client.products.list({
|
|
1135
|
+
* pageSize: 20,
|
|
1136
|
+
* pageNumber: 1
|
|
1137
|
+
* });
|
|
1097
1138
|
*/
|
|
1098
1139
|
list(params?: ProductsApiListParams): Promise<ProductsApiListResponse>;
|
|
1099
1140
|
/**
|
|
1100
1141
|
* Retrieves reviews for a specific product.
|
|
1142
|
+
*
|
|
1143
|
+
* @example
|
|
1144
|
+
* const reviews = await client.products.getReviews({
|
|
1145
|
+
* productId: 12345
|
|
1146
|
+
* });
|
|
1101
1147
|
*/
|
|
1102
1148
|
getReviews(params: ProductsApiGetReviewsParams): Promise<ProductsApiGetReviewsResponse>;
|
|
1103
1149
|
}
|
|
@@ -1154,9 +1200,17 @@ type PromoApiListParams = BaseParams;
|
|
|
1154
1200
|
*/
|
|
1155
1201
|
declare class PromoApi {
|
|
1156
1202
|
private http;
|
|
1203
|
+
/**
|
|
1204
|
+
* Initializes a new instance of the PromoApi.
|
|
1205
|
+
*
|
|
1206
|
+
* @param http HTTP client instance.
|
|
1207
|
+
*/
|
|
1157
1208
|
constructor(http: HttpClient);
|
|
1158
1209
|
/**
|
|
1159
1210
|
* Retrieves a list of all active promotions.
|
|
1211
|
+
*
|
|
1212
|
+
* @example
|
|
1213
|
+
* const promos = await client.promo.list();
|
|
1160
1214
|
*/
|
|
1161
1215
|
list(params?: PromoApiListParams): Promise<PromoApiListResponse>;
|
|
1162
1216
|
}
|
|
@@ -1498,7 +1552,7 @@ interface ShopsApiGetProductsParams extends BaseParams {
|
|
|
1498
1552
|
/**
|
|
1499
1553
|
* Sorting option for the results
|
|
1500
1554
|
*/
|
|
1501
|
-
sortBy?:
|
|
1555
|
+
sortBy?: ProductSortKey;
|
|
1502
1556
|
/**
|
|
1503
1557
|
* Filter by category ID
|
|
1504
1558
|
*/
|
|
@@ -1523,17 +1577,36 @@ interface ShopsApiGetProductsParams extends BaseParams {
|
|
|
1523
1577
|
*/
|
|
1524
1578
|
declare class ShopsApi {
|
|
1525
1579
|
private http;
|
|
1580
|
+
/**
|
|
1581
|
+
* Initializes a new instance of the ShopsApi.
|
|
1582
|
+
*
|
|
1583
|
+
* @param http HTTP client instance.
|
|
1584
|
+
*/
|
|
1526
1585
|
constructor(http: HttpClient);
|
|
1527
1586
|
/**
|
|
1528
1587
|
* Retrieves details of a specific shop.
|
|
1588
|
+
*
|
|
1589
|
+
* @example
|
|
1590
|
+
* const shop = await client.shops.get({
|
|
1591
|
+
* shopId: 123
|
|
1592
|
+
* });
|
|
1529
1593
|
*/
|
|
1530
1594
|
get(params: ShopsApiGetParams): Promise<ShopsApiGetResponse>;
|
|
1531
1595
|
/**
|
|
1532
1596
|
* Retrieves monobrand shop details.
|
|
1597
|
+
*
|
|
1598
|
+
* @example
|
|
1599
|
+
* const monobrand = await client.shops.getMonobrand();
|
|
1533
1600
|
*/
|
|
1534
1601
|
getMonobrand(params?: ShopsApiGetMonobrandParams): Promise<ShopsApiGetMonobrandResponse>;
|
|
1535
1602
|
/**
|
|
1536
1603
|
* Retrieves products for a specific shop.
|
|
1604
|
+
*
|
|
1605
|
+
* @example
|
|
1606
|
+
* const shopProducts = await client.shops.getProducts({
|
|
1607
|
+
* shopId: 123,
|
|
1608
|
+
* pageSize: 10
|
|
1609
|
+
* });
|
|
1537
1610
|
*/
|
|
1538
1611
|
getProducts(params: ShopsApiGetProductsParams): Promise<ShopsApiGetProductsResponse>;
|
|
1539
1612
|
}
|
|
@@ -2027,21 +2100,46 @@ interface SkuApiGetReviewAvailableParams extends BaseParams {
|
|
|
2027
2100
|
*/
|
|
2028
2101
|
declare class SkuApi {
|
|
2029
2102
|
private http;
|
|
2103
|
+
/**
|
|
2104
|
+
* Initializes a new instance of the SkuApi.
|
|
2105
|
+
*
|
|
2106
|
+
* @param http HTTP client instance.
|
|
2107
|
+
*/
|
|
2030
2108
|
constructor(http: HttpClient);
|
|
2031
2109
|
/**
|
|
2032
2110
|
* Retrieves details of a specific SKU.
|
|
2111
|
+
*
|
|
2112
|
+
* @example
|
|
2113
|
+
* const sku = await client.sku.get({
|
|
2114
|
+
* skuId: 123
|
|
2115
|
+
* });
|
|
2033
2116
|
*/
|
|
2034
2117
|
get(params: SkuApiGetParams): Promise<SkuApiGetResponse>;
|
|
2035
2118
|
/**
|
|
2036
2119
|
* Retrieves similar SKUs.
|
|
2120
|
+
*
|
|
2121
|
+
* @example
|
|
2122
|
+
* const similar = await client.sku.getSimilar({
|
|
2123
|
+
* skuId: 123
|
|
2124
|
+
* });
|
|
2037
2125
|
*/
|
|
2038
2126
|
getSimilar(params: SkuApiGetSimilarParams): Promise<SkuApiGetSimilarResponse>;
|
|
2039
2127
|
/**
|
|
2040
2128
|
* Retrieves collections associated with a SKU.
|
|
2129
|
+
*
|
|
2130
|
+
* @example
|
|
2131
|
+
* const collections = await client.sku.getCollections({
|
|
2132
|
+
* skuId: 123
|
|
2133
|
+
* });
|
|
2041
2134
|
*/
|
|
2042
2135
|
getCollections(params: SkuApiGetCollectionsParams): Promise<SkuApiGetCollectionsResponse>;
|
|
2043
2136
|
/**
|
|
2044
2137
|
* Checks if a review is available for a SKU.
|
|
2138
|
+
*
|
|
2139
|
+
* @example
|
|
2140
|
+
* const isAvailable = await client.sku.getReviewAvailable({
|
|
2141
|
+
* skuId: 123
|
|
2142
|
+
* });
|
|
2045
2143
|
*/
|
|
2046
2144
|
getReviewAvailable(params: SkuApiGetReviewAvailableParams): Promise<SkuApiGetReviewAvailableResponse>;
|
|
2047
2145
|
}
|
|
@@ -2049,6 +2147,12 @@ declare class SkuApi {
|
|
|
2049
2147
|
//#region src/client.d.ts
|
|
2050
2148
|
/**
|
|
2051
2149
|
* Main client for interacting with the Teez B2C API.
|
|
2150
|
+
*
|
|
2151
|
+
* @example
|
|
2152
|
+
* const client = new TeezClient({
|
|
2153
|
+
* language: "ru",
|
|
2154
|
+
* timeout: 10000
|
|
2155
|
+
* });
|
|
2052
2156
|
*/
|
|
2053
2157
|
declare class TeezClient {
|
|
2054
2158
|
/**
|
|
@@ -2091,6 +2195,11 @@ declare class TeezClient {
|
|
|
2091
2195
|
* API for retrieving SKU details.
|
|
2092
2196
|
*/
|
|
2093
2197
|
readonly sku: SkuApi;
|
|
2198
|
+
/**
|
|
2199
|
+
* Initializes a new instance of the TeezClient.
|
|
2200
|
+
*
|
|
2201
|
+
* @param config Optional client configuration.
|
|
2202
|
+
*/
|
|
2094
2203
|
constructor(config?: TeezClientConfig);
|
|
2095
2204
|
/**
|
|
2096
2205
|
* Returns the current client configuration.
|
|
@@ -4490,5 +4599,5 @@ declare const FeatureFlagsApiListResponseSchema: z.ZodMiniArray<z.ZodMiniObject<
|
|
|
4490
4599
|
isActive: z.ZodMiniBoolean<boolean>;
|
|
4491
4600
|
}, z.core.$strip>>;
|
|
4492
4601
|
//#endregion
|
|
4493
|
-
export { BASE_URL, BannerActionTypes, BannerActionTypesSchema, BannerImageType, BannerImageTypeSchema, BannersApi, BannersApiAction, BannersApiActionSchema, BannersApiBannerItem, BannersApiBannerItemSchema, BannersApiImage, BannersApiImageSchema, BannersApiListParams, BannersApiListResponse, BannersApiListResponseSchema, BaseParams, CategoriesApi, CategoriesApiGetParams, CategoriesApiGetParentsParams, CategoriesApiGetParentsResponse, CategoriesApiGetParentsResponseItem, CategoriesApiGetParentsResponseItemSchema, CategoriesApiGetParentsResponseSchema, CategoriesApiGetResponse, CategoriesApiGetResponseSchema, CategoriesApiListParams, CategoriesApiListResponse, CategoriesApiListResponseItem, CategoriesApiListResponseItemSchema, CategoriesApiListResponseSchema, CollectionType, CollectionTypeSchema, CollectionsApi, CollectionsApiGetParams, CollectionsApiGetResponse, CollectionsApiGetResponseSchema, CollectionsApiGetSkusParams, CollectionsApiGetSkusResponse, CollectionsApiGetSkusResponseSchema, CollectionsApiListItem, CollectionsApiListItemSchema, CollectionsApiListParams, CollectionsApiListResponse, CollectionsApiListResponseSchema, CollectionsApiSkuItem, CollectionsApiSkuItemSchema, CollectionsApiStockAvailability, CollectionsApiStockAvailabilitySchema, CollectionsStockAvailabilityType, CollectionsStockAvailabilityTypeSchema, DEFAULT_APP_VERSION, DEFAULT_CONFIG, FeatureFlagsApi, FeatureFlagsApiItem, FeatureFlagsApiItemSchema, FeatureFlagsApiListParams, FeatureFlagsApiListResponse, FeatureFlagsApiListResponseSchema, LANGUAGES, Language, ProductSortKey, ProductSortKeySchema, ProductsApi, ProductsApiBadge, ProductsApiBadgeSchema, ProductsApiGetReviewsParams, ProductsApiGetReviewsResponse, ProductsApiGetReviewsResponseSchema, ProductsApiGetSortOptionsParams, ProductsApiGetSortOptionsResponse, ProductsApiGetSortOptionsResponseSchema, ProductsApiListParams, ProductsApiListResponse, ProductsApiListResponseSchema, ProductsApiProductItem, ProductsApiProductItemSchema, ProductsApiReviewItem, ProductsApiReviewItemSchema, ProductsApiSortOption, ProductsApiSortOptionSchema, ProductsApiStockAvailability, ProductsApiStockAvailabilitySchema, ProductsStockAvailabilityType, ProductsStockAvailabilityTypeSchema, PromoApi, PromoApiItem, PromoApiItemSchema, PromoApiListParams, PromoApiListResponse, PromoApiListResponseSchema, ResolvedTeezClientConfig,
|
|
4602
|
+
export { BASE_URL, BannerActionTypes, BannerActionTypesSchema, BannerImageType, BannerImageTypeSchema, BannersApi, BannersApiAction, BannersApiActionSchema, BannersApiBannerItem, BannersApiBannerItemSchema, BannersApiImage, BannersApiImageSchema, BannersApiListParams, BannersApiListResponse, BannersApiListResponseSchema, BaseParams, CategoriesApi, CategoriesApiGetParams, CategoriesApiGetParentsParams, CategoriesApiGetParentsResponse, CategoriesApiGetParentsResponseItem, CategoriesApiGetParentsResponseItemSchema, CategoriesApiGetParentsResponseSchema, CategoriesApiGetResponse, CategoriesApiGetResponseSchema, CategoriesApiListParams, CategoriesApiListResponse, CategoriesApiListResponseItem, CategoriesApiListResponseItemSchema, CategoriesApiListResponseSchema, CollectionType, CollectionTypeSchema, CollectionsApi, CollectionsApiGetParams, CollectionsApiGetResponse, CollectionsApiGetResponseSchema, CollectionsApiGetSkusParams, CollectionsApiGetSkusResponse, CollectionsApiGetSkusResponseSchema, CollectionsApiListItem, CollectionsApiListItemSchema, CollectionsApiListParams, CollectionsApiListResponse, CollectionsApiListResponseSchema, CollectionsApiSkuItem, CollectionsApiSkuItemSchema, CollectionsApiStockAvailability, CollectionsApiStockAvailabilitySchema, CollectionsStockAvailabilityType, CollectionsStockAvailabilityTypeSchema, DEFAULT_APP_VERSION, DEFAULT_CONFIG, FeatureFlagsApi, FeatureFlagsApiItem, FeatureFlagsApiItemSchema, FeatureFlagsApiListParams, FeatureFlagsApiListResponse, FeatureFlagsApiListResponseSchema, LANGUAGES, Language, ProductSortKey, ProductSortKeySchema, ProductsApi, ProductsApiBadge, ProductsApiBadgeSchema, ProductsApiGetReviewsParams, ProductsApiGetReviewsResponse, ProductsApiGetReviewsResponseSchema, ProductsApiGetSortOptionsParams, ProductsApiGetSortOptionsResponse, ProductsApiGetSortOptionsResponseSchema, ProductsApiListParams, ProductsApiListResponse, ProductsApiListResponseSchema, ProductsApiProductItem, ProductsApiProductItemSchema, ProductsApiReviewItem, ProductsApiReviewItemSchema, ProductsApiSortOption, ProductsApiSortOptionSchema, ProductsApiStockAvailability, ProductsApiStockAvailabilitySchema, ProductsStockAvailabilityType, ProductsStockAvailabilityTypeSchema, PromoApi, PromoApiItem, PromoApiItemSchema, PromoApiListParams, PromoApiListResponse, PromoApiListResponseSchema, ResolvedTeezClientConfig, ShopsApi, ShopsApiContactInfo, ShopsApiContactInfoSchema, ShopsApiGetMonobrandParams, ShopsApiGetMonobrandResponse, ShopsApiGetMonobrandResponseSchema, ShopsApiGetParams, ShopsApiGetProductsParams, ShopsApiGetProductsResponse, ShopsApiGetProductsResponseSchema, ShopsApiGetResponse, ShopsApiGetResponseSchema, ShopsApiProductItem, ShopsApiProductItemSchema, ShopsApiShopItem, ShopsApiShopItemSchema, ShopsApiStockAvailability, ShopsApiStockAvailabilitySchema, ShopsApiTag, ShopsApiTagSchema, ShopsStockAvailabilityType, ShopsStockAvailabilityTypeSchema, SkuApi, SkuApiAttribute, SkuApiAttributeProperty, SkuApiAttributePropertySchema, SkuApiAttributePropertyValue, SkuApiAttributePropertyValueSchema, SkuApiAttributeSchema, SkuApiBrand, SkuApiBrandSchema, SkuApiCategory, SkuApiCategorySchema, SkuApiCollectionItem, SkuApiCollectionItemSchema, SkuApiGetCollectionsParams, SkuApiGetCollectionsResponse, SkuApiGetCollectionsResponseSchema, SkuApiGetParams, SkuApiGetResponse, SkuApiGetResponseSchema, SkuApiGetReviewAvailableParams, SkuApiGetReviewAvailableResponse, SkuApiGetReviewAvailableResponseSchema, SkuApiGetSimilarParams, SkuApiGetSimilarResponse, SkuApiGetSimilarResponseSchema, SkuApiInstallment, SkuApiInstallmentSchema, SkuApiShop, SkuApiShopSchema, SkuApiSimilarItem, SkuApiSimilarItemSchema, SkuApiStockAvailability, SkuApiStockAvailabilitySchema, SkuApiTag, SkuApiTagSchema, SkuStockAvailabilityType, SkuStockAvailabilityTypeSchema, TeezApiError, TeezApiErrorOptions, TeezClient, TeezClientConfig, TeezError, TeezNetworkError, TeezNetworkErrorOptions, TeezTimeoutError, TeezTimeoutErrorOptions, TeezValidationError, TeezValidationErrorOptions, TeezValidationIssue, buildHeaders, buildUserAgent, resolveConfig };
|
|
4494
4603
|
//# sourceMappingURL=index.d.mts.map
|