@epcc-sdk/sdks-shopper 0.0.31 → 0.0.33

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 (37) hide show
  1. package/README.md +32 -10
  2. package/dist/client/@tanstack/react-query.gen.cjs +43 -64
  3. package/dist/client/@tanstack/react-query.gen.cjs.map +1 -1
  4. package/dist/client/@tanstack/react-query.gen.d.cts +67 -96
  5. package/dist/client/@tanstack/react-query.gen.d.ts +67 -96
  6. package/dist/client/@tanstack/react-query.gen.mjs +41 -61
  7. package/dist/client/@tanstack/react-query.gen.mjs.map +1 -1
  8. package/dist/client/index.d.cts +2 -2
  9. package/dist/client/index.d.ts +2 -2
  10. package/dist/client/sdk.gen.cjs +44 -34
  11. package/dist/client/sdk.gen.cjs.map +1 -1
  12. package/dist/client/sdk.gen.d.cts +26 -32
  13. package/dist/client/sdk.gen.d.ts +26 -32
  14. package/dist/client/sdk.gen.mjs +41 -30
  15. package/dist/client/sdk.gen.mjs.map +1 -1
  16. package/dist/client/transformers.gen.cjs +3 -94
  17. package/dist/client/transformers.gen.cjs.map +1 -1
  18. package/dist/client/transformers.gen.d.cts +2 -9
  19. package/dist/client/transformers.gen.d.ts +2 -9
  20. package/dist/client/transformers.gen.mjs +3 -87
  21. package/dist/client/transformers.gen.mjs.map +1 -1
  22. package/dist/client/types.gen.cjs.map +1 -1
  23. package/dist/client/types.gen.d.cts +252 -245
  24. package/dist/client/types.gen.d.ts +252 -245
  25. package/dist/index.cjs +0 -2
  26. package/dist/index.cjs.map +1 -1
  27. package/dist/index.d.cts +2 -4
  28. package/dist/index.d.ts +2 -4
  29. package/dist/index.mjs +0 -1
  30. package/dist/index.mjs.map +1 -1
  31. package/dist/react-query.cjs +23 -0
  32. package/dist/react-query.cjs.map +1 -0
  33. package/dist/react-query.d.cts +4 -0
  34. package/dist/react-query.d.ts +4 -0
  35. package/dist/react-query.mjs +2 -0
  36. package/dist/react-query.mjs.map +1 -0
  37. package/package.json +11 -1
package/README.md CHANGED
@@ -1,6 +1,28 @@
1
1
  # @epcc-sdk/sdks-shopper SDK
2
2
 
3
- Below you’ll find instructions on how to install, set up, and use the client, along with a list of available operations.
3
+ Below you'll find instructions on how to install, set up, and use the client, along with a list of available operations.
4
+
5
+
6
+ ## React Query Support
7
+
8
+ This SDK provides optional React Query hooks for React applications. To use them, you need to:
9
+
10
+ 1. Install `@tanstack/react-query` as a peer dependency:
11
+ ```bash
12
+ npm install @tanstack/react-query
13
+ # or
14
+ pnpm install @tanstack/react-query
15
+ # or
16
+ yarn add @tanstack/react-query
17
+ ```
18
+
19
+ 2. Import hooks from the `/react-query` subpath:
20
+ ```ts
21
+ import { useGetByContextProduct } from "@epcc-sdk/sdks-shopper/react-query";
22
+ ```
23
+
24
+ **Note**: If you're not using React or React Query, you can use the SDK without installing `@tanstack/react-query`. The main exports work independently.
25
+
4
26
 
5
27
  ## Features
6
28
 
@@ -12,6 +34,7 @@ Below you’ll find instructions on how to install, set up, and use the client,
12
34
 
13
35
  ---
14
36
 
37
+
15
38
  ## Installation
16
39
 
