@open-loyalty/mcp-server 1.3.7 → 1.5.3

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 (100) hide show
  1. package/dist/config.d.ts +4 -3
  2. package/dist/config.js +9 -7
  3. package/dist/instructions.d.ts +1 -1
  4. package/dist/instructions.js +26 -8
  5. package/dist/tools/achievement/handlers.js +60 -1
  6. package/dist/tools/achievement/index.d.ts +8 -8
  7. package/dist/tools/achievement/index.js +10 -11
  8. package/dist/tools/achievement/schemas.d.ts +8 -8
  9. package/dist/tools/achievement/schemas.js +36 -32
  10. package/dist/tools/analytics.js +9 -9
  11. package/dist/tools/badge.js +4 -4
  12. package/dist/tools/campaign/handlers.js +35 -1
  13. package/dist/tools/campaign/index.d.ts +97 -34
  14. package/dist/tools/campaign/index.js +14 -12
  15. package/dist/tools/campaign/schemas.d.ts +96 -33
  16. package/dist/tools/campaign/schemas.js +89 -55
  17. package/dist/tools/custom-event.js +10 -9
  18. package/dist/tools/export.js +4 -4
  19. package/dist/tools/import.d.ts +1 -1
  20. package/dist/tools/import.js +11 -6
  21. package/dist/tools/index.js +4 -4
  22. package/dist/tools/member/handlers.js +48 -1
  23. package/dist/tools/member/index.d.ts +1 -1
  24. package/dist/tools/member/index.js +3 -1
  25. package/dist/tools/member/schemas.js +12 -12
  26. package/dist/tools/points/handlers.d.ts +75 -0
  27. package/dist/tools/{points.js → points/handlers.js} +21 -112
  28. package/dist/tools/points/index.d.ts +84 -0
  29. package/dist/tools/points/index.js +63 -0
  30. package/dist/tools/points/schemas.d.ts +45 -0
  31. package/dist/tools/points/schemas.js +47 -0
  32. package/dist/tools/referral/schemas.js +3 -3
  33. package/dist/tools/reward/handlers.d.ts +2 -0
  34. package/dist/tools/reward/handlers.js +79 -6
  35. package/dist/tools/reward/index.d.ts +2 -0
  36. package/dist/tools/reward/index.js +10 -10
  37. package/dist/tools/reward/schemas.d.ts +2 -0
  38. package/dist/tools/reward/schemas.js +42 -23
  39. package/dist/tools/segment/index.js +7 -5
  40. package/dist/tools/segment/schemas.js +11 -11
  41. package/dist/tools/tierset/handlers.d.ts +26 -0
  42. package/dist/tools/tierset/handlers.js +196 -0
  43. package/dist/tools/tierset/index.d.ts +124 -0
  44. package/dist/tools/tierset/index.js +88 -0
  45. package/dist/tools/tierset/schemas.d.ts +127 -0
  46. package/dist/tools/tierset/schemas.js +62 -0
  47. package/dist/tools/transaction/handlers.d.ts +89 -0
  48. package/dist/tools/transaction/handlers.js +159 -0
  49. package/dist/tools/transaction/index.d.ts +153 -0
  50. package/dist/tools/transaction/index.js +54 -0
  51. package/dist/tools/transaction/schemas.d.ts +126 -0
  52. package/dist/tools/transaction/schemas.js +60 -0
  53. package/dist/tools/wallet-type/handlers.d.ts +63 -0
  54. package/dist/tools/{wallet-type.js → wallet-type/handlers.js} +15 -78
  55. package/dist/tools/{wallet-type.d.ts → wallet-type/index.d.ts} +3 -64
  56. package/dist/tools/wallet-type/index.js +65 -0
  57. package/dist/tools/wallet-type/schemas.d.ts +1 -0
  58. package/dist/tools/wallet-type/schemas.js +1 -0
  59. package/dist/tools/webhook.js +6 -6
  60. package/dist/types/schemas/achievement.d.ts +48 -48
  61. package/dist/types/schemas/admin.d.ts +10 -10
  62. package/dist/types/schemas/campaign.d.ts +12 -12
  63. package/dist/types/schemas/common.js +1 -1
  64. package/dist/types/schemas/member.d.ts +18 -18
  65. package/dist/types/schemas/role.d.ts +4 -4
  66. package/dist/types/schemas/tierset.js +2 -1
  67. package/dist/types/schemas/transaction.d.ts +12 -12
  68. package/dist/types/schemas/wallet-type.js +12 -10
  69. package/dist/types/schemas/webhook.d.ts +6 -6
  70. package/dist/utils/errors.js +40 -0
  71. package/package.json +3 -2
  72. package/dist/prompts/fan-engagement-setup.d.ts +0 -107
  73. package/dist/prompts/fan-engagement-setup.js +0 -492
  74. package/dist/tools/achievement.d.ts +0 -1017
  75. package/dist/tools/achievement.js +0 -354
  76. package/dist/tools/campaign.d.ts +0 -1800
  77. package/dist/tools/campaign.js +0 -737
  78. package/dist/tools/member.d.ts +0 -366
  79. package/dist/tools/member.js +0 -352
  80. package/dist/tools/points.d.ts +0 -201
  81. package/dist/tools/reward.d.ts +0 -279
  82. package/dist/tools/reward.js +0 -361
  83. package/dist/tools/segment.d.ts +0 -816
  84. package/dist/tools/segment.js +0 -333
  85. package/dist/tools/tierset.d.ts +0 -273
  86. package/dist/tools/tierset.js +0 -289
  87. package/dist/tools/transaction.d.ts +0 -365
  88. package/dist/tools/transaction.js +0 -259
  89. package/dist/workflows/app-login-streak.d.ts +0 -39
  90. package/dist/workflows/app-login-streak.js +0 -298
  91. package/dist/workflows/early-arrival.d.ts +0 -33
  92. package/dist/workflows/early-arrival.js +0 -148
  93. package/dist/workflows/index.d.ts +0 -101
  94. package/dist/workflows/index.js +0 -208
  95. package/dist/workflows/match-attendance.d.ts +0 -45
  96. package/dist/workflows/match-attendance.js +0 -308
  97. package/dist/workflows/sportsbar-visit.d.ts +0 -41
  98. package/dist/workflows/sportsbar-visit.js +0 -284
  99. package/dist/workflows/vod-watching.d.ts +0 -43
  100. package/dist/workflows/vod-watching.js +0 -326
