@delopay/sdk 0.112.0 → 0.115.0

package/dist/index.d.cts

@@ -1603,6 +1603,18 @@ interface BillingProfileResponse {
     suspension_source?: string | null;
     /** Admin-provided reason for a manual suspension. Absent otherwise. */
     suspension_reason?: string | null;
+    /**
+     * Free (not billed) merchant. While set, no platform fee is deducted on
+     * any payment, the payment gate never blocks on `billing_status`, top-ups
+     * are refused and auto-recharge is inert. Orthogonal to `is_trusted`, which
+     * only shields against suspension. Absent on a router that predates the
+     * flag (delopay-backend#378); read absent as `false`.
+     */
+    is_free?: boolean;
+    /** Admin-provided reason the merchant is free. Absent when not free. */
+    free_reason?: string | null;
+    /** When the free flag was set (ISO 8601). Absent when not free. */
+    free_set_at?: string | null;
     created_at: string;
     modified_at: string;
     /**
@@ -6485,13 +6497,15 @@ interface CheckoutBrandingUpdate {
     payment_link_config?: BusinessPaymentLinkConfig | null;
 }
 /**
- * Response of `GET /shops/{merchant_id}/{shop_id}/checkout-branding`.
+ * Response of both checkout-branding routes: the `GET` on
+ * `/shops/{merchant_id}/{shop_id}/checkout-branding`, and the `POST` echoing
+ * back what it persisted.
  *
  * Deliberately not a `ProfileResponse`: that carries `payment_response_hash_key`
  * — the webhook signing secret — plus the card-vault and authentication
  * configuration, and a role that may only restyle a checkout has no business
- * reading any of it. This carries what the branding editor renders and nothing
- * else.
+ * reading any of it, whether it asked to load the checkout or has just saved
+ * it. This carries what the branding editor renders and nothing else.
  */
 interface CheckoutBrandingResponse {
     /** The shop (business profile) this branding belongs to. */
@@ -8555,6 +8569,17 @@ declare class Routing {
     updateDefault(params: Record<string, unknown>): Promise<RoutableConnectorChoice[]>;
     /** Retrieve default config for profiles. `GET /routing/default/profile` */
     getDefaultProfile(): Promise<RoutableConnectorChoice[] | ProfileDefaultRoutingConfig[]>;
+    /**
+     * Retrieve one profile's default config. `GET /routing/default/profile/{profileId}`
+     *
+     * The narrow counterpart of `getDefaultProfile()`: that one returns every
+     * profile of the merchant and needs merchant-level routing read, so a
+     * profile-scoped (shop) role could write its own default through
+     * `updateDefaultProfile()` but never read it back. This read is gated on
+     * profile-level routing read and pinned to the caller's own profile — a shop
+     * role asking for a sibling profile is refused.
+     */
+    getDefaultForProfile(profileId: string): Promise<ProfileDefaultRoutingConfig>;
     /** Update default config for a profile. `POST /routing/default/profile/{profileId}` */
     updateDefaultProfile(profileId: string, params: Record<string, unknown>): Promise<ProfileDefaultRoutingConfig>;
     /** List routing configs for profile. `GET /routing/list/profile` */
@@ -8972,9 +8997,12 @@ declare class Shops {
      * @param merchantId - The merchant account ID.
      * @param shopId - The shop (business profile) ID to restyle.
      * @param params - The new `payment_link_config` blob (full replacement).
-     * @returns The updated business profile.
+     * @returns The saved branding — the same shape `retrieveCheckoutBranding`
+     * returns, not the whole shop. A role whose only power is restyling a
+     * checkout must not receive the webhook signing key or the card-vault
+     * configuration back from a save.
      */
-    updateCheckoutBranding(merchantId: string, shopId: string, params: CheckoutBrandingUpdate, options?: RequestExtras): Promise<ProfileResponse>;
+    updateCheckoutBranding(merchantId: string, shopId: string, params: CheckoutBrandingUpdate, options?: RequestExtras): Promise<CheckoutBrandingResponse>;
     /**
      * Read only the checkout appearance of a shop, so the role that may restyle a
      * checkout can load the checkout it may restyle.

package/dist/index.d.ts

@@ -1603,6 +1603,18 @@ interface BillingProfileResponse {
     suspension_source?: string | null;
     /** Admin-provided reason for a manual suspension. Absent otherwise. */
     suspension_reason?: string | null;
+    /**
+     * Free (not billed) merchant. While set, no platform fee is deducted on
+     * any payment, the payment gate never blocks on `billing_status`, top-ups
+     * are refused and auto-recharge is inert. Orthogonal to `is_trusted`, which
+     * only shields against suspension. Absent on a router that predates the
+     * flag (delopay-backend#378); read absent as `false`.
+     */
+    is_free?: boolean;
+    /** Admin-provided reason the merchant is free. Absent when not free. */
+    free_reason?: string | null;
+    /** When the free flag was set (ISO 8601). Absent when not free. */
+    free_set_at?: string | null;
     created_at: string;
     modified_at: string;
     /**
@@ -6485,13 +6497,15 @@ interface CheckoutBrandingUpdate {
     payment_link_config?: BusinessPaymentLinkConfig | null;
 }
 /**
- * Response of `GET /shops/{merchant_id}/{shop_id}/checkout-branding`.
+ * Response of both checkout-branding routes: the `GET` on
+ * `/shops/{merchant_id}/{shop_id}/checkout-branding`, and the `POST` echoing
+ * back what it persisted.
  *
  * Deliberately not a `ProfileResponse`: that carries `payment_response_hash_key`
  * — the webhook signing secret — plus the card-vault and authentication
  * configuration, and a role that may only restyle a checkout has no business
- * reading any of it. This carries what the branding editor renders and nothing
- * else.
+ * reading any of it, whether it asked to load the checkout or has just saved
+ * it. This carries what the branding editor renders and nothing else.
  */
 interface CheckoutBrandingResponse {
     /** The shop (business profile) this branding belongs to. */
@@ -8555,6 +8569,17 @@ declare class Routing {
     updateDefault(params: Record<string, unknown>): Promise<RoutableConnectorChoice[]>;
     /** Retrieve default config for profiles. `GET /routing/default/profile` */
     getDefaultProfile(): Promise<RoutableConnectorChoice[] | ProfileDefaultRoutingConfig[]>;
+    /**
+     * Retrieve one profile's default config. `GET /routing/default/profile/{profileId}`
+     *
+     * The narrow counterpart of `getDefaultProfile()`: that one returns every
+     * profile of the merchant and needs merchant-level routing read, so a
+     * profile-scoped (shop) role could write its own default through
+     * `updateDefaultProfile()` but never read it back. This read is gated on
+     * profile-level routing read and pinned to the caller's own profile — a shop
+     * role asking for a sibling profile is refused.
+     */
+    getDefaultForProfile(profileId: string): Promise<ProfileDefaultRoutingConfig>;
     /** Update default config for a profile. `POST /routing/default/profile/{profileId}` */
     updateDefaultProfile(profileId: string, params: Record<string, unknown>): Promise<ProfileDefaultRoutingConfig>;
     /** List routing configs for profile. `GET /routing/list/profile` */
@@ -8972,9 +8997,12 @@ declare class Shops {
      * @param merchantId - The merchant account ID.
      * @param shopId - The shop (business profile) ID to restyle.
      * @param params - The new `payment_link_config` blob (full replacement).
-     * @returns The updated business profile.
+     * @returns The saved branding — the same shape `retrieveCheckoutBranding`
+     * returns, not the whole shop. A role whose only power is restyling a
+     * checkout must not receive the webhook signing key or the card-vault
+     * configuration back from a save.
      */
-    updateCheckoutBranding(merchantId: string, shopId: string, params: CheckoutBrandingUpdate, options?: RequestExtras): Promise<ProfileResponse>;
+    updateCheckoutBranding(merchantId: string, shopId: string, params: CheckoutBrandingUpdate, options?: RequestExtras): Promise<CheckoutBrandingResponse>;
     /**
      * Read only the checkout appearance of a shop, so the role that may restyle a
      * checkout can load the checkout it may restyle.

package/dist/index.js

@@ -110,7 +110,7 @@ import {
   validatePanes,
   verticalGapValue,
   visibleCustomFields
-} from "./chunk-3O5MU6FP.js";
+} from "./chunk-VH5NCMH6.js";
 export {
   ALL_CUSTOM_FIELD_CONDITION_SOURCES,
   ALL_CUSTOM_FIELD_OPERATORS,

package/dist/internal.cjs

@@ -2536,6 +2536,19 @@ var Routing = class {
   async getDefaultProfile() {
     return this.request("GET", "/routing/default/profile");
   }
+  /**
+   * Retrieve one profile's default config. `GET /routing/default/profile/{profileId}`
+   *
+   * The narrow counterpart of `getDefaultProfile()`: that one returns every
+   * profile of the merchant and needs merchant-level routing read, so a
+   * profile-scoped (shop) role could write its own default through
+   * `updateDefaultProfile()` but never read it back. This read is gated on
+   * profile-level routing read and pinned to the caller's own profile — a shop
+   * role asking for a sibling profile is refused.
+   */
+  async getDefaultForProfile(profileId) {
+    return this.request("GET", `/routing/default/profile/${encodeURIComponent(profileId)}`);
+  }
   /** Update default config for a profile. `POST /routing/default/profile/{profileId}` */
   async updateDefaultProfile(profileId, params) {
     return this.request("POST", `/routing/default/profile/${encodeURIComponent(profileId)}`, {
@@ -2978,7 +2991,10 @@ var Shops = class {
    * @param merchantId - The merchant account ID.
    * @param shopId - The shop (business profile) ID to restyle.
    * @param params - The new `payment_link_config` blob (full replacement).
-   * @returns The updated business profile.
+   * @returns The saved branding — the same shape `retrieveCheckoutBranding`
+   * returns, not the whole shop. A role whose only power is restyling a
+   * checkout must not receive the webhook signing key or the card-vault
+   * configuration back from a save.
    */
   async updateCheckoutBranding(merchantId, shopId, params, options) {
     return this.request(
@@ -7132,6 +7148,13 @@ var AdminPortal = class {
    * against signup policy + JWT blacklist). `reset_2fa` clears TOTP state
    * so the user re-enrolls on next login. `is_active` supports both
    * directions: false soft-disables, true reactivates a soft-disabled user.
+   *
+   * Throws a `400` with `code === 'UR_66'` when the change would leave a
+   * merchant with no administrator — `is_active: false` or `is_verified:
+   * false` on, or a `role_id` demoting, the only active user whose role can
+   * manage that merchant's users. Nothing is written. `error.data` carries a
+   * {@link LastAdministratorRefusal} naming the merchant and which change was
+   * refused; render that rather than the generic message.
    */
   async updateUser(userId, body) {
     return this.request("PATCH", `/admin-portal/users/${encodeURIComponent(userId)}`, { body });
@@ -7140,6 +7163,9 @@ var AdminPortal = class {
    * Soft-delete a user globally: deactivates the row, blacklists existing
    * JWTs, and wipes credentials. Distinct from `deleteUserRole`, which
    * removes a single role binding while leaving the user signed-in elsewhere.
+   *
+   * Throws the same `UR_66` as {@link updateUser} when the user is the last
+   * administrator of any merchant they belong to, with `route: 'delete'`.
    */
   async deleteUser(userId) {
     return this.request("DELETE", `/admin-portal/users/${encodeURIComponent(userId)}`);
@@ -7647,6 +7673,62 @@ var PlatformBilling = class {
       body: params
     });
   }
+  /**
+   * Mark a merchant free (not billed), or put it back on the prepaid model
+   * (delopay-backend#378). While free, no platform fee is deducted, the
+   * payment gate never blocks on billing status, top-ups are refused and
+   * auto-recharge is inert. Marking free needs a `reason` and is refused
+   * (412) while an admin suspension is in force — lift that first.
+   *
+   * Requires a router with delopay-backend#378; older routers answer `404`.
+   *
+   * @param merchantId - The merchant account ID.
+   * @param params - The desired free state and, when marking free, the reason.
+   * @returns The updated billing profile.
+   */
+  async setFree(merchantId, params) {
+    return this.request("PATCH", `/billing/${encodeURIComponent(merchantId)}/admin/free`, {
+      body: params
+    });
+  }
+  /**
+   * Delete a merchant's **entire** ledger (delopay-backend#378). Every live
+   * entry is soft-deleted — kept, so a replayed fee deduction or top-up
+   * webhook still no-ops — the balance is set to zero and the status
+   * re-derived (`active` for a free merchant; an active paying merchant
+   * lands in `delinquent`). Refused (412) while the merchant has shop
+   * allocations. Audited.
+   *
+   * Requires a router with delopay-backend#378; older routers answer `404`.
+   *
+   * @param merchantId - The merchant account ID.
+   * @param params - The reason, required for audit.
+   * @returns What was removed and the post-reset profile.
+   */
+  async resetLedger(merchantId, params) {
+    return this.request("DELETE", `/billing/${encodeURIComponent(merchantId)}/admin/ledger`, {
+      body: params
+    });
+  }
+  /**
+   * (Re)create a merchant's ledger, optionally seeded with an opening balance
+   * (delopay-backend#378). Ensures the billing profile exists (created
+   * without the welcome promo credit) and, when `opening_balance` is set,
+   * writes one `opening_balance` entry through the same atomic helper an
+   * admin credit uses. Refused (412) while live entries or a non-zero balance
+   * remain — reset first. Does not clear the free flag. Audited.
+   *
+   * Requires a router with delopay-backend#378; older routers answer `404`.
+   *
+   * @param merchantId - The merchant account ID.
+   * @param params - Opening balance (minor units), currency for a new profile, and the reason.
+   * @returns The opening entry id (if one was written) and the profile.
+   */
+  async createLedger(merchantId, params) {
+    return this.request("POST", `/billing/${encodeURIComponent(merchantId)}/admin/ledger`, {
+      body: params
+    });
+  }
 };
 
 // src/internal/resources/platformFees.ts