17
40
  ```bash
@@ -381,28 +404,26 @@ const product = await getByContextProduct({
381
404
 
382
405
  - **`cancelATransaction`** (`POST /v2/orders/{orderID}/transactions/{transactionID}/cancel`)
383
406
 
384
- - **`getSubscriptionProduct`** (`GET /v2/subscriptions/products/{product_uuid}`)
385
-
386
- - **`getPlan`** (`GET /v2/subscriptions/plans/{plan_uuid}`)
387
-
388
407
  - **`listOfferings`** (`GET /v2/subscriptions/offerings`)
389
408
 
390
409
  - **`getOffering`** (`GET /v2/subscriptions/offerings/{offering_uuid}`)
391
410
 
392
- - **`listOfferingPlans`** (`GET /v2/subscriptions/offerings/{offering_uuid}/plans`)
411
+ - **`listOfferingPricingOptions`** (`GET /v2/subscriptions/offerings/{offering_uuid}/pricing-options`)
393
412
 
394
413
  - **`listOfferingFeatures`** (`GET /v2/subscriptions/offerings/{offering_uuid}/features`)
395
414
 
396
- - **`listOfferingProducts`** (`GET /v2/subscriptions/offerings/{offering_uuid}/products`)
415
+ - **`listOfferingPlans`** (`GET /v2/subscriptions/offerings/{offering_uuid}/plans`)
416
+
417
+ - **`listOfferingPlanPricingOptions`** (`GET /v2/subscriptions/offerings/{offering_uuid}/plans/{plan_uuid}/relationships/pricing_options`)
397
418
 
398
419
  - **`listSubscriptions`** (`GET /v2/subscriptions/subscriptions`)
399
420
 
400
421
  - **`getSubscription`** (`GET /v2/subscriptions/subscriptions/{subscription_uuid}`)
401
422
 
402
- - **`listSubscriptionProducts`** (`GET /v2/subscriptions/subscriptions/{subscription_uuid}/products`)
403
-
404
423
  - **`listSubscriptionPlans`** (`GET /v2/subscriptions/subscriptions/{subscription_uuid}/plans`)
405
424
 
425
+ - **`listSubscriptionPricingOptions`** (`GET /v2/subscriptions/subscriptions/{subscription_uuid}/pricing-options`)
426
+
406
427
  - **`listSubscriptionStates`** (`GET /v2/subscriptions/subscriptions/{subscription_uuid}/states`)
407
428
 
408
429
  - **`getSubscriptionState`** (`GET /v2/subscriptions/subscriptions/{subscription_uuid}/states/{state_uuid}`)
@@ -467,4 +488,5 @@ const product = await getByContextProduct({
467
488
 
468
489
 
469
490
 
470
- ---
491
+
492
+ ---
@@ -175,8 +175,6 @@ __export(react_query_gen_exports, {
175
175
  getOrderItemsQueryKey: () => getOrderItemsQueryKey,
176
176
  getOrderTransactionsOptions: () => getOrderTransactionsOptions,
177
177
  getOrderTransactionsQueryKey: () => getOrderTransactionsQueryKey,
178
- getPlanOptions: () => getPlanOptions,
179
- getPlanQueryKey: () => getPlanQueryKey,
180
178
  getProductOptions: () => getProductOptions,
181
179
  getProductQueryKey: () => getProductQueryKey,
182
180
  getProductsForHierarchyOptions: () => getProductsForHierarchyOptions,
@@ -198,8 +196,6 @@ __export(react_query_gen_exports, {
198
196
  getSubscriptionInvoicePaymentQueryKey: () => getSubscriptionInvoicePaymentQueryKey,
199
197
  getSubscriptionInvoiceQueryKey: () => getSubscriptionInvoiceQueryKey,
200
198
  getSubscriptionOptions: () => getSubscriptionOptions,
201
- getSubscriptionProductOptions: () => getSubscriptionProductOptions,
202
- getSubscriptionProductQueryKey: () => getSubscriptionProductQueryKey,
203
199
  getSubscriptionQueryKey: () => getSubscriptionQueryKey,
204
200
  getSubscriptionStateOptions: () => getSubscriptionStateOptions,
205
201
  getSubscriptionStateQueryKey: () => getSubscriptionStateQueryKey,
@@ -223,10 +219,12 @@ __export(react_query_gen_exports, {
223
219
  listLocationsQueryKey: () => listLocationsQueryKey,
224
220
  listOfferingFeaturesOptions: () => listOfferingFeaturesOptions,
225
221
  listOfferingFeaturesQueryKey: () => listOfferingFeaturesQueryKey,
222
+ listOfferingPlanPricingOptionsOptions: () => listOfferingPlanPricingOptionsOptions,
223
+ listOfferingPlanPricingOptionsQueryKey: () => listOfferingPlanPricingOptionsQueryKey,
226
224
  listOfferingPlansOptions: () => listOfferingPlansOptions,
227
225
  listOfferingPlansQueryKey: () => listOfferingPlansQueryKey,
228
- listOfferingProductsOptions: () => listOfferingProductsOptions,
229
- listOfferingProductsQueryKey: () => listOfferingProductsQueryKey,
226
+ listOfferingPricingOptionsOptions: () => listOfferingPricingOptionsOptions,
227
+ listOfferingPricingOptionsQueryKey: () => listOfferingPricingOptionsQueryKey,
230
228
  listOfferingsOptions: () => listOfferingsOptions,
231
229
  listOfferingsQueryKey: () => listOfferingsQueryKey,
232
230
  listSubscriptionInvoicePaymentsOptions: () => listSubscriptionInvoicePaymentsOptions,
@@ -235,8 +233,8 @@ __export(react_query_gen_exports, {
235
233
  listSubscriptionInvoicesQueryKey: () => listSubscriptionInvoicesQueryKey,
236
234
  listSubscriptionPlansOptions: () => listSubscriptionPlansOptions,
237
235
  listSubscriptionPlansQueryKey: () => listSubscriptionPlansQueryKey,
238
- listSubscriptionProductsOptions: () => listSubscriptionProductsOptions,
239
- listSubscriptionProductsQueryKey: () => listSubscriptionProductsQueryKey,
236
+ listSubscriptionPricingOptionsOptions: () => listSubscriptionPricingOptionsOptions,
237
+ listSubscriptionPricingOptionsQueryKey: () => listSubscriptionPricingOptionsQueryKey,
240
238
  listSubscriptionStatesOptions: () => listSubscriptionStatesOptions,
241
239
  listSubscriptionStatesQueryKey: () => listSubscriptionStatesQueryKey,
242
240
  listSubscriptionsOptions: () => listSubscriptionsOptions,
@@ -1856,38 +1854,6 @@ const cancelATransactionMutation = (options) => {
1856
1854
  };
1857
1855
  return mutationOptions;
1858
1856
  };
1859
- const getSubscriptionProductQueryKey = (options) => [createQueryKey("getSubscriptionProduct", options)];
1860
- const getSubscriptionProductOptions = (options) => {
1861
- return (0, import_react_query.queryOptions)({
1862
- queryFn: async ({ queryKey, signal }) => {
1863
- const { data } = await (0, import_sdk.getSubscriptionProduct)({
1864
- ...options,
1865
- ...queryKey[0],
1866
- signal,
1867
- throwOnError: true
1868
- });
1869
- return data;
1870
- },
1871
- queryKey: getSubscriptionProductQueryKey(options)
1872
- });
1873
- };
1874
- const getPlanQueryKey = (options) => [
1875
- createQueryKey("getPlan", options)
1876
- ];
1877
- const getPlanOptions = (options) => {
1878
- return (0, import_react_query.queryOptions)({
1879
- queryFn: async ({ queryKey, signal }) => {
1880
- const { data } = await (0, import_sdk.getPlan)({
1881
- ...options,
1882
- ...queryKey[0],
1883
- signal,
1884
- throwOnError: true
1885
- });
1886
- return data;
1887
- },
1888
- queryKey: getPlanQueryKey(options)
1889
- });
1890
- };
1891
1857
  const listOfferingsQueryKey = (options) => [
1892
1858
  createQueryKey("listOfferings", options)
1893
1859
  ];
@@ -1922,11 +1888,11 @@ const getOfferingOptions = (options) => {
1922
1888
  queryKey: getOfferingQueryKey(options)
1923
1889
  });
1924
1890
  };
1925
- const listOfferingPlansQueryKey = (options) => [createQueryKey("listOfferingPlans", options)];
1926
- const listOfferingPlansOptions = (options) => {
1891
+ const listOfferingPricingOptionsQueryKey = (options) => [createQueryKey("listOfferingPricingOptions", options)];
1892
+ const listOfferingPricingOptionsOptions = (options) => {
1927
1893
  return (0, import_react_query.queryOptions)({
1928
1894
  queryFn: async ({ queryKey, signal }) => {
1929
- const { data } = await (0, import_sdk.listOfferingPlans)({
1895
+ const { data } = await (0, import_sdk.listOfferingPricingOptions)({
1930
1896
  ...options,
1931
1897
  ...queryKey[0],
1932
1898
  signal,
@@ -1934,7 +1900,7 @@ const listOfferingPlansOptions = (options) => {
1934
1900
  });
1935
1901
  return data;
1936
1902
  },
1937
- queryKey: listOfferingPlansQueryKey(options)
1903
+ queryKey: listOfferingPricingOptionsQueryKey(options)
1938
1904
  });
1939
1905
  };
1940
1906
  const listOfferingFeaturesQueryKey = (options) => [createQueryKey("listOfferingFeatures", options)];
@@ -1952,11 +1918,11 @@ const listOfferingFeaturesOptions = (options) => {
1952
1918
  queryKey: listOfferingFeaturesQueryKey(options)
1953
1919
  });
1954
1920
  };
1955
- const listOfferingProductsQueryKey = (options) => [createQueryKey("listOfferingProducts", options)];
1956
- const listOfferingProductsOptions = (options) => {
1921
+ const listOfferingPlansQueryKey = (options) => [createQueryKey("listOfferingPlans", options)];
1922
+ const listOfferingPlansOptions = (options) => {
1957
1923
  return (0, import_react_query.queryOptions)({
1958
1924
  queryFn: async ({ queryKey, signal }) => {
1959
- const { data } = await (0, import_sdk.listOfferingProducts)({
1925
+ const { data } = await (0, import_sdk.listOfferingPlans)({
1960
1926
  ...options,
1961
1927
  ...queryKey[0],
1962
1928
  signal,
@@ -1964,7 +1930,22 @@ const listOfferingProductsOptions = (options) => {
1964
1930
  });
1965
1931
  return data;
1966
1932
  },
1967
- queryKey: listOfferingProductsQueryKey(options)
1933
+ queryKey: listOfferingPlansQueryKey(options)
1934
+ });
1935
+ };
1936
+ const listOfferingPlanPricingOptionsQueryKey = (options) => [createQueryKey("listOfferingPlanPricingOptions", options)];
1937
+ const listOfferingPlanPricingOptionsOptions = (options) => {
1938
+ return (0, import_react_query.queryOptions)({
1939
+ queryFn: async ({ queryKey, signal }) => {
1940
+ const { data } = await (0, import_sdk.listOfferingPlanPricingOptions)({
1941
+ ...options,
1942
+ ...queryKey[0],
1943
+ signal,
1944
+ throwOnError: true
1945
+ });
1946
+ return data;
1947
+ },
1948
+ queryKey: listOfferingPlanPricingOptionsQueryKey(options)
1968
1949
  });
1969
1950
  };
1970
1951
  const listSubscriptionsQueryKey = (options) => [createQueryKey("listSubscriptions", options)];
@@ -1997,11 +1978,11 @@ const getSubscriptionOptions = (options) => {
1997
1978
  queryKey: getSubscriptionQueryKey(options)
1998
1979
  });
1999
1980
  };
2000
- const listSubscriptionProductsQueryKey = (options) => [createQueryKey("listSubscriptionProducts", options)];
2001
- const listSubscriptionProductsOptions = (options) => {
1981
+ const listSubscriptionPlansQueryKey = (options) => [createQueryKey("listSubscriptionPlans", options)];
1982
+ const listSubscriptionPlansOptions = (options) => {
2002
1983
  return (0, import_react_query.queryOptions)({
2003
1984
  queryFn: async ({ queryKey, signal }) => {
2004
- const { data } = await (0, import_sdk.listSubscriptionProducts)({
1985
+ const { data } = await (0, import_sdk.listSubscriptionPlans)({
2005
1986
  ...options,
2006
1987
  ...queryKey[0],
2007
1988
  signal,
@@ -2009,14 +1990,14 @@ const listSubscriptionProductsOptions = (options) => {
2009
1990
  });
2010
1991
  return data;
2011
1992
  },
2012
- queryKey: listSubscriptionProductsQueryKey(options)
1993
+ queryKey: listSubscriptionPlansQueryKey(options)
2013
1994
  });
2014
1995
  };
2015
- const listSubscriptionPlansQueryKey = (options) => [createQueryKey("listSubscriptionPlans", options)];
2016
- const listSubscriptionPlansOptions = (options) => {
1996
+ const listSubscriptionPricingOptionsQueryKey = (options) => [createQueryKey("listSubscriptionPricingOptions", options)];
1997
+ const listSubscriptionPricingOptionsOptions = (options) => {
2017
1998
  return (0, import_react_query.queryOptions)({
2018
1999
  queryFn: async ({ queryKey, signal }) => {
2019
- const { data } = await (0, import_sdk.listSubscriptionPlans)({
2000
+ const { data } = await (0, import_sdk.listSubscriptionPricingOptions)({
2020
2001
  ...options,
2021
2002
  ...queryKey[0],
2022
2003
  signal,
@@ -2024,7 +2005,7 @@ const listSubscriptionPlansOptions = (options) => {
2024
2005
  });
2025
2006
  return data;
2026
2007
  },
2027
- queryKey: listSubscriptionPlansQueryKey(options)
2008
+ queryKey: listSubscriptionPricingOptionsQueryKey(options)
2028
2009
  });
2029
2010
  };
2030
2011
  const listSubscriptionStatesQueryKey = (options) => [createQueryKey("listSubscriptionStates", options)];
@@ -2726,8 +2707,6 @@ const getAFileOptions = (options) => {
2726
2707
  getOrderItemsQueryKey,
2727
2708
  getOrderTransactionsOptions,
2728
2709
  getOrderTransactionsQueryKey,
2729
- getPlanOptions,
2730
- getPlanQueryKey,
2731
2710
  getProductOptions,
2732
2711
  getProductQueryKey,
2733
2712
  getProductsForHierarchyOptions,
@@ -2749,8 +2728,6 @@ const getAFileOptions = (options) => {
2749
2728
  getSubscriptionInvoicePaymentQueryKey,
2750
2729
  getSubscriptionInvoiceQueryKey,
2751
2730
  getSubscriptionOptions,
2752
- getSubscriptionProductOptions,
2753
- getSubscriptionProductQueryKey,
2754
2731
  getSubscriptionQueryKey,
2755
2732
  getSubscriptionStateOptions,
2756
2733
  getSubscriptionStateQueryKey,
@@ -2774,10 +2751,12 @@ const getAFileOptions = (options) => {
2774
2751
  listLocationsQueryKey,
2775
2752
  listOfferingFeaturesOptions,
2776
2753
  listOfferingFeaturesQueryKey,
2754
+ listOfferingPlanPricingOptionsOptions,
2755
+ listOfferingPlanPricingOptionsQueryKey,
2777
2756
  listOfferingPlansOptions,
2778
2757
  listOfferingPlansQueryKey,
2779
- listOfferingProductsOptions,
2780
- listOfferingProductsQueryKey,
2758
+ listOfferingPricingOptionsOptions,
2759
+ listOfferingPricingOptionsQueryKey,
2781
2760
  listOfferingsOptions,
2782
2761
  listOfferingsQueryKey,
2783
2762
  listSubscriptionInvoicePaymentsOptions,
@@ -2786,8 +2765,8 @@ const getAFileOptions = (options) => {
2786
2765
  listSubscriptionInvoicesQueryKey,
2787
2766
  listSubscriptionPlansOptions,
2788
2767
  listSubscriptionPlansQueryKey,
2789
- listSubscriptionProductsOptions,
2790
- listSubscriptionProductsQueryKey,
2768
+ listSubscriptionPricingOptionsOptions,
2769
+ listSubscriptionPricingOptionsQueryKey,
2791
2770
  listSubscriptionStatesOptions,
2792
2771
  listSubscriptionStatesQueryKey,
2793
2772
  listSubscriptionsOptions,