@01.software/sdk 0.13.0 → 0.15.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/README.md +9 -1
- package/dist/analytics.cjs +209 -0
- package/dist/analytics.cjs.map +1 -0
- package/dist/analytics.d.cts +20 -0
- package/dist/analytics.d.ts +20 -0
- package/dist/analytics.js +186 -0
- package/dist/analytics.js.map +1 -0
- package/dist/{const-DqcpKgSA.d.cts → const-9RunqFfj.d.cts} +1 -1
- package/dist/{const-DSTPrI77.d.ts → const-ovU3MmND.d.ts} +1 -1
- package/dist/index.cjs +173 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +7 -6
- package/dist/index.d.ts +7 -6
- package/dist/index.js +173 -0
- package/dist/index.js.map +1 -1
- package/dist/{payload-types-DqX4iuTW.d.cts → payload-types-Cjbr7XZZ.d.cts} +415 -53
- package/dist/{payload-types-DqX4iuTW.d.ts → payload-types-Cjbr7XZZ.d.ts} +415 -53
- package/dist/realtime.d.cts +2 -2
- package/dist/realtime.d.ts +2 -2
- package/dist/ui/form.d.cts +1 -1
- package/dist/ui/form.d.ts +1 -1
- package/dist/ui/video.d.cts +1 -1
- package/dist/ui/video.d.ts +1 -1
- package/dist/{webhook-CX21PpBt.d.ts → webhook-2zxdCwB4.d.ts} +2 -2
- package/dist/{webhook-mXjcW86I.d.cts → webhook-BVA28ptL.d.cts} +2 -2
- package/dist/webhook.d.cts +3 -3
- package/dist/webhook.d.ts +3 -3
- package/package.json +11 -1
|
@@ -19,7 +19,12 @@ interface Config {
|
|
|
19
19
|
'personal-access-tokens': PersonalAccessToken;
|
|
20
20
|
tenants: Tenant;
|
|
21
21
|
'tenant-metadata': TenantMetadatum;
|
|
22
|
+
'tenant-auth-settings': TenantAuthSetting;
|
|
23
|
+
'tenant-community-settings': TenantCommunitySetting;
|
|
22
24
|
'api-usage': ApiUsage;
|
|
25
|
+
'tenant-analytics-daily': TenantAnalyticsDaily;
|
|
26
|
+
'analytics-event-schemas': AnalyticsEventSchema;
|
|
27
|
+
'tenant-entitlements': TenantEntitlement;
|
|
23
28
|
subscriptions: Subscription;
|
|
24
29
|
'billing-history': BillingHistory;
|
|
25
30
|
'tenant-logos': TenantLogo;
|
|
@@ -147,7 +152,12 @@ interface Config {
|
|
|
147
152
|
'personal-access-tokens': PersonalAccessTokensSelect<false> | PersonalAccessTokensSelect<true>;
|
|
148
153
|
tenants: TenantsSelect<false> | TenantsSelect<true>;
|
|
149
154
|
'tenant-metadata': TenantMetadataSelect<false> | TenantMetadataSelect<true>;
|
|
155
|
+
'tenant-auth-settings': TenantAuthSettingsSelect<false> | TenantAuthSettingsSelect<true>;
|
|
156
|
+
'tenant-community-settings': TenantCommunitySettingsSelect<false> | TenantCommunitySettingsSelect<true>;
|
|
150
157
|
'api-usage': ApiUsageSelect<false> | ApiUsageSelect<true>;
|
|
158
|
+
'tenant-analytics-daily': TenantAnalyticsDailySelect<false> | TenantAnalyticsDailySelect<true>;
|
|
159
|
+
'analytics-event-schemas': AnalyticsEventSchemasSelect<false> | AnalyticsEventSchemasSelect<true>;
|
|
160
|
+
'tenant-entitlements': TenantEntitlementsSelect<false> | TenantEntitlementsSelect<true>;
|
|
151
161
|
subscriptions: SubscriptionsSelect<false> | SubscriptionsSelect<true>;
|
|
152
162
|
'billing-history': BillingHistorySelect<false> | BillingHistorySelect<true>;
|
|
153
163
|
'tenant-logos': TenantLogosSelect<false> | TenantLogosSelect<true>;
|
|
@@ -313,6 +323,7 @@ interface CodeBlock {
|
|
|
313
323
|
*/
|
|
314
324
|
interface User {
|
|
315
325
|
id: string;
|
|
326
|
+
_users_members_order?: string | null;
|
|
316
327
|
roles: ('super-admin' | 'user')[];
|
|
317
328
|
tenants?: {
|
|
318
329
|
tenant: string | Tenant;
|
|
@@ -374,34 +385,34 @@ interface Tenant {
|
|
|
374
385
|
* Tenant owner. Only the owner can delete the tenant or transfer ownership.
|
|
375
386
|
*/
|
|
376
387
|
owner: string | User;
|
|
377
|
-
plan: 'free' | 'starter' | 'basic' | 'pro' | 'enterprise';
|
|
378
|
-
features?: ('ecommerce' | 'customers' | 'playlists' | 'galleries' | 'links' | 'forms' | 'posts' | 'documents' | 'canvas' | 'videos' | 'live-streaming' | 'community')[] | null;
|
|
379
388
|
/**
|
|
380
|
-
*
|
|
389
|
+
* Feature projection entries. Each item carries feature + provenance.
|
|
381
390
|
*/
|
|
382
|
-
|
|
391
|
+
features?: {
|
|
392
|
+
feature: 'ecommerce' | 'customers' | 'playlists' | 'galleries' | 'links' | 'forms' | 'posts' | 'documents' | 'canvas' | 'videos' | 'live-streaming' | 'community';
|
|
393
|
+
provenance: string;
|
|
394
|
+
id?: string | null;
|
|
395
|
+
}[] | null;
|
|
383
396
|
/**
|
|
384
|
-
*
|
|
397
|
+
* Features this tenant has opted out of. Only effective for features granted by the plan.
|
|
385
398
|
*/
|
|
386
|
-
|
|
399
|
+
disabledFeatures?: ('ecommerce' | 'customers' | 'playlists' | 'galleries' | 'links' | 'forms' | 'posts' | 'documents' | 'canvas' | 'videos' | 'live-streaming' | 'community')[] | null;
|
|
387
400
|
/**
|
|
388
401
|
* Dev mode shows configuration tools like the field settings panel. Turn off after setup for a clean production UI.
|
|
389
402
|
*/
|
|
390
403
|
isDevMode?: boolean | null;
|
|
391
404
|
status?: ('active' | 'paused' | 'past_due' | 'canceled' | 'pending_deletion') | null;
|
|
392
|
-
trialEndsAt?: string | null;
|
|
393
|
-
deletionScheduledAt?: string | null;
|
|
394
405
|
/**
|
|
395
|
-
*
|
|
406
|
+
* Publishable Key — safe to embed in browser code. Prefix: pk01_
|
|
407
|
+
*/
|
|
408
|
+
publishableKey: string;
|
|
409
|
+
/**
|
|
410
|
+
* Allowed CORS origins for browser SDK requests. Together with the publishable key, this defines browser access boundaries. Empty = all origins allowed.
|
|
396
411
|
*/
|
|
397
412
|
cors?: {
|
|
398
413
|
origin: string;
|
|
399
414
|
id?: string | null;
|
|
400
415
|
}[] | null;
|
|
401
|
-
/**
|
|
402
|
-
* Publishable Key — safe to embed in browser code. Prefix: pk01_
|
|
403
|
-
*/
|
|
404
|
-
publishableKey: string;
|
|
405
416
|
/**
|
|
406
417
|
* Webhook endpoints to notify on data changes.
|
|
407
418
|
*/
|
|
@@ -410,6 +421,10 @@ interface Tenant {
|
|
|
410
421
|
* e.g. Main Server, Analytics
|
|
411
422
|
*/
|
|
412
423
|
name?: string | null;
|
|
424
|
+
/**
|
|
425
|
+
* Leave empty for legacy generic collection-change delivery. verification/password-reset are reserved for auth delivery only.
|
|
426
|
+
*/
|
|
427
|
+
purpose?: ('events' | 'verification' | 'password-reset') | null;
|
|
413
428
|
/**
|
|
414
429
|
* The URL to send webhooks to. Must be HTTPS.
|
|
415
430
|
*/
|
|
@@ -429,6 +444,24 @@ interface Tenant {
|
|
|
429
444
|
hasNextPage?: boolean;
|
|
430
445
|
totalDocs?: number;
|
|
431
446
|
};
|
|
447
|
+
webAnalytics: {
|
|
448
|
+
enabled?: boolean | null;
|
|
449
|
+
/**
|
|
450
|
+
* Empty = browser analytics disabled (fail-closed)
|
|
451
|
+
*/
|
|
452
|
+
allowedOrigins?: {
|
|
453
|
+
origin: string;
|
|
454
|
+
id?: string | null;
|
|
455
|
+
}[] | null;
|
|
456
|
+
/**
|
|
457
|
+
* Timezone for daily bucket calculation. Cannot be changed after analytics data is created (v1).
|
|
458
|
+
*/
|
|
459
|
+
timezone: string;
|
|
460
|
+
/**
|
|
461
|
+
* Automatically set to true after the first aggregate write. Only super-admin can unlock.
|
|
462
|
+
*/
|
|
463
|
+
tzLocked?: boolean | null;
|
|
464
|
+
};
|
|
432
465
|
updatedAt: string;
|
|
433
466
|
createdAt: string;
|
|
434
467
|
}
|
|
@@ -440,6 +473,11 @@ interface Image {
|
|
|
440
473
|
id: string;
|
|
441
474
|
tenant?: (string | null) | Tenant;
|
|
442
475
|
alt?: string | null;
|
|
476
|
+
caption?: string | null;
|
|
477
|
+
/**
|
|
478
|
+
* Photographer or source attribution
|
|
479
|
+
*/
|
|
480
|
+
credit?: string | null;
|
|
443
481
|
/**
|
|
444
482
|
* Low quality image placeholder
|
|
445
483
|
*/
|
|
@@ -837,6 +875,11 @@ interface BrandLogo {
|
|
|
837
875
|
id: string;
|
|
838
876
|
tenant?: (string | null) | Tenant;
|
|
839
877
|
alt?: string | null;
|
|
878
|
+
caption?: string | null;
|
|
879
|
+
/**
|
|
880
|
+
* Photographer or source attribution
|
|
881
|
+
*/
|
|
882
|
+
credit?: string | null;
|
|
840
883
|
/**
|
|
841
884
|
* Low quality image placeholder
|
|
842
885
|
*/
|
|
@@ -920,6 +963,34 @@ interface BrandLogo {
|
|
|
920
963
|
};
|
|
921
964
|
};
|
|
922
965
|
}
|
|
966
|
+
/**
|
|
967
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
968
|
+
* via the `definition` "tenant-auth-settings".
|
|
969
|
+
*/
|
|
970
|
+
interface TenantAuthSetting {
|
|
971
|
+
id: string;
|
|
972
|
+
tenant?: (string | null) | Tenant;
|
|
973
|
+
/**
|
|
974
|
+
* Require customer email verification before registration-dependent auth flows proceed.
|
|
975
|
+
*/
|
|
976
|
+
requiresEmailVerification?: boolean | null;
|
|
977
|
+
updatedAt: string;
|
|
978
|
+
createdAt: string;
|
|
979
|
+
}
|
|
980
|
+
/**
|
|
981
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
982
|
+
* via the `definition` "tenant-community-settings".
|
|
983
|
+
*/
|
|
984
|
+
interface TenantCommunitySetting {
|
|
985
|
+
id: string;
|
|
986
|
+
tenant?: (string | null) | Tenant;
|
|
987
|
+
/**
|
|
988
|
+
* When enabled, new customer-created threads remain pending until approved by an admin.
|
|
989
|
+
*/
|
|
990
|
+
requiresPostApproval?: boolean | null;
|
|
991
|
+
updatedAt: string;
|
|
992
|
+
createdAt: string;
|
|
993
|
+
}
|
|
923
994
|
/**
|
|
924
995
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
925
996
|
* via the `definition` "api-usage".
|
|
@@ -969,6 +1040,132 @@ interface ApiUsage {
|
|
|
969
1040
|
updatedAt: string;
|
|
970
1041
|
createdAt: string;
|
|
971
1042
|
}
|
|
1043
|
+
/**
|
|
1044
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
1045
|
+
* via the `definition` "tenant-analytics-daily".
|
|
1046
|
+
*/
|
|
1047
|
+
interface TenantAnalyticsDaily {
|
|
1048
|
+
id: string;
|
|
1049
|
+
tenant?: (string | null) | Tenant;
|
|
1050
|
+
/**
|
|
1051
|
+
* YYYY-MM-DD (UTC)
|
|
1052
|
+
*/
|
|
1053
|
+
date: string;
|
|
1054
|
+
pageviews: number;
|
|
1055
|
+
/**
|
|
1056
|
+
* Estimated via HyperLogLog (±0.81%)
|
|
1057
|
+
*/
|
|
1058
|
+
visitors: number;
|
|
1059
|
+
topPages?: {
|
|
1060
|
+
pathname: string;
|
|
1061
|
+
views: number;
|
|
1062
|
+
id?: string | null;
|
|
1063
|
+
}[] | null;
|
|
1064
|
+
topReferrers?: {
|
|
1065
|
+
source: string;
|
|
1066
|
+
views: number;
|
|
1067
|
+
id?: string | null;
|
|
1068
|
+
}[] | null;
|
|
1069
|
+
topEvents?: {
|
|
1070
|
+
name: string;
|
|
1071
|
+
count: number;
|
|
1072
|
+
id?: string | null;
|
|
1073
|
+
}[] | null;
|
|
1074
|
+
eventsDropped?: {
|
|
1075
|
+
cardinality?: number | null;
|
|
1076
|
+
schema?: number | null;
|
|
1077
|
+
late?: number | null;
|
|
1078
|
+
origin?: number | null;
|
|
1079
|
+
key?: number | null;
|
|
1080
|
+
rate?: number | null;
|
|
1081
|
+
disabled?: number | null;
|
|
1082
|
+
};
|
|
1083
|
+
snapshottedAt?: string | null;
|
|
1084
|
+
/**
|
|
1085
|
+
* 이 snapshot의 bucket이 계산된 tenant timezone
|
|
1086
|
+
*/
|
|
1087
|
+
bucketTz: string;
|
|
1088
|
+
/**
|
|
1089
|
+
* aggregate의 dimension key 집합 해시 (shape mismatch 감지용). custom event 없는 날은 "pageview-only".
|
|
1090
|
+
*/
|
|
1091
|
+
schemaShape: string;
|
|
1092
|
+
/**
|
|
1093
|
+
* Per-event dimension/page/referrer aggregates. Populated by snapshot cron when registered events have Redis data.
|
|
1094
|
+
*/
|
|
1095
|
+
eventDetails?: {
|
|
1096
|
+
eventName: string;
|
|
1097
|
+
dimensions?: {
|
|
1098
|
+
dimension: string;
|
|
1099
|
+
values?: {
|
|
1100
|
+
value: string;
|
|
1101
|
+
count: number;
|
|
1102
|
+
id?: string | null;
|
|
1103
|
+
}[] | null;
|
|
1104
|
+
id?: string | null;
|
|
1105
|
+
}[] | null;
|
|
1106
|
+
pages?: {
|
|
1107
|
+
pathname: string;
|
|
1108
|
+
count: number;
|
|
1109
|
+
id?: string | null;
|
|
1110
|
+
}[] | null;
|
|
1111
|
+
referrers?: {
|
|
1112
|
+
source: string;
|
|
1113
|
+
count: number;
|
|
1114
|
+
id?: string | null;
|
|
1115
|
+
}[] | null;
|
|
1116
|
+
id?: string | null;
|
|
1117
|
+
}[] | null;
|
|
1118
|
+
updatedAt: string;
|
|
1119
|
+
createdAt: string;
|
|
1120
|
+
}
|
|
1121
|
+
/**
|
|
1122
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
1123
|
+
* via the `definition` "analytics-event-schemas".
|
|
1124
|
+
*/
|
|
1125
|
+
interface AnalyticsEventSchema {
|
|
1126
|
+
id: string;
|
|
1127
|
+
tenant?: (string | null) | Tenant;
|
|
1128
|
+
/**
|
|
1129
|
+
* snake_case identifier. Must match /^[a-z][a-z0-9_]*$/
|
|
1130
|
+
*/
|
|
1131
|
+
eventName: string;
|
|
1132
|
+
enabled: boolean;
|
|
1133
|
+
dimensions?: {
|
|
1134
|
+
key: string;
|
|
1135
|
+
type: 'enum' | 'boolean';
|
|
1136
|
+
/**
|
|
1137
|
+
* Comma-separated. Required when type=enum. Boolean auto-derives {true,false}. Max 20 values per key.
|
|
1138
|
+
*/
|
|
1139
|
+
allowedValues?: string | null;
|
|
1140
|
+
description?: string | null;
|
|
1141
|
+
id?: string | null;
|
|
1142
|
+
}[] | null;
|
|
1143
|
+
createdBy?: (string | null) | User;
|
|
1144
|
+
updatedBy?: (string | null) | User;
|
|
1145
|
+
updatedAt: string;
|
|
1146
|
+
createdAt: string;
|
|
1147
|
+
}
|
|
1148
|
+
/**
|
|
1149
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
1150
|
+
* via the `definition` "tenant-entitlements".
|
|
1151
|
+
*/
|
|
1152
|
+
interface TenantEntitlement {
|
|
1153
|
+
id: string;
|
|
1154
|
+
tenant: string | Tenant;
|
|
1155
|
+
plan: 'free' | 'starter' | 'basic' | 'pro' | 'enterprise';
|
|
1156
|
+
status: 'active' | 'scheduled' | 'expired' | 'revoked';
|
|
1157
|
+
sourceType: 'subscription' | 'manual' | 'support' | 'promo' | 'trial' | 'legacy_migration' | 'enterprise_contract';
|
|
1158
|
+
sourceSubscription?: (string | null) | Subscription;
|
|
1159
|
+
priority: number;
|
|
1160
|
+
startsAt: string;
|
|
1161
|
+
endsAt?: string | null;
|
|
1162
|
+
reason?: string | null;
|
|
1163
|
+
grantedBy?: (string | null) | User;
|
|
1164
|
+
revokedAt?: string | null;
|
|
1165
|
+
revokedBy?: (string | null) | User;
|
|
1166
|
+
updatedAt: string;
|
|
1167
|
+
createdAt: string;
|
|
1168
|
+
}
|
|
972
1169
|
/**
|
|
973
1170
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
974
1171
|
* via the `definition` "subscriptions".
|
|
@@ -984,7 +1181,7 @@ interface Subscription {
|
|
|
984
1181
|
amount: number;
|
|
985
1182
|
status: 'active' | 'past_due' | 'canceled' | 'expired' | 'suspended';
|
|
986
1183
|
currency: 'KRW' | 'USD';
|
|
987
|
-
provider: 'toss'
|
|
1184
|
+
provider: 'toss';
|
|
988
1185
|
currentPeriodStart?: string | null;
|
|
989
1186
|
currentPeriodEnd?: string | null;
|
|
990
1187
|
trialStartAt?: string | null;
|
|
@@ -1010,14 +1207,6 @@ interface Subscription {
|
|
|
1010
1207
|
number?: string | null;
|
|
1011
1208
|
cardType?: string | null;
|
|
1012
1209
|
};
|
|
1013
|
-
/**
|
|
1014
|
-
* Provider subscription ID
|
|
1015
|
-
*/
|
|
1016
|
-
providerSubscriptionId?: string | null;
|
|
1017
|
-
/**
|
|
1018
|
-
* Provider customer ID
|
|
1019
|
-
*/
|
|
1020
|
-
providerCustomerId?: string | null;
|
|
1021
1210
|
/**
|
|
1022
1211
|
* Additional provider metadata
|
|
1023
1212
|
*/
|
|
@@ -1056,7 +1245,7 @@ interface BillingHistory {
|
|
|
1056
1245
|
* Plan at time of payment
|
|
1057
1246
|
*/
|
|
1058
1247
|
plan: 'starter' | 'basic' | 'pro';
|
|
1059
|
-
provider: 'toss'
|
|
1248
|
+
provider: 'toss';
|
|
1060
1249
|
currency: 'KRW' | 'USD';
|
|
1061
1250
|
billingCycle?: ('monthly' | 'yearly') | null;
|
|
1062
1251
|
periodStart?: string | null;
|
|
@@ -1076,16 +1265,6 @@ interface BillingHistory {
|
|
|
1076
1265
|
tossResponse?: {
|
|
1077
1266
|
[k: string]: unknown;
|
|
1078
1267
|
} | unknown[] | string | number | boolean | null;
|
|
1079
|
-
/**
|
|
1080
|
-
* Polar order ID
|
|
1081
|
-
*/
|
|
1082
|
-
polarOrderId?: string | null;
|
|
1083
|
-
/**
|
|
1084
|
-
* Full Polar API response
|
|
1085
|
-
*/
|
|
1086
|
-
polarResponse?: {
|
|
1087
|
-
[k: string]: unknown;
|
|
1088
|
-
} | unknown[] | string | number | boolean | null;
|
|
1089
1268
|
errorMessage?: string | null;
|
|
1090
1269
|
/**
|
|
1091
1270
|
* Original billing record for retry
|
|
@@ -1102,6 +1281,11 @@ interface TenantLogo {
|
|
|
1102
1281
|
id: string;
|
|
1103
1282
|
tenant?: (string | null) | Tenant;
|
|
1104
1283
|
alt?: string | null;
|
|
1284
|
+
caption?: string | null;
|
|
1285
|
+
/**
|
|
1286
|
+
* Photographer or source attribution
|
|
1287
|
+
*/
|
|
1288
|
+
credit?: string | null;
|
|
1105
1289
|
/**
|
|
1106
1290
|
* Low quality image placeholder
|
|
1107
1291
|
*/
|
|
@@ -2165,6 +2349,14 @@ interface CustomerAddress {
|
|
|
2165
2349
|
postalCode?: string | null;
|
|
2166
2350
|
address1?: string | null;
|
|
2167
2351
|
address2?: string | null;
|
|
2352
|
+
/**
|
|
2353
|
+
* Road name vs jibun address type
|
|
2354
|
+
*/
|
|
2355
|
+
addressType?: ('road' | 'jibun') | null;
|
|
2356
|
+
/**
|
|
2357
|
+
* ISO 3166-1 alpha-2 country code
|
|
2358
|
+
*/
|
|
2359
|
+
country?: string | null;
|
|
2168
2360
|
isDefault?: boolean | null;
|
|
2169
2361
|
/**
|
|
2170
2362
|
* Default delivery message
|
|
@@ -2188,6 +2380,11 @@ interface OrderItem {
|
|
|
2188
2380
|
* Price per unit at time of order
|
|
2189
2381
|
*/
|
|
2190
2382
|
unitPrice: number;
|
|
2383
|
+
variantTitle?: string | null;
|
|
2384
|
+
sku?: string | null;
|
|
2385
|
+
compareAtPrice?: number | null;
|
|
2386
|
+
weight?: number | null;
|
|
2387
|
+
requiresShipping?: boolean | null;
|
|
2191
2388
|
/**
|
|
2192
2389
|
* unitPrice × quantity
|
|
2193
2390
|
*/
|
|
@@ -2357,6 +2554,7 @@ interface ReturnItem {
|
|
|
2357
2554
|
product: string | Product;
|
|
2358
2555
|
variant?: (string | null) | ProductVariant;
|
|
2359
2556
|
quantity: number;
|
|
2557
|
+
restockAction: 'return_to_stock' | 'discard';
|
|
2360
2558
|
productTitle?: string | null;
|
|
2361
2559
|
updatedAt: string;
|
|
2362
2560
|
createdAt: string;
|
|
@@ -2424,6 +2622,9 @@ interface Cart {
|
|
|
2424
2622
|
*/
|
|
2425
2623
|
discountAmount?: number | null;
|
|
2426
2624
|
totalAmount?: number | null;
|
|
2625
|
+
/**
|
|
2626
|
+
* Guest cart identity token. Immutable after creation.
|
|
2627
|
+
*/
|
|
2427
2628
|
cartToken?: string | null;
|
|
2428
2629
|
lastActivityAt?: string | null;
|
|
2429
2630
|
abandonedAt?: string | null;
|
|
@@ -2575,7 +2776,7 @@ interface Post {
|
|
|
2575
2776
|
};
|
|
2576
2777
|
[k: string]: unknown;
|
|
2577
2778
|
} | null;
|
|
2578
|
-
|
|
2779
|
+
authors?: (string | PostAuthor)[] | null;
|
|
2579
2780
|
categories?: (string | PostCategory)[] | null;
|
|
2580
2781
|
tags?: (string | PostTag)[] | null;
|
|
2581
2782
|
videos?: (string | Video)[] | null;
|
|
@@ -2619,7 +2820,6 @@ interface Post {
|
|
|
2619
2820
|
thumbnail?: (string | null) | Image;
|
|
2620
2821
|
images?: (string | Image)[] | null;
|
|
2621
2822
|
publishedAt?: string | null;
|
|
2622
|
-
customer?: (string | null) | Customer;
|
|
2623
2823
|
isFeatured?: boolean | null;
|
|
2624
2824
|
/**
|
|
2625
2825
|
* Reading time (minutes)
|
|
@@ -2771,7 +2971,11 @@ interface Document {
|
|
|
2771
2971
|
*/
|
|
2772
2972
|
changeLog?: string | null;
|
|
2773
2973
|
/**
|
|
2774
|
-
*
|
|
2974
|
+
* Audience/timing for required agreement
|
|
2975
|
+
*/
|
|
2976
|
+
agreementScope?: ('all_users' | 'new_users' | 'on_update') | null;
|
|
2977
|
+
/**
|
|
2978
|
+
* Legacy compatibility field; replaced by agreementScope
|
|
2775
2979
|
*/
|
|
2776
2980
|
requiresAgreement?: boolean | null;
|
|
2777
2981
|
/**
|
|
@@ -3062,7 +3266,6 @@ interface Track {
|
|
|
3062
3266
|
*/
|
|
3063
3267
|
sourceProvider?: string | null;
|
|
3064
3268
|
sourceId?: string | null;
|
|
3065
|
-
createdBy?: (string | null) | Customer;
|
|
3066
3269
|
/**
|
|
3067
3270
|
* ISRC
|
|
3068
3271
|
*/
|
|
@@ -3131,7 +3334,6 @@ interface TrackAsset {
|
|
|
3131
3334
|
id: string;
|
|
3132
3335
|
tenant?: (string | null) | Tenant;
|
|
3133
3336
|
title?: string | null;
|
|
3134
|
-
customer?: (string | null) | Customer;
|
|
3135
3337
|
metadata?: {
|
|
3136
3338
|
[k: string]: unknown;
|
|
3137
3339
|
} | unknown[] | string | number | boolean | null;
|
|
@@ -3338,6 +3540,8 @@ interface Link {
|
|
|
3338
3540
|
opensInNewTab?: boolean | null;
|
|
3339
3541
|
noFollow?: boolean | null;
|
|
3340
3542
|
expiresAt?: string | null;
|
|
3543
|
+
clickCount?: number | null;
|
|
3544
|
+
lastClickedAt?: string | null;
|
|
3341
3545
|
status?: ('draft' | 'published' | 'archived') | null;
|
|
3342
3546
|
isFeatured?: boolean | null;
|
|
3343
3547
|
metadata?: {
|
|
@@ -4086,9 +4290,24 @@ interface PayloadLockedDocument {
|
|
|
4086
4290
|
} | null) | ({
|
|
4087
4291
|
relationTo: 'tenant-metadata';
|
|
4088
4292
|
value: string | TenantMetadatum;
|
|
4293
|
+
} | null) | ({
|
|
4294
|
+
relationTo: 'tenant-auth-settings';
|
|
4295
|
+
value: string | TenantAuthSetting;
|
|
4296
|
+
} | null) | ({
|
|
4297
|
+
relationTo: 'tenant-community-settings';
|
|
4298
|
+
value: string | TenantCommunitySetting;
|
|
4089
4299
|
} | null) | ({
|
|
4090
4300
|
relationTo: 'api-usage';
|
|
4091
4301
|
value: string | ApiUsage;
|
|
4302
|
+
} | null) | ({
|
|
4303
|
+
relationTo: 'tenant-analytics-daily';
|
|
4304
|
+
value: string | TenantAnalyticsDaily;
|
|
4305
|
+
} | null) | ({
|
|
4306
|
+
relationTo: 'analytics-event-schemas';
|
|
4307
|
+
value: string | AnalyticsEventSchema;
|
|
4308
|
+
} | null) | ({
|
|
4309
|
+
relationTo: 'tenant-entitlements';
|
|
4310
|
+
value: string | TenantEntitlement;
|
|
4092
4311
|
} | null) | ({
|
|
4093
4312
|
relationTo: 'subscriptions';
|
|
4094
4313
|
value: string | Subscription;
|
|
@@ -4338,6 +4557,7 @@ interface PayloadMigration {
|
|
|
4338
4557
|
* via the `definition` "users_select".
|
|
4339
4558
|
*/
|
|
4340
4559
|
interface UsersSelect<T extends boolean = true> {
|
|
4560
|
+
_users_members_order?: T;
|
|
4341
4561
|
roles?: T;
|
|
4342
4562
|
tenants?: T | {
|
|
4343
4563
|
tenant?: T;
|
|
@@ -4398,6 +4618,8 @@ interface FieldConfigsSelect<T extends boolean = true> {
|
|
|
4398
4618
|
interface ImagesSelect<T extends boolean = true> {
|
|
4399
4619
|
tenant?: T;
|
|
4400
4620
|
alt?: T;
|
|
4621
|
+
caption?: T;
|
|
4622
|
+
credit?: T;
|
|
4401
4623
|
lqip?: T;
|
|
4402
4624
|
palette?: T | {
|
|
4403
4625
|
vibrant?: T;
|
|
@@ -4570,27 +4792,37 @@ interface TenantsSelect<T extends boolean = true> {
|
|
|
4570
4792
|
name?: T;
|
|
4571
4793
|
slug?: T;
|
|
4572
4794
|
owner?: T;
|
|
4573
|
-
|
|
4574
|
-
|
|
4575
|
-
|
|
4576
|
-
|
|
4795
|
+
features?: T | {
|
|
4796
|
+
feature?: T;
|
|
4797
|
+
provenance?: T;
|
|
4798
|
+
id?: T;
|
|
4799
|
+
};
|
|
4800
|
+
disabledFeatures?: T;
|
|
4577
4801
|
isDevMode?: T;
|
|
4578
4802
|
status?: T;
|
|
4579
|
-
|
|
4580
|
-
deletionScheduledAt?: T;
|
|
4803
|
+
publishableKey?: T;
|
|
4581
4804
|
cors?: T | {
|
|
4582
4805
|
origin?: T;
|
|
4583
4806
|
id?: T;
|
|
4584
4807
|
};
|
|
4585
|
-
publishableKey?: T;
|
|
4586
4808
|
webhooks?: T | {
|
|
4587
4809
|
name?: T;
|
|
4810
|
+
purpose?: T;
|
|
4588
4811
|
url?: T;
|
|
4589
4812
|
secret?: T;
|
|
4590
4813
|
isEnabled?: T;
|
|
4591
4814
|
id?: T;
|
|
4592
4815
|
};
|
|
4593
4816
|
members?: T;
|
|
4817
|
+
webAnalytics?: T | {
|
|
4818
|
+
enabled?: T;
|
|
4819
|
+
allowedOrigins?: T | {
|
|
4820
|
+
origin?: T;
|
|
4821
|
+
id?: T;
|
|
4822
|
+
};
|
|
4823
|
+
timezone?: T;
|
|
4824
|
+
tzLocked?: T;
|
|
4825
|
+
};
|
|
4594
4826
|
updatedAt?: T;
|
|
4595
4827
|
createdAt?: T;
|
|
4596
4828
|
}
|
|
@@ -4658,6 +4890,26 @@ interface TenantMetadataSelect<T extends boolean = true> {
|
|
|
4658
4890
|
updatedAt?: T;
|
|
4659
4891
|
createdAt?: T;
|
|
4660
4892
|
}
|
|
4893
|
+
/**
|
|
4894
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
4895
|
+
* via the `definition` "tenant-auth-settings_select".
|
|
4896
|
+
*/
|
|
4897
|
+
interface TenantAuthSettingsSelect<T extends boolean = true> {
|
|
4898
|
+
tenant?: T;
|
|
4899
|
+
requiresEmailVerification?: T;
|
|
4900
|
+
updatedAt?: T;
|
|
4901
|
+
createdAt?: T;
|
|
4902
|
+
}
|
|
4903
|
+
/**
|
|
4904
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
4905
|
+
* via the `definition` "tenant-community-settings_select".
|
|
4906
|
+
*/
|
|
4907
|
+
interface TenantCommunitySettingsSelect<T extends boolean = true> {
|
|
4908
|
+
tenant?: T;
|
|
4909
|
+
requiresPostApproval?: T;
|
|
4910
|
+
updatedAt?: T;
|
|
4911
|
+
createdAt?: T;
|
|
4912
|
+
}
|
|
4661
4913
|
/**
|
|
4662
4914
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
4663
4915
|
* via the `definition` "api-usage_select".
|
|
@@ -4679,6 +4931,108 @@ interface ApiUsageSelect<T extends boolean = true> {
|
|
|
4679
4931
|
updatedAt?: T;
|
|
4680
4932
|
createdAt?: T;
|
|
4681
4933
|
}
|
|
4934
|
+
/**
|
|
4935
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
4936
|
+
* via the `definition` "tenant-analytics-daily_select".
|
|
4937
|
+
*/
|
|
4938
|
+
interface TenantAnalyticsDailySelect<T extends boolean = true> {
|
|
4939
|
+
tenant?: T;
|
|
4940
|
+
date?: T;
|
|
4941
|
+
pageviews?: T;
|
|
4942
|
+
visitors?: T;
|
|
4943
|
+
topPages?: T | {
|
|
4944
|
+
pathname?: T;
|
|
4945
|
+
views?: T;
|
|
4946
|
+
id?: T;
|
|
4947
|
+
};
|
|
4948
|
+
topReferrers?: T | {
|
|
4949
|
+
source?: T;
|
|
4950
|
+
views?: T;
|
|
4951
|
+
id?: T;
|
|
4952
|
+
};
|
|
4953
|
+
topEvents?: T | {
|
|
4954
|
+
name?: T;
|
|
4955
|
+
count?: T;
|
|
4956
|
+
id?: T;
|
|
4957
|
+
};
|
|
4958
|
+
eventsDropped?: T | {
|
|
4959
|
+
cardinality?: T;
|
|
4960
|
+
schema?: T;
|
|
4961
|
+
late?: T;
|
|
4962
|
+
origin?: T;
|
|
4963
|
+
key?: T;
|
|
4964
|
+
rate?: T;
|
|
4965
|
+
disabled?: T;
|
|
4966
|
+
};
|
|
4967
|
+
snapshottedAt?: T;
|
|
4968
|
+
bucketTz?: T;
|
|
4969
|
+
schemaShape?: T;
|
|
4970
|
+
eventDetails?: T | {
|
|
4971
|
+
eventName?: T;
|
|
4972
|
+
dimensions?: T | {
|
|
4973
|
+
dimension?: T;
|
|
4974
|
+
values?: T | {
|
|
4975
|
+
value?: T;
|
|
4976
|
+
count?: T;
|
|
4977
|
+
id?: T;
|
|
4978
|
+
};
|
|
4979
|
+
id?: T;
|
|
4980
|
+
};
|
|
4981
|
+
pages?: T | {
|
|
4982
|
+
pathname?: T;
|
|
4983
|
+
count?: T;
|
|
4984
|
+
id?: T;
|
|
4985
|
+
};
|
|
4986
|
+
referrers?: T | {
|
|
4987
|
+
source?: T;
|
|
4988
|
+
count?: T;
|
|
4989
|
+
id?: T;
|
|
4990
|
+
};
|
|
4991
|
+
id?: T;
|
|
4992
|
+
};
|
|
4993
|
+
updatedAt?: T;
|
|
4994
|
+
createdAt?: T;
|
|
4995
|
+
}
|
|
4996
|
+
/**
|
|
4997
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
4998
|
+
* via the `definition` "analytics-event-schemas_select".
|
|
4999
|
+
*/
|
|
5000
|
+
interface AnalyticsEventSchemasSelect<T extends boolean = true> {
|
|
5001
|
+
tenant?: T;
|
|
5002
|
+
eventName?: T;
|
|
5003
|
+
enabled?: T;
|
|
5004
|
+
dimensions?: T | {
|
|
5005
|
+
key?: T;
|
|
5006
|
+
type?: T;
|
|
5007
|
+
allowedValues?: T;
|
|
5008
|
+
description?: T;
|
|
5009
|
+
id?: T;
|
|
5010
|
+
};
|
|
5011
|
+
createdBy?: T;
|
|
5012
|
+
updatedBy?: T;
|
|
5013
|
+
updatedAt?: T;
|
|
5014
|
+
createdAt?: T;
|
|
5015
|
+
}
|
|
5016
|
+
/**
|
|
5017
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
5018
|
+
* via the `definition` "tenant-entitlements_select".
|
|
5019
|
+
*/
|
|
5020
|
+
interface TenantEntitlementsSelect<T extends boolean = true> {
|
|
5021
|
+
tenant?: T;
|
|
5022
|
+
plan?: T;
|
|
5023
|
+
status?: T;
|
|
5024
|
+
sourceType?: T;
|
|
5025
|
+
sourceSubscription?: T;
|
|
5026
|
+
priority?: T;
|
|
5027
|
+
startsAt?: T;
|
|
5028
|
+
endsAt?: T;
|
|
5029
|
+
reason?: T;
|
|
5030
|
+
grantedBy?: T;
|
|
5031
|
+
revokedAt?: T;
|
|
5032
|
+
revokedBy?: T;
|
|
5033
|
+
updatedAt?: T;
|
|
5034
|
+
createdAt?: T;
|
|
5035
|
+
}
|
|
4682
5036
|
/**
|
|
4683
5037
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
4684
5038
|
* via the `definition` "subscriptions_select".
|
|
@@ -4704,8 +5058,6 @@ interface SubscriptionsSelect<T extends boolean = true> {
|
|
|
4704
5058
|
number?: T;
|
|
4705
5059
|
cardType?: T;
|
|
4706
5060
|
};
|
|
4707
|
-
providerSubscriptionId?: T;
|
|
4708
|
-
providerCustomerId?: T;
|
|
4709
5061
|
providerMetadata?: T;
|
|
4710
5062
|
cancelAtPeriodEnd?: T;
|
|
4711
5063
|
canceledAt?: T;
|
|
@@ -4741,8 +5093,6 @@ interface BillingHistorySelect<T extends boolean = true> {
|
|
|
4741
5093
|
orderName?: T;
|
|
4742
5094
|
paymentKey?: T;
|
|
4743
5095
|
tossResponse?: T;
|
|
4744
|
-
polarOrderId?: T;
|
|
4745
|
-
polarResponse?: T;
|
|
4746
5096
|
errorMessage?: T;
|
|
4747
5097
|
retryOf?: T;
|
|
4748
5098
|
updatedAt?: T;
|
|
@@ -4755,6 +5105,8 @@ interface BillingHistorySelect<T extends boolean = true> {
|
|
|
4755
5105
|
interface TenantLogosSelect<T extends boolean = true> {
|
|
4756
5106
|
tenant?: T;
|
|
4757
5107
|
alt?: T;
|
|
5108
|
+
caption?: T;
|
|
5109
|
+
credit?: T;
|
|
4758
5110
|
lqip?: T;
|
|
4759
5111
|
palette?: T | {
|
|
4760
5112
|
vibrant?: T;
|
|
@@ -5070,6 +5422,8 @@ interface BrandsSelect<T extends boolean = true> {
|
|
|
5070
5422
|
interface BrandLogosSelect<T extends boolean = true> {
|
|
5071
5423
|
tenant?: T;
|
|
5072
5424
|
alt?: T;
|
|
5425
|
+
caption?: T;
|
|
5426
|
+
credit?: T;
|
|
5073
5427
|
lqip?: T;
|
|
5074
5428
|
palette?: T | {
|
|
5075
5429
|
vibrant?: T;
|
|
@@ -5214,6 +5568,11 @@ interface OrderItemsSelect<T extends boolean = true> {
|
|
|
5214
5568
|
variant?: T;
|
|
5215
5569
|
quantity?: T;
|
|
5216
5570
|
unitPrice?: T;
|
|
5571
|
+
variantTitle?: T;
|
|
5572
|
+
sku?: T;
|
|
5573
|
+
compareAtPrice?: T;
|
|
5574
|
+
weight?: T;
|
|
5575
|
+
requiresShipping?: T;
|
|
5217
5576
|
totalPrice?: T;
|
|
5218
5577
|
productTitle?: T;
|
|
5219
5578
|
updatedAt?: T;
|
|
@@ -5343,6 +5702,7 @@ interface ReturnItemsSelect<T extends boolean = true> {
|
|
|
5343
5702
|
product?: T;
|
|
5344
5703
|
variant?: T;
|
|
5345
5704
|
quantity?: T;
|
|
5705
|
+
restockAction?: T;
|
|
5346
5706
|
productTitle?: T;
|
|
5347
5707
|
updatedAt?: T;
|
|
5348
5708
|
createdAt?: T;
|
|
@@ -5460,6 +5820,8 @@ interface CustomerAddressesSelect<T extends boolean = true> {
|
|
|
5460
5820
|
postalCode?: T;
|
|
5461
5821
|
address1?: T;
|
|
5462
5822
|
address2?: T;
|
|
5823
|
+
addressType?: T;
|
|
5824
|
+
country?: T;
|
|
5463
5825
|
isDefault?: T;
|
|
5464
5826
|
deliveryMessage?: T;
|
|
5465
5827
|
updatedAt?: T;
|
|
@@ -5590,7 +5952,7 @@ interface PostsSelect<T extends boolean = true> {
|
|
|
5590
5952
|
subtitle?: T;
|
|
5591
5953
|
description?: T;
|
|
5592
5954
|
content?: T;
|
|
5593
|
-
|
|
5955
|
+
authors?: T;
|
|
5594
5956
|
categories?: T;
|
|
5595
5957
|
tags?: T;
|
|
5596
5958
|
videos?: T;
|
|
@@ -5610,7 +5972,6 @@ interface PostsSelect<T extends boolean = true> {
|
|
|
5610
5972
|
thumbnail?: T;
|
|
5611
5973
|
images?: T;
|
|
5612
5974
|
publishedAt?: T;
|
|
5613
|
-
customer?: T;
|
|
5614
5975
|
isFeatured?: T;
|
|
5615
5976
|
readingMinutes?: T;
|
|
5616
5977
|
excerpt?: T;
|
|
@@ -5696,6 +6057,7 @@ interface DocumentsSelect<T extends boolean = true> {
|
|
|
5696
6057
|
effectiveAt?: T;
|
|
5697
6058
|
expiresAt?: T;
|
|
5698
6059
|
changeLog?: T;
|
|
6060
|
+
agreementScope?: T;
|
|
5699
6061
|
requiresAgreement?: T;
|
|
5700
6062
|
keywords?: T | {
|
|
5701
6063
|
keyword?: T;
|
|
@@ -5866,7 +6228,6 @@ interface TracksSelect<T extends boolean = true> {
|
|
|
5866
6228
|
sourceUrl?: T;
|
|
5867
6229
|
sourceProvider?: T;
|
|
5868
6230
|
sourceId?: T;
|
|
5869
|
-
createdBy?: T;
|
|
5870
6231
|
isrc?: T;
|
|
5871
6232
|
isExplicit?: T;
|
|
5872
6233
|
previewUrl?: T;
|
|
@@ -5881,7 +6242,6 @@ interface TracksSelect<T extends boolean = true> {
|
|
|
5881
6242
|
interface TrackAssetsSelect<T extends boolean = true> {
|
|
5882
6243
|
tenant?: T;
|
|
5883
6244
|
title?: T;
|
|
5884
|
-
customer?: T;
|
|
5885
6245
|
metadata?: T;
|
|
5886
6246
|
prefix?: T;
|
|
5887
6247
|
updatedAt?: T;
|
|
@@ -6044,6 +6404,8 @@ interface LinksSelect<T extends boolean = true> {
|
|
|
6044
6404
|
opensInNewTab?: T;
|
|
6045
6405
|
noFollow?: T;
|
|
6046
6406
|
expiresAt?: T;
|
|
6407
|
+
clickCount?: T;
|
|
6408
|
+
lastClickedAt?: T;
|
|
6047
6409
|
status?: T;
|
|
6048
6410
|
isFeatured?: T;
|
|
6049
6411
|
metadata?: T;
|