package/dist/tools/segment.d.ts DELETED
@@ -1,816 +0,0 @@
1
- import { z } from "zod";
2
- import { SegmentListItem } from "../types/schemas/segment.js";
3
- export declare const SegmentListInputSchema: {
4
- storeCode: z.ZodOptional<z.ZodString>;
5
- page: z.ZodOptional<z.ZodNumber>;
6
- perPage: z.ZodOptional<z.ZodNumber>;
7
- active: z.ZodOptional<z.ZodBoolean>;
8
- name: z.ZodOptional<z.ZodString>;
9
- };
10
- export declare const SegmentCreateInputSchema: {
11
- storeCode: z.ZodOptional<z.ZodString>;
12
- name: z.ZodString;
13
- description: z.ZodOptional<z.ZodString>;
14
- active: z.ZodOptional<z.ZodBoolean>;
15
- parts: z.ZodArray<z.ZodObject<{
16
- segmentPartId: z.ZodOptional<z.ZodString>;
17
- criteria: z.ZodArray<z.ZodObject<{
18
- type: z.ZodString;
19
- criterionId: z.ZodOptional<z.ZodString>;
20
- days: z.ZodOptional<z.ZodNumber>;
21
- fromDate: z.ZodOptional<z.ZodString>;
22
- toDate: z.ZodOptional<z.ZodString>;
23
- min: z.ZodOptional<z.ZodNumber>;
24
- max: z.ZodOptional<z.ZodNumber>;
25
- posIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
26
- skus: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
27
- makers: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
28
- labels: z.ZodOptional<z.ZodArray<z.ZodObject<{
29
- key: z.ZodString;
30
- value: z.ZodString;
31
- }, "strip", z.ZodTypeAny, {
32
- value: string;
33
- key: string;
34
- }, {
35
- value: string;
36
- key: string;
37
- }>, "many">>;
38
- tierIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
39
- campaignId: z.ZodOptional<z.ZodString>;
40
- countries: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
41
- anniversaryType: z.ZodOptional<z.ZodString>;
42
- customAttributeKey: z.ZodOptional<z.ZodString>;
43
- customAttributeValue: z.ZodOptional<z.ZodString>;
44
- }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
45
- type: z.ZodString;
46
- criterionId: z.ZodOptional<z.ZodString>;
47
- days: z.ZodOptional<z.ZodNumber>;
48
- fromDate: z.ZodOptional<z.ZodString>;
49
- toDate: z.ZodOptional<z.ZodString>;
50
- min: z.ZodOptional<z.ZodNumber>;
51
- max: z.ZodOptional<z.ZodNumber>;
52
- posIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
53
- skus: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
54
- makers: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
55
- labels: z.ZodOptional<z.ZodArray<z.ZodObject<{
56
- key: z.ZodString;
57
- value: z.ZodString;
58
- }, "strip", z.ZodTypeAny, {
59
- value: string;
60
- key: string;
61
- }, {
62
- value: string;
63
- key: string;
64
- }>, "many">>;
65
- tierIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
66
- campaignId: z.ZodOptional<z.ZodString>;
67
- countries: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
68
- anniversaryType: z.ZodOptional<z.ZodString>;
69
- customAttributeKey: z.ZodOptional<z.ZodString>;
70
- customAttributeValue: z.ZodOptional<z.ZodString>;
71
- }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
72
- type: z.ZodString;
73
- criterionId: z.ZodOptional<z.ZodString>;
74
- days: z.ZodOptional<z.ZodNumber>;
75
- fromDate: z.ZodOptional<z.ZodString>;
76
- toDate: z.ZodOptional<z.ZodString>;
77
- min: z.ZodOptional<z.ZodNumber>;
78
- max: z.ZodOptional<z.ZodNumber>;
79
- posIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
80
- skus: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
81
- makers: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
82
- labels: z.ZodOptional<z.ZodArray<z.ZodObject<{
83
- key: z.ZodString;
84
- value: z.ZodString;
85
- }, "strip", z.ZodTypeAny, {
86
- value: string;
87
- key: string;
88
- }, {
89
- value: string;
90
- key: string;
91
- }>, "many">>;
92
- tierIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
93
- campaignId: z.ZodOptional<z.ZodString>;
94
- countries: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
95
- anniversaryType: z.ZodOptional<z.ZodString>;
96
- customAttributeKey: z.ZodOptional<z.ZodString>;
97
- customAttributeValue: z.ZodOptional<z.ZodString>;
98
- }, z.ZodTypeAny, "passthrough">>, "many">;
99
- }, "strip", z.ZodTypeAny, {
100
- criteria: z.objectOutputType<{
101
- type: z.ZodString;
102
- criterionId: z.ZodOptional<z.ZodString>;
103
- days: z.ZodOptional<z.ZodNumber>;
104
- fromDate: z.ZodOptional<z.ZodString>;
105
- toDate: z.ZodOptional<z.ZodString>;
106
- min: z.ZodOptional<z.ZodNumber>;
107
- max: z.ZodOptional<z.ZodNumber>;
108
- posIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
109
- skus: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
110
- makers: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
111
- labels: z.ZodOptional<z.ZodArray<z.ZodObject<{
112
- key: z.ZodString;
113
- value: z.ZodString;
114
- }, "strip", z.ZodTypeAny, {
115
- value: string;
116
- key: string;
117
- }, {
118
- value: string;
119
- key: string;
120
- }>, "many">>;
121
- tierIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
122
- campaignId: z.ZodOptional<z.ZodString>;
123
- countries: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
124
- anniversaryType: z.ZodOptional<z.ZodString>;
125
- customAttributeKey: z.ZodOptional<z.ZodString>;
126
- customAttributeValue: z.ZodOptional<z.ZodString>;
127
- }, z.ZodTypeAny, "passthrough">[];
128
- segmentPartId?: string | undefined;
129
- }, {
130
- criteria: z.objectInputType<{
131
- type: z.ZodString;
132
- criterionId: z.ZodOptional<z.ZodString>;
133
- days: z.ZodOptional<z.ZodNumber>;
134
- fromDate: z.ZodOptional<z.ZodString>;
135
- toDate: z.ZodOptional<z.ZodString>;
136
- min: z.ZodOptional<z.ZodNumber>;
137
- max: z.ZodOptional<z.ZodNumber>;
138
- posIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
139
- skus: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
140
- makers: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
141
- labels: z.ZodOptional<z.ZodArray<z.ZodObject<{
142
- key: z.ZodString;
143
- value: z.ZodString;
144
- }, "strip", z.ZodTypeAny, {
145
- value: string;
146
- key: string;
147
- }, {
148
- value: string;
149
- key: string;
150
- }>, "many">>;
151
- tierIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
152
- campaignId: z.ZodOptional<z.ZodString>;
153
- countries: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
154
- anniversaryType: z.ZodOptional<z.ZodString>;
155
- customAttributeKey: z.ZodOptional<z.ZodString>;
156
- customAttributeValue: z.ZodOptional<z.ZodString>;
157
- }, z.ZodTypeAny, "passthrough">[];
158
- segmentPartId?: string | undefined;
159
- }>, "many">;
160
- };
161
- export declare const SegmentGetInputSchema: {
162
- storeCode: z.ZodOptional<z.ZodString>;
163
- segmentId: z.ZodString;
164
- };
165
- export declare const SegmentUpdateInputSchema: {
166
- storeCode: z.ZodOptional<z.ZodString>;
167
- segmentId: z.ZodString;
168
- name: z.ZodString;
169
- description: z.ZodOptional<z.ZodString>;
170
- active: z.ZodOptional<z.ZodBoolean>;
171
- parts: z.ZodArray<z.ZodObject<{
172
- segmentPartId: z.ZodOptional<z.ZodString>;
173
- criteria: z.ZodArray<z.ZodObject<{
174
- type: z.ZodString;
175
- criterionId: z.ZodOptional<z.ZodString>;
176
- days: z.ZodOptional<z.ZodNumber>;
177
- fromDate: z.ZodOptional<z.ZodString>;
178
- toDate: z.ZodOptional<z.ZodString>;
179
- min: z.ZodOptional<z.ZodNumber>;
180
- max: z.ZodOptional<z.ZodNumber>;
181
- posIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
182
- skus: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
183
- makers: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
184
- labels: z.ZodOptional<z.ZodArray<z.ZodObject<{
185
- key: z.ZodString;
186
- value: z.ZodString;
187
- }, "strip", z.ZodTypeAny, {
188
- value: string;
189
- key: string;
190
- }, {
191
- value: string;
192
- key: string;
193
- }>, "many">>;
194
- tierIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
195
- campaignId: z.ZodOptional<z.ZodString>;
196
- countries: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
197
- anniversaryType: z.ZodOptional<z.ZodString>;
198
- customAttributeKey: z.ZodOptional<z.ZodString>;
199
- customAttributeValue: z.ZodOptional<z.ZodString>;
200
- }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
201
- type: z.ZodString;
202
- criterionId: z.ZodOptional<z.ZodString>;
203
- days: z.ZodOptional<z.ZodNumber>;
204
- fromDate: z.ZodOptional<z.ZodString>;
205
- toDate: z.ZodOptional<z.ZodString>;
206
- min: z.ZodOptional<z.ZodNumber>;
207
- max: z.ZodOptional<z.ZodNumber>;
208
- posIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
209
- skus: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
210
- makers: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
211
- labels: z.ZodOptional<z.ZodArray<z.ZodObject<{
212
- key: z.ZodString;
213
- value: z.ZodString;
214
- }, "strip", z.ZodTypeAny, {
215
- value: string;
216
- key: string;
217
- }, {
218
- value: string;
219
- key: string;
220
- }>, "many">>;
221
- tierIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
222
- campaignId: z.ZodOptional<z.ZodString>;
223
- countries: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
224
- anniversaryType: z.ZodOptional<z.ZodString>;
225
- customAttributeKey: z.ZodOptional<z.ZodString>;
226
- customAttributeValue: z.ZodOptional<z.ZodString>;
227
- }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
228
- type: z.ZodString;
229
- criterionId: z.ZodOptional<z.ZodString>;
230
- days: z.ZodOptional<z.ZodNumber>;
231
- fromDate: z.ZodOptional<z.ZodString>;
232
- toDate: z.ZodOptional<z.ZodString>;
233
- min: z.ZodOptional<z.ZodNumber>;
234
- max: z.ZodOptional<z.ZodNumber>;
235
- posIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
236
- skus: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
237
- makers: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
238
- labels: z.ZodOptional<z.ZodArray<z.ZodObject<{
239
- key: z.ZodString;
240
- value: z.ZodString;
241
- }, "strip", z.ZodTypeAny, {
242
- value: string;
243
- key: string;
244
- }, {
245
- value: string;
246
- key: string;
247
- }>, "many">>;
248
- tierIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
249
- campaignId: z.ZodOptional<z.ZodString>;
250
- countries: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
251
- anniversaryType: z.ZodOptional<z.ZodString>;
252
- customAttributeKey: z.ZodOptional<z.ZodString>;
253
- customAttributeValue: z.ZodOptional<z.ZodString>;
254
- }, z.ZodTypeAny, "passthrough">>, "many">;
255
- }, "strip", z.ZodTypeAny, {
256
- criteria: z.objectOutputType<{
257
- type: z.ZodString;
258
- criterionId: z.ZodOptional<z.ZodString>;
259
- days: z.ZodOptional<z.ZodNumber>;
260
- fromDate: z.ZodOptional<z.ZodString>;
261
- toDate: z.ZodOptional<z.ZodString>;
262
- min: z.ZodOptional<z.ZodNumber>;
263
- max: z.ZodOptional<z.ZodNumber>;
264
- posIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
265
- skus: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
266
- makers: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
267
- labels: z.ZodOptional<z.ZodArray<z.ZodObject<{
268
- key: z.ZodString;
269
- value: z.ZodString;
270
- }, "strip", z.ZodTypeAny, {
271
- value: string;
272
- key: string;
273
- }, {
274
- value: string;
275
- key: string;
276
- }>, "many">>;
277
- tierIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
278
- campaignId: z.ZodOptional<z.ZodString>;
279
- countries: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
280
- anniversaryType: z.ZodOptional<z.ZodString>;
281
- customAttributeKey: z.ZodOptional<z.ZodString>;
282
- customAttributeValue: z.ZodOptional<z.ZodString>;
283
- }, z.ZodTypeAny, "passthrough">[];
284
- segmentPartId?: string | undefined;
285
- }, {
286
- criteria: z.objectInputType<{
287
- type: z.ZodString;
288
- criterionId: z.ZodOptional<z.ZodString>;
289
- days: z.ZodOptional<z.ZodNumber>;
290
- fromDate: z.ZodOptional<z.ZodString>;
291
- toDate: z.ZodOptional<z.ZodString>;
292
- min: z.ZodOptional<z.ZodNumber>;
293
- max: z.ZodOptional<z.ZodNumber>;
294
- posIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
295
- skus: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
296
- makers: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
297
- labels: z.ZodOptional<z.ZodArray<z.ZodObject<{
298
- key: z.ZodString;
299
- value: z.ZodString;
300
- }, "strip", z.ZodTypeAny, {
301
- value: string;
302
- key: string;
303
- }, {
304
- value: string;
305
- key: string;
306
- }>, "many">>;
307
- tierIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
308
- campaignId: z.ZodOptional<z.ZodString>;
309
- countries: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
310
- anniversaryType: z.ZodOptional<z.ZodString>;
311
- customAttributeKey: z.ZodOptional<z.ZodString>;
312
- customAttributeValue: z.ZodOptional<z.ZodString>;
313
- }, z.ZodTypeAny, "passthrough">[];
314
- segmentPartId?: string | undefined;
315
- }>, "many">;
316
- };
317
- export declare const SegmentDeleteInputSchema: {
318
- storeCode: z.ZodOptional<z.ZodString>;
319
- segmentId: z.ZodString;
320
- };
321
- export declare const SegmentGetMembersInputSchema: {
322
- storeCode: z.ZodOptional<z.ZodString>;
323
- segmentId: z.ZodString;
324
- page: z.ZodOptional<z.ZodNumber>;
325
- perPage: z.ZodOptional<z.ZodNumber>;
326
- };
327
- export declare const SegmentActivateInputSchema: {
328
- storeCode: z.ZodOptional<z.ZodString>;
329
- segmentId: z.ZodString;
330
- };
331
- export declare const SegmentDeactivateInputSchema: {
332
- storeCode: z.ZodOptional<z.ZodString>;
333
- segmentId: z.ZodString;
334
- };
335
- export declare const SegmentGetResourcesInputSchema: {
336
- storeCode: z.ZodOptional<z.ZodString>;
337
- segmentId: z.ZodString;
338
- };
339
- export declare function segmentList(input: {
340
- storeCode?: string;
341
- page?: number;
342
- perPage?: number;
343
- active?: boolean;
344
- name?: string;
345
- }): Promise<{
346
- segments: SegmentListItem[];
347
- total: {
348
- all?: number;
349
- filtered?: number;
350
- };
351
- }>;
352
- interface SegmentCreateInput {
353
- storeCode?: string;
354
- name: string;
355
- description?: string;
356
- active?: boolean;
357
- parts: Array<{
358
- segmentPartId?: string;
359
- criteria: Array<Record<string, unknown>>;
360
- }>;
361
- }
362
- export declare function segmentCreate(input: SegmentCreateInput): Promise<{
363
- segmentId: string;
364
- }>;
365
- export declare function segmentGet(input: {
366
- storeCode?: string;
367
- segmentId: string;
368
- }): Promise<Record<string, unknown>>;
369
- interface SegmentUpdateInput {
370
- storeCode?: string;
371
- segmentId: string;
372
- name: string;
373
- description?: string;
374
- active?: boolean;
375
- parts: Array<{
376
- segmentPartId?: string;
377
- criteria: Array<Record<string, unknown>>;
378
- }>;
379
- }
380
- export declare function segmentUpdate(input: SegmentUpdateInput): Promise<void>;
381
- export declare function segmentDelete(input: {
382
- storeCode?: string;
383
- segmentId: string;
384
- }): Promise<void>;
385
- interface SegmentMember {
386
- customerId: string;
387
- firstName?: string;
388
- lastName?: string;
389
- email?: string;
390
- loyaltyCardNumber?: string;
391
- active?: boolean;
392
- }
393
- export declare function segmentGetMembers(input: {
394
- storeCode?: string;
395
- segmentId: string;
396
- page?: number;
397
- perPage?: number;
398
- }): Promise<{
399
- members: SegmentMember[];
400
- total: {
401
- all?: number;
402
- filtered?: number;
403
- };
404
- }>;
405
- export declare function segmentActivate(input: {
406
- storeCode?: string;
407
- segmentId: string;
408
- }): Promise<void>;
409
- export declare function segmentDeactivate(input: {
410
- storeCode?: string;
411
- segmentId: string;
412
- }): Promise<void>;
413
- interface SegmentResource {
414
- resourceId: string;
415
- resourceType: string;
416
- name?: string;
417
- }
418
- export declare function segmentGetResources(input: {
419
- storeCode?: string;
420
- segmentId: string;
421
- }): Promise<{
422
- resources: SegmentResource[];
423
- }>;
424
- export declare const segmentToolDefinitions: readonly [{
425
- readonly name: "ol_segment_list";
426
- readonly title: "List Segments";
427
- readonly description: "List customer segments. Segments group members by criteria (purchase behavior, tier, location, etc). Use for campaign targeting and analytics.";
428
- readonly readOnly: true;
429
- readonly inputSchema: {
430
- storeCode: z.ZodOptional<z.ZodString>;
431
- page: z.ZodOptional<z.ZodNumber>;
432
- perPage: z.ZodOptional<z.ZodNumber>;
433
- active: z.ZodOptional<z.ZodBoolean>;
434
- name: z.ZodOptional<z.ZodString>;
435
- };
436
- readonly handler: typeof segmentList;
437
- }, {
438
- readonly name: "ol_segment_create";
439
- readonly title: "Create Segment";
440
- readonly description: string;
441
- readonly readOnly: false;
442
- readonly inputSchema: {
443
- storeCode: z.ZodOptional<z.ZodString>;
444
- name: z.ZodString;
445
- description: z.ZodOptional<z.ZodString>;
446
- active: z.ZodOptional<z.ZodBoolean>;
447
- parts: z.ZodArray<z.ZodObject<{
448
- segmentPartId: z.ZodOptional<z.ZodString>;
449
- criteria: z.ZodArray<z.ZodObject<{
450
- type: z.ZodString;
451
- criterionId: z.ZodOptional<z.ZodString>;
452
- days: z.ZodOptional<z.ZodNumber>;
453
- fromDate: z.ZodOptional<z.ZodString>;
454
- toDate: z.ZodOptional<z.ZodString>;
455
- min: z.ZodOptional<z.ZodNumber>;
456
- max: z.ZodOptional<z.ZodNumber>;
457
- posIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
458
- skus: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
459
- makers: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
460
- labels: z.ZodOptional<z.ZodArray<z.ZodObject<{
461
- key: z.ZodString;
462
- value: z.ZodString;
463
- }, "strip", z.ZodTypeAny, {
464
- value: string;
465
- key: string;
466
- }, {
467
- value: string;
468
- key: string;
469
- }>, "many">>;
470
- tierIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
471
- campaignId: z.ZodOptional<z.ZodString>;
472
- countries: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
473
- anniversaryType: z.ZodOptional<z.ZodString>;
474
- customAttributeKey: z.ZodOptional<z.ZodString>;
475
- customAttributeValue: z.ZodOptional<z.ZodString>;
476
- }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
477
- type: z.ZodString;
478
- criterionId: z.ZodOptional<z.ZodString>;
479
- days: z.ZodOptional<z.ZodNumber>;
480
- fromDate: z.ZodOptional<z.ZodString>;
481
- toDate: z.ZodOptional<z.ZodString>;
482
- min: z.ZodOptional<z.ZodNumber>;
483
- max: z.ZodOptional<z.ZodNumber>;
484
- posIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
485
- skus: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
486
- makers: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
487
- labels: z.ZodOptional<z.ZodArray<z.ZodObject<{
488
- key: z.ZodString;
489
- value: z.ZodString;
490
- }, "strip", z.ZodTypeAny, {
491
- value: string;
492
- key: string;
493
- }, {
494
- value: string;
495
- key: string;
496
- }>, "many">>;
497
- tierIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
498
- campaignId: z.ZodOptional<z.ZodString>;
499
- countries: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
500
- anniversaryType: z.ZodOptional<z.ZodString>;
501
- customAttributeKey: z.ZodOptional<z.ZodString>;
502
- customAttributeValue: z.ZodOptional<z.ZodString>;
503
- }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
504
- type: z.ZodString;
505
- criterionId: z.ZodOptional<z.ZodString>;
506
- days: z.ZodOptional<z.ZodNumber>;
507
- fromDate: z.ZodOptional<z.ZodString>;
508
- toDate: z.ZodOptional<z.ZodString>;
509
- min: z.ZodOptional<z.ZodNumber>;
510
- max: z.ZodOptional<z.ZodNumber>;
511
- posIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
512
- skus: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
513
- makers: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
514
- labels: z.ZodOptional<z.ZodArray<z.ZodObject<{
515
- key: z.ZodString;
516
- value: z.ZodString;
517
- }, "strip", z.ZodTypeAny, {
518
- value: string;
519
- key: string;
520
- }, {
521
- value: string;
522
- key: string;
523
- }>, "many">>;
524
- tierIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
525
- campaignId: z.ZodOptional<z.ZodString>;
526
- countries: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
527
- anniversaryType: z.ZodOptional<z.ZodString>;
528
- customAttributeKey: z.ZodOptional<z.ZodString>;
529
- customAttributeValue: z.ZodOptional<z.ZodString>;
530
- }, z.ZodTypeAny, "passthrough">>, "many">;
531
- }, "strip", z.ZodTypeAny, {
532
- criteria: z.objectOutputType<{
533
- type: z.ZodString;
534
- criterionId: z.ZodOptional<z.ZodString>;
535
- days: z.ZodOptional<z.ZodNumber>;
536
- fromDate: z.ZodOptional<z.ZodString>;
537
- toDate: z.ZodOptional<z.ZodString>;
538
- min: z.ZodOptional<z.ZodNumber>;
539
- max: z.ZodOptional<z.ZodNumber>;
540
- posIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
541
- skus: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
542
- makers: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
543
- labels: z.ZodOptional<z.ZodArray<z.ZodObject<{
544
- key: z.ZodString;
545
- value: z.ZodString;
546
- }, "strip", z.ZodTypeAny, {
547
- value: string;
548
- key: string;
549
- }, {
550
- value: string;
551
- key: string;
552
- }>, "many">>;
553
- tierIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
554
- campaignId: z.ZodOptional<z.ZodString>;
555
- countries: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
556
- anniversaryType: z.ZodOptional<z.ZodString>;
557
- customAttributeKey: z.ZodOptional<z.ZodString>;
558
- customAttributeValue: z.ZodOptional<z.ZodString>;
559
- }, z.ZodTypeAny, "passthrough">[];
560
- segmentPartId?: string | undefined;
561
- }, {
562
- criteria: z.objectInputType<{
563
- type: z.ZodString;
564
- criterionId: z.ZodOptional<z.ZodString>;
565
- days: z.ZodOptional<z.ZodNumber>;
566
- fromDate: z.ZodOptional<z.ZodString>;
567
- toDate: z.ZodOptional<z.ZodString>;
568
- min: z.ZodOptional<z.ZodNumber>;
569
- max: z.ZodOptional<z.ZodNumber>;
570
- posIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
571
- skus: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
572
- makers: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
573
- labels: z.ZodOptional<z.ZodArray<z.ZodObject<{
574
- key: z.ZodString;
575
- value: z.ZodString;
576
- }, "strip", z.ZodTypeAny, {
577
- value: string;
578
- key: string;
579
- }, {
580
- value: string;
581
- key: string;
582
- }>, "many">>;
583
- tierIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
584
- campaignId: z.ZodOptional<z.ZodString>;
585
- countries: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
586
- anniversaryType: z.ZodOptional<z.ZodString>;
587
- customAttributeKey: z.ZodOptional<z.ZodString>;
588
- customAttributeValue: z.ZodOptional<z.ZodString>;
589
- }, z.ZodTypeAny, "passthrough">[];
590
- segmentPartId?: string | undefined;
591
- }>, "many">;
592
- };
593
- readonly handler: typeof segmentCreate;
594
- }, {
595
- readonly name: "ol_segment_get";
596
- readonly title: "Get Segment Details";
597
- readonly description: "Get full segment details including all parts and criteria configurations.";
598
- readonly readOnly: true;
599
- readonly inputSchema: {
600
- storeCode: z.ZodOptional<z.ZodString>;
601
- segmentId: z.ZodString;
602
- };
603
- readonly handler: typeof segmentGet;
604
- }, {
605
- readonly name: "ol_segment_update";
606
- readonly title: "Update Segment";
607
- readonly description: "Update segment configuration. Requires full segment definition (name, parts with criteria). Use segment_get first to retrieve current configuration.";
608
- readonly readOnly: false;
609
- readonly inputSchema: {
610
- storeCode: z.ZodOptional<z.ZodString>;
611
- segmentId: z.ZodString;
612
- name: z.ZodString;
613
- description: z.ZodOptional<z.ZodString>;
614
- active: z.ZodOptional<z.ZodBoolean>;
615
- parts: z.ZodArray<z.ZodObject<{
616
- segmentPartId: z.ZodOptional<z.ZodString>;
617
- criteria: z.ZodArray<z.ZodObject<{
618
- type: z.ZodString;
619
- criterionId: z.ZodOptional<z.ZodString>;
620
- days: z.ZodOptional<z.ZodNumber>;
621
- fromDate: z.ZodOptional<z.ZodString>;
622
- toDate: z.ZodOptional<z.ZodString>;
623
- min: z.ZodOptional<z.ZodNumber>;
624
- max: z.ZodOptional<z.ZodNumber>;
625
- posIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
626
- skus: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
627
- makers: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
628
- labels: z.ZodOptional<z.ZodArray<z.ZodObject<{
629
- key: z.ZodString;
630
- value: z.ZodString;
631
- }, "strip", z.ZodTypeAny, {
632
- value: string;
633
- key: string;
634
- }, {
635
- value: string;
636
- key: string;
637
- }>, "many">>;
638
- tierIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
639
- campaignId: z.ZodOptional<z.ZodString>;
640
- countries: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
641
- anniversaryType: z.ZodOptional<z.ZodString>;
642
- customAttributeKey: z.ZodOptional<z.ZodString>;
643
- customAttributeValue: z.ZodOptional<z.ZodString>;
644
- }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
645
- type: z.ZodString;
646
- criterionId: z.ZodOptional<z.ZodString>;
647
- days: z.ZodOptional<z.ZodNumber>;
648
- fromDate: z.ZodOptional<z.ZodString>;
649
- toDate: z.ZodOptional<z.ZodString>;
650
- min: z.ZodOptional<z.ZodNumber>;
651
- max: z.ZodOptional<z.ZodNumber>;
652
- posIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
653
- skus: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
654
- makers: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
655
- labels: z.ZodOptional<z.ZodArray<z.ZodObject<{
656
- key: z.ZodString;
657
- value: z.ZodString;
658
- }, "strip", z.ZodTypeAny, {
659
- value: string;
660
- key: string;
661
- }, {
662
- value: string;
663
- key: string;
664
- }>, "many">>;
665
- tierIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
666
- campaignId: z.ZodOptional<z.ZodString>;
667
- countries: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
668
- anniversaryType: z.ZodOptional<z.ZodString>;
669
- customAttributeKey: z.ZodOptional<z.ZodString>;
670
- customAttributeValue: z.ZodOptional<z.ZodString>;
671
- }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
672
- type: z.ZodString;
673
- criterionId: z.ZodOptional<z.ZodString>;
674
- days: z.ZodOptional<z.ZodNumber>;
675
- fromDate: z.ZodOptional<z.ZodString>;
676
- toDate: z.ZodOptional<z.ZodString>;
677
- min: z.ZodOptional<z.ZodNumber>;
678
- max: z.ZodOptional<z.ZodNumber>;
679
- posIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
680
- skus: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
681
- makers: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
682
- labels: z.ZodOptional<z.ZodArray<z.ZodObject<{
683
- key: z.ZodString;
684
- value: z.ZodString;
685
- }, "strip", z.ZodTypeAny, {
686
- value: string;
687
- key: string;
688
- }, {
689
- value: string;
690
- key: string;
691
- }>, "many">>;
692
- tierIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
693
- campaignId: z.ZodOptional<z.ZodString>;
694
- countries: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
695
- anniversaryType: z.ZodOptional<z.ZodString>;
696
- customAttributeKey: z.ZodOptional<z.ZodString>;
697
- customAttributeValue: z.ZodOptional<z.ZodString>;
698
- }, z.ZodTypeAny, "passthrough">>, "many">;
699
- }, "strip", z.ZodTypeAny, {
700
- criteria: z.objectOutputType<{
701
- type: z.ZodString;
702
- criterionId: z.ZodOptional<z.ZodString>;
703
- days: z.ZodOptional<z.ZodNumber>;
704
- fromDate: z.ZodOptional<z.ZodString>;
705
- toDate: z.ZodOptional<z.ZodString>;
706
- min: z.ZodOptional<z.ZodNumber>;
707
- max: z.ZodOptional<z.ZodNumber>;
708
- posIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
709
- skus: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
710
- makers: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
711
- labels: z.ZodOptional<z.ZodArray<z.ZodObject<{
712
- key: z.ZodString;
713
- value: z.ZodString;
714
- }, "strip", z.ZodTypeAny, {
715
- value: string;
716
- key: string;
717
- }, {
718
- value: string;
719
- key: string;
720
- }>, "many">>;
721
- tierIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
722
- campaignId: z.ZodOptional<z.ZodString>;
723
- countries: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
724
- anniversaryType: z.ZodOptional<z.ZodString>;
725
- customAttributeKey: z.ZodOptional<z.ZodString>;
726
- customAttributeValue: z.ZodOptional<z.ZodString>;
727
- }, z.ZodTypeAny, "passthrough">[];
728
- segmentPartId?: string | undefined;
729
- }, {
730
- criteria: z.objectInputType<{
731
- type: z.ZodString;
732
- criterionId: z.ZodOptional<z.ZodString>;
733
- days: z.ZodOptional<z.ZodNumber>;
734
- fromDate: z.ZodOptional<z.ZodString>;
735
- toDate: z.ZodOptional<z.ZodString>;
736
- min: z.ZodOptional<z.ZodNumber>;
737
- max: z.ZodOptional<z.ZodNumber>;
738
- posIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
739
- skus: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
740
- makers: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
741
- labels: z.ZodOptional<z.ZodArray<z.ZodObject<{
742
- key: z.ZodString;
743
- value: z.ZodString;
744
- }, "strip", z.ZodTypeAny, {
745
- value: string;
746
- key: string;
747
- }, {
748
- value: string;
749
- key: string;
750
- }>, "many">>;
751
- tierIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
752
- campaignId: z.ZodOptional<z.ZodString>;
753
- countries: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
754
- anniversaryType: z.ZodOptional<z.ZodString>;
755
- customAttributeKey: z.ZodOptional<z.ZodString>;
756
- customAttributeValue: z.ZodOptional<z.ZodString>;
757
- }, z.ZodTypeAny, "passthrough">[];
758
- segmentPartId?: string | undefined;
759
- }>, "many">;
760
- };
761
- readonly handler: typeof segmentUpdate;
762
- }, {
763
- readonly name: "ol_segment_delete";
764
- readonly title: "Delete Segment (Permanent)";
765
- readonly description: "Permanently delete a segment. Cannot be undone. Check segment_get_resources first to see what uses this segment.";
766
- readonly readOnly: false;
767
- readonly destructive: true;
768
- readonly inputSchema: {
769
- storeCode: z.ZodOptional<z.ZodString>;
770
- segmentId: z.ZodString;
771
- };
772
- readonly handler: typeof segmentDelete;
773
- }, {
774
- readonly name: "ol_segment_get_members";
775
- readonly title: "Get Segment Members";
776
- readonly description: "Get members belonging to a segment. Returns paginated list of member details. Use for verifying segment criteria or exporting member lists.";
777
- readonly readOnly: true;
778
- readonly inputSchema: {
779
- storeCode: z.ZodOptional<z.ZodString>;
780
- segmentId: z.ZodString;
781
- page: z.ZodOptional<z.ZodNumber>;
782
- perPage: z.ZodOptional<z.ZodNumber>;
783
- };
784
- readonly handler: typeof segmentGetMembers;
785
- }, {
786
- readonly name: "ol_segment_activate";
787
- readonly title: "Activate Segment";
788
- readonly description: "Activate a segment. Active segments are used for campaign targeting and can be queried for members.";
789
- readonly readOnly: false;
790
- readonly inputSchema: {
791
- storeCode: z.ZodOptional<z.ZodString>;
792
- segmentId: z.ZodString;
793
- };
794
- readonly handler: typeof segmentActivate;
795
- }, {
796
- readonly name: "ol_segment_deactivate";
797
- readonly title: "Deactivate Segment";
798
- readonly description: "Deactivate a segment. Deactivated segments are not used for campaign targeting but retain their configuration.";
799
- readonly readOnly: false;
800
- readonly inputSchema: {
801
- storeCode: z.ZodOptional<z.ZodString>;
802
- segmentId: z.ZodString;
803
- };
804
- readonly handler: typeof segmentDeactivate;
805
- }, {
806
- readonly name: "ol_segment_get_resources";
807
- readonly title: "Get Segment Resources";
808
- readonly description: "Get resources (campaigns, rewards, etc.) that use this segment for targeting. Check before deleting a segment.";
809
- readonly readOnly: true;
810
- readonly inputSchema: {
811
- storeCode: z.ZodOptional<z.ZodString>;
812
- segmentId: z.ZodString;
813
- };
814
- readonly handler: typeof segmentGetResources;
815
- }];
816
- export {};