@typewoo/sdk 3.7.4 → 3.7.5
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.ts +13 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +14 -0
- package/dist/index.js.map +1 -1
- package/dist/lib/interceptors/admin-auth.interceptor.d.ts.map +1 -1
- package/dist/lib/interceptors/admin-auth.interceptor.js +5 -3
- package/dist/lib/interceptors/admin-auth.interceptor.js.map +1 -1
- package/dist/lib/sdk.d.ts +11 -0
- package/dist/lib/sdk.d.ts.map +1 -1
- package/dist/lib/sdk.js +16 -0
- package/dist/lib/sdk.js.map +1 -1
- package/dist/lib/services/analytics/categories.service.d.ts +22 -0
- package/dist/lib/services/analytics/categories.service.d.ts.map +1 -0
- package/dist/lib/services/analytics/categories.service.js +44 -0
- package/dist/lib/services/analytics/categories.service.js.map +1 -0
- package/dist/lib/services/analytics/coupons.service.d.ts +22 -0
- package/dist/lib/services/analytics/coupons.service.d.ts.map +1 -0
- package/dist/lib/services/analytics/coupons.service.js +44 -0
- package/dist/lib/services/analytics/coupons.service.js.map +1 -0
- package/dist/lib/services/analytics/customers.service.d.ts +22 -0
- package/dist/lib/services/analytics/customers.service.d.ts.map +1 -0
- package/dist/lib/services/analytics/customers.service.js +44 -0
- package/dist/lib/services/analytics/customers.service.js.map +1 -0
- package/dist/lib/services/analytics/downloads.service.d.ts +22 -0
- package/dist/lib/services/analytics/downloads.service.d.ts.map +1 -0
- package/dist/lib/services/analytics/downloads.service.js +44 -0
- package/dist/lib/services/analytics/downloads.service.js.map +1 -0
- package/dist/lib/services/analytics/leaderboards.service.d.ts +21 -0
- package/dist/lib/services/analytics/leaderboards.service.d.ts.map +1 -0
- package/dist/lib/services/analytics/leaderboards.service.js +37 -0
- package/dist/lib/services/analytics/leaderboards.service.js.map +1 -0
- package/dist/lib/services/analytics/orders.service.d.ts +22 -0
- package/dist/lib/services/analytics/orders.service.d.ts.map +1 -0
- package/dist/lib/services/analytics/orders.service.js +44 -0
- package/dist/lib/services/analytics/orders.service.js.map +1 -0
- package/dist/lib/services/analytics/performance.service.d.ts +22 -0
- package/dist/lib/services/analytics/performance.service.d.ts.map +1 -0
- package/dist/lib/services/analytics/performance.service.js +38 -0
- package/dist/lib/services/analytics/performance.service.js.map +1 -0
- package/dist/lib/services/analytics/products.service.d.ts +22 -0
- package/dist/lib/services/analytics/products.service.d.ts.map +1 -0
- package/dist/lib/services/analytics/products.service.js +44 -0
- package/dist/lib/services/analytics/products.service.js.map +1 -0
- package/dist/lib/services/analytics/revenue.service.d.ts +17 -0
- package/dist/lib/services/analytics/revenue.service.d.ts.map +1 -0
- package/dist/lib/services/analytics/revenue.service.js +27 -0
- package/dist/lib/services/analytics/revenue.service.js.map +1 -0
- package/dist/lib/services/analytics/stock.service.d.ts +22 -0
- package/dist/lib/services/analytics/stock.service.d.ts.map +1 -0
- package/dist/lib/services/analytics/stock.service.js +43 -0
- package/dist/lib/services/analytics/stock.service.js.map +1 -0
- package/dist/lib/services/analytics/taxes.service.d.ts +22 -0
- package/dist/lib/services/analytics/taxes.service.d.ts.map +1 -0
- package/dist/lib/services/analytics/taxes.service.js +44 -0
- package/dist/lib/services/analytics/taxes.service.js.map +1 -0
- package/dist/lib/services/analytics/variations.service.d.ts +22 -0
- package/dist/lib/services/analytics/variations.service.d.ts.map +1 -0
- package/dist/lib/services/analytics/variations.service.js +44 -0
- package/dist/lib/services/analytics/variations.service.js.map +1 -0
- package/dist/lib/services/analytics.service.d.ts +83 -0
- package/dist/lib/services/analytics.service.d.ts.map +1 -0
- package/dist/lib/services/analytics.service.js +131 -0
- package/dist/lib/services/analytics.service.js.map +1 -0
- package/dist/lib/services/store.service.d.ts +18 -22
- package/dist/lib/services/store.service.d.ts.map +1 -1
- package/dist/lib/services/store.service.js +50 -19
- package/dist/lib/services/store.service.js.map +1 -1
- package/dist/lib/types/admin/attribute.types.d.ts +1 -1
- package/dist/lib/types/admin/coupon.types.d.ts +2 -2
- package/dist/lib/types/admin/order.types.d.ts +3 -3
- package/dist/lib/types/admin/product-brand.types.d.ts +1 -1
- package/dist/lib/types/admin/product-review.types.d.ts +2 -2
- package/dist/lib/types/admin/product.types.d.ts +5 -5
- package/dist/lib/types/admin/refund.types.d.ts +2 -2
- package/dist/lib/types/admin/setting.types.d.ts +1 -1
- package/dist/lib/types/admin/taxonomy.types.d.ts +3 -3
- package/dist/lib/types/admin/webhook.types.d.ts +1 -1
- package/dist/lib/types/analytics/categories.types.d.ts +84 -0
- package/dist/lib/types/analytics/categories.types.d.ts.map +1 -0
- package/dist/lib/types/analytics/categories.types.js +46 -0
- package/dist/lib/types/analytics/categories.types.js.map +1 -0
- package/dist/lib/types/analytics/common.types.d.ts +96 -0
- package/dist/lib/types/analytics/common.types.d.ts.map +1 -0
- package/dist/lib/types/analytics/common.types.js +52 -0
- package/dist/lib/types/analytics/common.types.js.map +1 -0
- package/dist/lib/types/analytics/coupons.types.d.ts +87 -0
- package/dist/lib/types/analytics/coupons.types.d.ts.map +1 -0
- package/dist/lib/types/analytics/coupons.types.js +44 -0
- package/dist/lib/types/analytics/coupons.types.js.map +1 -0
- package/dist/lib/types/analytics/customers.types.d.ts +107 -0
- package/dist/lib/types/analytics/customers.types.d.ts.map +1 -0
- package/dist/lib/types/analytics/customers.types.js +58 -0
- package/dist/lib/types/analytics/customers.types.js.map +1 -0
- package/dist/lib/types/analytics/downloads.types.d.ts +83 -0
- package/dist/lib/types/analytics/downloads.types.d.ts.map +1 -0
- package/dist/lib/types/analytics/downloads.types.js +50 -0
- package/dist/lib/types/analytics/downloads.types.js.map +1 -0
- package/dist/lib/types/analytics/index.d.ts +14 -0
- package/dist/lib/types/analytics/index.d.ts.map +1 -0
- package/dist/lib/types/analytics/index.js +14 -0
- package/dist/lib/types/analytics/index.js.map +1 -0
- package/dist/lib/types/analytics/leaderboards.types.d.ts +63 -0
- package/dist/lib/types/analytics/leaderboards.types.d.ts.map +1 -0
- package/dist/lib/types/analytics/leaderboards.types.js +41 -0
- package/dist/lib/types/analytics/leaderboards.types.js.map +1 -0
- package/dist/lib/types/analytics/orders.types.d.ts +178 -0
- package/dist/lib/types/analytics/orders.types.d.ts.map +1 -0
- package/dist/lib/types/analytics/orders.types.js +105 -0
- package/dist/lib/types/analytics/orders.types.js.map +1 -0
- package/dist/lib/types/analytics/performance.types.d.ts +46 -0
- package/dist/lib/types/analytics/performance.types.d.ts.map +1 -0
- package/dist/lib/types/analytics/performance.types.js +29 -0
- package/dist/lib/types/analytics/performance.types.js.map +1 -0
- package/dist/lib/types/analytics/products.types.d.ts +111 -0
- package/dist/lib/types/analytics/products.types.d.ts.map +1 -0
- package/dist/lib/types/analytics/products.types.js +57 -0
- package/dist/lib/types/analytics/products.types.js.map +1 -0
- package/dist/lib/types/analytics/revenue.types.d.ts +59 -0
- package/dist/lib/types/analytics/revenue.types.d.ts.map +1 -0
- package/dist/lib/types/analytics/revenue.types.js +33 -0
- package/dist/lib/types/analytics/revenue.types.js.map +1 -0
- package/dist/lib/types/analytics/stock.types.d.ts +59 -0
- package/dist/lib/types/analytics/stock.types.d.ts.map +1 -0
- package/dist/lib/types/analytics/stock.types.js +36 -0
- package/dist/lib/types/analytics/stock.types.js.map +1 -0
- package/dist/lib/types/analytics/taxes.types.d.ts +94 -0
- package/dist/lib/types/analytics/taxes.types.d.ts.map +1 -0
- package/dist/lib/types/analytics/taxes.types.js +52 -0
- package/dist/lib/types/analytics/taxes.types.js.map +1 -0
- package/dist/lib/types/analytics/variations.types.d.ts +115 -0
- package/dist/lib/types/analytics/variations.types.d.ts.map +1 -0
- package/dist/lib/types/analytics/variations.types.js +61 -0
- package/dist/lib/types/analytics/variations.types.js.map +1 -0
- package/dist/lib/types/index.d.ts +1 -0
- package/dist/lib/types/index.d.ts.map +1 -1
- package/dist/lib/types/index.js +1 -0
- package/dist/lib/types/index.js.map +1 -1
- package/dist/lib/types/store/product/product.request.d.ts +9 -9
- package/dist/lib/types/store/product-attribute-term/product.attribute.term.request.d.ts +1 -1
- package/dist/lib/types/store/product-review/product.review.request.d.ts +2 -2
- package/package.json +1 -1
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
/**
|
|
3
|
+
* Category stats totals/subtotals shape
|
|
4
|
+
*/
|
|
5
|
+
export declare const AnalyticsCategoryStatsSchema: z.ZodObject<{
|
|
6
|
+
items_sold: z.ZodNumber;
|
|
7
|
+
net_revenue: z.ZodNumber;
|
|
8
|
+
orders_count: z.ZodNumber;
|
|
9
|
+
products_count: z.ZodNumber;
|
|
10
|
+
}, z.core.$strip>;
|
|
11
|
+
export type AnalyticsCategoryStats = z.infer<typeof AnalyticsCategoryStatsSchema>;
|
|
12
|
+
/**
|
|
13
|
+
* Extended info for a category detail row
|
|
14
|
+
*/
|
|
15
|
+
export declare const AnalyticsCategoryExtendedInfoSchema: z.ZodObject<{
|
|
16
|
+
name: z.ZodOptional<z.ZodString>;
|
|
17
|
+
}, z.core.$strip>;
|
|
18
|
+
export type AnalyticsCategoryExtendedInfo = z.infer<typeof AnalyticsCategoryExtendedInfoSchema>;
|
|
19
|
+
/**
|
|
20
|
+
* Single category row from the categories detail endpoint
|
|
21
|
+
*/
|
|
22
|
+
export declare const AnalyticsCategorySchema: z.ZodObject<{
|
|
23
|
+
category_id: z.ZodNumber;
|
|
24
|
+
items_sold: z.ZodNumber;
|
|
25
|
+
net_revenue: z.ZodNumber;
|
|
26
|
+
orders_count: z.ZodNumber;
|
|
27
|
+
products_count: z.ZodNumber;
|
|
28
|
+
extended_info: z.ZodOptional<z.ZodObject<{
|
|
29
|
+
name: z.ZodOptional<z.ZodString>;
|
|
30
|
+
}, z.core.$strip>>;
|
|
31
|
+
_links: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
|
|
32
|
+
href: z.ZodString;
|
|
33
|
+
}, z.core.$strip>>>>;
|
|
34
|
+
}, z.core.$strip>;
|
|
35
|
+
export type AnalyticsCategory = z.infer<typeof AnalyticsCategorySchema>;
|
|
36
|
+
/**
|
|
37
|
+
* Query parameters for categories stats endpoint
|
|
38
|
+
*/
|
|
39
|
+
export declare const AnalyticsCategoriesStatsQueryParamsSchema: z.ZodObject<{
|
|
40
|
+
before: z.ZodOptional<z.ZodString>;
|
|
41
|
+
after: z.ZodOptional<z.ZodString>;
|
|
42
|
+
interval: z.ZodOptional<z.ZodEnum<{
|
|
43
|
+
hour: "hour";
|
|
44
|
+
day: "day";
|
|
45
|
+
week: "week";
|
|
46
|
+
month: "month";
|
|
47
|
+
quarter: "quarter";
|
|
48
|
+
year: "year";
|
|
49
|
+
}>>;
|
|
50
|
+
page: z.ZodOptional<z.ZodNumber>;
|
|
51
|
+
per_page: z.ZodOptional<z.ZodNumber>;
|
|
52
|
+
orderby: z.ZodOptional<z.ZodString>;
|
|
53
|
+
order: z.ZodOptional<z.ZodEnum<{
|
|
54
|
+
asc: "asc";
|
|
55
|
+
desc: "desc";
|
|
56
|
+
}>>;
|
|
57
|
+
force_cache_refresh: z.ZodOptional<z.ZodBoolean>;
|
|
58
|
+
fields: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
59
|
+
categories: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
|
|
60
|
+
status_is: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
61
|
+
status_is_not: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
62
|
+
}, z.core.$strip>;
|
|
63
|
+
export type AnalyticsCategoriesStatsQueryParams = z.infer<typeof AnalyticsCategoriesStatsQueryParamsSchema>;
|
|
64
|
+
/**
|
|
65
|
+
* Query parameters for categories list (detail) endpoint
|
|
66
|
+
*/
|
|
67
|
+
export declare const AnalyticsCategoriesListQueryParamsSchema: z.ZodObject<{
|
|
68
|
+
before: z.ZodOptional<z.ZodString>;
|
|
69
|
+
after: z.ZodOptional<z.ZodString>;
|
|
70
|
+
page: z.ZodOptional<z.ZodNumber>;
|
|
71
|
+
per_page: z.ZodOptional<z.ZodNumber>;
|
|
72
|
+
orderby: z.ZodOptional<z.ZodString>;
|
|
73
|
+
order: z.ZodOptional<z.ZodEnum<{
|
|
74
|
+
asc: "asc";
|
|
75
|
+
desc: "desc";
|
|
76
|
+
}>>;
|
|
77
|
+
extended_info: z.ZodOptional<z.ZodBoolean>;
|
|
78
|
+
force_cache_refresh: z.ZodOptional<z.ZodBoolean>;
|
|
79
|
+
categories: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
|
|
80
|
+
status_is: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
81
|
+
status_is_not: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
82
|
+
}, z.core.$strip>;
|
|
83
|
+
export type AnalyticsCategoriesListQueryParams = z.infer<typeof AnalyticsCategoriesListQueryParamsSchema>;
|
|
84
|
+
//# sourceMappingURL=categories.types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"categories.types.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/analytics/categories.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAOxB;;GAEG;AACH,eAAO,MAAM,4BAA4B;;;;;iBAKvC,CAAC;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAC1C,OAAO,4BAA4B,CACpC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mCAAmC;;iBAE9C,CAAC;AACH,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,mCAAmC,CAC3C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;iBAQlC,CAAC;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE;;GAEG;AACH,eAAO,MAAM,yCAAyC;;;;;;;;;;;;;;;;;;;;;;;iBAKlD,CAAC;AACL,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,yCAAyC,CACjD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,wCAAwC;;;;;;;;;;;;;;;iBAKjD,CAAC;AACL,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,wCAAwC,CAChD,CAAC"}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import { AnalyticsStatsQueryParamsSchema, AnalyticsListQueryParamsSchema, AnalyticsLinksSchema, } from './common.types.js';
|
|
3
|
+
/**
|
|
4
|
+
* Category stats totals/subtotals shape
|
|
5
|
+
*/
|
|
6
|
+
export const AnalyticsCategoryStatsSchema = z.object({
|
|
7
|
+
items_sold: z.number(),
|
|
8
|
+
net_revenue: z.number(),
|
|
9
|
+
orders_count: z.number(),
|
|
10
|
+
products_count: z.number(),
|
|
11
|
+
});
|
|
12
|
+
/**
|
|
13
|
+
* Extended info for a category detail row
|
|
14
|
+
*/
|
|
15
|
+
export const AnalyticsCategoryExtendedInfoSchema = z.object({
|
|
16
|
+
name: z.string().optional(),
|
|
17
|
+
});
|
|
18
|
+
/**
|
|
19
|
+
* Single category row from the categories detail endpoint
|
|
20
|
+
*/
|
|
21
|
+
export const AnalyticsCategorySchema = z.object({
|
|
22
|
+
category_id: z.number(),
|
|
23
|
+
items_sold: z.number(),
|
|
24
|
+
net_revenue: z.number(),
|
|
25
|
+
orders_count: z.number(),
|
|
26
|
+
products_count: z.number(),
|
|
27
|
+
extended_info: AnalyticsCategoryExtendedInfoSchema.optional(),
|
|
28
|
+
_links: AnalyticsLinksSchema.optional(),
|
|
29
|
+
});
|
|
30
|
+
/**
|
|
31
|
+
* Query parameters for categories stats endpoint
|
|
32
|
+
*/
|
|
33
|
+
export const AnalyticsCategoriesStatsQueryParamsSchema = AnalyticsStatsQueryParamsSchema.extend({
|
|
34
|
+
categories: z.array(z.number()).optional(),
|
|
35
|
+
status_is: z.array(z.string()).optional(),
|
|
36
|
+
status_is_not: z.array(z.string()).optional(),
|
|
37
|
+
});
|
|
38
|
+
/**
|
|
39
|
+
* Query parameters for categories list (detail) endpoint
|
|
40
|
+
*/
|
|
41
|
+
export const AnalyticsCategoriesListQueryParamsSchema = AnalyticsListQueryParamsSchema.extend({
|
|
42
|
+
categories: z.array(z.number()).optional(),
|
|
43
|
+
status_is: z.array(z.string()).optional(),
|
|
44
|
+
status_is_not: z.array(z.string()).optional(),
|
|
45
|
+
});
|
|
46
|
+
//# sourceMappingURL=categories.types.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"categories.types.js","sourceRoot":"","sources":["../../../../src/lib/types/analytics/categories.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,+BAA+B,EAC/B,8BAA8B,EAC9B,oBAAoB,GACrB,MAAM,mBAAmB,CAAC;AAE3B;;GAEG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;CAC3B,CAAC,CAAC;AAKH;;GAEG;AACH,MAAM,CAAC,MAAM,mCAAmC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1D,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC5B,CAAC,CAAC;AAKH;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,aAAa,EAAE,mCAAmC,CAAC,QAAQ,EAAE;IAC7D,MAAM,EAAE,oBAAoB,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC;AAGH;;GAEG;AACH,MAAM,CAAC,MAAM,yCAAyC,GACpD,+BAA+B,CAAC,MAAM,CAAC;IACrC,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC1C,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACzC,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CAC9C,CAAC,CAAC;AAKL;;GAEG;AACH,MAAM,CAAC,MAAM,wCAAwC,GACnD,8BAA8B,CAAC,MAAM,CAAC;IACpC,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC1C,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACzC,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CAC9C,CAAC,CAAC"}
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
/**
|
|
3
|
+
* Time interval options for analytics buckets
|
|
4
|
+
*/
|
|
5
|
+
export declare const AnalyticsIntervalEnum: z.ZodEnum<{
|
|
6
|
+
hour: "hour";
|
|
7
|
+
day: "day";
|
|
8
|
+
week: "week";
|
|
9
|
+
month: "month";
|
|
10
|
+
quarter: "quarter";
|
|
11
|
+
year: "year";
|
|
12
|
+
}>;
|
|
13
|
+
export type AnalyticsIntervalType = z.infer<typeof AnalyticsIntervalEnum>;
|
|
14
|
+
/**
|
|
15
|
+
* Common query parameters shared across all analytics stats endpoints
|
|
16
|
+
*/
|
|
17
|
+
export declare const AnalyticsStatsQueryParamsSchema: z.ZodObject<{
|
|
18
|
+
before: z.ZodOptional<z.ZodString>;
|
|
19
|
+
after: z.ZodOptional<z.ZodString>;
|
|
20
|
+
interval: z.ZodOptional<z.ZodEnum<{
|
|
21
|
+
hour: "hour";
|
|
22
|
+
day: "day";
|
|
23
|
+
week: "week";
|
|
24
|
+
month: "month";
|
|
25
|
+
quarter: "quarter";
|
|
26
|
+
year: "year";
|
|
27
|
+
}>>;
|
|
28
|
+
page: z.ZodOptional<z.ZodNumber>;
|
|
29
|
+
per_page: z.ZodOptional<z.ZodNumber>;
|
|
30
|
+
orderby: z.ZodOptional<z.ZodString>;
|
|
31
|
+
order: z.ZodOptional<z.ZodEnum<{
|
|
32
|
+
asc: "asc";
|
|
33
|
+
desc: "desc";
|
|
34
|
+
}>>;
|
|
35
|
+
force_cache_refresh: z.ZodOptional<z.ZodBoolean>;
|
|
36
|
+
fields: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
37
|
+
}, z.core.$strip>;
|
|
38
|
+
export type AnalyticsStatsQueryParams = z.infer<typeof AnalyticsStatsQueryParamsSchema>;
|
|
39
|
+
/**
|
|
40
|
+
* Common query parameters shared across analytics list (detail) endpoints
|
|
41
|
+
*/
|
|
42
|
+
export declare const AnalyticsListQueryParamsSchema: z.ZodObject<{
|
|
43
|
+
before: z.ZodOptional<z.ZodString>;
|
|
44
|
+
after: z.ZodOptional<z.ZodString>;
|
|
45
|
+
page: z.ZodOptional<z.ZodNumber>;
|
|
46
|
+
per_page: z.ZodOptional<z.ZodNumber>;
|
|
47
|
+
orderby: z.ZodOptional<z.ZodString>;
|
|
48
|
+
order: z.ZodOptional<z.ZodEnum<{
|
|
49
|
+
asc: "asc";
|
|
50
|
+
desc: "desc";
|
|
51
|
+
}>>;
|
|
52
|
+
extended_info: z.ZodOptional<z.ZodBoolean>;
|
|
53
|
+
force_cache_refresh: z.ZodOptional<z.ZodBoolean>;
|
|
54
|
+
}, z.core.$strip>;
|
|
55
|
+
export type AnalyticsListQueryParams = z.infer<typeof AnalyticsListQueryParamsSchema>;
|
|
56
|
+
/**
|
|
57
|
+
* Segment within a stats response (used when segmentby is applied)
|
|
58
|
+
*/
|
|
59
|
+
export declare const AnalyticsSegmentSchema: z.ZodObject<{
|
|
60
|
+
segment_id: z.ZodNumber;
|
|
61
|
+
segment_label: z.ZodOptional<z.ZodString>;
|
|
62
|
+
subtotals: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
63
|
+
}, z.core.$strip>;
|
|
64
|
+
export type AnalyticsSegment = z.infer<typeof AnalyticsSegmentSchema>;
|
|
65
|
+
export declare const AnalyticsLinkSchema: z.ZodObject<{
|
|
66
|
+
href: z.ZodString;
|
|
67
|
+
}, z.core.$strip>;
|
|
68
|
+
export type AnalyticsLink = z.infer<typeof AnalyticsLinkSchema>;
|
|
69
|
+
export declare const AnalyticsLinksSchema: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
|
|
70
|
+
href: z.ZodString;
|
|
71
|
+
}, z.core.$strip>>>;
|
|
72
|
+
export type AnalyticsLinks = z.infer<typeof AnalyticsLinksSchema>;
|
|
73
|
+
export type AnalyticsSegmentedTotals<T> = T & {
|
|
74
|
+
segments?: AnalyticsSegment[];
|
|
75
|
+
};
|
|
76
|
+
export interface AnalyticsTotalsResponse<T> {
|
|
77
|
+
totals: T;
|
|
78
|
+
}
|
|
79
|
+
/**
|
|
80
|
+
* A single time interval in a stats response
|
|
81
|
+
*/
|
|
82
|
+
export interface AnalyticsStatsInterval<T> {
|
|
83
|
+
interval: string;
|
|
84
|
+
date_start: string;
|
|
85
|
+
date_start_gmt: string;
|
|
86
|
+
date_end: string;
|
|
87
|
+
date_end_gmt: string;
|
|
88
|
+
subtotals: AnalyticsSegmentedTotals<T>;
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
* Top-level shape returned by all /stats endpoints
|
|
92
|
+
*/
|
|
93
|
+
export interface AnalyticsStatsResponse<T> extends AnalyticsTotalsResponse<AnalyticsSegmentedTotals<T>> {
|
|
94
|
+
intervals?: AnalyticsStatsInterval<T>[];
|
|
95
|
+
}
|
|
96
|
+
//# sourceMappingURL=common.types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"common.types.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/analytics/common.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,eAAO,MAAM,qBAAqB;;;;;;;EAOhC,CAAC;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAE1E;;GAEG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;iBAU1C,CAAC;AACH,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAC7C,OAAO,+BAA+B,CACvC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;iBASzC,CAAC;AACH,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAC5C,OAAO,8BAA8B,CACtC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;iBAIjC,CAAC;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE,eAAO,MAAM,mBAAmB;;iBAE9B,CAAC;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE,eAAO,MAAM,oBAAoB;;mBAGhC,CAAC;AACF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE,MAAM,MAAM,wBAAwB,CAAC,CAAC,IAAI,CAAC,GAAG;IAC5C,QAAQ,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAC/B,CAAC;AAEF,MAAM,WAAW,uBAAuB,CAAC,CAAC;IACxC,MAAM,EAAE,CAAC,CAAC;CACX;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB,CAAC,CAAC;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,wBAAwB,CAAC,CAAC,CAAC,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB,CAAC,CAAC,CACvC,SAAQ,uBAAuB,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC;IAC5D,SAAS,CAAC,EAAE,sBAAsB,CAAC,CAAC,CAAC,EAAE,CAAC;CACzC"}
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
/**
|
|
3
|
+
* Time interval options for analytics buckets
|
|
4
|
+
*/
|
|
5
|
+
export const AnalyticsIntervalEnum = z.enum([
|
|
6
|
+
'hour',
|
|
7
|
+
'day',
|
|
8
|
+
'week',
|
|
9
|
+
'month',
|
|
10
|
+
'quarter',
|
|
11
|
+
'year',
|
|
12
|
+
]);
|
|
13
|
+
/**
|
|
14
|
+
* Common query parameters shared across all analytics stats endpoints
|
|
15
|
+
*/
|
|
16
|
+
export const AnalyticsStatsQueryParamsSchema = z.object({
|
|
17
|
+
before: z.string().optional(),
|
|
18
|
+
after: z.string().optional(),
|
|
19
|
+
interval: AnalyticsIntervalEnum.optional(),
|
|
20
|
+
page: z.number().optional(),
|
|
21
|
+
per_page: z.number().optional(),
|
|
22
|
+
orderby: z.string().optional(),
|
|
23
|
+
order: z.enum(['asc', 'desc']).optional(),
|
|
24
|
+
force_cache_refresh: z.boolean().optional(),
|
|
25
|
+
fields: z.array(z.string()).optional(),
|
|
26
|
+
});
|
|
27
|
+
/**
|
|
28
|
+
* Common query parameters shared across analytics list (detail) endpoints
|
|
29
|
+
*/
|
|
30
|
+
export const AnalyticsListQueryParamsSchema = z.object({
|
|
31
|
+
before: z.string().optional(),
|
|
32
|
+
after: z.string().optional(),
|
|
33
|
+
page: z.number().optional(),
|
|
34
|
+
per_page: z.number().optional(),
|
|
35
|
+
orderby: z.string().optional(),
|
|
36
|
+
order: z.enum(['asc', 'desc']).optional(),
|
|
37
|
+
extended_info: z.boolean().optional(),
|
|
38
|
+
force_cache_refresh: z.boolean().optional(),
|
|
39
|
+
});
|
|
40
|
+
/**
|
|
41
|
+
* Segment within a stats response (used when segmentby is applied)
|
|
42
|
+
*/
|
|
43
|
+
export const AnalyticsSegmentSchema = z.object({
|
|
44
|
+
segment_id: z.number(),
|
|
45
|
+
segment_label: z.string().optional(),
|
|
46
|
+
subtotals: z.record(z.string(), z.unknown()),
|
|
47
|
+
});
|
|
48
|
+
export const AnalyticsLinkSchema = z.object({
|
|
49
|
+
href: z.string(),
|
|
50
|
+
});
|
|
51
|
+
export const AnalyticsLinksSchema = z.record(z.string(), z.array(AnalyticsLinkSchema));
|
|
52
|
+
//# sourceMappingURL=common.types.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"common.types.js","sourceRoot":"","sources":["../../../../src/lib/types/analytics/common.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,IAAI,CAAC;IAC1C,MAAM;IACN,KAAK;IACL,MAAM;IACN,OAAO;IACP,SAAS;IACT,MAAM;CACP,CAAC,CAAC;AAGH;;GAEG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,CAAC,MAAM,CAAC;IACtD,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,QAAQ,EAAE,qBAAqB,CAAC,QAAQ,EAAE;IAC1C,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE;IACzC,mBAAmB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC3C,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CACvC,CAAC,CAAC;AAKH;;GAEG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,CAAC,MAAM,CAAC;IACrD,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE;IACzC,aAAa,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACrC,mBAAmB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CAC5C,CAAC,CAAC;AAKH;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7C,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;CAC7C,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;CACjB,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAC1C,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAC7B,CAAC"}
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
/**
|
|
3
|
+
* Coupon stats totals/subtotals shape
|
|
4
|
+
*/
|
|
5
|
+
export declare const AnalyticsCouponStatsSchema: z.ZodObject<{
|
|
6
|
+
amount: z.ZodNumber;
|
|
7
|
+
coupons_count: z.ZodNumber;
|
|
8
|
+
orders_count: z.ZodNumber;
|
|
9
|
+
}, z.core.$strip>;
|
|
10
|
+
export type AnalyticsCouponStats = z.infer<typeof AnalyticsCouponStatsSchema>;
|
|
11
|
+
/**
|
|
12
|
+
* Extended info for a coupon detail row
|
|
13
|
+
*/
|
|
14
|
+
export declare const AnalyticsCouponExtendedInfoSchema: z.ZodObject<{
|
|
15
|
+
code: z.ZodOptional<z.ZodString>;
|
|
16
|
+
date_created: z.ZodOptional<z.ZodString>;
|
|
17
|
+
date_created_gmt: z.ZodOptional<z.ZodString>;
|
|
18
|
+
date_expires: z.ZodOptional<z.ZodString>;
|
|
19
|
+
date_expires_gmt: z.ZodOptional<z.ZodString>;
|
|
20
|
+
discount_type: z.ZodOptional<z.ZodString>;
|
|
21
|
+
}, z.core.$strip>;
|
|
22
|
+
export type AnalyticsCouponExtendedInfo = z.infer<typeof AnalyticsCouponExtendedInfoSchema>;
|
|
23
|
+
/**
|
|
24
|
+
* Single coupon row from the coupons detail endpoint
|
|
25
|
+
*/
|
|
26
|
+
export declare const AnalyticsCouponSchema: z.ZodObject<{
|
|
27
|
+
coupon_id: z.ZodNumber;
|
|
28
|
+
amount: z.ZodNumber;
|
|
29
|
+
orders_count: z.ZodNumber;
|
|
30
|
+
extended_info: z.ZodOptional<z.ZodObject<{
|
|
31
|
+
code: z.ZodOptional<z.ZodString>;
|
|
32
|
+
date_created: z.ZodOptional<z.ZodString>;
|
|
33
|
+
date_created_gmt: z.ZodOptional<z.ZodString>;
|
|
34
|
+
date_expires: z.ZodOptional<z.ZodString>;
|
|
35
|
+
date_expires_gmt: z.ZodOptional<z.ZodString>;
|
|
36
|
+
discount_type: z.ZodOptional<z.ZodString>;
|
|
37
|
+
}, z.core.$strip>>;
|
|
38
|
+
_links: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
|
|
39
|
+
href: z.ZodString;
|
|
40
|
+
}, z.core.$strip>>>>;
|
|
41
|
+
}, z.core.$strip>;
|
|
42
|
+
export type AnalyticsCoupon = z.infer<typeof AnalyticsCouponSchema>;
|
|
43
|
+
/**
|
|
44
|
+
* Query parameters for coupons stats endpoint
|
|
45
|
+
*/
|
|
46
|
+
export declare const AnalyticsCouponsStatsQueryParamsSchema: z.ZodObject<{
|
|
47
|
+
before: z.ZodOptional<z.ZodString>;
|
|
48
|
+
after: z.ZodOptional<z.ZodString>;
|
|
49
|
+
interval: z.ZodOptional<z.ZodEnum<{
|
|
50
|
+
hour: "hour";
|
|
51
|
+
day: "day";
|
|
52
|
+
week: "week";
|
|
53
|
+
month: "month";
|
|
54
|
+
quarter: "quarter";
|
|
55
|
+
year: "year";
|
|
56
|
+
}>>;
|
|
57
|
+
page: z.ZodOptional<z.ZodNumber>;
|
|
58
|
+
per_page: z.ZodOptional<z.ZodNumber>;
|
|
59
|
+
orderby: z.ZodOptional<z.ZodString>;
|
|
60
|
+
order: z.ZodOptional<z.ZodEnum<{
|
|
61
|
+
asc: "asc";
|
|
62
|
+
desc: "desc";
|
|
63
|
+
}>>;
|
|
64
|
+
force_cache_refresh: z.ZodOptional<z.ZodBoolean>;
|
|
65
|
+
fields: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
66
|
+
coupons: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
|
|
67
|
+
}, z.core.$strip>;
|
|
68
|
+
export type AnalyticsCouponsStatsQueryParams = z.infer<typeof AnalyticsCouponsStatsQueryParamsSchema>;
|
|
69
|
+
/**
|
|
70
|
+
* Query parameters for coupons list (detail) endpoint
|
|
71
|
+
*/
|
|
72
|
+
export declare const AnalyticsCouponsListQueryParamsSchema: z.ZodObject<{
|
|
73
|
+
before: z.ZodOptional<z.ZodString>;
|
|
74
|
+
after: z.ZodOptional<z.ZodString>;
|
|
75
|
+
page: z.ZodOptional<z.ZodNumber>;
|
|
76
|
+
per_page: z.ZodOptional<z.ZodNumber>;
|
|
77
|
+
orderby: z.ZodOptional<z.ZodString>;
|
|
78
|
+
order: z.ZodOptional<z.ZodEnum<{
|
|
79
|
+
asc: "asc";
|
|
80
|
+
desc: "desc";
|
|
81
|
+
}>>;
|
|
82
|
+
extended_info: z.ZodOptional<z.ZodBoolean>;
|
|
83
|
+
force_cache_refresh: z.ZodOptional<z.ZodBoolean>;
|
|
84
|
+
coupons: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
|
|
85
|
+
}, z.core.$strip>;
|
|
86
|
+
export type AnalyticsCouponsListQueryParams = z.infer<typeof AnalyticsCouponsListQueryParamsSchema>;
|
|
87
|
+
//# sourceMappingURL=coupons.types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"coupons.types.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/analytics/coupons.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAOxB;;GAEG;AACH,eAAO,MAAM,0BAA0B;;;;iBAIrC,CAAC;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E;;GAEG;AACH,eAAO,MAAM,iCAAiC;;;;;;;iBAO5C,CAAC;AACH,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,iCAAiC,CACzC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;iBAMhC,CAAC;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpE;;GAEG;AACH,eAAO,MAAM,sCAAsC;;;;;;;;;;;;;;;;;;;;;iBAG/C,CAAC;AACL,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,sCAAsC,CAC9C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,qCAAqC;;;;;;;;;;;;;iBAG9C,CAAC;AACL,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,qCAAqC,CAC7C,CAAC"}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import { AnalyticsStatsQueryParamsSchema, AnalyticsListQueryParamsSchema, AnalyticsLinksSchema, } from './common.types.js';
|
|
3
|
+
/**
|
|
4
|
+
* Coupon stats totals/subtotals shape
|
|
5
|
+
*/
|
|
6
|
+
export const AnalyticsCouponStatsSchema = z.object({
|
|
7
|
+
amount: z.number(),
|
|
8
|
+
coupons_count: z.number(),
|
|
9
|
+
orders_count: z.number(),
|
|
10
|
+
});
|
|
11
|
+
/**
|
|
12
|
+
* Extended info for a coupon detail row
|
|
13
|
+
*/
|
|
14
|
+
export const AnalyticsCouponExtendedInfoSchema = z.object({
|
|
15
|
+
code: z.string().optional(),
|
|
16
|
+
date_created: z.string().optional(),
|
|
17
|
+
date_created_gmt: z.string().optional(),
|
|
18
|
+
date_expires: z.string().optional(),
|
|
19
|
+
date_expires_gmt: z.string().optional(),
|
|
20
|
+
discount_type: z.string().optional(),
|
|
21
|
+
});
|
|
22
|
+
/**
|
|
23
|
+
* Single coupon row from the coupons detail endpoint
|
|
24
|
+
*/
|
|
25
|
+
export const AnalyticsCouponSchema = z.object({
|
|
26
|
+
coupon_id: z.number(),
|
|
27
|
+
amount: z.number(),
|
|
28
|
+
orders_count: z.number(),
|
|
29
|
+
extended_info: AnalyticsCouponExtendedInfoSchema.optional(),
|
|
30
|
+
_links: AnalyticsLinksSchema.optional(),
|
|
31
|
+
});
|
|
32
|
+
/**
|
|
33
|
+
* Query parameters for coupons stats endpoint
|
|
34
|
+
*/
|
|
35
|
+
export const AnalyticsCouponsStatsQueryParamsSchema = AnalyticsStatsQueryParamsSchema.extend({
|
|
36
|
+
coupons: z.array(z.number()).optional(),
|
|
37
|
+
});
|
|
38
|
+
/**
|
|
39
|
+
* Query parameters for coupons list (detail) endpoint
|
|
40
|
+
*/
|
|
41
|
+
export const AnalyticsCouponsListQueryParamsSchema = AnalyticsListQueryParamsSchema.extend({
|
|
42
|
+
coupons: z.array(z.number()).optional(),
|
|
43
|
+
});
|
|
44
|
+
//# sourceMappingURL=coupons.types.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"coupons.types.js","sourceRoot":"","sources":["../../../../src/lib/types/analytics/coupons.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,+BAA+B,EAC/B,8BAA8B,EAC9B,oBAAoB,GACrB,MAAM,mBAAmB,CAAC;AAE3B;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE;IACzB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;CACzB,CAAC,CAAC;AAGH;;GAEG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAAC,CAAC,MAAM,CAAC;IACxD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACrC,CAAC,CAAC;AAKH;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,aAAa,EAAE,iCAAiC,CAAC,QAAQ,EAAE;IAC3D,MAAM,EAAE,oBAAoB,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC;AAGH;;GAEG;AACH,MAAM,CAAC,MAAM,sCAAsC,GACjD,+BAA+B,CAAC,MAAM,CAAC;IACrC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC;AAKL;;GAEG;AACH,MAAM,CAAC,MAAM,qCAAqC,GAChD,8BAA8B,CAAC,MAAM,CAAC;IACpC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC"}
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
/**
|
|
3
|
+
* Customer stats totals/subtotals shape
|
|
4
|
+
*/
|
|
5
|
+
export declare const AnalyticsCustomerStatsSchema: z.ZodObject<{
|
|
6
|
+
customers_count: z.ZodNumber;
|
|
7
|
+
avg_orders_count: z.ZodNumber;
|
|
8
|
+
avg_total_spend: z.ZodNumber;
|
|
9
|
+
avg_avg_order_value: z.ZodNumber;
|
|
10
|
+
}, z.core.$strip>;
|
|
11
|
+
export type AnalyticsCustomerStats = z.infer<typeof AnalyticsCustomerStatsSchema>;
|
|
12
|
+
/**
|
|
13
|
+
* Single customer row from the customers detail endpoint
|
|
14
|
+
*/
|
|
15
|
+
export declare const AnalyticsCustomerSchema: z.ZodObject<{
|
|
16
|
+
id: z.ZodNumber;
|
|
17
|
+
user_id: z.ZodNumber;
|
|
18
|
+
name: z.ZodString;
|
|
19
|
+
username: z.ZodString;
|
|
20
|
+
first_name: z.ZodOptional<z.ZodString>;
|
|
21
|
+
last_name: z.ZodOptional<z.ZodString>;
|
|
22
|
+
country: z.ZodString;
|
|
23
|
+
city: z.ZodString;
|
|
24
|
+
state: z.ZodString;
|
|
25
|
+
postcode: z.ZodString;
|
|
26
|
+
date_registered: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
27
|
+
date_registered_gmt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
28
|
+
date_last_active: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
29
|
+
date_last_active_gmt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
30
|
+
date_last_order: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
31
|
+
orders_count: z.ZodNumber;
|
|
32
|
+
total_spend: z.ZodNumber;
|
|
33
|
+
avg_order_value: z.ZodNumber;
|
|
34
|
+
email: z.ZodOptional<z.ZodString>;
|
|
35
|
+
_links: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
|
|
36
|
+
href: z.ZodString;
|
|
37
|
+
}, z.core.$strip>>>>;
|
|
38
|
+
}, z.core.$strip>;
|
|
39
|
+
export type AnalyticsCustomer = z.infer<typeof AnalyticsCustomerSchema>;
|
|
40
|
+
/**
|
|
41
|
+
* Query parameters for customers stats endpoint
|
|
42
|
+
*/
|
|
43
|
+
export declare const AnalyticsCustomersStatsQueryParamsSchema: z.ZodObject<{
|
|
44
|
+
before: z.ZodOptional<z.ZodString>;
|
|
45
|
+
after: z.ZodOptional<z.ZodString>;
|
|
46
|
+
interval: z.ZodOptional<z.ZodEnum<{
|
|
47
|
+
hour: "hour";
|
|
48
|
+
day: "day";
|
|
49
|
+
week: "week";
|
|
50
|
+
month: "month";
|
|
51
|
+
quarter: "quarter";
|
|
52
|
+
year: "year";
|
|
53
|
+
}>>;
|
|
54
|
+
page: z.ZodOptional<z.ZodNumber>;
|
|
55
|
+
per_page: z.ZodOptional<z.ZodNumber>;
|
|
56
|
+
orderby: z.ZodOptional<z.ZodString>;
|
|
57
|
+
order: z.ZodOptional<z.ZodEnum<{
|
|
58
|
+
asc: "asc";
|
|
59
|
+
desc: "desc";
|
|
60
|
+
}>>;
|
|
61
|
+
force_cache_refresh: z.ZodOptional<z.ZodBoolean>;
|
|
62
|
+
fields: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
63
|
+
match: z.ZodOptional<z.ZodEnum<{
|
|
64
|
+
any: "any";
|
|
65
|
+
all: "all";
|
|
66
|
+
}>>;
|
|
67
|
+
search: z.ZodOptional<z.ZodString>;
|
|
68
|
+
searchby: z.ZodOptional<z.ZodEnum<{
|
|
69
|
+
name: "name";
|
|
70
|
+
username: "username";
|
|
71
|
+
email: "email";
|
|
72
|
+
}>>;
|
|
73
|
+
customers: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
|
|
74
|
+
}, z.core.$strip>;
|
|
75
|
+
export type AnalyticsCustomersStatsQueryParams = z.infer<typeof AnalyticsCustomersStatsQueryParamsSchema>;
|
|
76
|
+
/**
|
|
77
|
+
* Query parameters for customers list (detail) endpoint
|
|
78
|
+
*/
|
|
79
|
+
export declare const AnalyticsCustomersListQueryParamsSchema: z.ZodObject<{
|
|
80
|
+
before: z.ZodOptional<z.ZodString>;
|
|
81
|
+
after: z.ZodOptional<z.ZodString>;
|
|
82
|
+
page: z.ZodOptional<z.ZodNumber>;
|
|
83
|
+
per_page: z.ZodOptional<z.ZodNumber>;
|
|
84
|
+
orderby: z.ZodOptional<z.ZodString>;
|
|
85
|
+
order: z.ZodOptional<z.ZodEnum<{
|
|
86
|
+
asc: "asc";
|
|
87
|
+
desc: "desc";
|
|
88
|
+
}>>;
|
|
89
|
+
extended_info: z.ZodOptional<z.ZodBoolean>;
|
|
90
|
+
force_cache_refresh: z.ZodOptional<z.ZodBoolean>;
|
|
91
|
+
match: z.ZodOptional<z.ZodEnum<{
|
|
92
|
+
any: "any";
|
|
93
|
+
all: "all";
|
|
94
|
+
}>>;
|
|
95
|
+
search: z.ZodOptional<z.ZodString>;
|
|
96
|
+
searchby: z.ZodOptional<z.ZodEnum<{
|
|
97
|
+
name: "name";
|
|
98
|
+
username: "username";
|
|
99
|
+
email: "email";
|
|
100
|
+
}>>;
|
|
101
|
+
customers: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
|
|
102
|
+
name: z.ZodOptional<z.ZodString>;
|
|
103
|
+
email: z.ZodOptional<z.ZodString>;
|
|
104
|
+
country: z.ZodOptional<z.ZodString>;
|
|
105
|
+
}, z.core.$strip>;
|
|
106
|
+
export type AnalyticsCustomersListQueryParams = z.infer<typeof AnalyticsCustomersListQueryParamsSchema>;
|
|
107
|
+
//# sourceMappingURL=customers.types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"customers.types.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/analytics/customers.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAOxB;;GAEG;AACH,eAAO,MAAM,4BAA4B;;;;;iBAKvC,CAAC;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAC1C,OAAO,4BAA4B,CACpC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;iBAqBlC,CAAC;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE;;GAEG;AACH,eAAO,MAAM,wCAAwC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAMjD,CAAC;AACL,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,wCAAwC,CAChD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,uCAAuC;;;;;;;;;;;;;;;;;;;;;;;;;;iBAShD,CAAC;AACL,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,uCAAuC,CAC/C,CAAC"}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import { AnalyticsStatsQueryParamsSchema, AnalyticsListQueryParamsSchema, AnalyticsLinksSchema, } from './common.types.js';
|
|
3
|
+
/**
|
|
4
|
+
* Customer stats totals/subtotals shape
|
|
5
|
+
*/
|
|
6
|
+
export const AnalyticsCustomerStatsSchema = z.object({
|
|
7
|
+
customers_count: z.number(),
|
|
8
|
+
avg_orders_count: z.number(),
|
|
9
|
+
avg_total_spend: z.number(),
|
|
10
|
+
avg_avg_order_value: z.number(),
|
|
11
|
+
});
|
|
12
|
+
/**
|
|
13
|
+
* Single customer row from the customers detail endpoint
|
|
14
|
+
*/
|
|
15
|
+
export const AnalyticsCustomerSchema = z.object({
|
|
16
|
+
id: z.number(),
|
|
17
|
+
user_id: z.number(),
|
|
18
|
+
name: z.string(),
|
|
19
|
+
username: z.string(),
|
|
20
|
+
first_name: z.string().optional(),
|
|
21
|
+
last_name: z.string().optional(),
|
|
22
|
+
country: z.string(),
|
|
23
|
+
city: z.string(),
|
|
24
|
+
state: z.string(),
|
|
25
|
+
postcode: z.string(),
|
|
26
|
+
date_registered: z.string().nullable().optional(),
|
|
27
|
+
date_registered_gmt: z.string().nullable().optional(),
|
|
28
|
+
date_last_active: z.string().nullable().optional(),
|
|
29
|
+
date_last_active_gmt: z.string().nullable().optional(),
|
|
30
|
+
date_last_order: z.string().nullable().optional(),
|
|
31
|
+
orders_count: z.number(),
|
|
32
|
+
total_spend: z.number(),
|
|
33
|
+
avg_order_value: z.number(),
|
|
34
|
+
email: z.string().optional(),
|
|
35
|
+
_links: AnalyticsLinksSchema.optional(),
|
|
36
|
+
});
|
|
37
|
+
/**
|
|
38
|
+
* Query parameters for customers stats endpoint
|
|
39
|
+
*/
|
|
40
|
+
export const AnalyticsCustomersStatsQueryParamsSchema = AnalyticsStatsQueryParamsSchema.extend({
|
|
41
|
+
match: z.enum(['all', 'any']).optional(),
|
|
42
|
+
search: z.string().optional(),
|
|
43
|
+
searchby: z.enum(['name', 'username', 'email']).optional(),
|
|
44
|
+
customers: z.array(z.number()).optional(),
|
|
45
|
+
});
|
|
46
|
+
/**
|
|
47
|
+
* Query parameters for customers list (detail) endpoint
|
|
48
|
+
*/
|
|
49
|
+
export const AnalyticsCustomersListQueryParamsSchema = AnalyticsListQueryParamsSchema.extend({
|
|
50
|
+
match: z.enum(['all', 'any']).optional(),
|
|
51
|
+
search: z.string().optional(),
|
|
52
|
+
searchby: z.enum(['name', 'username', 'email']).optional(),
|
|
53
|
+
customers: z.array(z.number()).optional(),
|
|
54
|
+
name: z.string().optional(),
|
|
55
|
+
email: z.string().optional(),
|
|
56
|
+
country: z.string().optional(),
|
|
57
|
+
});
|
|
58
|
+
//# sourceMappingURL=customers.types.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"customers.types.js","sourceRoot":"","sources":["../../../../src/lib/types/analytics/customers.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,+BAA+B,EAC/B,8BAA8B,EAC9B,oBAAoB,GACrB,MAAM,mBAAmB,CAAC;AAE3B;;GAEG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE;IAC3B,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC5B,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE;IAC3B,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE;CAChC,CAAC,CAAC;AAKH;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACjD,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACrD,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAClD,oBAAoB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACtD,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACjD,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE;IAC3B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,MAAM,EAAE,oBAAoB,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC;AAGH;;GAEG;AACH,MAAM,CAAC,MAAM,wCAAwC,GACnD,+BAA+B,CAAC,MAAM,CAAC;IACrC,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,QAAQ,EAAE;IACxC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC1D,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CAC1C,CAAC,CAAC;AAKL;;GAEG;AACH,MAAM,CAAC,MAAM,uCAAuC,GAClD,8BAA8B,CAAC,MAAM,CAAC;IACpC,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,QAAQ,EAAE;IACxC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC1D,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACzC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC,CAAC"}
|