@delopay/sdk 0.182.0 → 0.184.0

package/README.md

@@ -141,6 +141,32 @@ const payment = await delopay.payments.create({
 });
 ```
 
+### Sell from the catalog
+
+```typescript
+// A product belongs to a shop; every call names the shop last.
+const product = await delopay.products.create(
+  {
+    name: 'Annual report',
+    kind: 'one_time',
+    prices: [{ amount: 2999, currency: 'EUR', is_default: true }],
+  },
+  'pro_abc123',
+);
+
+// Price a payment from the catalog: no amount, no currency — the server
+// freezes the product's active default price (or a named `price_id`) onto it.
+const payment = await delopay.payments.create({
+  product_id: product.id,
+  profile_id: 'pro_abc123',
+  payment_link: true,
+});
+
+// What the payment sold, as it was when it was created — unchanged by later
+// catalog edits or deletion.
+const sold = await delopay.payments.productLines(payment.payment_id);
+```
+
 ### Handle disputes
 
 ```typescript

package/dist/{chunk-3GSFUNXW.js → chunk-RH4CX4MU.js}

@@ -1948,7 +1948,8 @@ var Payments = class {
   /**
    * Create a new payment intent.
    *
-   * @param params - Payment creation parameters including amount and currency.
+   * @param params - An explicit amount and currency, or a DeloPay one-time
+   *   product whose active price supplies both on the server.
    * @param options - Optional per-call extras: extra `headers` (e.g. an
    *   `Idempotency-Key` to make the create safe to retry), a `timeout` override,
    *   and an `AbortSignal`.
@@ -1962,6 +1963,16 @@ var Payments = class {
    * );
    * ```
    *
+   * @example Charge the active default price of a shop-owned product without
+   * copying the product to the payment provider:
+   * ```typescript
+   * const payment = await delopay.payments.create({
+   *   product_id: 'prd_123',
+   *   profile_id: 'pro_123',
+   *   payment_link: true,
+   * });
+   * ```
+   *
    * @example Send `test_mode` to pick the environment per payment, so a staging
    * deploy cannot charge real cards and a forgotten processor toggle cannot
    * swallow production traffic:
@@ -2015,6 +2026,10 @@ var Payments = class {
     if (Object.keys(query).length === 0) return this.request("GET", path);
     return this.request("GET", path, { query });
   }
+  /** Product names and prices as frozen when the payment was created. */
+  async productLines(paymentId) {
+    return this.request("GET", `/payments/${encodeURIComponent(paymentId)}/lines`);
+  }
   /**
    * List every attempt made on a payment, each with its full failure detail
    * (`error_code` / `error_message`, the Delopay-unified `unified_code` and
@@ -3969,6 +3984,14 @@ var Users = class {
   async listUserRoles(params) {
     return this.request("POST", "/user/employees", { body: params });
   }
+  /**
+   * The current role's explicit payment-data policy, or `null` when the role
+   * retains its pre-control access. A dashboard hint: every API response
+   * enforces the same policy on its own. `GET /user/role/payment-visibility`
+   */
+  async getRolePaymentVisibility() {
+    return this.request("GET", "/user/role/payment-visibility");
+  }
   /**
    * Change a team member's role. `POST /user/employees/update-role`
    *
@@ -4899,6 +4922,16 @@ var Products = class {
   scoped(profileId, options) {
     return { ...options, headers: { "X-Profile-Id": profileId, ...options?.headers } };
   }
+  /** Upload a PNG, JPEG or WebP image to the merchant CDN. Save the returned
+   * URL in a product create or update request; upload alone changes no product. */
+  async uploadImage(file, profileId, options) {
+    const form = new FormData();
+    form.append("file", file);
+    return this.request("POST", "/products/images", {
+      body: form,
+      ...this.scoped(profileId, options)
+    });
+  }
   /**
    * Create a product together with its prices.
    * `POST /products`
@@ -4967,6 +5000,13 @@ var Products = class {
       ...this.scoped(profileId, options)
     });
   }
+  /** Mark an archived product deleted. Historical payment lines keep
+   * their own immutable purchase snapshots, and the catalog row remains stored. */
+  async delete(productId, profileId, options) {
+    return this.request("DELETE", `/products/${encodeURIComponent(productId)}`, {
+      ...this.scoped(profileId, options)
+    });
+  }
   /**
    * Add a price to an existing product.
    * `POST /products/{product_id}/prices`
@@ -5004,6 +5044,89 @@ var Products = class {
       { ...this.scoped(profileId, options) }
     );
   }
+  // --- add-on selection groups ---------------------------------------
+  /**
+   * Add a group of optional extras to a one-time product, with how many of
+   * them a buyer must and may choose. Each add-on is an active product of kind
+   * `addon` in the same shop. Returns the whole product.
+   * `POST /products/{product_id}/addon-groups`
+   */
+  async createAddonGroup(productId, group, profileId, options) {
+    return this.request("POST", `/products/${encodeURIComponent(productId)}/addon-groups`, {
+      body: group,
+      ...this.scoped(profileId, options)
+    });
+  }
+  /**
+   * Change a group's name, bounds, or the add-ons it offers; a new list
+   * replaces the old one whole.
+   * `POST /products/{product_id}/addon-groups/{group_id}`
+   */
+  async updateAddonGroup(productId, groupId, changes, profileId, options) {
+    return this.request(
+      "POST",
+      `/products/${encodeURIComponent(productId)}/addon-groups/${encodeURIComponent(groupId)}`,
+      { body: changes, ...this.scoped(profileId, options) }
+    );
+  }
+  /**
+   * Remove a group and what it offered. The add-on products themselves stay.
+   * `DELETE /products/{product_id}/addon-groups/{group_id}`
+   */
+  async deleteAddonGroup(productId, groupId, profileId, options) {
+    return this.request(
+      "DELETE",
+      `/products/${encodeURIComponent(productId)}/addon-groups/${encodeURIComponent(groupId)}`,
+      { ...this.scoped(profileId, options) }
+    );
+  }
+  // --- bundles ---------------------------------------------------------
+  /**
+   * Replace what a bundle contains. Its pricing mode is fixed at creation;
+   * past purchases keep their own frozen lines.
+   * `POST /products/{product_id}/bundle`
+   */
+  async replaceBundle(productId, bundle, profileId, options) {
+    return this.request("POST", `/products/${encodeURIComponent(productId)}/bundle`, {
+      body: bundle,
+      ...this.scoped(profileId, options)
+    });
+  }
+  // --- provider import ---------------------------------------------
+  /**
+   * Read a connected billing account's products and say how each relates to
+   * the catalog. Reads only: nothing is written to the provider or the catalog.
+   * `POST /products/import/preview`
+   */
+  async importPreview(request, profileId, options) {
+    return this.request("POST", "/products/import/preview", {
+      body: request,
+      ...this.scoped(profileId, options)
+    });
+  }
+  /**
+   * Create a product for every new item and add the new prices of every
+   * changed one, tied to the provider's ids. Nothing is edited or removed, and
+   * nothing is written to the provider. A failed item is reported with its
+   * reason and can be retried by naming it in `connector_product_ids`.
+   * `POST /products/import/apply`
+   */
+  async importApply(request, profileId, options) {
+    return this.request("POST", "/products/import/apply", {
+      body: request,
+      ...this.scoped(profileId, options)
+    });
+  }
+  /**
+   * The shop's past imports from one connected account, newest first.
+   * `GET /products/import/runs`
+   */
+  async listImportRuns(merchantConnectorId, profileId, options) {
+    return this.request("GET", "/products/import/runs", {
+      query: { merchant_connector_id: merchantConnectorId },
+      ...this.scoped(profileId, options)
+    });
+  }
 };
 
 // src/resources/processorCosts.ts
