ce-storefront 0.13.1 → 0.13.2

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.
Files changed (85) hide show
  1. package/FUNCTIONS.md +5 -22
  2. package/README.md +44 -58
  3. package/docs/sdks/auth/README.md +50 -90
  4. package/docs/sdks/carts/README.md +60 -108
  5. package/docs/sdks/catalog/README.md +55 -99
  6. package/docs/sdks/common/README.md +5 -9
  7. package/docs/sdks/customers/README.md +35 -63
  8. package/docs/sdks/orders/README.md +35 -63
  9. package/docs/sdks/shipping/README.md +5 -9
  10. package/esm/funcs/catalogGetProductDetail.js +2 -5
  11. package/esm/funcs/catalogGetProductDetail.js.map +1 -1
  12. package/esm/funcs/catalogGetVariantDetail.js +2 -5
  13. package/esm/funcs/catalogGetVariantDetail.js.map +1 -1
  14. package/esm/funcs/catalogListCrosssellProducts.js +2 -1
  15. package/esm/funcs/catalogListCrosssellProducts.js.map +1 -1
  16. package/esm/funcs/catalogListProductVariants.js +2 -5
  17. package/esm/funcs/catalogListProductVariants.js.map +1 -1
  18. package/esm/funcs/catalogListProducts.js +2 -2
  19. package/esm/funcs/catalogListProducts.js.map +1 -1
  20. package/esm/funcs/catalogListSimilarProducts.js +2 -1
  21. package/esm/funcs/catalogListSimilarProducts.js.map +1 -1
  22. package/esm/funcs/catalogListSkus.js +2 -2
  23. package/esm/funcs/catalogListSkus.js.map +1 -1
  24. package/esm/funcs/catalogListUpsellProducts.js +2 -1
  25. package/esm/funcs/catalogListUpsellProducts.js.map +1 -1
  26. package/esm/index.d.ts +2 -0
  27. package/esm/index.d.ts.map +1 -1
  28. package/esm/index.js +1 -0
  29. package/esm/index.js.map +1 -1
  30. package/esm/lib/config.d.ts +3 -3
  31. package/esm/lib/config.js +3 -3
  32. package/esm/models/errors/ceerror.d.ts +14 -2
  33. package/esm/models/errors/ceerror.d.ts.map +1 -1
  34. package/esm/models/errors/ceerror.js +1 -1
  35. package/esm/models/errors/ceerror.js.map +1 -1
  36. package/esm/models/operations/getproductdetail.d.ts +5 -5
  37. package/esm/models/operations/getproductdetail.d.ts.map +1 -1
  38. package/esm/models/operations/getproductdetail.js +4 -4
  39. package/esm/models/operations/getproductdetail.js.map +1 -1
  40. package/esm/models/operations/getvariantdetail.d.ts +5 -5
  41. package/esm/models/operations/getvariantdetail.d.ts.map +1 -1
  42. package/esm/models/operations/getvariantdetail.js +4 -4
  43. package/esm/models/operations/getvariantdetail.js.map +1 -1
  44. package/esm/models/operations/listcrosssellproducts.d.ts +5 -0
  45. package/esm/models/operations/listcrosssellproducts.d.ts.map +1 -1
  46. package/esm/models/operations/listcrosssellproducts.js +4 -0
  47. package/esm/models/operations/listcrosssellproducts.js.map +1 -1
  48. package/esm/models/operations/listproducts.d.ts +1 -1
  49. package/esm/models/operations/listproductvariants.d.ts +5 -5
  50. package/esm/models/operations/listproductvariants.d.ts.map +1 -1
  51. package/esm/models/operations/listproductvariants.js +4 -4
  52. package/esm/models/operations/listproductvariants.js.map +1 -1
  53. package/esm/models/operations/listsimilarproducts.d.ts +5 -0
  54. package/esm/models/operations/listsimilarproducts.d.ts.map +1 -1
  55. package/esm/models/operations/listsimilarproducts.js +4 -0
  56. package/esm/models/operations/listsimilarproducts.js.map +1 -1
  57. package/esm/models/operations/listskus.d.ts +5 -5
  58. package/esm/models/operations/listskus.d.ts.map +1 -1
  59. package/esm/models/operations/listskus.js +2 -2
  60. package/esm/models/operations/listskus.js.map +1 -1
  61. package/esm/models/operations/listupsellproducts.d.ts +5 -0
  62. package/esm/models/operations/listupsellproducts.d.ts.map +1 -1
  63. package/esm/models/operations/listupsellproducts.js +4 -0
  64. package/esm/models/operations/listupsellproducts.js.map +1 -1
  65. package/jsr.json +1 -1
  66. package/package.json +1 -1
  67. package/src/funcs/catalogGetProductDetail.ts +6 -6
  68. package/src/funcs/catalogGetVariantDetail.ts +6 -6
  69. package/src/funcs/catalogListCrosssellProducts.ts +6 -1
  70. package/src/funcs/catalogListProductVariants.ts +6 -6
  71. package/src/funcs/catalogListProducts.ts +6 -2
  72. package/src/funcs/catalogListSimilarProducts.ts +6 -1
  73. package/src/funcs/catalogListSkus.ts +6 -2
  74. package/src/funcs/catalogListUpsellProducts.ts +6 -1
  75. package/src/index.ts +2 -0
  76. package/src/lib/config.ts +3 -3
  77. package/src/models/errors/ceerror.ts +18 -3
  78. package/src/models/operations/getproductdetail.ts +9 -9
  79. package/src/models/operations/getvariantdetail.ts +9 -9
  80. package/src/models/operations/listcrosssellproducts.ts +9 -0
  81. package/src/models/operations/listproducts.ts +1 -1
  82. package/src/models/operations/listproductvariants.ts +9 -9
  83. package/src/models/operations/listsimilarproducts.ts +9 -0
  84. package/src/models/operations/listskus.ts +7 -7
  85. package/src/models/operations/listupsellproducts.ts +9 -0
