@waffo/pancake-ts 0.3.3 → 0.3.4

package/dist/index.d.cts

@@ -304,7 +304,13 @@ interface CreateStoreParams {
     /** Store name (slug is auto-generated) */
     name: string;
 }
-/** Parameters for updating a store. */
+/**
+ * Parameters for updating a store.
+ *
+ * Settings objects support partial updates — omitted sub-fields keep their
+ * existing values, `null` clears a field, and a concrete value sets it.
+ * Pass the entire settings object as `null` to clear all fields in the group.
+ */
 interface UpdateStoreParams {
     /** Store ID */
     id: string;
@@ -318,12 +324,12 @@ interface UpdateStoreParams {
     supportEmail?: string | null;
     /** Store website URL (set to `null` to remove) */
     website?: string | null;
-    /** Webhook configuration for test and production environments (set to `null` to remove) */
-    webhookSettings?: WebhookSettings | null;
-    /** Notification preferences (set to `null` to remove) */
-    notificationSettings?: NotificationSettings | null;
-    /** Checkout page theme configuration (set to `null` to remove) */
-    checkoutSettings?: CheckoutSettings | null;
+    /** Webhook configuration (partial update — omitted fields keep existing values, set to `null` to clear all) */
+    webhookSettings?: Partial<WebhookSettings> | null;
+    /** Notification preferences (partial update — omitted fields keep existing values, set to `null` to clear all) */
+    notificationSettings?: Partial<NotificationSettings> | null;
+    /** Checkout page theme configuration (partial update — omitted fields keep existing values, set to `null` to clear all) */
+    checkoutSettings?: Partial<CheckoutSettings> | null;
 }
 /** Parameters for deleting (soft-delete) a store. */
 interface DeleteStoreParams {
@@ -1449,14 +1455,26 @@ declare class StoresResource {
     /**
      * Update an existing store's settings.
      *
+     * Settings objects (`webhookSettings`, `notificationSettings`, `checkoutSettings`)
+     * support partial updates: omitted sub-fields keep existing values, `null` clears
+     * a field. Pass the entire settings object as `null` to clear all fields.
+     *
      * @param params - Fields to update (only provided fields are changed)
      * @returns Updated store entity
      *
      * @example
+     * // Update name
      * const { store } = await client.stores.update({
      *   id: "STO_xxx",
      *   name: "Updated Name",
      * });
+     *
+     * @example
+     * // Clear test webhook URL while keeping other webhook settings
+     * const { store } = await client.stores.update({
+     *   id: "STO_xxx",
+     *   webhookSettings: { testWebhookUrl: null },
+     * });
      */
     update(params: UpdateStoreParams): Promise<{
         store: Store;

package/dist/index.d.ts

@@ -304,7 +304,13 @@ interface CreateStoreParams {
     /** Store name (slug is auto-generated) */
     name: string;
 }
-/** Parameters for updating a store. */
+/**
+ * Parameters for updating a store.
+ *
+ * Settings objects support partial updates — omitted sub-fields keep their
+ * existing values, `null` clears a field, and a concrete value sets it.
+ * Pass the entire settings object as `null` to clear all fields in the group.
+ */
 interface UpdateStoreParams {
     /** Store ID */
     id: string;
@@ -318,12 +324,12 @@ interface UpdateStoreParams {
     supportEmail?: string | null;
     /** Store website URL (set to `null` to remove) */
     website?: string | null;
-    /** Webhook configuration for test and production environments (set to `null` to remove) */
-    webhookSettings?: WebhookSettings | null;
-    /** Notification preferences (set to `null` to remove) */
-    notificationSettings?: NotificationSettings | null;
-    /** Checkout page theme configuration (set to `null` to remove) */
-    checkoutSettings?: CheckoutSettings | null;
+    /** Webhook configuration (partial update — omitted fields keep existing values, set to `null` to clear all) */
+    webhookSettings?: Partial<WebhookSettings> | null;
+    /** Notification preferences (partial update — omitted fields keep existing values, set to `null` to clear all) */
+    notificationSettings?: Partial<NotificationSettings> | null;
+    /** Checkout page theme configuration (partial update — omitted fields keep existing values, set to `null` to clear all) */
+    checkoutSettings?: Partial<CheckoutSettings> | null;
 }
 /** Parameters for deleting (soft-delete) a store. */
 interface DeleteStoreParams {
@@ -1449,14 +1455,26 @@ declare class StoresResource {
     /**
      * Update an existing store's settings.
      *
+     * Settings objects (`webhookSettings`, `notificationSettings`, `checkoutSettings`)
+     * support partial updates: omitted sub-fields keep existing values, `null` clears
+     * a field. Pass the entire settings object as `null` to clear all fields.
+     *
      * @param params - Fields to update (only provided fields are changed)
      * @returns Updated store entity
      *
      * @example
+     * // Update name
      * const { store } = await client.stores.update({
      *   id: "STO_xxx",
      *   name: "Updated Name",
      * });
+     *
+     * @example
+     * // Clear test webhook URL while keeping other webhook settings
+     * const { store } = await client.stores.update({
+     *   id: "STO_xxx",
+     *   webhookSettings: { testWebhookUrl: null },
+     * });
      */
     update(params: UpdateStoreParams): Promise<{
         store: Store;

package/dist/index.js

@@ -786,14 +786,26 @@ var StoresResource = class {
   /**
    * Update an existing store's settings.
    *
+   * Settings objects (`webhookSettings`, `notificationSettings`, `checkoutSettings`)
+   * support partial updates: omitted sub-fields keep existing values, `null` clears
+   * a field. Pass the entire settings object as `null` to clear all fields.
+   *
    * @param params - Fields to update (only provided fields are changed)
    * @returns Updated store entity
    *
    * @example
+   * // Update name
    * const { store } = await client.stores.update({
    *   id: "STO_xxx",
    *   name: "Updated Name",
    * });
+   *
+   * @example
+   * // Clear test webhook URL while keeping other webhook settings
+   * const { store } = await client.stores.update({
+   *   id: "STO_xxx",
+   *   webhookSettings: { testWebhookUrl: null },
+   * });
    */
   async update(params) {
     validateShortId("id", params.id, "STO");