@delopay/sdk 0.183.0 → 0.185.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-HITQ3SXH.js → chunk-LA4KAVRD.js}

@@ -3984,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`
    *
@@ -4950,6 +4958,19 @@ var Products = class {
       ...this.scoped(profileId, options)
     });
   }
+  /**
+   * Find the product a name or a connector's id belongs to. Pass exactly one
+   * of `alias`, `connector_product_id` and `connector_price_id`; the connector
+   * ids need `connector` as well. Archived products resolve too, so a payment
+   * that references one is still attributed. No match answers 404.
+   * `GET /products/resolve`
+   */
+  async resolve(query, profileId, options) {
+    return this.request("GET", "/products/resolve", {
+      query: { ...query },
+      ...this.scoped(profileId, options)
+    });
+  }
   /**
    * Retrieve one product with its prices.
    * `GET /products/{product_id}`
@@ -4960,7 +4981,8 @@ var Products = class {
     });
   }
   /**
-   * Change a product's name, description or metadata.
+   * Change a product's name, description, image, metadata or category
+   * (`category_id: null` makes it uncategorized).
    * `POST /products/{product_id}`
    *
    * Its kind and its prices are not editable here — see the class note.
@@ -5036,6 +5058,231 @@ 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)
+    });
+  }
+  // --- identity: names and connector references ---------------------
+  /**
+   * Add a name the product goes by. A name it already goes by is returned
+   * as it is; one another product of the shop goes by is refused.
+   * `POST /products/{product_id}/aliases`
+   */
+  async addAlias(productId, body, profileId, options) {
+    return this.request("POST", `/products/${encodeURIComponent(productId)}/aliases`, {
+      body,
+      ...this.scoped(profileId, options)
+    });
+  }
+  /**
+   * Remove a name the product goes by. Its current name stays.
+   * `POST /products/{product_id}/aliases/{alias_id}/remove`
+   */
+  async removeAlias(productId, aliasId, profileId, options) {
+    return this.request(
+      "POST",
+      `/products/${encodeURIComponent(productId)}/aliases/${encodeURIComponent(aliasId)}/remove`,
+      { ...this.scoped(profileId, options) }
+    );
+  }
+  /**
+   * Tie a connected account's product, or one of its prices, to the product.
+   * Recorded as `manual_id`: the ids are not checked against the account.
+   * `POST /products/{product_id}/connector-references`
+   */
+  async addConnectorReference(productId, body, profileId, options) {
+    return this.request("POST", `/products/${encodeURIComponent(productId)}/connector-references`, {
+      body,
+      ...this.scoped(profileId, options)
+    });
+  }
+  /**
+   * Remove a connected account's product or price from the product.
+   * `POST /products/{product_id}/connector-references/{reference_id}/remove`
+   */
+  async removeConnectorReference(productId, referenceId, profileId, options) {
+    return this.request(
+      "POST",
+      `/products/${encodeURIComponent(productId)}/connector-references/${encodeURIComponent(referenceId)}/remove`,
+      { ...this.scoped(profileId, options) }
+    );
+  }
+  /**
+   * One bounded page of a connected billing account's products, to pick an
+   * existing one to tie to a product. Reads only.
+   * `GET /products/import-suggestions`
+   */
+  async importSuggestions(query, profileId, options) {
+    return this.request("GET", "/products/import-suggestions", {
+      query: { ...query },
+      ...this.scoped(profileId, options)
+    });
+  }
+  /**
+   * Tie one of a connected account's existing products (or a price of it) to
+   * the product, verified against a fresh read of the page it was suggested
+   * on — pass the same `limit` and `offset`. Recorded as `map_existing`.
+   * `POST /products/{product_id}/connector-references/import`
+   */
+  async acceptImport(productId, body, profileId, options) {
+    return this.request(
+      "POST",
+      `/products/${encodeURIComponent(productId)}/connector-references/import`,
+      { body, ...this.scoped(profileId, options) }
+    );
+  }
+  // --- categories ------------------------------------------------------
+  /**
+   * Add a category to the shop, at the end of its order. File products under
+   * it with `category_id` on `create` or `update`.
+   * `POST /products/categories`
+   */
+  async createCategory(body, profileId, options) {
+    return this.request("POST", "/products/categories", {
+      body,
+      ...this.scoped(profileId, options)
+    });
+  }
+  /**
+   * The shop's categories in order. Archived ones only with
+   * `include_archived`; deleted ones never.
+   * `GET /products/categories/list`
+   */
+  async listCategories(query, profileId, options) {
+    return this.request("GET", "/products/categories/list", {
+      query: query === void 0 ? void 0 : { ...query },
+      ...this.scoped(profileId, options)
+    });
+  }
+  /**
+   * Put the shop's categories in a new order. Name every live category,
+   * archived ones included, exactly once. Returns the categories in their new
+   * order.
+   * `POST /products/categories/reorder`
+   */
+  async reorderCategories(body, profileId, options) {
+    return this.request("POST", "/products/categories/reorder", {
+      body,
+      ...this.scoped(profileId, options)
+    });
+  }
+  /**
+   * Rename a category.
+   * `POST /products/categories/{category_id}`
+   */
+  async updateCategory(categoryId, changes, profileId, options) {
+    return this.request("POST", `/products/categories/${encodeURIComponent(categoryId)}`, {
+      body: changes,
+      ...this.scoped(profileId, options)
+    });
+  }
+  /**
+   * Mark a category deleted. Its products become uncategorized and no payment
+   * changes. Returns the deleted category.
+   * `DELETE /products/categories/{category_id}`
+   */
+  async deleteCategory(categoryId, profileId, options) {
+    return this.request("DELETE", `/products/categories/${encodeURIComponent(categoryId)}`, {
+      ...this.scoped(profileId, options)
+    });
+  }
+  /**
+   * Keep a category with its products, but file no new product under it.
+   * `POST /products/categories/{category_id}/archive`
+   */
+  async archiveCategory(categoryId, profileId, options) {
+    return this.request("POST", `/products/categories/${encodeURIComponent(categoryId)}/archive`, {
+      ...this.scoped(profileId, options)
+    });
+  }
+  /**
+   * Let an archived category take products again.
+   * `POST /products/categories/{category_id}/restore`
+   */
+  async restoreCategory(categoryId, profileId, options) {
+    return this.request("POST", `/products/categories/${encodeURIComponent(categoryId)}/restore`, {
+      ...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
@@ -5170,6 +5417,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,
@@ -10475,4 +10732,4 @@ export {
   decodeNativePanes,
   encodeNativePanes
 };
-//# sourceMappingURL=chunk-HITQ3SXH.js.map
+//# sourceMappingURL=chunk-LA4KAVRD.js.map