@waffo/pancake-ts 0.9.0 → 0.11.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;
 }
@@ -518,9 +537,9 @@ interface CreateOnetimeProductParams {
     storeId: string;
     name: string;
     prices: Prices;
-    description?: string;
+    description?: string | null;
     media?: MediaItem[];
-    successUrl?: string;
+    successUrl?: string | null;
     metadata?: Record<string, unknown>;
 }
 /**
@@ -531,9 +550,9 @@ interface UpdateOnetimeProductParams {
     id: string;
     name?: string;
     prices?: Prices;
-    description?: string;
+    description?: string | null;
     media?: MediaItem[];
-    successUrl?: string;
+    successUrl?: string | null;
     metadata?: Record<string, unknown>;
 }
 /** Parameters for publishing a one-time product's test version to production. */
@@ -576,9 +595,9 @@ interface CreateSubscriptionProductParams {
     name: string;
     billingPeriod: BillingPeriod;
     prices: Prices;
-    description?: string;
+    description?: string | null;
     media?: MediaItem[];
-    successUrl?: string;
+    successUrl?: string | null;
     metadata?: Record<string, unknown>;
 }
 /**
@@ -590,9 +609,9 @@ interface UpdateSubscriptionProductParams {
     name?: string;
     billingPeriod?: BillingPeriod;
     prices?: Prices;
-    description?: string;
+    description?: string | null;
     media?: MediaItem[];
-    successUrl?: string;
+    successUrl?: string | null;
     metadata?: Record<string, unknown>;
 }
 /** Parameters for publishing a subscription product's test version to production. */
@@ -2103,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;
 }
@@ -518,9 +537,9 @@ interface CreateOnetimeProductParams {
     storeId: string;
     name: string;
     prices: Prices;
-    description?: string;
+    description?: string | null;
     media?: MediaItem[];
-    successUrl?: string;
+    successUrl?: string | null;
     metadata?: Record<string, unknown>;
 }
 /**
@@ -531,9 +550,9 @@ interface UpdateOnetimeProductParams {
     id: string;
     name?: string;
     prices?: Prices;
-    description?: string;
+    description?: string | null;
     media?: MediaItem[];
-    successUrl?: string;
+    successUrl?: string | null;
     metadata?: Record<string, unknown>;
 }
 /** Parameters for publishing a one-time product's test version to production. */
@@ -576,9 +595,9 @@ interface CreateSubscriptionProductParams {
     name: string;
     billingPeriod: BillingPeriod;
     prices: Prices;
-    description?: string;
+    description?: string | null;
     media?: MediaItem[];
-    successUrl?: string;
+    successUrl?: string | null;
     metadata?: Record<string, unknown>;
 }
 /**
@@ -590,9 +609,9 @@ interface UpdateSubscriptionProductParams {
     name?: string;
     billingPeriod?: BillingPeriod;
     prices?: Prices;
-    description?: string;
+    description?: string | null;
     media?: MediaItem[];
-    successUrl?: string;
+    successUrl?: string | null;
     metadata?: Record<string, unknown>;
 }
 /** Parameters for publishing a subscription product's test version to production. */
@@ -2103,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 };