@waffo/pancake-ts 0.8.0 → 0.10.0

package/dist/index.d.cts

@@ -325,9 +325,28 @@ interface NotificationSettings {
     emailSubscriptionCanceled: boolean;
     emailSubscriptionRevoked: boolean;
     emailSubscriptionPastDue: boolean;
+    emailTrialStarted: boolean;
+    emailTrialEnding: boolean;
     notifyNewOrders: boolean;
     notifyNewSubscriptions: boolean;
+    notifySubscriptionCanceled: boolean;
+    notifySubscriptionEnded: boolean;
+    notifySubscriptionPastDue: boolean;
+    notifySubscriptionRenewed: boolean;
+    notifySubscriptionUncanceled: boolean;
+    notifySubscriptionUpdated: boolean;
+    notifyChargeback: boolean;
+    notifyPayoutCompleted: boolean;
+    notifyPayoutFailed: boolean;
 }
+/**
+ * Merchant-writable subset of {@link NotificationSettings}.
+ *
+ * Consumer-email toggles (`email*`) are managed by the PANCAKE platform (admin-only
+ * via DB) and **not** writable from this SDK; they would be silently dropped by the
+ * `update-store` endpoint if included. Use this type for any merchant-side update.
+ */
+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
@@ -398,7 +417,7 @@ interface UpdateStoreParams {
     /** Store website URL (set to `null` to remove) */
     website?: string | null;
     /** Notification preferences (partial update — omitted fields keep existing values, set to `null` to clear all) */
-    notificationSettings?: Partial<NotificationSettings> | null;
+    notificationSettings?: Partial<MerchantWritableNotificationSettings> | null;
     /** Checkout page theme configuration (partial update — omitted fields keep existing values, set to `null` to clear all) */
     checkoutSettings?: Partial<CheckoutSettings> | null;
 }