@@ -10,10 +10,6 @@ import * as components from "../components/index.js";
10
10
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
11
 
12
12
  export type GetVariantDetailRequest = {
13
- /**
14
- * use this param only if different pricing is configured as per customer group
15
- */
16
- customerGroupId?: string | undefined;
17
13
  /**
18
14
  * product id
19
15
  */
@@ -22,6 +18,10 @@ export type GetVariantDetailRequest = {
22
18
  * variant id
23
19
  */
24
20
  variantId: string;
21
+ /**
22
+ * The customer_group_id is used to determine product pricing, promotions, and subscription rates. If a valid customer_group_id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id. If no data is found for the default group either, the highest applicable price will be returned.
23
+ */
24
+ customerGroupId?: string | undefined;
25
25
  };
26
26
 
27
27
  export type GetVariantDetailContent = {
@@ -43,22 +43,22 @@ export const GetVariantDetailRequest$inboundSchema: z.ZodType<
43
43
  z.ZodTypeDef,
44
44
  unknown
45
45
  > = z.object({
46
- customer_group_id: z.string().optional(),
47
46
  product_id: z.string(),
48
47
  variant_id: z.string(),
48
+ customer_group_id: z.string().optional(),
49
49
  }).transform((v) => {
50
50
  return remap$(v, {
51
- "customer_group_id": "customerGroupId",
52
51
  "product_id": "productId",
53
52
  "variant_id": "variantId",
53
+ "customer_group_id": "customerGroupId",
54
54
  });
55
55
  });
56
56
 
57
57
  /** @internal */
58
58
  export type GetVariantDetailRequest$Outbound = {
59
- customer_group_id?: string | undefined;
60
59
  product_id: string;
61
60
  variant_id: string;
61
+ customer_group_id?: string | undefined;
62
62
  };
63
63
 
64
64
  /** @internal */
@@ -67,14 +67,14 @@ export const GetVariantDetailRequest$outboundSchema: z.ZodType<
67
67
  z.ZodTypeDef,
68
68
  GetVariantDetailRequest
69
69
  > = z.object({
70
- customerGroupId: z.string().optional(),
71
70
  productId: z.string(),
72
71
  variantId: z.string(),
72
+ customerGroupId: z.string().optional(),
73
73
  }).transform((v) => {
74
74
  return remap$(v, {
75
- customerGroupId: "customer_group_id",
76
75
  productId: "product_id",
77
76
  variantId: "variant_id",
77
+ customerGroupId: "customer_group_id",
78
78
  });
79
79
  });
80
80
 
@@ -26,6 +26,10 @@ export type ListCrosssellProductsRequest = {
26
26
  * json to sort records
27
27
  */
28
28
  sortBy?: string | undefined;
29
+ /**
30
+ * The customer_group_id is used to determine product pricing, promotions, and subscription rates. If a valid customer_group_id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id. If no data is found for the default group either, the highest applicable price will be returned.
31
+ */
32
+ customerGroupId?: string | undefined;
29
33
  };
30
34
 
31
35
  export type ListCrosssellProductsContent = {
@@ -55,10 +59,12 @@ export const ListCrosssellProductsRequest$inboundSchema: z.ZodType<
55
59
  page: z.number().int().optional(),
56
60
  limit: z.number().int().optional(),
57
61
  sort_by: z.string().optional(),
62
+ customer_group_id: z.string().optional(),
58
63
  }).transform((v) => {
59
64
  return remap$(v, {
60
65
  "product_id": "productId",
61
66
  "sort_by": "sortBy",
67
+ "customer_group_id": "customerGroupId",
62
68
  });
63
69
  });
64
70
 
@@ -68,6 +74,7 @@ export type ListCrosssellProductsRequest$Outbound = {
68
74
  page?: number | undefined;
69
75
  limit?: number | undefined;
70
76
  sort_by?: string | undefined;
77
+ customer_group_id?: string | undefined;
71
78
  };
72
79
 
73
80
  /** @internal */
@@ -80,10 +87,12 @@ export const ListCrosssellProductsRequest$outboundSchema: z.ZodType<
80
87
  page: z.number().int().optional(),
81
88
  limit: z.number().int().optional(),
82
89
  sortBy: z.string().optional(),
90
+ customerGroupId: z.string().optional(),
83
91
  }).transform((v) => {
84
92
  return remap$(v, {
85
93
  productId: "product_id",
86
94
  sortBy: "sort_by",
95
+ customerGroupId: "customer_group_id",
87
96
  });
88
97
  });
