@sayren/store-sdk 0.6.0 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +303 -31
- package/dist/index.mjs +331 -217
- package/dist/server.d.mts +45 -1
- package/dist/server.mjs +56 -1
- package/package.json +1 -1
- package/src/client.ts +31 -0
- package/src/member-delegation.ts +98 -0
- package/src/schemas/analytics.ts +145 -0
- package/src/schemas/order.ts +10 -0
- package/src/schemas/payment.ts +84 -32
- package/src/server.ts +6 -0
package/dist/index.d.mts
CHANGED
|
@@ -100,6 +100,7 @@ export declare const analyticsOverviewSchema: z.ZodObject<{
|
|
|
100
100
|
conversionRate: z.ZodNullable<z.ZodNumber>;
|
|
101
101
|
date: z.ZodString;
|
|
102
102
|
}, z.core.$strip>>;
|
|
103
|
+
excludedBotSessions: z.ZodNumber;
|
|
103
104
|
from: z.ZodString;
|
|
104
105
|
to: z.ZodString;
|
|
105
106
|
timezone: z.ZodLiteral<"Asia/Seoul">;
|
|
@@ -144,6 +145,7 @@ export declare const analyticsProductRowSchema: z.ZodObject<{
|
|
|
144
145
|
quantity: z.ZodNumber;
|
|
145
146
|
revenue: z.ZodNumber;
|
|
146
147
|
purchaseRate: z.ZodNullable<z.ZodNumber>;
|
|
148
|
+
clickThroughRate: z.ZodNullable<z.ZodNumber>;
|
|
147
149
|
}, z.core.$strip>;
|
|
148
150
|
export type AnalyticsProductRow = z.infer<typeof analyticsProductRowSchema>;
|
|
149
151
|
export declare const analyticsProductsSchema: z.ZodObject<{
|
|
@@ -165,6 +167,7 @@ export declare const analyticsProductsSchema: z.ZodObject<{
|
|
|
165
167
|
quantity: z.ZodNumber;
|
|
166
168
|
revenue: z.ZodNumber;
|
|
167
169
|
purchaseRate: z.ZodNullable<z.ZodNumber>;
|
|
170
|
+
clickThroughRate: z.ZodNullable<z.ZodNumber>;
|
|
168
171
|
}, z.core.$strip>>;
|
|
169
172
|
from: z.ZodString;
|
|
170
173
|
to: z.ZodString;
|
|
@@ -279,6 +282,159 @@ export declare const analyticsSourcesSchema: z.ZodObject<{
|
|
|
279
282
|
lastComputedAt: z.ZodNullable<z.ZodString>;
|
|
280
283
|
}, z.core.$strip>;
|
|
281
284
|
export type AnalyticsSources = z.infer<typeof analyticsSourcesSchema>;
|
|
285
|
+
export declare const analyticsRealtimeSchema: z.ZodObject<{
|
|
286
|
+
asOf: z.ZodString;
|
|
287
|
+
windowMinutes: z.ZodLiteral<5>;
|
|
288
|
+
visitors: z.ZodNumber;
|
|
289
|
+
sessions: z.ZodNumber;
|
|
290
|
+
pageViews: z.ZodNumber;
|
|
291
|
+
pages: z.ZodArray<z.ZodObject<{
|
|
292
|
+
path: z.ZodString;
|
|
293
|
+
visitors: z.ZodNumber;
|
|
294
|
+
pageViews: z.ZodNumber;
|
|
295
|
+
}, z.core.$strip>>;
|
|
296
|
+
}, z.core.$strip>;
|
|
297
|
+
export type AnalyticsRealtime = z.infer<typeof analyticsRealtimeSchema>;
|
|
298
|
+
export declare const analyticsDeviceRowSchema: z.ZodObject<{
|
|
299
|
+
device: z.ZodEnum<{
|
|
300
|
+
unknown: "unknown";
|
|
301
|
+
desktop: "desktop";
|
|
302
|
+
mobile: "mobile";
|
|
303
|
+
tablet: "tablet";
|
|
304
|
+
}>;
|
|
305
|
+
sessions: z.ZodNumber;
|
|
306
|
+
productViewSessions: z.ZodNumber;
|
|
307
|
+
addToCartSessions: z.ZodNumber;
|
|
308
|
+
beginCheckoutSessions: z.ZodNumber;
|
|
309
|
+
purchaseSessions: z.ZodNumber;
|
|
310
|
+
conversionRate: z.ZodNullable<z.ZodNumber>;
|
|
311
|
+
}, z.core.$strip>;
|
|
312
|
+
export type AnalyticsDeviceRow = z.infer<typeof analyticsDeviceRowSchema>;
|
|
313
|
+
export declare const analyticsDevicesSchema: z.ZodObject<{
|
|
314
|
+
rows: z.ZodArray<z.ZodObject<{
|
|
315
|
+
device: z.ZodEnum<{
|
|
316
|
+
unknown: "unknown";
|
|
317
|
+
desktop: "desktop";
|
|
318
|
+
mobile: "mobile";
|
|
319
|
+
tablet: "tablet";
|
|
320
|
+
}>;
|
|
321
|
+
sessions: z.ZodNumber;
|
|
322
|
+
productViewSessions: z.ZodNumber;
|
|
323
|
+
addToCartSessions: z.ZodNumber;
|
|
324
|
+
beginCheckoutSessions: z.ZodNumber;
|
|
325
|
+
purchaseSessions: z.ZodNumber;
|
|
326
|
+
conversionRate: z.ZodNullable<z.ZodNumber>;
|
|
327
|
+
}, z.core.$strip>>;
|
|
328
|
+
from: z.ZodString;
|
|
329
|
+
to: z.ZodString;
|
|
330
|
+
timezone: z.ZodLiteral<"Asia/Seoul">;
|
|
331
|
+
currency: z.ZodLiteral<"KRW">;
|
|
332
|
+
includeTest: z.ZodBoolean;
|
|
333
|
+
lastComputedAt: z.ZodNullable<z.ZodString>;
|
|
334
|
+
}, z.core.$strip>;
|
|
335
|
+
export type AnalyticsDevices = z.infer<typeof analyticsDevicesSchema>;
|
|
336
|
+
export declare const analyticsPagesQuerySchema: z.ZodObject<{
|
|
337
|
+
from: z.ZodString;
|
|
338
|
+
to: z.ZodString;
|
|
339
|
+
includeTest: z.ZodOptional<z.ZodEnum<{
|
|
340
|
+
true: "true";
|
|
341
|
+
false: "false";
|
|
342
|
+
}>>;
|
|
343
|
+
limit: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
|
|
344
|
+
}, z.core.$strip>;
|
|
345
|
+
export type AnalyticsPagesParams = z.infer<typeof analyticsPagesQuerySchema>;
|
|
346
|
+
export declare const analyticsPagesSchema: z.ZodObject<{
|
|
347
|
+
landings: z.ZodArray<z.ZodObject<{
|
|
348
|
+
path: z.ZodString;
|
|
349
|
+
entrances: z.ZodNumber;
|
|
350
|
+
bounces: z.ZodNumber;
|
|
351
|
+
bounceRate: z.ZodNullable<z.ZodNumber>;
|
|
352
|
+
}, z.core.$strip>>;
|
|
353
|
+
exits: z.ZodArray<z.ZodObject<{
|
|
354
|
+
path: z.ZodString;
|
|
355
|
+
pageViews: z.ZodNumber;
|
|
356
|
+
exits: z.ZodNumber;
|
|
357
|
+
exitRate: z.ZodNullable<z.ZodNumber>;
|
|
358
|
+
}, z.core.$strip>>;
|
|
359
|
+
from: z.ZodString;
|
|
360
|
+
to: z.ZodString;
|
|
361
|
+
timezone: z.ZodLiteral<"Asia/Seoul">;
|
|
362
|
+
currency: z.ZodLiteral<"KRW">;
|
|
363
|
+
includeTest: z.ZodBoolean;
|
|
364
|
+
lastComputedAt: z.ZodNullable<z.ZodString>;
|
|
365
|
+
}, z.core.$strip>;
|
|
366
|
+
export type AnalyticsPages = z.infer<typeof analyticsPagesSchema>;
|
|
367
|
+
export declare const analyticsSearchQuerySchema: z.ZodObject<{
|
|
368
|
+
from: z.ZodString;
|
|
369
|
+
to: z.ZodString;
|
|
370
|
+
includeTest: z.ZodOptional<z.ZodEnum<{
|
|
371
|
+
true: "true";
|
|
372
|
+
false: "false";
|
|
373
|
+
}>>;
|
|
374
|
+
limit: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
|
|
375
|
+
}, z.core.$strip>;
|
|
376
|
+
export type AnalyticsSearchParams = z.infer<typeof analyticsSearchQuerySchema>;
|
|
377
|
+
export declare const analyticsSearchSchema: z.ZodObject<{
|
|
378
|
+
summary: z.ZodObject<{
|
|
379
|
+
searches: z.ZodNumber;
|
|
380
|
+
zeroResultSearches: z.ZodNumber;
|
|
381
|
+
searchSessions: z.ZodNumber;
|
|
382
|
+
purchaseSessions: z.ZodNumber;
|
|
383
|
+
conversionRate: z.ZodNullable<z.ZodNumber>;
|
|
384
|
+
}, z.core.$strip>;
|
|
385
|
+
terms: z.ZodArray<z.ZodObject<{
|
|
386
|
+
term: z.ZodString;
|
|
387
|
+
searches: z.ZodNumber;
|
|
388
|
+
zeroResultSearches: z.ZodNumber;
|
|
389
|
+
searchSessions: z.ZodNumber;
|
|
390
|
+
purchaseSessions: z.ZodNumber;
|
|
391
|
+
conversionRate: z.ZodNullable<z.ZodNumber>;
|
|
392
|
+
}, z.core.$strip>>;
|
|
393
|
+
zeroResultTerms: z.ZodArray<z.ZodObject<{
|
|
394
|
+
term: z.ZodString;
|
|
395
|
+
searches: z.ZodNumber;
|
|
396
|
+
zeroResultSearches: z.ZodNumber;
|
|
397
|
+
}, z.core.$strip>>;
|
|
398
|
+
from: z.ZodString;
|
|
399
|
+
to: z.ZodString;
|
|
400
|
+
timezone: z.ZodLiteral<"Asia/Seoul">;
|
|
401
|
+
currency: z.ZodLiteral<"KRW">;
|
|
402
|
+
includeTest: z.ZodBoolean;
|
|
403
|
+
lastComputedAt: z.ZodNullable<z.ZodString>;
|
|
404
|
+
}, z.core.$strip>;
|
|
405
|
+
export type AnalyticsSearch = z.infer<typeof analyticsSearchSchema>;
|
|
406
|
+
export declare const analyticsCheckoutOutcomeSchema: z.ZodEnum<{
|
|
407
|
+
OTHER: "OTHER";
|
|
408
|
+
COMPLETED: "COMPLETED";
|
|
409
|
+
NOT_OPENED: "NOT_OPENED";
|
|
410
|
+
USER_CANCELED: "USER_CANCELED";
|
|
411
|
+
DECLINED: "DECLINED";
|
|
412
|
+
PREPARE_FAILURE: "PREPARE_FAILURE";
|
|
413
|
+
IN_PROGRESS: "IN_PROGRESS";
|
|
414
|
+
}>;
|
|
415
|
+
export type AnalyticsCheckoutOutcome = z.infer<typeof analyticsCheckoutOutcomeSchema>;
|
|
416
|
+
export declare const analyticsCheckoutSchema: z.ZodObject<{
|
|
417
|
+
sessions: z.ZodNumber;
|
|
418
|
+
outcomes: z.ZodArray<z.ZodObject<{
|
|
419
|
+
outcome: z.ZodEnum<{
|
|
420
|
+
OTHER: "OTHER";
|
|
421
|
+
COMPLETED: "COMPLETED";
|
|
422
|
+
NOT_OPENED: "NOT_OPENED";
|
|
423
|
+
USER_CANCELED: "USER_CANCELED";
|
|
424
|
+
DECLINED: "DECLINED";
|
|
425
|
+
PREPARE_FAILURE: "PREPARE_FAILURE";
|
|
426
|
+
IN_PROGRESS: "IN_PROGRESS";
|
|
427
|
+
}>;
|
|
428
|
+
sessions: z.ZodNumber;
|
|
429
|
+
}, z.core.$strip>>;
|
|
430
|
+
from: z.ZodString;
|
|
431
|
+
to: z.ZodString;
|
|
432
|
+
timezone: z.ZodLiteral<"Asia/Seoul">;
|
|
433
|
+
currency: z.ZodLiteral<"KRW">;
|
|
434
|
+
includeTest: z.ZodBoolean;
|
|
435
|
+
lastComputedAt: z.ZodNullable<z.ZodString>;
|
|
436
|
+
}, z.core.$strip>;
|
|
437
|
+
export type AnalyticsCheckout = z.infer<typeof analyticsCheckoutSchema>;
|
|
282
438
|
//#endregion
|
|
283
439
|
//#region src/schemas/api-client.d.ts
|
|
284
440
|
/**
|
|
@@ -1886,6 +2042,7 @@ export declare const orderSchema: z.ZodObject<{
|
|
|
1886
2042
|
MIXED: "MIXED";
|
|
1887
2043
|
}>;
|
|
1888
2044
|
approvedMethod: z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
|
|
2045
|
+
easyPayProvider: z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
|
|
1889
2046
|
productAmount: z.ZodNumber;
|
|
1890
2047
|
deliveryFee: z.ZodNumber;
|
|
1891
2048
|
discountAmount: z.ZodNumber;
|
|
@@ -2245,18 +2402,23 @@ export declare const pgPaymentMethodSchema: z.ZodEnum<{
|
|
|
2245
2402
|
EASY_PAY: "EASY_PAY";
|
|
2246
2403
|
}>;
|
|
2247
2404
|
export type PgPaymentMethod = z.infer<typeof pgPaymentMethodSchema>;
|
|
2248
|
-
|
|
2249
|
-
|
|
2250
|
-
|
|
2251
|
-
|
|
2252
|
-
export
|
|
2253
|
-
|
|
2254
|
-
|
|
2255
|
-
|
|
2256
|
-
|
|
2257
|
-
SINGLE: "SINGLE";
|
|
2405
|
+
/**
|
|
2406
|
+
* 간편결제사 — 결제 옵션(스토어프론트 `paymentOptions`)과 PG 설정의 `easyPayProviders`에 쓴다.
|
|
2407
|
+
* `@sayren/storefront-sdk`의 `easyPayProviderSchema`와 같은 값이다(api 계약 테스트가 고정한다)
|
|
2408
|
+
*/
|
|
2409
|
+
export declare const easyPayProviderSchema: z.ZodEnum<{
|
|
2410
|
+
NAVERPAY: "NAVERPAY";
|
|
2411
|
+
KAKAOPAY: "KAKAOPAY";
|
|
2412
|
+
TOSSPAY: "TOSSPAY";
|
|
2413
|
+
PAYCO: "PAYCO";
|
|
2258
2414
|
}>;
|
|
2259
|
-
export type
|
|
2415
|
+
export type EasyPayProvider = z.infer<typeof easyPayProviderSchema>;
|
|
2416
|
+
/**
|
|
2417
|
+
* 응답에 실리는 간편결제사 — 서버가 간편결제사를 추가해도 파싱이 깨지지 않게 문자열로 받는다
|
|
2418
|
+
* (`pgProvider`·결제수단과 같은 방식). 요청(`easyPayProviders`)은 값을 골라 보내는 자리라 enum 그대로다.
|
|
2419
|
+
* 현재 값은 `NAVERPAY`·`KAKAOPAY`·`TOSSPAY`·`PAYCO`이고 화면은 모르는 값을 원문 그대로 보여 준다.
|
|
2420
|
+
*/
|
|
2421
|
+
export declare const easyPayProviderResponseSchema: z.ZodString;
|
|
2260
2422
|
export declare const pgEnvironmentSchema: z.ZodEnum<{
|
|
2261
2423
|
TEST: "TEST";
|
|
2262
2424
|
LIVE: "LIVE";
|
|
@@ -2356,6 +2518,12 @@ export type UpsertPortOneProviderRequest = z.infer<typeof upsertPortOneProviderR
|
|
|
2356
2518
|
export declare const updatePaymentProviderRequestSchema: z.ZodObject<{
|
|
2357
2519
|
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
2358
2520
|
sandboxMode: z.ZodOptional<z.ZodBoolean>;
|
|
2521
|
+
easyPayProviders: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
2522
|
+
NAVERPAY: "NAVERPAY";
|
|
2523
|
+
KAKAOPAY: "KAKAOPAY";
|
|
2524
|
+
TOSSPAY: "TOSSPAY";
|
|
2525
|
+
PAYCO: "PAYCO";
|
|
2526
|
+
}>>>;
|
|
2359
2527
|
}, z.core.$strip>;
|
|
2360
2528
|
export type UpdatePaymentProviderRequest = z.infer<typeof updatePaymentProviderRequestSchema>;
|
|
2361
2529
|
export declare const verifyPaymentProviderRequestSchema: z.ZodObject<{
|
|
@@ -2366,14 +2534,11 @@ export declare const verifyPaymentProviderRequestSchema: z.ZodObject<{
|
|
|
2366
2534
|
}, z.core.$strip>;
|
|
2367
2535
|
export type VerifyPaymentProviderRequest = z.infer<typeof verifyPaymentProviderRequestSchema>;
|
|
2368
2536
|
export declare const updatePaymentSettingsRequestSchema: z.ZodObject<{
|
|
2369
|
-
|
|
2370
|
-
PRIORITY_DISPLAY: "PRIORITY_DISPLAY";
|
|
2371
|
-
AUTO_FAILOVER: "AUTO_FAILOVER";
|
|
2372
|
-
}>;
|
|
2373
|
-
priority: z.ZodArray<z.ZodEnum<{
|
|
2537
|
+
priority: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
2374
2538
|
tosspayments: "tosspayments";
|
|
2375
2539
|
portone: "portone";
|
|
2376
|
-
}
|
|
2540
|
+
}>>>;
|
|
2541
|
+
checkoutOrigins: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
2377
2542
|
}, z.core.$strip>;
|
|
2378
2543
|
export type UpdatePaymentSettingsRequest = z.infer<typeof updatePaymentSettingsRequestSchema>;
|
|
2379
2544
|
export declare const maskedSecretSchema: z.ZodObject<{
|
|
@@ -2612,6 +2777,7 @@ export declare const paymentProviderSchema: z.ZodObject<{
|
|
|
2612
2777
|
}, z.core.$strip>>;
|
|
2613
2778
|
openedAt: z.ZodNullable<z.ZodString>;
|
|
2614
2779
|
}, z.core.$strip>;
|
|
2780
|
+
easyPayProviders: z.ZodArray<z.ZodString>;
|
|
2615
2781
|
retiredCredentialCount: z.ZodNumber;
|
|
2616
2782
|
routingExclusion: z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
|
|
2617
2783
|
}, z.core.$strip>;
|
|
@@ -2623,16 +2789,7 @@ export type PaymentProvider = z.infer<typeof paymentProviderSchema>;
|
|
|
2623
2789
|
export declare const PAYMENT_ROUTING_EXCLUSION_CODES: readonly ["NOT_CONNECTED", "DISABLED", "CREDENTIAL_MISSING", "SANDBOX_IN_LIVE_STORE", "PLATFORM_BLOCKED", "MODE_MISMATCH"];
|
|
2624
2790
|
export type KnownPaymentRoutingExclusion = (typeof PAYMENT_ROUTING_EXCLUSION_CODES)[number];
|
|
2625
2791
|
export declare const paymentSettingsSchema: z.ZodObject<{
|
|
2626
|
-
|
|
2627
|
-
PRIORITY_DISPLAY: "PRIORITY_DISPLAY";
|
|
2628
|
-
AUTO_FAILOVER: "AUTO_FAILOVER";
|
|
2629
|
-
}>;
|
|
2630
|
-
effectiveRoutingMode: z.ZodEnum<{
|
|
2631
|
-
PRIORITY_DISPLAY: "PRIORITY_DISPLAY";
|
|
2632
|
-
AUTO_FAILOVER: "AUTO_FAILOVER";
|
|
2633
|
-
NONE: "NONE";
|
|
2634
|
-
SINGLE: "SINGLE";
|
|
2635
|
-
}>;
|
|
2792
|
+
checkoutOrigins: z.ZodArray<z.ZodString>;
|
|
2636
2793
|
providers: z.ZodArray<z.ZodObject<{
|
|
2637
2794
|
provider: z.ZodEnum<{
|
|
2638
2795
|
tosspayments: "tosspayments";
|
|
@@ -2769,6 +2926,7 @@ export declare const paymentSettingsSchema: z.ZodObject<{
|
|
|
2769
2926
|
}, z.core.$strip>>;
|
|
2770
2927
|
openedAt: z.ZodNullable<z.ZodString>;
|
|
2771
2928
|
}, z.core.$strip>;
|
|
2929
|
+
easyPayProviders: z.ZodArray<z.ZodString>;
|
|
2772
2930
|
retiredCredentialCount: z.ZodNumber;
|
|
2773
2931
|
routingExclusion: z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
|
|
2774
2932
|
}, z.core.$strip>>;
|
|
@@ -2953,6 +3111,7 @@ export declare const paymentRecordSchema: z.ZodObject<{
|
|
|
2953
3111
|
MOBILE: "MOBILE";
|
|
2954
3112
|
EASY_PAY: "EASY_PAY";
|
|
2955
3113
|
}>>;
|
|
3114
|
+
easyPayProvider: z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
|
|
2956
3115
|
environment: z.ZodNullable<z.ZodEnum<{
|
|
2957
3116
|
TEST: "TEST";
|
|
2958
3117
|
LIVE: "LIVE";
|
|
@@ -2997,6 +3156,7 @@ export declare const paymentRecordPageSchema: z.ZodObject<{
|
|
|
2997
3156
|
MOBILE: "MOBILE";
|
|
2998
3157
|
EASY_PAY: "EASY_PAY";
|
|
2999
3158
|
}>>;
|
|
3159
|
+
easyPayProvider: z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
|
|
3000
3160
|
environment: z.ZodNullable<z.ZodEnum<{
|
|
3001
3161
|
TEST: "TEST";
|
|
3002
3162
|
LIVE: "LIVE";
|
|
@@ -3027,6 +3187,7 @@ export declare const paymentAttemptRecordSchema: z.ZodObject<{
|
|
|
3027
3187
|
MOBILE: "MOBILE";
|
|
3028
3188
|
EASY_PAY: "EASY_PAY";
|
|
3029
3189
|
}>;
|
|
3190
|
+
easyPayProvider: z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
|
|
3030
3191
|
approvedMethod: z.ZodNullable<z.ZodEnum<{
|
|
3031
3192
|
CARD: "CARD";
|
|
3032
3193
|
BANK_TRANSFER: "BANK_TRANSFER";
|
|
@@ -3034,6 +3195,7 @@ export declare const paymentAttemptRecordSchema: z.ZodObject<{
|
|
|
3034
3195
|
MOBILE: "MOBILE";
|
|
3035
3196
|
EASY_PAY: "EASY_PAY";
|
|
3036
3197
|
}>>;
|
|
3198
|
+
approvedEasyPayProvider: z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
|
|
3037
3199
|
amount: z.ZodNumber;
|
|
3038
3200
|
environment: z.ZodEnum<{
|
|
3039
3201
|
TEST: "TEST";
|
|
@@ -3082,6 +3244,7 @@ export declare const paymentRecordDetailSchema: z.ZodObject<{
|
|
|
3082
3244
|
MOBILE: "MOBILE";
|
|
3083
3245
|
EASY_PAY: "EASY_PAY";
|
|
3084
3246
|
}>>;
|
|
3247
|
+
easyPayProvider: z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
|
|
3085
3248
|
environment: z.ZodNullable<z.ZodEnum<{
|
|
3086
3249
|
TEST: "TEST";
|
|
3087
3250
|
LIVE: "LIVE";
|
|
@@ -3111,6 +3274,7 @@ export declare const paymentRecordDetailSchema: z.ZodObject<{
|
|
|
3111
3274
|
MOBILE: "MOBILE";
|
|
3112
3275
|
EASY_PAY: "EASY_PAY";
|
|
3113
3276
|
}>;
|
|
3277
|
+
easyPayProvider: z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
|
|
3114
3278
|
approvedMethod: z.ZodNullable<z.ZodEnum<{
|
|
3115
3279
|
CARD: "CARD";
|
|
3116
3280
|
BANK_TRANSFER: "BANK_TRANSFER";
|
|
@@ -3118,6 +3282,7 @@ export declare const paymentRecordDetailSchema: z.ZodObject<{
|
|
|
3118
3282
|
MOBILE: "MOBILE";
|
|
3119
3283
|
EASY_PAY: "EASY_PAY";
|
|
3120
3284
|
}>>;
|
|
3285
|
+
approvedEasyPayProvider: z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
|
|
3121
3286
|
amount: z.ZodNumber;
|
|
3122
3287
|
environment: z.ZodEnum<{
|
|
3123
3288
|
TEST: "TEST";
|
|
@@ -4414,6 +4579,7 @@ export declare function createStoreClient(options: StoreClientOptions): {
|
|
|
4414
4579
|
payment: {
|
|
4415
4580
|
method: "CARD" | "BANK_TRANSFER" | "VIRTUAL_ACCOUNT" | "MOBILE" | "POINT" | "MIXED";
|
|
4416
4581
|
approvedMethod: string | null;
|
|
4582
|
+
easyPayProvider: string | null;
|
|
4417
4583
|
productAmount: number;
|
|
4418
4584
|
deliveryFee: number;
|
|
4419
4585
|
discountAmount: number;
|
|
@@ -5065,6 +5231,7 @@ export declare function createStoreClient(options: StoreClientOptions): {
|
|
|
5065
5231
|
conversionRate: number | null;
|
|
5066
5232
|
date: string;
|
|
5067
5233
|
}[];
|
|
5234
|
+
excludedBotSessions: number;
|
|
5068
5235
|
from: string;
|
|
5069
5236
|
to: string;
|
|
5070
5237
|
timezone: "Asia/Seoul";
|
|
@@ -5086,6 +5253,7 @@ export declare function createStoreClient(options: StoreClientOptions): {
|
|
|
5086
5253
|
quantity: number;
|
|
5087
5254
|
revenue: number;
|
|
5088
5255
|
purchaseRate: number | null;
|
|
5256
|
+
clickThroughRate: number | null;
|
|
5089
5257
|
}[];
|
|
5090
5258
|
from: string;
|
|
5091
5259
|
to: string;
|
|
@@ -5118,6 +5286,101 @@ export declare function createStoreClient(options: StoreClientOptions): {
|
|
|
5118
5286
|
includeTest: boolean;
|
|
5119
5287
|
lastComputedAt: string | null;
|
|
5120
5288
|
}>;
|
|
5289
|
+
/** `GET /v1/analytics/realtime` — 최근 5분 방문자·세션·페이지(원본 이벤트 기준, 봇 제외) */
|
|
5290
|
+
realtime: () => Promise<{
|
|
5291
|
+
asOf: string;
|
|
5292
|
+
windowMinutes: 5;
|
|
5293
|
+
visitors: number;
|
|
5294
|
+
sessions: number;
|
|
5295
|
+
pageViews: number;
|
|
5296
|
+
pages: {
|
|
5297
|
+
path: string;
|
|
5298
|
+
visitors: number;
|
|
5299
|
+
pageViews: number;
|
|
5300
|
+
}[];
|
|
5301
|
+
}>;
|
|
5302
|
+
/** `GET /v1/analytics/devices` — 기기별 세션 퍼널 */
|
|
5303
|
+
devices: (params: AnalyticsRangeParams) => Promise<{
|
|
5304
|
+
rows: {
|
|
5305
|
+
device: "unknown" | "desktop" | "mobile" | "tablet";
|
|
5306
|
+
sessions: number;
|
|
5307
|
+
productViewSessions: number;
|
|
5308
|
+
addToCartSessions: number;
|
|
5309
|
+
beginCheckoutSessions: number;
|
|
5310
|
+
purchaseSessions: number;
|
|
5311
|
+
conversionRate: number | null;
|
|
5312
|
+
}[];
|
|
5313
|
+
from: string;
|
|
5314
|
+
to: string;
|
|
5315
|
+
timezone: "Asia/Seoul";
|
|
5316
|
+
currency: "KRW";
|
|
5317
|
+
includeTest: boolean;
|
|
5318
|
+
lastComputedAt: string | null;
|
|
5319
|
+
}>;
|
|
5320
|
+
/** `GET /v1/analytics/pages` — 첫 페이지(진입·반송)와 이탈 페이지 */
|
|
5321
|
+
pages: (params: AnalyticsPagesParams) => Promise<{
|
|
5322
|
+
landings: {
|
|
5323
|
+
path: string;
|
|
5324
|
+
entrances: number;
|
|
5325
|
+
bounces: number;
|
|
5326
|
+
bounceRate: number | null;
|
|
5327
|
+
}[];
|
|
5328
|
+
exits: {
|
|
5329
|
+
path: string;
|
|
5330
|
+
pageViews: number;
|
|
5331
|
+
exits: number;
|
|
5332
|
+
exitRate: number | null;
|
|
5333
|
+
}[];
|
|
5334
|
+
from: string;
|
|
5335
|
+
to: string;
|
|
5336
|
+
timezone: "Asia/Seoul";
|
|
5337
|
+
currency: "KRW";
|
|
5338
|
+
includeTest: boolean;
|
|
5339
|
+
lastComputedAt: string | null;
|
|
5340
|
+
}>;
|
|
5341
|
+
/** `GET /v1/analytics/search` — 검색어별 검색·결과 0개·검색 후 구매 */
|
|
5342
|
+
search: (params: AnalyticsSearchParams) => Promise<{
|
|
5343
|
+
summary: {
|
|
5344
|
+
searches: number;
|
|
5345
|
+
zeroResultSearches: number;
|
|
5346
|
+
searchSessions: number;
|
|
5347
|
+
purchaseSessions: number;
|
|
5348
|
+
conversionRate: number | null;
|
|
5349
|
+
};
|
|
5350
|
+
terms: {
|
|
5351
|
+
term: string;
|
|
5352
|
+
searches: number;
|
|
5353
|
+
zeroResultSearches: number;
|
|
5354
|
+
searchSessions: number;
|
|
5355
|
+
purchaseSessions: number;
|
|
5356
|
+
conversionRate: number | null;
|
|
5357
|
+
}[];
|
|
5358
|
+
zeroResultTerms: {
|
|
5359
|
+
term: string;
|
|
5360
|
+
searches: number;
|
|
5361
|
+
zeroResultSearches: number;
|
|
5362
|
+
}[];
|
|
5363
|
+
from: string;
|
|
5364
|
+
to: string;
|
|
5365
|
+
timezone: "Asia/Seoul";
|
|
5366
|
+
currency: "KRW";
|
|
5367
|
+
includeTest: boolean;
|
|
5368
|
+
lastComputedAt: string | null;
|
|
5369
|
+
}>;
|
|
5370
|
+
/** `GET /v1/analytics/checkout` — 결제 세션의 결과별 수(결제 단계 이탈 이유) */
|
|
5371
|
+
checkout: (params: AnalyticsRangeParams) => Promise<{
|
|
5372
|
+
sessions: number;
|
|
5373
|
+
outcomes: {
|
|
5374
|
+
outcome: "OTHER" | "COMPLETED" | "NOT_OPENED" | "USER_CANCELED" | "DECLINED" | "PREPARE_FAILURE" | "IN_PROGRESS";
|
|
5375
|
+
sessions: number;
|
|
5376
|
+
}[];
|
|
5377
|
+
from: string;
|
|
5378
|
+
to: string;
|
|
5379
|
+
timezone: "Asia/Seoul";
|
|
5380
|
+
currency: "KRW";
|
|
5381
|
+
includeTest: boolean;
|
|
5382
|
+
lastComputedAt: string | null;
|
|
5383
|
+
}>;
|
|
5121
5384
|
};
|
|
5122
5385
|
/**
|
|
5123
5386
|
* 결제 내역 — 스코프 `settlement:r`. 결제 건(세션) 단위이고 주문 목록과 다르다. 주문이 만들어지지 않은
|
|
@@ -5143,6 +5406,7 @@ export declare function createStoreClient(options: StoreClientOptions): {
|
|
|
5143
5406
|
refundedAmount: number;
|
|
5144
5407
|
provider: "tosspayments" | "portone" | null;
|
|
5145
5408
|
method: "CARD" | "BANK_TRANSFER" | "VIRTUAL_ACCOUNT" | "MOBILE" | "EASY_PAY" | null;
|
|
5409
|
+
easyPayProvider: string | null;
|
|
5146
5410
|
environment: "TEST" | "LIVE" | null;
|
|
5147
5411
|
testPayment: boolean;
|
|
5148
5412
|
pgTransactionId: string | null;
|
|
@@ -5165,6 +5429,7 @@ export declare function createStoreClient(options: StoreClientOptions): {
|
|
|
5165
5429
|
refundedAmount: number;
|
|
5166
5430
|
provider: "tosspayments" | "portone" | null;
|
|
5167
5431
|
method: "CARD" | "BANK_TRANSFER" | "VIRTUAL_ACCOUNT" | "MOBILE" | "EASY_PAY" | null;
|
|
5432
|
+
easyPayProvider: string | null;
|
|
5168
5433
|
environment: "TEST" | "LIVE" | null;
|
|
5169
5434
|
testPayment: boolean;
|
|
5170
5435
|
pgTransactionId: string | null;
|
|
@@ -5182,7 +5447,9 @@ export declare function createStoreClient(options: StoreClientOptions): {
|
|
|
5182
5447
|
provider: "tosspayments" | "portone";
|
|
5183
5448
|
status: string;
|
|
5184
5449
|
method: "CARD" | "BANK_TRANSFER" | "VIRTUAL_ACCOUNT" | "MOBILE" | "EASY_PAY";
|
|
5450
|
+
easyPayProvider: string | null;
|
|
5185
5451
|
approvedMethod: "CARD" | "BANK_TRANSFER" | "VIRTUAL_ACCOUNT" | "MOBILE" | "EASY_PAY" | null;
|
|
5452
|
+
approvedEasyPayProvider: string | null;
|
|
5186
5453
|
amount: number;
|
|
5187
5454
|
environment: "TEST" | "LIVE";
|
|
5188
5455
|
pgTransactionId: string | null;
|
|
@@ -5212,8 +5479,7 @@ export declare function createStoreClient(options: StoreClientOptions): {
|
|
|
5212
5479
|
paymentSettings: {
|
|
5213
5480
|
/** `GET /v1/store/payment-settings` — 라우팅 모드와 지원 PG 전부(연결된 것은 우선순위순) */
|
|
5214
5481
|
get: () => Promise<{
|
|
5215
|
-
|
|
5216
|
-
effectiveRoutingMode: "PRIORITY_DISPLAY" | "AUTO_FAILOVER" | "NONE" | "SINGLE";
|
|
5482
|
+
checkoutOrigins: string[];
|
|
5217
5483
|
providers: {
|
|
5218
5484
|
provider: "tosspayments" | "portone";
|
|
5219
5485
|
displayName: string;
|
|
@@ -5302,6 +5568,7 @@ export declare function createStoreClient(options: StoreClientOptions): {
|
|
|
5302
5568
|
}[];
|
|
5303
5569
|
openedAt: string | null;
|
|
5304
5570
|
};
|
|
5571
|
+
easyPayProviders: string[];
|
|
5305
5572
|
retiredCredentialCount: number;
|
|
5306
5573
|
routingExclusion: string | null;
|
|
5307
5574
|
}[];
|
|
@@ -5313,8 +5580,7 @@ export declare function createStoreClient(options: StoreClientOptions): {
|
|
|
5313
5580
|
* (빠지거나 중복되면 400 `INVALID_PRIORITY`). 진행 중인 결제에는 적용되지 않는다.
|
|
5314
5581
|
*/
|
|
5315
5582
|
update: (body: UpdatePaymentSettingsRequest) => Promise<{
|
|
5316
|
-
|
|
5317
|
-
effectiveRoutingMode: "PRIORITY_DISPLAY" | "AUTO_FAILOVER" | "NONE" | "SINGLE";
|
|
5583
|
+
checkoutOrigins: string[];
|
|
5318
5584
|
providers: {
|
|
5319
5585
|
provider: "tosspayments" | "portone";
|
|
5320
5586
|
displayName: string;
|
|
@@ -5403,6 +5669,7 @@ export declare function createStoreClient(options: StoreClientOptions): {
|
|
|
5403
5669
|
}[];
|
|
5404
5670
|
openedAt: string | null;
|
|
5405
5671
|
};
|
|
5672
|
+
easyPayProviders: string[];
|
|
5406
5673
|
retiredCredentialCount: number;
|
|
5407
5674
|
routingExclusion: string | null;
|
|
5408
5675
|
}[];
|
|
@@ -5508,6 +5775,7 @@ export declare function createStoreClient(options: StoreClientOptions): {
|
|
|
5508
5775
|
}[];
|
|
5509
5776
|
openedAt: string | null;
|
|
5510
5777
|
};
|
|
5778
|
+
easyPayProviders: string[];
|
|
5511
5779
|
retiredCredentialCount: number;
|
|
5512
5780
|
routingExclusion: string | null;
|
|
5513
5781
|
}>;
|
|
@@ -5603,6 +5871,7 @@ export declare function createStoreClient(options: StoreClientOptions): {
|
|
|
5603
5871
|
}[];
|
|
5604
5872
|
openedAt: string | null;
|
|
5605
5873
|
};
|
|
5874
|
+
easyPayProviders: string[];
|
|
5606
5875
|
retiredCredentialCount: number;
|
|
5607
5876
|
routingExclusion: string | null;
|
|
5608
5877
|
}>;
|
|
@@ -5708,6 +5977,7 @@ export declare function createStoreClient(options: StoreClientOptions): {
|
|
|
5708
5977
|
}[];
|
|
5709
5978
|
openedAt: string | null;
|
|
5710
5979
|
};
|
|
5980
|
+
easyPayProviders: string[];
|
|
5711
5981
|
retiredCredentialCount: number;
|
|
5712
5982
|
routingExclusion: string | null;
|
|
5713
5983
|
}>;
|
|
@@ -5803,6 +6073,7 @@ export declare function createStoreClient(options: StoreClientOptions): {
|
|
|
5803
6073
|
}[];
|
|
5804
6074
|
openedAt: string | null;
|
|
5805
6075
|
};
|
|
6076
|
+
easyPayProviders: string[];
|
|
5806
6077
|
retiredCredentialCount: number;
|
|
5807
6078
|
routingExclusion: string | null;
|
|
5808
6079
|
}>;
|
|
@@ -5907,6 +6178,7 @@ export declare function createStoreClient(options: StoreClientOptions): {
|
|
|
5907
6178
|
}[];
|
|
5908
6179
|
openedAt: string | null;
|
|
5909
6180
|
};
|
|
6181
|
+
easyPayProviders: string[];
|
|
5910
6182
|
retiredCredentialCount: number;
|
|
5911
6183
|
routingExclusion: string | null;
|
|
5912
6184
|
}>;
|