@@ -720,6 +739,8 @@ interface CreateCheckoutSessionParams {
     darkMode?: boolean;
     /** Custom metadata */
     metadata?: Record<string, string>;
+    /** Order-side business identifier (max 128 chars); inherited by orders, payments, refunds */
+    orderMerchantExternalId?: string;
 }
 /** Result of creating a checkout session. */
 interface CheckoutSessionResult {
@@ -781,6 +802,8 @@ interface CreateRefundTicketParams {
     requestedAmount: RequestedAmount;
     /** Custom metadata */
     metadata?: Record<string, unknown>;
+    /** Refund-ticket business-side identifier (max 128 chars); inherited by the executed refund on PSP success */
+    refundTicketMerchantExternalId?: string;
 }
 /** Parameters for resubmitting a rejected refund ticket (buyer-side). */
 interface ResubmitRefundTicketParams {
@@ -821,6 +844,8 @@ interface RefundTicket {
     executedAt: string | null;
     /** Custom metadata */
     metadata: Record<string, unknown>;
+    /** Refund-ticket business-side identifier (max 128 chars, immutable across resubmits) */
+    refundTicketMerchantExternalId: string | null;
     /** Current version number */
     versionNumber: number | null;
     /** Current (latest) version data */
@@ -954,6 +979,10 @@ interface WebhookEventData {
     buyerEmail: string;
     /** Merchant-provided buyer identity from checkout session */
     merchantProvidedBuyerIdentity?: string;
+    /** Order business identifier; present on order/payment + refund events (inherited from order) */
+    orderMerchantExternalId?: string;
+    /** Refund-ticket business identifier; only present on refund.* events */
+    refundTicketMerchantExternalId?: string;
     currency: string;
     /** Billing/shipping address (structured object) */
     billingDetail?: Record<string, unknown>;
@@ -1244,6 +1273,7 @@ declare class BuyerSession {
      *   paymentId: "PAY_xxx",
      *   reason: "Product not as described",
      *   requestedAmount: { amount: "29.00", currency: "USD" },
+     *   refundTicketMerchantExternalId: "REF-2026-00891",
      * });
      */
     createRefundTicket(params: CreateRefundTicketParams): Promise<{
@@ -1313,12 +1343,13 @@ declare class CheckoutAnonymousResource {
      * });
      *
      * @example
-     * // Pre-fill email and billing without issuing a session token
+     * // Pre-fill email + billing + attach business-side order reference
      * const result = await client.checkout.anonymous.create({
      *   productId: "PROD_xxx",
      *   currency: "USD",
      *   buyerEmail: "customer@example.com",
      *   billingDetail: { country: "US", isBusiness: false, postcode: "10001" },
+     *   orderMerchantExternalId: "ORDER-2026-00891",
      * });
      */
     create(params: AnonymousCheckoutParams): Promise<CheckoutSessionResult & {
@@ -1356,6 +1387,7 @@ declare class CheckoutAuthenticatedResource {
      *   currency: "USD",
      *   buyerIdentity: "user-123",
      *   buyerEmail: "customer@example.com",
+     *   orderMerchantExternalId: "ORDER-2026-00891",
      * });
      * // Redirect to result.checkoutUrl (includes #token=...)
      */
@@ -2090,4 +2122,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 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 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 };

package/dist/index.d.ts

@@ -325,9 +325,28 @@ interface NotificationSettings {
     emailSubscriptionCanceled: boolean;
     emailSubscriptionRevoked: boolean;
     emailSubscriptionPastDue: boolean;
+    emailTrialStarted: boolean;
+    emailTrialEnding: boolean;
     notifyNewOrders: boolean;
     notifyNewSubscriptions: boolean;
+    notifySubscriptionCanceled: boolean;
+    notifySubscriptionEnded: boolean;
+    notifySubscriptionPastDue: boolean;
+    notifySubscriptionRenewed: boolean;
+    notifySubscriptionUncanceled: boolean;
+    notifySubscriptionUpdated: boolean;
+    notifyChargeback: boolean;
+    notifyPayoutCompleted: boolean;
+    notifyPayoutFailed: boolean;
 }
+/**
+ * Merchant-writable subset of {@link NotificationSettings}.
+ *
+ * Consumer-email toggles (`email*`) are managed by the PANCAKE platform (admin-only
+ * via DB) and **not** writable from this SDK; they would be silently dropped by the
+ * `update-store` endpoint if included. Use this type for any merchant-side update.
+ */
+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
@@ -398,7 +417,7 @@ interface UpdateStoreParams {
     /** Store website URL (set to `null` to remove) */
     website?: string | null;
     /** Notification preferences (partial update — omitted fields keep existing values, set to `null` to clear all) */
-    notificationSettings?: Partial<NotificationSettings> | null;
+    notificationSettings?: Partial<MerchantWritableNotificationSettings> | null;
     /** Checkout page theme configuration (partial update — omitted fields keep existing values, set to `null` to clear all) */
     checkoutSettings?: Partial<CheckoutSettings> | null;
 }
@@ -720,6 +739,8 @@ interface CreateCheckoutSessionParams {
     darkMode?: boolean;
     /** Custom metadata */
     metadata?: Record<string, string>;
+    /** Order-side business identifier (max 128 chars); inherited by orders, payments, refunds */
+    orderMerchantExternalId?: string;
 }
 /** Result of creating a checkout session. */
 interface CheckoutSessionResult {
@@ -781,6 +802,8 @@ interface CreateRefundTicketParams {
     requestedAmount: RequestedAmount;
     /** Custom metadata */
     metadata?: Record<string, unknown>;
+    /** Refund-ticket business-side identifier (max 128 chars); inherited by the executed refund on PSP success */
+    refundTicketMerchantExternalId?: string;
 }
 /** Parameters for resubmitting a rejected refund ticket (buyer-side). */
 interface ResubmitRefundTicketParams {
@@ -821,6 +844,8 @@ interface RefundTicket {
     executedAt: string | null;
     /** Custom metadata */
     metadata: Record<string, unknown>;
+    /** Refund-ticket business-side identifier (max 128 chars, immutable across resubmits) */
+    refundTicketMerchantExternalId: string | null;
     /** Current version number */
     versionNumber: number | null;
     /** Current (latest) version data */
@@ -954,6 +979,10 @@ interface WebhookEventData {
     buyerEmail: string;
     /** Merchant-provided buyer identity from checkout session */
     merchantProvidedBuyerIdentity?: string;
+    /** Order business identifier; present on order/payment + refund events (inherited from order) */
+    orderMerchantExternalId?: string;
+    /** Refund-ticket business identifier; only present on refund.* events */
+    refundTicketMerchantExternalId?: string;
     currency: string;
     /** Billing/shipping address (structured object) */
     billingDetail?: Record<string, unknown>;
@@ -1244,6 +1273,7 @@ declare class BuyerSession {
      *   paymentId: "PAY_xxx",
      *   reason: "Product not as described",
      *   requestedAmount: { amount: "29.00", currency: "USD" },
+     *   refundTicketMerchantExternalId: "REF-2026-00891",
      * });
      */
     createRefundTicket(params: CreateRefundTicketParams): Promise<{
@@ -1313,12 +1343,13 @@ declare class CheckoutAnonymousResource {
      * });
      *
      * @example
-     * // Pre-fill email and billing without issuing a session token
+     * // Pre-fill email + billing + attach business-side order reference
      * const result = await client.checkout.anonymous.create({
      *   productId: "PROD_xxx",
      *   currency: "USD",
      *   buyerEmail: "customer@example.com",
      *   billingDetail: { country: "US", isBusiness: false, postcode: "10001" },
+     *   orderMerchantExternalId: "ORDER-2026-00891",
      * });
      */
     create(params: AnonymousCheckoutParams): Promise<CheckoutSessionResult & {
@@ -1356,6 +1387,7 @@ declare class CheckoutAuthenticatedResource {
      *   currency: "USD",
      *   buyerIdentity: "user-123",
      *   buyerEmail: "customer@example.com",
+     *   orderMerchantExternalId: "ORDER-2026-00891",
      * });
      * // Redirect to result.checkoutUrl (includes #token=...)
      */
@@ -2090,4 +2122,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 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 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 };

package/dist/index.js

@@ -271,6 +271,11 @@ function validateEnum(field, value, allowed) {
     fail(`Invalid ${field}: expected one of [${allowed.join(", ")}], got "${value}"`);
   }
 }
+function validateMaxLength(field, value, max) {
+  if (value !== void 0 && value.length > max) {
+    fail(`${field} must be at most ${max} characters, got ${value.length}`);
+  }
+}
 function validatePositiveInteger(field, value) {
   if (!Number.isInteger(value) || value <= 0) {
     fail(`Invalid ${field}: expected positive integer, got ${value}`);
@@ -313,6 +318,7 @@ function validateCheckoutCommon(params) {
   if (params.expiresInSeconds !== void 0) {
     validatePositiveInteger("expiresInSeconds", params.expiresInSeconds);
   }
+  validateMaxLength("orderMerchantExternalId", params.orderMerchantExternalId, 128);
 }
 
 // src/resources/auth.ts
@@ -415,6 +421,7 @@ var BuyerSession = class {
    *   paymentId: "PAY_xxx",
    *   reason: "Product not as described",
    *   requestedAmount: { amount: "29.00", currency: "USD" },
+   *   refundTicketMerchantExternalId: "REF-2026-00891",
    * });
    */
   async createRefundTicket(params) {
@@ -422,6 +429,7 @@ var BuyerSession = class {
     validateRequired("reason", params.reason);
     validateAmountString("requestedAmount.amount", params.requestedAmount.amount);
     validateCurrencyCode("requestedAmount.currency", params.requestedAmount.currency);
+    validateMaxLength("refundTicketMerchantExternalId", params.refundTicketMerchantExternalId, 128);
     return unwrapAction(await this.http.post("/v1/actions/refund-ticket/create-ticket", params));
   }
   /**
@@ -488,12 +496,13 @@ var CheckoutAnonymousResource = class {
    * });
    *
    * @example
-   * // Pre-fill email and billing without issuing a session token
+   * // Pre-fill email + billing + attach business-side order reference
    * const result = await client.checkout.anonymous.create({
    *   productId: "PROD_xxx",
    *   currency: "USD",
    *   buyerEmail: "customer@example.com",
    *   billingDetail: { country: "US", isBusiness: false, postcode: "10001" },
+   *   orderMerchantExternalId: "ORDER-2026-00891",
    * });
    */
   async create(params) {
@@ -529,6 +538,7 @@ var CheckoutAuthenticatedResource = class {
    *   currency: "USD",
    *   buyerIdentity: "user-123",
    *   buyerEmail: "customer@example.com",
+   *   orderMerchantExternalId: "ORDER-2026-00891",
    * });
    * // Redirect to result.checkoutUrl (includes #token=...)
    */