@waffo/pancake-ts 0.12.0 → 0.14.0

package/dist/index.d.cts

@@ -81,7 +81,7 @@ interface PostResult<T> extends Envelope<T> {
 }
 /**
  * Environment type.
- * @see waffo-pancake-order-service/app/lib/types.ts
+ * @see docs/api-reference/authentication.mdx
  */
 declare enum Environment {
     Test = "test",
@@ -89,7 +89,7 @@ declare enum Environment {
 }
 /**
  * Tax category for products.
- * @see waffo-pancake-product-service/app/lib/resources/types.ts
+ * @see docs/api-reference/endpoints/onetime-products/overview.mdx
  */
 declare enum TaxCategory {
     DigitalGoods = "digital_goods",
@@ -102,7 +102,7 @@ declare enum TaxCategory {
 }
 /**
  * Subscription billing period.
- * @see waffo-pancake-product-service/app/lib/resources/types.ts
+ * @see docs/api-reference/endpoints/subscription-products/overview.mdx
  */
 declare enum BillingPeriod {
     Weekly = "weekly",
@@ -112,7 +112,7 @@ declare enum BillingPeriod {
 }
 /**
  * Product version status.
- * @see waffo-pancake-product-service/app/lib/resources/types.ts
+ * @see docs/api-reference/endpoints/onetime-products/overview.mdx
  */
 declare enum ProductVersionStatus {
     Active = "active",
@@ -120,7 +120,7 @@ declare enum ProductVersionStatus {
 }
 /**
  * Store entity status.
- * @see waffo-pancake-store-service/app/lib/resources/store.ts
+ * @see docs/api-reference/endpoints/stores/overview.mdx
  */
 declare enum EntityStatus {
     Active = "active",
@@ -129,7 +129,7 @@ declare enum EntityStatus {
 }
 /**
  * Store member role.
- * @see waffo-pancake-store-service/app/lib/resources/store.ts
+ * @see docs/api-reference/endpoints/stores/overview.mdx
  */
 declare enum StoreRole {
     Owner = "owner",
@@ -138,7 +138,7 @@ declare enum StoreRole {
 }
 /**
  * One-time order status.
- * @see waffo-pancake-order-service/app/lib/resources/onetime-order.ts
+ * @see docs/api-reference/endpoints/orders/overview.mdx
  */
 declare enum OnetimeOrderStatus {
     Pending = "pending",
@@ -157,7 +157,7 @@ declare enum OnetimeOrderStatus {
  * - canceled -> terminal
  * - expired -> terminal
  *
- * @see waffo-pancake-order-service/app/lib/resources/subscription-order.ts
+ * @see docs/api-reference/endpoints/subscriptions/overview.mdx
  */
 declare enum SubscriptionOrderStatus {
     Pending = "pending",
@@ -170,7 +170,7 @@ declare enum SubscriptionOrderStatus {
 }
 /**
  * Payment status.
- * @see waffo-pancake-order-service/app/lib/resources/payment.ts
+ * @see docs/api-reference/endpoints/orders/overview.mdx
  */
 declare enum PaymentStatus {
     Pending = "pending",
@@ -180,7 +180,7 @@ declare enum PaymentStatus {
 }
 /**
  * Refund ticket status.
- * @see waffo-pancake-order-service/app/lib/resources/refund-ticket.ts
+ * @see docs/api-reference/endpoints/refunds/overview.mdx
  */
 declare enum RefundTicketStatus {
     Pending = "pending",
@@ -195,7 +195,7 @@ declare enum RefundTicketStatus {
 }
 /**
  * Refund status.
- * @see waffo-pancake-order-service/app/lib/resources/refund.ts
+ * @see docs/api-reference/endpoints/refunds/overview.mdx
  */
 declare enum RefundStatus {
     Succeeded = "succeeded",
@@ -203,7 +203,7 @@ declare enum RefundStatus {
 }
 /**
  * Media asset type.
- * @see waffo-pancake-product-service/app/lib/resources/types.ts
+ * @see docs/api-reference/endpoints/onetime-products/overview.mdx
  */
 declare enum MediaType {
     Image = "image",
@@ -230,7 +230,7 @@ declare enum ErrorLayer {
  * Provide either `storeId` or `productId` (at least one required).
  * When `productId` is given without `storeId`, the server derives the store from the product.
  *
- * @see waffo-pancake-user-service/app/lib/utils/jwt.ts IssueSessionTokenRequest
+ * @see docs/api-reference/endpoints/auth/issue-session-token.mdx
  */
 interface IssueSessionTokenParams {
     /**
@@ -265,7 +265,7 @@ type WebhookChannel = "http" | "feishu" | "discord" | "telegram" | "slack";
 /**
  * Configured webhook endpoint (one row of `store.store_webhooks`).
  *
- * @see waffo-pancake-store-service/app/lib/types.ts
+ * @see docs/api-reference/endpoints/webhooks/overview.mdx
  */
 interface StoreWebhook {
     /** Webhook UUID (not Short ID) */
@@ -316,7 +316,7 @@ interface RemoveWebhookParams {
 }
 /**
  * Notification settings (all default to true).
- * @see waffo-pancake-store-service/app/lib/types.ts
+ * @see docs/api-reference/endpoints/stores/overview.mdx
  */
 interface NotificationSettings {
     emailOrderConfirmation: boolean;
@@ -349,7 +349,7 @@ interface NotificationSettings {
 type MerchantWritableNotificationSettings = Pick<NotificationSettings, "notifyNewOrders" | "notifyNewSubscriptions" | "notifySubscriptionCanceled" | "notifySubscriptionEnded" | "notifySubscriptionPastDue" | "notifySubscriptionRenewed" | "notifySubscriptionUncanceled" | "notifySubscriptionUpdated" | "notifyChargeback" | "notifyPayoutCompleted" | "notifyPayoutFailed">;
 /**
  * Single-theme checkout page styling.
- * @see waffo-pancake-store-service/app/lib/types.ts
+ * @see docs/api-reference/endpoints/stores/overview.mdx
  */
 interface CheckoutThemeSettings {
     checkoutLogo: string | null;
@@ -361,7 +361,7 @@ interface CheckoutThemeSettings {
 }
 /**
  * Checkout page configuration (light and dark themes).
- * @see waffo-pancake-store-service/app/lib/types.ts
+ * @see docs/api-reference/endpoints/stores/overview.mdx
  */
 interface CheckoutSettings {
     defaultDarkMode: boolean;
@@ -370,7 +370,7 @@ interface CheckoutSettings {
 }
 /**
  * Store entity.
- * @see waffo-pancake-store-service/app/lib/resources/store.ts
+ * @see docs/api-reference/endpoints/stores/overview.mdx
  */
 interface Store {
     id: string;
@@ -470,7 +470,7 @@ interface UpdateRoleResult {
  * Amounts are represented as display strings (e.g., "9.99" for USD, "1000" for JPY).
  * The server handles conversion to/from smallest currency units internally.
  *
- * @see waffo-pancake-product-service/app/lib/resources/types.ts
+ * @see docs/api-reference/endpoints/onetime-products/overview.mdx
  *
  * @example
  * // USD $9.99
@@ -489,7 +489,7 @@ interface PriceInfo {
 /**
  * Multi-currency prices (keyed by ISO 4217 currency code).
  *
- * @see waffo-pancake-product-service/app/lib/resources/types.ts
+ * @see docs/api-reference/endpoints/onetime-products/overview.mdx
  *
  * @example
  * {
@@ -500,7 +500,7 @@ interface PriceInfo {
 type Prices = Record<string, PriceInfo>;
 /**
  * Media asset (image or video).
- * @see waffo-pancake-product-service/app/lib/resources/types.ts
+ * @see docs/api-reference/endpoints/onetime-products/overview.mdx
  */
 interface MediaItem {
     /** Media type */
@@ -514,7 +514,7 @@ interface MediaItem {
 }
 /**
  * One-time product detail (public API shape).
- * @see waffo-pancake-product-service/app/lib/resources/onetime-product.ts OnetimeProductDetail
+ * @see docs/api-reference/endpoints/onetime-products/overview.mdx
  */
 interface OnetimeProductDetail {
     id: string;
@@ -531,7 +531,7 @@ interface OnetimeProductDetail {
 }
 /**
  * Parameters for creating a one-time product.
- * @see waffo-pancake-product-service/app/lib/resources/onetime-product.ts CreateOnetimeProductRequestBody
+ * @see docs/api-reference/endpoints/onetime-products/create-product.mdx
  */
 interface CreateOnetimeProductParams {
     storeId: string;
@@ -544,7 +544,7 @@ interface CreateOnetimeProductParams {
 }
 /**
  * Parameters for updating a one-time product (creates a new version; skips if unchanged).
- * @see waffo-pancake-product-service/app/lib/resources/onetime-product.ts UpdateOnetimeProductContentRequestBody
+ * @see docs/api-reference/endpoints/onetime-products/update-product.mdx
  */
 interface UpdateOnetimeProductParams {
     id: string;
@@ -562,7 +562,7 @@ interface PublishOnetimeProductParams {
 }
 /**
  * Parameters for updating a one-time product's status.
- * @see waffo-pancake-product-service/app/lib/resources/onetime-product.ts UpdateOnetimeStatusRequestBody
+ * @see docs/api-reference/endpoints/onetime-products/update-status.mdx
  */
 interface UpdateOnetimeStatusParams {
     id: string;
@@ -570,7 +570,7 @@ interface UpdateOnetimeStatusParams {
 }
 /**
  * Subscription product detail (public API shape).
- * @see waffo-pancake-product-service/app/lib/resources/subscription-product.ts SubscriptionProductDetail
+ * @see docs/api-reference/endpoints/subscription-products/overview.mdx
  */
 interface SubscriptionProductDetail {
     id: string;
@@ -588,7 +588,7 @@ interface SubscriptionProductDetail {
 }
 /**
  * Parameters for creating a subscription product.
- * @see waffo-pancake-product-service/app/lib/resources/subscription-product.ts CreateSubscriptionProductRequestBody
+ * @see docs/api-reference/endpoints/subscription-products/create-product.mdx
  */
 interface CreateSubscriptionProductParams {
     storeId: string;
@@ -602,7 +602,7 @@ interface CreateSubscriptionProductParams {
 }
 /**
  * Parameters for updating a subscription product (creates a new version; skips if unchanged).
- * @see waffo-pancake-product-service/app/lib/resources/subscription-product.ts UpdateSubscriptionProductContentRequestBody
+ * @see docs/api-reference/endpoints/subscription-products/update-product.mdx
  */
 interface UpdateSubscriptionProductParams {
     id: string;
@@ -621,7 +621,7 @@ interface PublishSubscriptionProductParams {
 }
 /**
  * Parameters for updating a subscription product's status.
- * @see waffo-pancake-product-service/app/lib/resources/subscription-product.ts UpdateSubscriptionStatusRequestBody
+ * @see docs/api-reference/endpoints/subscription-products/update-status.mdx
  */
 interface UpdateSubscriptionStatusParams {
     id: string;
@@ -629,7 +629,7 @@ interface UpdateSubscriptionStatusParams {
 }
 /**
  * Group rules for subscription product groups.
- * @see waffo-pancake-product-service/app/lib/resources/subscription-product-group.ts
+ * @see docs/api-reference/endpoints/subscription-products/overview.mdx
  */
 interface GroupRules {
     /** Whether trial period is shared across products in the group */
@@ -637,7 +637,7 @@ interface GroupRules {
 }
 /**
  * Subscription product group entity.
- * @see waffo-pancake-product-service/app/lib/resources/subscription-product-group.ts
+ * @see docs/api-reference/endpoints/subscription-products/overview.mdx
  */
 interface SubscriptionProductGroup {
     id: string;
@@ -652,7 +652,7 @@ interface SubscriptionProductGroup {
 }
 /**
  * Parameters for creating a subscription product group.
- * @see waffo-pancake-product-service/app/lib/resources/subscription-product-group.ts CreateGroupRequestBody
+ * @see docs/api-reference/endpoints/subscription-products/create-group.mdx
  */
 interface CreateSubscriptionProductGroupParams {
     storeId: string;
@@ -663,7 +663,7 @@ interface CreateSubscriptionProductGroupParams {
 }
 /**
  * Parameters for updating a subscription product group (`productIds` is a full replacement).
- * @see waffo-pancake-product-service/app/lib/resources/subscription-product-group.ts UpdateGroupRequestBody
+ * @see docs/api-reference/endpoints/subscription-products/update-group.mdx
  */
 interface UpdateSubscriptionProductGroupParams {
     id: string;
@@ -689,7 +689,7 @@ interface CancelSubscriptionParams {
 }
 /**
  * Result of canceling a subscription order.
- * @see waffo-pancake-order-service cancel-order route.ts
+ * @see docs/api-reference/endpoints/subscriptions/cancel-subscription.mdx
  */
 interface CancelSubscriptionResult {
     orderId: string;
@@ -698,7 +698,7 @@ interface CancelSubscriptionResult {
 }
 /**
  * Customer billing details for checkout.
- * @see waffo-pancake-order-service/app/lib/types.ts
+ * @see docs/api-reference/endpoints/orders/overview.mdx
  */
 interface BillingDetail {
     /** Country code (ISO 3166-1 alpha-2) */
@@ -714,9 +714,17 @@ interface BillingDetail {
     /** Tax ID / VAT number (EU businesses: triggers reverse charge 0% when provided) */
     taxId?: string;
 }
+/**
+ * Supported checkout cashier languages (IETF BCP 47 tags).
+ *
+ * The default language of the hosted checkout page. Pass one of these values as
+ * {@link CreateCheckoutSessionParams.language}; the customer can still switch language
+ * on the checkout page. Language×currency mismatches are rejected by the payment provider.
+ */
+type CashierLanguage = "en" | "pt-BR" | "es-MX" | "id-ID" | "vi-VN" | "ru-RU" | "en-KE" | "es-PE" | "es-CO" | "es-CL" | "zh-Hant-TW" | "zh-Hant-HK" | "th-TH" | "ja-JP" | "en-NG" | "ko-KR" | "en-HK" | "zh-Hans-HK" | "pl-PL" | "tr-TR" | "zh-Hans" | "ms-MY";
 /**
  * Parameters for creating a checkout session.
- * @see waffo-pancake-order-service/app/lib/types.ts CreateCheckoutSessionRequest
+ * @see docs/api-reference/endpoints/orders/create-checkout-session.mdx
  */
 interface CreateCheckoutSessionParams {
     /** Product ID */
@@ -741,6 +749,11 @@ interface CreateCheckoutSessionParams {
     metadata?: Record<string, string>;
     /** Order-side business identifier (max 128 chars); inherited by orders, payments, refunds */
     orderMerchantExternalId?: string;
+    /**
+     * Default language of the hosted checkout page ({@link CashierLanguage}, IETF BCP 47).
+     * The customer can switch language on the checkout page. Omit to let the provider infer.
+     */
+    language?: CashierLanguage;
 }
 /** Result of creating a checkout session. */
 interface CheckoutSessionResult {
@@ -1110,6 +1123,81 @@ interface VerifyWebhookOptions {
      */
     publicKeys?: WebhookPublicKeys;
 }
+/**
+ * Content-safety scan verdict.
+ * @see docs/api-reference/endpoints/content-safety/scan-prompt.mdx
+ */
+declare enum ScanAction {
+    Allow = "allow",
+    Review = "review",
+    Block = "block"
+}
+/**
+ * Scan verdict reason code.
+ * @see docs/api-reference/endpoints/content-safety/scan-prompt.mdx
+ */
+declare enum ScanReasonCode {
+    Allowed = "allowed",
+    ReviewRequired = "review_required",
+    RestrictedContent = "restricted_content",
+    ServiceDegraded = "service_degraded"
+}
+/**
+ * Matched content-safety policy category.
+ * @see docs/api-reference/endpoints/content-safety/scan-prompt.mdx
+ */
+declare enum ScanPolicyCategory {
+    CsamMinor = "csam_minor",
+    SexualViolenceNonconsensual = "sexual_violence_nonconsensual",
+    UndressTransform = "undress_transform",
+    FaceSwapIdentity = "face_swap_identity",
+    BestialityRestricted = "bestiality_restricted",
+    AdultNsfw = "adult_nsfw"
+}
+/**
+ * Semantic scan channel mode.
+ * @see docs/api-reference/endpoints/content-safety/scan-prompt.mdx
+ */
+declare enum ScanSemanticMode {
+    Off = "off",
+    Shadow = "shadow",
+    Enforce = "enforce"
+}
+/**
+ * Semantic scan channel status.
+ * @see docs/api-reference/endpoints/content-safety/scan-prompt.mdx
+ */
+declare enum ScanSemanticStatus {
+    Disabled = "disabled",
+    Scored = "scored",
+    ShadowScored = "shadow_scored",
+    SkippedRulesBlock = "skipped_rules_block",
+    SkippedBudget = "skipped_budget",
+    ProviderTimeout = "provider_timeout",
+    ProviderError = "provider_error"
+}
+/** Parameters for scanning a prompt before AIGC generation. */
+interface ScanPromptParams {
+    /** The user's text prompt to scan (1–10,000 characters). */
+    prompt: string;
+    /** Prompt text language (default "en"). */
+    locale?: "ja" | "en" | "zh";
+    /** How the external semantic channel participates. */
+    semantic?: ScanSemanticMode;
+}
+/** Redacted scan verdict — no scores, thresholds, or keyword text. */
+interface ScanResult {
+    /** Final verdict; continue only when `allow`. */
+    action: ScanAction;
+    /** Stable machine-readable reason. */
+    reasonCode: ScanReasonCode;
+    /** Matched policy categories; empty when allowed. */
+    matchedCategories: ScanPolicyCategory[];
+    /** Correlation id for support and appeals; safe to log. */
+    requestId: string;
+    /** Whether/how the semantic channel contributed to this scan. */
+    semanticStatus: ScanSemanticStatus;
+}
 
 /**
  * Internal HTTP client that auto-signs requests.
@@ -1313,6 +1401,31 @@ declare class CheckoutResource {
     }>;
 }
 
+/** Content safety resource — scan user prompts before AIGC generation. */
+declare class ContentSafetyResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * Scan a user's text prompt for content-safety compliance before AIGC
+     * generation. Call this before invoking your image/video model and continue
+     * only when `action` is `allow`.
+     *
+     * Stateless — the check never stores prompt text. If the safety service is
+     * briefly unavailable, the verdict fails closed to `review` so an
+     * unmoderated prompt is never let through.
+     *
+     * @param params - Scan parameters (prompt required; locale / semantic optional)
+     * @returns Redacted scan verdict
+     *
+     * @example
+     * const verdict = await client.contentSafety.scanPrompt({ prompt: "a cat riding a bike" });
+     * if (verdict.action !== "allow") {
+     *   // do not generate
+     * }
+     */
+    scanPrompt(params: ScanPromptParams): Promise<ScanResult>;
+}
+
 /**
  * Internal HTTP client for customer-side requests using Bearer token authentication.
  *
@@ -2024,6 +2137,7 @@ declare class WaffoPancake {
     readonly checkout: CheckoutResource;
     readonly graphql: GraphQLResource;
     readonly webhooks: WebhooksResource;
+    readonly contentSafety: ContentSafetyResource;
     constructor(config: WaffoPancakeConfig);
     /**
      * Create a customer session for self-service operations.
@@ -2136,4 +2250,4 @@ declare class WaffoPancakeError extends Error {
  */
 declare function verifyWebhook<T = Record<string, unknown>>(payload: string, signatureHeader: string | undefined | null, options?: VerifyWebhookOptions): WebhookEvent<T>;
 
-export { type AddMerchantParams, type AddMerchantResult, type AddWebhookParams, type AnonymousCheckoutParams, type ApiError, type AuthenticatedCheckoutParams, type AuthenticatedCheckoutResult, type BillingDetail, BillingPeriod, type CancelOnetimeOrderParams, type CancelOnetimeOrderResult, type CancelSubscriptionParams, type CancelSubscriptionResult, type CheckoutSessionResult, type CheckoutSettings, type CheckoutThemeSettings, type CreateCheckoutSessionParams, type CreateOnetimeProductParams, type CreateRefundTicketParams, type CreateStoreParams, type CreateSubscriptionProductGroupParams, type CreateSubscriptionProductParams, type DeleteStoreParams, type DeleteSubscriptionProductGroupParams, EntityStatus, type Envelope, Environment, ErrorLayer, type GraphQLParams, type GraphQLResponse, type GroupRules, type IssueSessionTokenParams, type MediaItem, MediaType, type MerchantWritableNotificationSettings, type Notice, type NotificationSettings, OnetimeOrderStatus, type OnetimeProductDetail, PaymentStatus, type PostResult, type PriceInfo, type Prices, ProductVersionStatus, type PublishOnetimeProductParams, type PublishSubscriptionProductGroupParams, type PublishSubscriptionProductParams, type ReactivateSubscriptionParams, type ReactivateSubscriptionResult, RefundStatus, type RefundTicket, RefundTicketStatus, type RefundTicketVersionData, type RemoveMerchantParams, type RemoveMerchantResult, type RemoveWebhookParams, type RequestedAmount, type ResubmitRefundTicketParams, type SessionToken, type Store, StoreRole, type StoreWebhook, SubscriptionOrderStatus, type SubscriptionProductDetail, type SubscriptionProductGroup, TaxCategory, type UpdateOnetimeProductParams, type UpdateOnetimeStatusParams, type UpdateRoleParams, type UpdateRoleResult, type UpdateStoreParams, type UpdateSubscriptionProductGroupParams, type UpdateSubscriptionProductParams, type UpdateSubscriptionStatusParams, type UpdateWebhookParams, type VerifyWebhookOptions, WaffoPancake, type WaffoPancakeConfig, WaffoPancakeError, type WebhookChannel, type WebhookEvent, type WebhookEventData, WebhookEventType, type WebhookPublicKeys, verifyWebhook };
+export { type AddMerchantParams, type AddMerchantResult, type AddWebhookParams, type AnonymousCheckoutParams, type ApiError, type AuthenticatedCheckoutParams, type AuthenticatedCheckoutResult, type BillingDetail, BillingPeriod, type CancelOnetimeOrderParams, type CancelOnetimeOrderResult, type CancelSubscriptionParams, type CancelSubscriptionResult, type CashierLanguage, type CheckoutSessionResult, type CheckoutSettings, type CheckoutThemeSettings, type CreateCheckoutSessionParams, type CreateOnetimeProductParams, type CreateRefundTicketParams, type CreateStoreParams, type CreateSubscriptionProductGroupParams, type CreateSubscriptionProductParams, type DeleteStoreParams, type DeleteSubscriptionProductGroupParams, EntityStatus, type Envelope, Environment, ErrorLayer, type GraphQLParams, type GraphQLResponse, type GroupRules, type IssueSessionTokenParams, type MediaItem, MediaType, type MerchantWritableNotificationSettings, type Notice, type NotificationSettings, OnetimeOrderStatus, type OnetimeProductDetail, PaymentStatus, type PostResult, type PriceInfo, type Prices, ProductVersionStatus, type PublishOnetimeProductParams, type PublishSubscriptionProductGroupParams, type PublishSubscriptionProductParams, type ReactivateSubscriptionParams, type ReactivateSubscriptionResult, RefundStatus, type RefundTicket, RefundTicketStatus, type RefundTicketVersionData, type RemoveMerchantParams, type RemoveMerchantResult, type RemoveWebhookParams, type RequestedAmount, type ResubmitRefundTicketParams, ScanAction, ScanPolicyCategory, type ScanPromptParams, ScanReasonCode, type ScanResult, ScanSemanticMode, ScanSemanticStatus, type SessionToken, type Store, StoreRole, type StoreWebhook, SubscriptionOrderStatus, type SubscriptionProductDetail, type SubscriptionProductGroup, TaxCategory, type UpdateOnetimeProductParams, type UpdateOnetimeStatusParams, type UpdateRoleParams, type UpdateRoleResult, type UpdateStoreParams, type UpdateSubscriptionProductGroupParams, type UpdateSubscriptionProductParams, type UpdateSubscriptionStatusParams, type UpdateWebhookParams, type VerifyWebhookOptions, WaffoPancake, type WaffoPancakeConfig, WaffoPancakeError, type WebhookChannel, type WebhookEvent, type WebhookEventData, WebhookEventType, type WebhookPublicKeys, verifyWebhook };