@delopay/sdk 0.290.0 → 0.291.0

package/dist/index.cjs

@@ -3641,15 +3641,21 @@ var Projects = class {
     this.request = request;
   }
   /**
-   * Create a new project under a merchant account.
+   * Create a new project under a merchant account. Pass `parent_id` to create
+   * it as a sub-project; past the merchant's maximum depth it is refused with
+   * `400` and code `PR_01` (`project_depth_exceeded`).
    *
-   * @param params - Project creation parameters (name, description, etc.).
+   * @param params - Project creation parameters (name, description, parent).
    * @param merchantId - The merchant account ID that owns this project.
    * @returns The created project.
    *
    * @example
    * ```typescript
-   * const project = await delopay.projects.create({ name: 'EU Stores' }, 'merch_123');
+   * const eu = await delopay.projects.create({ project_name: 'EU Stores' }, 'merch_123');
+   * const de = await delopay.projects.create(
+   *   { project_name: 'Germany', parent_id: eu.id },
+   *   'merch_123',
+   * );
    * ```
    */
   async create(params, merchantId) {
@@ -3674,7 +3680,14 @@ var Projects = class {
     return this.request("GET", path, { query: { merchant_id: merchantId } });
   }
   /**
-   * Update a project's details.
+   * Update a project's details, or move it with `parent_id` (omitted keeps the
+   * parent, `null` makes it a top-level project, an id moves it under that
+   * project). A move is refused with `PR_01` when the moved subtree would
+   * exceed the maximum depth and with `PR_02` (`project_cycle`) when the target
+   * is the project itself or one of its sub-projects. When the merchant's
+   * project tree changed while the move was being checked, it is refused with
+   * `409` and code `PR_05` (`project_tree_changed`): read the tree again and
+   * retry.
    *
    * @param projectId - The project ID to update.
    * @param params - Fields to update.
@@ -3690,6 +3703,9 @@ var Projects = class {
    * Delete a project.
    *
    * @param projectId - The project ID to delete.
+   * Refused with `409` and code `PR_03` (`project_not_empty`) while the
+   * project still has sub-projects or shops; move or delete those first.
+   *
    * @param merchantId - Optional merchant scope. See {@link Projects.retrieve}.
    * @returns The deleted project object.
    */
@@ -3699,7 +3715,9 @@ var Projects = class {
     return this.request("DELETE", path, { query: { merchant_id: merchantId } });
   }
   /**
-   * List all projects for a merchant.
+   * List all projects for a merchant, at every level, as a flat array. Rebuild
+   * the tree from each project's `parent_id`; `level`, `path`,
+   * `child_project_count` and `direct_shop_count` are filled in for each one.
    *
    * @param merchantId - The merchant account ID.
    * @returns Array of projects.
@@ -3712,6 +3730,11 @@ var Projects = class {
   /**
    * Get aggregate payment statistics across all projects for a merchant.
    *
+   * Each project's figures cover its whole subtree (its own shops and the
+   * shops of its sub-projects); `projects[].direct` holds the figures for the
+   * project's own shops only, and `projects[].shops[]` lists only those. The
+   * merchant totals count each shop once.
+   *
    * The response's flat `shops[]` array holds every shop, including shops that
    * belong to no project — those are absent from `projects[].shops[]`, so look
    * a single shop up in `shops[]`. Requires `MerchantAccountRead`; a
@@ -3733,6 +3756,26 @@ var Projects = class {
     if (period !== void 0) query["period"] = String(period);
     return this.request("GET", "/projects/stats", { query });
   }
+  /**
+   * Get the project-depth limit that applies to a merchant: the maximum number
+   * of project levels, where that limit comes from, and how deep the
+   * merchant's tree currently is. Use it to tell whether a project can take a
+   * sub-project (`project.level < max_depth`) before offering the action.
+   *
+   * @param merchantId - The merchant account ID.
+   * @returns The merchant's project limits.
+   *
+   * @example
+   * ```typescript
+   * const { max_depth } = await delopay.projects.limits('merch_123');
+   * const canNest = project.level < max_depth;
+   * ```
+   */
+  async limits(merchantId) {
+    return this.request("GET", "/projects/limits", {
+      query: { merchant_id: merchantId }
+    });
+  }
   /**
    * Get a high-level overview (volume, counts, top connectors) for a merchant.
    *