@01.software/sdk 0.65.0 → 0.67.0

package/dist/{payload-types-BnIET0xU.d.cts → payload-types-jdsUXunB.d.cts}

@@ -30,6 +30,7 @@ interface Config {
         'tenant-purge-jobs': TenantPurgeJob;
         subscriptions: Subscription;
         'billing-history': BillingHistory;
+        'billing-consent-receipts': BillingConsentReceipt;
         plans: Plan;
         'usage-rate-cards': UsageRateCard;
         'usage-invoices': UsageInvoice;
@@ -277,6 +278,7 @@ interface Config {
         'tenant-purge-jobs': TenantPurgeJobsSelect<false> | TenantPurgeJobsSelect<true>;
         subscriptions: SubscriptionsSelect<false> | SubscriptionsSelect<true>;
         'billing-history': BillingHistorySelect<false> | BillingHistorySelect<true>;
+        'billing-consent-receipts': BillingConsentReceiptsSelect<false> | BillingConsentReceiptsSelect<true>;
         plans: PlansSelect<false> | PlansSelect<true>;
         'usage-rate-cards': UsageRateCardsSelect<false> | UsageRateCardsSelect<true>;
         'usage-invoices': UsageInvoicesSelect<false> | UsageInvoicesSelect<true>;
@@ -638,14 +640,14 @@ interface Tenant {
     environmentState?: ('requested' | 'provisioning' | 'ready' | 'suspended' | 'failed' | 'archived' | 'purge-pending' | 'purged') | null;
     environmentIsCurrent?: boolean | null;
     /**
-     * Managed from the current tenant Settings page.
+     * Managed from the current workspace Settings page.
      */
     consoleMenuLabels?: {
         [k: string]: unknown;
     } | unknown[] | string | number | boolean | null;
     name: string;
     /**
-     * IANA time zone for tenant daily aggregation and AI usage date boundaries.
+     * IANA time zone for workspace daily aggregation and AI usage date boundaries.
      */
     timezone?: string | null;
     /**
@@ -653,7 +655,7 @@ interface Tenant {
      */
     tenantPurpose?: ('production' | 'test') | null;
     /**
-     * A TEST tenant can be used for at most 30 days from creation.
+     * A TEST workspace can be used for at most 30 days from creation.
      */
     testExpiresAt?: string | null;
     /**
@@ -661,7 +663,7 @@ interface Tenant {
      */
     slug?: string | null;
     /**
-     * Tenant-owned frontend origins that can open saved-record preview. Storefronts, docs sites, community sites, and other tenant frontends register here. Managed separately from API CORS origins.
+     * Workspace-owned frontend origins that can open saved-record preview. Storefronts, docs sites, community sites, and other workspace frontends register here. Managed separately from API CORS origins.
      */
     previewDestinations?: {
         origin: string;
@@ -676,11 +678,11 @@ interface Tenant {
         id?: string | null;
     }[] | null;
     /**
-     * Base currency for the tenant store. Stored amounts carry no currency of their own, so changing this re-denominates the catalog and order amounts in place with no conversion (KRW 15000 becomes USD 15,000). The change is refused once live variants or unsettled orders exist.
+     * Base currency for the workspace store. Stored amounts carry no currency of their own, so changing this re-denominates the catalog and order amounts in place with no conversion (KRW 15000 becomes USD 15,000). The change is refused once live variants or unsettled orders exist.
      */
     shopCurrency?: string | null;
     /**
-     * Content locales this tenant operates.
+     * Content locales this workspace operates.
      */
     enabledContentLocales?: ('ko' | 'en')[] | null;
     /**
@@ -692,15 +694,15 @@ interface Tenant {
      */
     contentLocaleFallbackEnabled?: boolean | null;
     /**
-     * Tenant owner. Only the owner can delete the tenant or transfer ownership.
+     * Workspace owner. Only the owner can delete the workspace or transfer ownership.
      */
     owner: string | User;
     /**
-     * Only features checked above will be enabled for this tenant.
+     * Only features checked above will be enabled for this workspace.
      */
     enabledFeatures?: ('ecommerce' | 'customers' | 'playlists' | 'galleries' | 'links' | 'forms' | 'articles' | 'documents' | 'canvas' | 'videos' | 'live-streaming' | 'community' | 'events' | 'membership')[] | null;
     /**
-     * Only selected relationship recipes are active for this tenant. Recipes whose required features are disabled keep their stored intent but remain inactive at runtime.
+     * Only selected relationship recipes are active for this workspace. Recipes whose required features are disabled keep their stored intent but remain inactive at runtime.
      */
     enabledRelationshipRecipes?: ('event-commerce' | 'shoppable-content' | 'product-content-access' | 'form-context' | 'document-acceptance')[] | null;
     featureVersion?: number | null;
@@ -708,7 +710,7 @@ interface Tenant {
         [k: string]: unknown;
     } | unknown[] | string | number | boolean | null;
     /**
-     * Tenant lifecycle status. Managed automatically.
+     * Workspace lifecycle status. Managed automatically.
      */
     status?: ('active' | 'paused' | 'past_due' | 'canceled' | 'pending_deletion') | null;
     /**
@@ -716,7 +718,7 @@ interface Tenant {
      */
     publishableKey: string;
     /**
-     * Origins allowed to call this tenant API with a Publishable Key from a browser. Separate from saved-record preview destinations. Leave empty to block browser API calls.
+     * Origins allowed to call this workspace API with a Publishable Key from a browser. Separate from saved-record preview destinations. Leave empty to block browser API calls.
      */
     cors?: {
         origin: string;
@@ -736,7 +738,7 @@ interface Tenant {
      */
     senderIdentity?: {
         /**
-         * Brand name shown in the recipient's inbox. Leave blank to use the platform default sender. (The send-from address stays on the platform domain.)
+         * Brand name shown in the recipient's inbox. If blank, commerce and event notifications use the workspace name; customer authentication emails (password reset, sign-in codes) use the platform default sender. (The send-from address stays on the platform domain.)
          */
         displayName?: string | null;
         /**
@@ -832,7 +834,7 @@ interface Tenant {
         } | unknown[] | string | number | boolean | null;
     };
     /**
-     * Configure customer password registration and reset email. The tenant owns consent collection and evidence for direct signup.
+     * Configure customer password registration and reset email. The workspace owns consent collection and evidence for direct signup.
      */
     customerAuth?: {
         hostedConsentRequired?: boolean | null;
@@ -858,7 +860,7 @@ interface Tenant {
         passwordResetUrl?: string | null;
     };
     /**
-     * Users connected to this tenant
+     * Users connected to this workspace
      */
     members?: {
         docs?: (string | User)[];
@@ -880,15 +882,15 @@ interface Project {
      */
     name: string;
     /**
-     * URL-safe Project identifier. It is separate from a tenant slug and never substitutes for one.
+     * URL-safe Project identifier. It is separate from a workspace slug and never substitutes for one.
      */
     slug: string;
     /**
-     * Commercial Project lifecycle state, distinct from child tenant runtime state.
+     * Commercial Project lifecycle state, distinct from child workspace runtime state.
      */
     status: 'active' | 'suspended' | 'closed';
     /**
-     * ADR 0056 migration authority mode. `tenant` preserves legacy tenant billing; `project-billing` moves only subscription authority while retaining the current Live tenant as the compatibility anchor.
+     * ADR 0056 migration authority mode. `tenant` preserves legacy workspace billing; `project-billing` moves only subscription authority while retaining the current Live workspace as the compatibility anchor.
      */
     authorityMode: 'tenant' | 'project-billing';
     updatedAt: string;
@@ -1074,7 +1076,7 @@ interface Audience {
 interface EmailLog {
     id: string;
     /**
-     * Originating tenant. NULL for system-level emails (super-admin only).
+     * Originating workspace. NULL for system-level emails (super-admin only).
      */
     tenant?: (string | null) | Tenant;
     to: string;
@@ -1124,7 +1126,7 @@ interface CommerceNotificationIntent {
     id: string;
     tenant?: (string | null) | Tenant;
     /**
-     * Stable key that prevents duplicate notification intents within a tenant.
+     * Stable key that prevents duplicate notification intents within a workspace.
      */
     dedupeKey: string;
     event: 'orderPaid' | 'orderCanceled' | 'fulfillmentShipped' | 'orderDelivered' | 'returnRequested' | 'returnApproved' | 'returnRejected' | 'returnCanceled' | 'returnCompleted' | 'paymentReconciliationRequired' | 'paymentRefundRequiresAttention' | 'membershipActivated' | 'membershipPastDue' | 'membershipExpired' | 'membershipCancelled' | 'eventRegistrationConfirmed' | 'eventOccurrenceCanceled';
@@ -1497,11 +1499,11 @@ interface Customer {
         };
     };
     /**
-     * Tenant self-reported value. It is not a hosted server consent receipt.
+     * Workspace self-reported value. It is not a hosted server consent receipt.
      */
     acceptsTos?: boolean | null;
     /**
-     * Tenant self-reported version. Hosted reconsent does not use it.
+     * Workspace self-reported version. Hosted reconsent does not use it.
      */
     tosVersion?: string | null;
     /**
@@ -1617,7 +1619,7 @@ interface CustomerAddress {
      */
     address2?: string | null;
     /**
-     * Jibun lot-based address. Stored alongside the road-name `address1` so we can fall back when 도로명 is missing or for delivery providers that require 지번.
+     * Enter the lot-based jibun address.
      */
     jibunAddress?: string | null;
     /**
@@ -1625,7 +1627,7 @@ interface CustomerAddress {
      */
     city?: string | null;
     /**
-     * Administrative area (KR: 시/도 — usually folded into `city`; non-KR: state / province / region).
+     * Enter the state, province, or region (KR: 시/도).
      */
     administrativeArea?: string | null;
     /**
@@ -1637,7 +1639,7 @@ interface CustomerAddress {
      */
     country?: string | null;
     /**
-     * Delivery request preset. Pick "Other" to switch to a free-form deliveryNote.
+     * Choose a delivery option. Enter free-form details in Delivery Note.
      */
     deliveryRequest?: ('security_office' | 'handoff_in_person' | 'call_before' | 'leave_at_door' | 'other') | null;
     /**
@@ -1657,7 +1659,7 @@ interface CustomerProfile {
     tenant?: (string | null) | Tenant;
     customer: string | Customer;
     /**
-     * Public username shown like @01works. Store 3-30 characters without @, using lowercase ASCII letters, numbers, hyphens, or underscores, and keep it unique within the tenant.
+     * Public username shown like @01works. Store 3-30 characters without @, using lowercase ASCII letters, numbers, hyphens, or underscores, and keep it unique within the workspace.
      */
     handle?: string | null;
     displayName?: string | null;
@@ -2146,11 +2148,11 @@ interface LiveStream {
     startedAt?: string | null;
     endedAt?: string | null;
     /**
-     * Highest concurrent viewer count recorded during live sessions.
+     * Console does not automatically aggregate concurrent viewers. This displays the stored peak concurrent viewer count.
      */
     peakViewerCount?: number | null;
     /**
-     * Read-only counter accumulated from live stream view events.
+     * Console does not automatically aggregate live stream views. This is a read-only stored value.
      */
     viewCount?: number | null;
     updatedAt: string;
@@ -3220,7 +3222,7 @@ interface Checkout {
         id?: string | null;
     }[] | null;
     /**
-     * Tenant-unique reference supplied by a server integration.
+     * Workspace-unique reference supplied by a server integration.
      */
     clientReferenceId?: string | null;
     /**
@@ -3711,7 +3713,7 @@ interface CommercePaymentAccount {
      */
     providerAccountKey: string;
     environment: 'test' | 'live';
-    markets: (string | Market)[];
+    markets?: (string | Market)[] | null;
     tossConfiguration?: {
         /**
          * Toss Widget client key. Must use the test_gck_ / live_gck_ prefix matching the registered environment.
@@ -3818,7 +3820,7 @@ interface Event {
     categories?: (string | EventCategory)[] | null;
     tags?: (string | EventTag)[] | null;
     /**
-     * Products shown with this event. Available only when the Event commerce recipe is active for the tenant.
+     * Products shown with this event. Available only when the Event commerce recipe is active for the workspace.
      */
     products?: (string | Product)[] | null;
     /**
@@ -4687,7 +4689,7 @@ interface PersonalAccessToken {
      */
     displaySuffix: string;
     /**
-     * Default tenant ID for CLI operations. Set via `01 tenant use <name>`.
+     * Default workspace ID for CLI operations. Set via `01 tenant use <name>`.
      */
     defaultTenant?: string | null;
     /**
@@ -4744,7 +4746,7 @@ interface WebhookEvent {
     id: string;
     tenant?: (string | null) | Tenant;
     /**
-     * New runtime rows require tenant or global. Null marks legacy/old-runtime evidence during expand and is treated as unresolved like unknown.
+     * New runtime rows require workspace or global. Null marks legacy/old-runtime evidence during expand and is treated as unresolved like unknown.
      */
     ownershipScope?: ('tenant' | 'global' | 'unknown') | null;
     /**
@@ -4942,6 +4944,7 @@ interface WebhookOutboxDelivery {
 interface TenantMetadatum {
     id: string;
     tenant?: (string | null) | Tenant;
+    adminTitle?: string | null;
     siteInfo?: {
         /**
          * Site title (used in browser tab and SEO)
@@ -5240,7 +5243,7 @@ interface TenantEntitlement {
 interface Subscription {
     id: string;
     /**
-     * Project billing scope. The existing Live tenant relation remains the compatibility and evidence anchor.
+     * Project billing scope. The existing Live workspace relation remains the compatibility and evidence anchor.
      */
     project?: (string | null) | Project;
     tenant: string | Tenant;
@@ -5459,6 +5462,10 @@ interface UsageInvoice {
      */
     periodMonth: string;
     orderId: string;
+    protocolVersion?: number | null;
+    creationEpoch?: number | null;
+    preChargeNoticeVersion?: number | null;
+    preChargeNoticeReservedAt?: string | null;
     preChargeNoticeSentAt?: string | null;
     baseFeeChargedKrw: number;
     overageTotalKrw: number;
@@ -5530,7 +5537,7 @@ interface ApiUsage {
      */
     storageLimitBytes?: number | null;
     /**
-     * Total document count across all tenant-scoped collections
+     * Total document count across all workspace-scoped collections
      */
     documentCount?: number | null;
     /**
@@ -5559,6 +5566,12 @@ interface ApiUsage {
     emailUsage?: {
         [k: string]: unknown;
     } | unknown[] | string | number | boolean | null;
+    /**
+     * Last actual observation and attempt times. A numeric sample does not prove month completeness.
+     */
+    closedMonthObservation?: {
+        [k: string]: unknown;
+    } | unknown[] | string | number | boolean | null;
     /**
      * Timestamp when the usage snapshot cron calculated this monthly aggregate.
      */
@@ -5566,6 +5579,35 @@ interface ApiUsage {
     updatedAt: string;
     createdAt: string;
 }
+/**
+ * This interface was referenced by `Config`'s JSON-Schema
+ * via the `definition` "billing-consent-receipts".
+ */
+interface BillingConsentReceipt {
+    id: string;
+    tenant: string | Tenant;
+    project?: (string | null) | Project;
+    subscription?: (string | null) | Subscription;
+    billingHistory?: (string | null) | BillingHistory;
+    invoiceNumber?: string | null;
+    action: 'initial_flat' | 'enterprise_registration' | 'plan_upgrade' | 'plan_downgrade_schedule';
+    receiptKey: string;
+    consentId: string;
+    actor?: (string | null) | User;
+    actorUserId: string;
+    actorRole: 'tenant-admin' | 'super-admin';
+    acceptedAt: string;
+    termsVersion: string;
+    termsLocale: 'ko' | 'en';
+    termsSha256: string;
+    quoteRevision: string;
+    offerRevision?: string | null;
+    quoteSnapshot: {
+        [k: string]: unknown;
+    } | unknown[] | string | number | boolean | null;
+    updatedAt: string;
+    createdAt: string;
+}
 /**
  * This interface was referenced by `Config`'s JSON-Schema
  * via the `definition` "plans".
@@ -6350,6 +6392,7 @@ interface OrderExportProfile {
 interface TenantCommerceConfig {
     id: string;
     tenant?: (string | null) | Tenant;
+    adminTitle?: string | null;
     ecommerceReturnPolicy?: {
         initialShippingRefundMode?: ('full_order_only' | 'never') | null;
         eligibleInitialShippingRefundReasons?: ('change_of_mind' | 'defective' | 'wrong_delivery' | 'damaged' | 'other')[] | null;
@@ -6472,6 +6515,9 @@ interface CustomerOauthClient {
      */
     enabledSocialProviders?: ('google' | 'apple' | 'kakao' | 'naver')[] | null;
     metadata?: {
+        /**
+         * Hosted sign-in shows only logos on the 01 SOFTWARE media CDN; other URLs are saved but not shown. Leave blank to use the workspace logo from Site & Branding settings.
+         */
         logoUrl?: string | null;
         privacyPolicyUrl?: string | null;
         termsUrl?: string | null;
@@ -7590,7 +7636,7 @@ interface Link {
      */
     expiresAt?: string | null;
     /**
-     * Read-only counter accumulated from link click events.
+     * Read-only click count. Console does not currently collect clicks automatically.
      */
     clickCount?: number | null;
     lastClickedAt?: string | null;
@@ -8293,11 +8339,11 @@ interface CommunityBan {
     id: string;
     tenant?: (string | null) | Tenant;
     customer: string | Customer;
+    isPermanent: boolean;
     /**
-     * Temp ban expiry. null means check isPermanent
+     * Set an expiry time for a temporary ban
      */
     bannedUntil?: string | null;
-    isPermanent: boolean;
     reason?: ('spam' | 'harassment' | 'ban_evasion' | 'repeated_violations' | 'other') | null;
     /**
      * Additional context (optional)
@@ -8407,7 +8453,7 @@ interface EventCalendar {
      */
     color?: string | null;
     /**
-     * Visibility for the tenant-global calendar.
+     * Visibility for the workspace-global calendar.
      */
     visibility?: ('public' | 'unlisted' | 'private') | null;
     publishedAt?: string | null;
@@ -8456,6 +8502,14 @@ interface MembershipPlan {
      * Internal note for operators; not shown to customers.
      */
     description?: string | null;
+    /**
+     * Plan name shown to customers at signup. Falls back to the internal name when empty.
+     */
+    publicTitle?: string | null;
+    /**
+     * Plan description shown to customers at signup.
+     */
+    publicDescription?: string | null;
     /**
      * Free trial days (optional)
      */
@@ -8478,14 +8532,6 @@ interface MembershipPlan {
     activePriceCount?: number | null;
     isActive?: boolean | null;
     displayOrder?: number | null;
-    /**
-     * Plan name shown to customers at signup. Falls back to the internal name when empty.
-     */
-    publicTitle?: string | null;
-    /**
-     * Plan description shown to customers at signup.
-     */
-    publicDescription?: string | null;
     updatedAt: string;
     createdAt: string;
     deletedAt?: string | null;
@@ -9451,6 +9497,7 @@ interface TenantsSelect<T extends boolean = true> {
  */
 interface TenantMetadataSelect<T extends boolean = true> {
     tenant?: T;
+    adminTitle?: T;
     siteInfo?: T | {
         title?: T;
         description?: T;
@@ -9632,6 +9679,32 @@ interface BillingHistorySelect<T extends boolean = true> {
     createdAt?: T;
     deletedAt?: T;
 }
+/**
+ * This interface was referenced by `Config`'s JSON-Schema
+ * via the `definition` "billing-consent-receipts_select".
+ */
+interface BillingConsentReceiptsSelect<T extends boolean = true> {
+    tenant?: T;
+    project?: T;
+    subscription?: T;
+    billingHistory?: T;
+    invoiceNumber?: T;
+    action?: T;
+    receiptKey?: T;
+    consentId?: T;
+    actor?: T;
+    actorUserId?: T;
+    actorRole?: T;
+    acceptedAt?: T;
+    termsVersion?: T;
+    termsLocale?: T;
+    termsSha256?: T;
+    quoteRevision?: T;
+    offerRevision?: T;
+    quoteSnapshot?: T;
+    updatedAt?: T;
+    createdAt?: T;
+}
 /**
  * This interface was referenced by `Config`'s JSON-Schema
  * via the `definition` "plans_select".
@@ -9684,6 +9757,10 @@ interface UsageInvoicesSelect<T extends boolean = true> {
     currency?: T;
     periodMonth?: T;
     orderId?: T;
+    protocolVersion?: T;
+    creationEpoch?: T;
+    preChargeNoticeVersion?: T;
+    preChargeNoticeReservedAt?: T;
     preChargeNoticeSentAt?: T;
     baseFeeChargedKrw?: T;
     overageTotalKrw?: T;
@@ -9868,6 +9945,7 @@ interface ApiUsageSelect<T extends boolean = true> {
     aiGenerationCount?: T;
     notificationEmailCount?: T;
     emailUsage?: T;
+    closedMonthObservation?: T;
     snapshottedAt?: T;
     updatedAt?: T;
     createdAt?: T;
@@ -11302,6 +11380,7 @@ interface ShippingZonesSelect<T extends boolean = true> {
  */
 interface TenantCommerceConfigSelect<T extends boolean = true> {
     tenant?: T;
+    adminTitle?: T;
     ecommerceReturnPolicy?: T | {
         initialShippingRefundMode?: T;
         eligibleInitialShippingRefundReasons?: T;
@@ -12965,8 +13044,8 @@ interface ReportsSelect<T extends boolean = true> {
 interface CommunityBansSelect<T extends boolean = true> {
     tenant?: T;
     customer?: T;
-    bannedUntil?: T;
     isPermanent?: T;
+    bannedUntil?: T;
     reason?: T;
     reasonDetail?: T;
     sourceReport?: T;
@@ -13304,14 +13383,14 @@ interface MembershipPlansSelect<T extends boolean = true> {
     generateSlug?: T;
     slug?: T;
     description?: T;
+    publicTitle?: T;
+    publicDescription?: T;
     trialDays?: T;
     memberGroup?: T;
     prices?: T;
     activePriceCount?: T;
     isActive?: T;
     displayOrder?: T;
-    publicTitle?: T;
-    publicDescription?: T;
     updatedAt?: T;
     createdAt?: T;
     deletedAt?: T;