89
98
 
@@ -27,7 +27,7 @@ export type ListProductsRequest = {
27
27
  */
28
28
  categoryId?: Array<string> | undefined;
29
29
  /**
30
- * use this param only if different pricing is configured as per customer group
30
+ * The customer_group_id is used to determine product pricing, promotions, and subscription rates. If a valid customer_group_id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id. If no data is found for the default group either, the highest applicable price will be returned.
31
31
  */
32
32
  customerGroupId?: string | undefined;
33
33
  };
@@ -10,14 +10,14 @@ import * as components from "../components/index.js";
10
10
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
11
 
12
12
  export type ListProductVariantsRequest = {
13
- /**
14
- * use this param only if different pricing is configured as per customer group
15
- */
16
- customerGroupId?: string | undefined;
17
13
  /**
18
14
  * ID of a particular product
19
15
  */
20
16
  productId: string;
17
+ /**
18
+ * The customer_group_id is used to determine product pricing, promotions, and subscription rates. If a valid customer_group_id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id. If no data is found for the default group either, the highest applicable price will be returned.
19
+ */
20
+ customerGroupId?: string | undefined;
21
21
  };
22
22
 
23
23
  export type ListProductVariantsContent = {
@@ -39,19 +39,19 @@ export const ListProductVariantsRequest$inboundSchema: z.ZodType<
39
39
  z.ZodTypeDef,
40
40
  unknown
41
41
  > = z.object({
42
- customer_group_id: z.string().optional(),
43
42
  product_id: z.string(),
43
+ customer_group_id: z.string().optional(),
44
44
  }).transform((v) => {
45
45
  return remap$(v, {
46
- "customer_group_id": "customerGroupId",
47
46
  "product_id": "productId",
47
+ "customer_group_id": "customerGroupId",
48
48
  });
49
49
  });
50
50
 
51
51
  /** @internal */
52
52
  export type ListProductVariantsRequest$Outbound = {
53
- customer_group_id?: string | undefined;
54
53
  product_id: string;
54
+ customer_group_id?: string | undefined;
55
55
  };
56
56
 
57
57
  /** @internal */
@@ -60,12 +60,12 @@ export const ListProductVariantsRequest$outboundSchema: z.ZodType<
60
60
  z.ZodTypeDef,
61
61
  ListProductVariantsRequest
62
62
  > = z.object({
63
- customerGroupId: z.string().optional(),
64
63
  productId: z.string(),
64
+ customerGroupId: z.string().optional(),
65
65
  }).transform((v) => {
66
66
  return remap$(v, {
67
- customerGroupId: "customer_group_id",
68
67
  productId: "product_id",
68
+ customerGroupId: "customer_group_id",
69
69
  });
70
70
  });
71
71
 
@@ -26,6 +26,10 @@ export type ListSimilarProductsRequest = {
26
26
  * json to sort records
27
27
  */
28
28
  sortBy?: string | undefined;
29
+ /**
30
+ * The customer_group_id is used to determine product pricing, promotions, and subscription rates. If a valid customer_group_id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id. If no data is found for the default group either, the highest applicable price will be returned.
31
+ */
32
+ customerGroupId?: string | undefined;
29
33
  };
30
34
 
31
35
  export type ListSimilarProductsContent = {
@@ -55,10 +59,12 @@ export const ListSimilarProductsRequest$inboundSchema: z.ZodType<
55
59
  page: z.number().int().optional(),
56
60
  limit: z.number().int().optional(),
57
61
  sort_by: z.string().optional(),
62
+ customer_group_id: z.string().optional(),
58
63
  }).transform((v) => {
59
64
  return remap$(v, {
60
65
  "product_id": "productId",
61
66
  "sort_by": "sortBy",
67
+ "customer_group_id": "customerGroupId",
62
68
  });
63
69
  });