@@ -5138,6 +5261,16 @@ var CheckoutMethods = class {
       query: { merchant_id: merchantId }
     });
   }
+  /**
+   * The same document as {@link retrieve}, on the route that stays open to a
+   * reader of the checkout's appearance while the role's payment-data
+   * visibility is restricted. `GET /checkout-methods/{profile_id}/preview`
+   */
+  async preview(merchantId, profileId) {
+    return this.request("GET", `/checkout-methods/${encodeURIComponent(profileId)}/preview`, {
+      query: { merchant_id: merchantId }
+    });
+  }
   /**
    * Replace the shop's layout. The router refuses an express item that does
    * not draw its own button, more than two rows of two in the express strip,
@@ -5953,6 +6086,85 @@ var OperationLimits = class {
   }
 };
 
+// src/resources/replayRetention.ts
+var ReplayRetention = class {
+  constructor(request) {
+    this.request = request;
+  }
+  /**
+   * Every level that is set for the caller's merchant, plus the global level
+   * when one is set.
+   *
+   * `GET /replay-retention`
+   */
+  async list() {
+    return this.request("GET", "/replay-retention");
+  }
+  /**
+   * What applies to one shop's recordings, and which level decided.
+   *
+   * `GET /replay-retention/shops/{profileId}/effective`
+   */
+  async effective(profileId) {
+    return this.request(
+      "GET",
+      `/replay-retention/shops/${encodeURIComponent(profileId)}/effective`
+    );
+  }
+  /**
+   * Set the merchant-wide level.
+   *
+   * `PUT /replay-retention/merchant`
+   */
+  async setMerchant(params) {
+    return this.request("PUT", "/replay-retention/merchant", { body: params });
+  }
+  /**
+   * Hand the merchant-wide level back to the global one.
+   *
+   * `DELETE /replay-retention/merchant`
+   */
+  async clearMerchant() {
+    await this.request("DELETE", "/replay-retention/merchant");
+  }
+  /**
+   * Set one project's level.
+   *
+   * `PUT /replay-retention/projects/{projectId}`
+   */
+  async setProject(projectId, params) {
+    return this.request("PUT", `/replay-retention/projects/${encodeURIComponent(projectId)}`, {
+      body: params
+    });
+  }
+  /**
+   * Hand one project's level back to the merchant's.
+   *
+   * `DELETE /replay-retention/projects/{projectId}`
+   */
+  async clearProject(projectId) {
+    await this.request("DELETE", `/replay-retention/projects/${encodeURIComponent(projectId)}`);
+  }
+  /**
+   * Set one shop's level. A shop-scoped caller may set only its own shop.
+   *
+   * `PUT /replay-retention/shops/{profileId}`
+   */
+  async setShop(profileId, params) {
+    return this.request("PUT", `/replay-retention/shops/${encodeURIComponent(profileId)}`, {
+      body: params
+    });
+  }
+  /**
+   * Hand one shop's level back to its project's (or the merchant's).
+   *
+   * `DELETE /replay-retention/shops/{profileId}`
+   */
+  async clearShop(profileId) {
+    await this.request("DELETE", `/replay-retention/shops/${encodeURIComponent(profileId)}`);
+  }
+};
+
 // src/resources/risk.ts
 var Risk = class {
   constructor(request) {
@@ -6214,6 +6426,7 @@ var Delopay = class {
     this.audit = new Audit(request);
     this.settlement = new Settlement(request);
     this.operationLimits = new OperationLimits(request);
+    this.replayRetention = new ReplayRetention(request);
     this.risk = new Risk(request);
     this.subscriptions = new Subscriptions(request);
     this.files = new Files(request);
@@ -10171,6 +10384,7 @@ export {
   Audit,
   Settlement,
   OperationLimits,
+  ReplayRetention,
   Risk,
   Delopay,
   leaf,
@@ -10362,4 +10576,4 @@ export {
   decodeNativePanes,
   encodeNativePanes
 };
-//# sourceMappingURL=chunk-3GSFUNXW.js.map
+//# sourceMappingURL=chunk-RH4CX4MU.js.map