@teez-sdk/teez-b2c-api 1.0.1 → 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/dist/index.d.cts 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
  /**
@@ -682,142 +649,6 @@ interface CollectionsApiGetResponse {
682
649
  priority: number;
683
650
  }
684
651
  //#endregion
685
- //#region src/api/collections/types.d.ts
686
- /**
687
- * Parameters for fetching SKUs from a collection.
688
- */
689
- interface CollectionsApiGetSkusParams extends BaseParams {
690
- /**
691
- * Number of the page to retrieve
692
- */
693
- pageNumber?: number;
694
- /**
695
- * Number of items per page
696
- */
697
- pageSize?: number;
698
- /**
699
- * Unique identifier of the collection
700
- */
701
- collectionId: number;
702
- /**
703
- * Sorting option for the results
704
- */
705
- sortBy?: SortOption;
706
- }
707
- /**
708
- * Parameters for fetching the list of collections.
709
- */
710
- interface CollectionsApiListParams extends BaseParams {
711
- /**
712
- * Type of collections to filter by
713
- */
714
- type?: string;
715
- /**
716
- * Filter collections by shop ID
717
- */
718
- shopId?: number;
719
- }
720
- /**
721
- * Parameters for fetching a specific collection.
722
- */
723
- interface CollectionsApiGetParams extends BaseParams {
724
- /**
725
- * Unique identifier of the collection
726
- */
727
- collectionId: number;
728
- }
729
- //#endregion
730
- //#region src/api/collections/api.d.ts
731
- /**
732
- * API for retrieving curated collections of products.
733
- */
734
- declare class CollectionsApi {
735
- private http;
736
- /**
737
- * Initializes a new instance of the CollectionsApi.
738
- *
739
- * @param http HTTP client instance.
740
- */
741
- constructor(http: HttpClient);
742
- /**
743
- * Retrieves a list of SKUs belonging to a specific collection with pagination and sorting.
744
- *
745
- * @example
746
- * const skus = await client.collections.getSkus({
747
- * collectionId: 123,
748
- * pageSize: 10
749
- * });
750
- */
751
- getSkus(params: CollectionsApiGetSkusParams): Promise<CollectionsApiGetSkusResponse>;
752
- /**
753
- * Retrieves a list of all collections.
754
- *
755
- * @example
756
- * const collections = await client.collections.list();
757
- */
758
- list(params?: CollectionsApiListParams): Promise<CollectionsApiListResponse>;
759
- /**
760
- * Retrieves detailed information about a specific collection by its ID.
761
- *
762
- * @example
763
- * const collection = await client.collections.get({
764
- * collectionId: 123
765
- * });
766
- */
767
- get(params: CollectionsApiGetParams): Promise<CollectionsApiGetResponse>;
768
- }
769
- //#endregion
770
- //#region src/api/feature-flags/schema-types.d.ts
771
- /**
772
- * ⚠️ This file is auto-generated. Do not edit manually.
773
- * Run `npm run generate:schema-types` to regenerate.
774
- * Generated from: schemas.ts
775
- */
776
- /**
777
- * Schema for a feature flag item.
778
- */
779
- interface FeatureFlagsApiItem {
780
- /**
781
- * Name of the feature flag
782
- */
783
- name: string;
784
- /**
785
- * Indicates if the feature flag is currently active
786
- */
787
- isActive: boolean;
788
- }
789
- /**
790
- * Response schema for the list of feature flags.
791
- */
792
- type FeatureFlagsApiListResponse = FeatureFlagsApiItem[];
793
- //#endregion
794
- //#region src/api/feature-flags/types.d.ts
795
- /**
796
- * Parameters for fetching feature flags.
797
- */
798
- type FeatureFlagsApiListParams = BaseParams;
799
- //#endregion
800
- //#region src/api/feature-flags/api.d.ts
801
- /**
802
- * API for retrieving feature flags configuration.
803
- */
804
- declare class FeatureFlagsApi {
805
- private http;
806
- /**
807
- * Initializes a new instance of the FeatureFlagsApi.
808
- *
809
- * @param http HTTP client instance.
810
- */
811
- constructor(http: HttpClient);
812
- /**
813
- * Retrieves all active feature flags.
814
- *
815
- * @example
816
- * const flags = await client.featureFlags.list();
817
- */
818
- list(params?: FeatureFlagsApiListParams): Promise<FeatureFlagsApiListResponse>;
819
- }
820
- //#endregion
821
652
  //#region src/api/products/schema-types.d.ts
822
653
  /**
823
654
  * ⚠️ This file is auto-generated. Do not edit manually.
@@ -1072,6 +903,142 @@ interface ProductsApiListResponse {
1072
903
  hasNextPage: boolean;
1073
904
  }
1074
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
1075
1042
  //#region src/api/products/types.d.ts
1076
1043
  /**
1077
1044
  * Parameters for fetching product sort options.
@@ -1126,7 +1093,7 @@ interface ProductsApiListParams extends BaseParams {
1126
1093
  /**
1127
1094
  * Criteria to sort products by
1128
1095
  */
1129
- sortBy?: SortOption;
1096
+ sortBy?: ProductSortKey;
1130
1097
  /**
1131
1098
  * Filter products by brand ID
1132
1099
  */
@@ -1585,7 +1552,7 @@ interface ShopsApiGetProductsParams extends BaseParams {
1585
1552
  /**
1586
1553
  * Sorting option for the results
1587
1554
  */
1588
- sortBy?: SortOption;
1555
+ sortBy?: ProductSortKey;
1589
1556
  /**
1590
1557
  * Filter by category ID
1591
1558
  */
@@ -4632,5 +4599,5 @@ declare const FeatureFlagsApiListResponseSchema: z.ZodMiniArray<z.ZodMiniObject<
4632
4599
  isActive: z.ZodMiniBoolean<boolean>;
4633
4600
  }, z.core.$strip>>;
4634
4601
  //#endregion
4635
- 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, SORT_OPTIONS, 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, SortOption, TeezApiError, TeezApiErrorOptions, TeezClient, TeezClientConfig, TeezError, TeezNetworkError, TeezNetworkErrorOptions, TeezTimeoutError, TeezTimeoutErrorOptions, TeezValidationError, TeezValidationErrorOptions, TeezValidationIssue, buildHeaders, buildUserAgent, resolveConfig };
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 };
4636
4603
  //# sourceMappingURL=index.d.cts.map