64
70
 
@@ -68,6 +74,7 @@ export type ListSimilarProductsRequest$Outbound = {
68
74
  page?: number | undefined;
69
75
  limit?: number | undefined;
70
76
  sort_by?: string | undefined;
77
+ customer_group_id?: string | undefined;
71
78
  };
72
79
 
73
80
  /** @internal */
@@ -80,10 +87,12 @@ export const ListSimilarProductsRequest$outboundSchema: z.ZodType<
80
87
  page: z.number().int().optional(),
81
88
  limit: z.number().int().optional(),
82
89
  sortBy: z.string().optional(),
90
+ customerGroupId: z.string().optional(),
83
91
  }).transform((v) => {
84
92
  return remap$(v, {
85
93
  productId: "product_id",
86
94
  sortBy: "sort_by",
95
+ customerGroupId: "customer_group_id",
87
96
  });
88
97
  });
89
98
 
@@ -26,14 +26,14 @@ export type ListSkusRequest = {
26
26
  * filter sku by categories
27
27
  */
28
28
  categoryId?: Array<string> | undefined;
29
- /**
30
- * use this param only if different pricing is configured as per customer group
31
- */
32
- customerGroupId?: string | undefined;
33
29
  /**
34
30
  * array of sku
35
31
  */
36
32
  sku?: Array<string> | undefined;
33
+ /**
34
+ * The customer_group_id is used to determine product pricing, promotions, and subscription rates. If a valid customer_group_id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id. If no data is found for the default group either, the highest applicable price will be returned.
35
+ */
36
+ customerGroupId?: string | undefined;
37
37
  };
38
38
 
39
39
  export type ListSkusContent = {
@@ -63,8 +63,8 @@ export const ListSkusRequest$inboundSchema: z.ZodType<
63
63
  limit: z.number().int().optional(),
64
64
  sort_by: z.string().optional(),
65
65
  category_id: z.array(z.string()).optional(),
66
- customer_group_id: z.string().optional(),
67
66
  sku: z.array(z.string()).optional(),
67
+ customer_group_id: z.string().optional(),
68
68
  }).transform((v) => {
69
69
  return remap$(v, {
70
70
  "sort_by": "sortBy",
@@ -79,8 +79,8 @@ export type ListSkusRequest$Outbound = {
79
79
  limit?: number | undefined;
80
80
  sort_by?: string | undefined;
81
81
  category_id?: Array<string> | undefined;
82
- customer_group_id?: string | undefined;
83
82
  sku?: Array<string> | undefined;
83
+ customer_group_id?: string | undefined;
84
84
  };
85
85
 
86
86
  /** @internal */
@@ -93,8 +93,8 @@ export const ListSkusRequest$outboundSchema: z.ZodType<
93
93
  limit: z.number().int().optional(),
94
94
  sortBy: z.string().optional(),
95
95
  categoryId: z.array(z.string()).optional(),
96
- customerGroupId: z.string().optional(),
97
96
  sku: z.array(z.string()).optional(),
97
+ customerGroupId: z.string().optional(),
98
98
  }).transform((v) => {
99
99
  return remap$(v, {
100
100
  sortBy: "sort_by",
@@ -26,6 +26,10 @@ export type ListUpsellProductsRequest = {
26
26
  * json to sort records
27
27
  */
28
28
  sortBy?: string | undefined;
29
+ /**
30
+ * The customer_group_id is used to determine product pricing, promotions, and subscription rates. If a valid customer_group_id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id. If no data is found for the default group either, the highest applicable price will be returned.
31
+ */
32
+ customerGroupId?: string | undefined;
29
33
  };
30
34
 
31
35
  export type ListUpsellProductsContent = {
@@ -58,10 +62,12 @@ export const ListUpsellProductsRequest$inboundSchema: z.ZodType<
58
62
  page: z.number().int().optional(),
59
63
  limit: z.number().int().optional(),
60
64
  sort_by: z.string().optional(),
65
+ customer_group_id: z.string().optional(),
61
66
  }).transform((v) => {
62
67
  return remap$(v, {
63
68
  "product_id": "productId",
64
69
  "sort_by": "sortBy",
70
+ "customer_group_id": "customerGroupId",
65
71
  });
66
72
  });
67
73
 
@@ -71,6 +77,7 @@ export type ListUpsellProductsRequest$Outbound = {
71
77
  page?: number | undefined;
72
78
  limit?: number | undefined;
73
79
  sort_by?: string | undefined;
80
+ customer_group_id?: string | undefined;
74
81
  };
75
82
 
76
83
  /** @internal */
@@ -83,10 +90,12 @@ export const ListUpsellProductsRequest$outboundSchema: z.ZodType<
83
90
  page: z.number().int().optional(),
84
91
  limit: z.number().int().optional(),
85
92
  sortBy: z.string().optional(),
93
+ customerGroupId: z.string().optional(),
86
94
  }).transform((v) => {
87
95
  return remap$(v, {
88
96
  productId: "product_id",
89
97
  sortBy: "sort_by",
98
+ customerGroupId: "customer_group_id",
90
99
  });
91
100
  });
92
101