@delopay/sdk 0.365.0 → 0.368.0

package/dist/index.cjs

@@ -168,6 +168,7 @@ __export(index_exports, {
   Settlement: () => Settlement,
   ShopLabels: () => ShopLabels,
   Subscriptions: () => Subscriptions,
+  Support: () => Support,
   UNKNOWN_SECTION_ORDER: () => UNKNOWN_SECTION_ORDER,
   WCAG_AA_TEXT: () => WCAG_AA_TEXT,
   WCAG_AA_UI: () => WCAG_AA_UI,
@@ -1255,9 +1256,9 @@ var Connectors = class {
    *   to a single event.
    */
   async registerWebhook(merchantId, connectorId, params) {
-    const path = `/account/${encodeURIComponent(merchantId)}/connectors/webhooks/${encodeURIComponent(connectorId)}`;
-    if (params === void 0) return this.request("POST", path);
-    return this.request("POST", path, { body: params });
+    const path2 = `/account/${encodeURIComponent(merchantId)}/connectors/webhooks/${encodeURIComponent(connectorId)}`;
+    if (params === void 0) return this.request("POST", path2);
+    return this.request("POST", path2, { body: params });
   }
   /**
    * Register checkout/shop domains as Stripe payment method domains, so Apple
@@ -2055,11 +2056,11 @@ function negotiated(options, format, presentation) {
   }
   return format === "json" ? { ...options, headers } : { ...options, headers, responseType: "blob" };
 }
-function runExport(request, method, path, base, options) {
+function runExport(request, method, path2, base, options) {
   const format = options?.format ?? "json";
   return downloadExport(
     request,
-    { method, path, request: negotiated(base, format, options?.presentation), format },
+    { method, path: path2, request: negotiated(base, format, options?.presentation), format },
     options
   );
 }
@@ -2320,6 +2321,34 @@ var ChargebackPrevention = class {
   async retrieveCase(caseId) {
     return this.request("GET", `/chargeback-prevention/cases/${encodeURIComponent(caseId)}`);
   }
+  /**
+   * The refund rule of every connected account and environment; version `0`
+   * and off for one never saved. Needs a merchant-wide key or sign-in.
+   */
+  async listRefundRules() {
+    return this.request("GET", "/chargeback-prevention/refund-rules");
+  }
+  /**
+   * Save a refund rule over the version read. Dashboard sign-in only, by a
+   * merchant-wide user who may write refunds; an API key is refused. A rule
+   * saved since the version named is not overwritten: the call fails.
+   */
+  async saveRefundRule(body) {
+    return this.request("PUT", "/chargeback-prevention/refund-rules", { body });
+  }
+  /**
+   * What the stored rule, or unsaved `settings`, would do with each open
+   * alert of the account now. Nothing is refunded.
+   */
+  async previewRefundRule(body) {
+    return this.request("POST", "/chargeback-prevention/refund-rules/preview", { body });
+  }
+  /** What the merchant's refund rules did, newest first. */
+  async listRefundActions(params) {
+    return this.request("GET", "/chargeback-prevention/refund-actions", {
+      query: params
+    });
+  }
 };
 
 // src/resources/paypalDisputes.ts
@@ -3032,15 +3061,15 @@ var Payments = class {
    * ```
    */
   async retrieve(paymentId, options) {
-    const path = `/payments/${encodeURIComponent(paymentId)}`;
-    if (options === void 0) return this.request("GET", path);
+    const path2 = `/payments/${encodeURIComponent(paymentId)}`;
+    if (options === void 0) return this.request("GET", path2);
     const query = {};
     if (options.force_sync !== void 0) query["force_sync"] = options.force_sync;
     if (options.all_keys_required !== void 0) {
       query["all_keys_required"] = options.all_keys_required;
     }
-    if (Object.keys(query).length === 0) return this.request("GET", path);
-    return this.request("GET", path, { query });
+    if (Object.keys(query).length === 0) return this.request("GET", path2);
+    return this.request("GET", path2, { query });
   }
   /**
    * The payment's buyer risk evaluations, newest first (at most 50): each
@@ -3395,6 +3424,36 @@ var Payments = class {
       options
     );
   }
+  /**
+   * The statement name and suffix each attempt of a payment asked for and was
+   * sent to its provider with. A name the merchant, the shop or the connector
+   * account configures replaces the payment's own: `name_ignored` /
+   * `suffix_ignored` say the payment's value was not used, and a `null` sent
+   * value leaves the provider account's own default.
+   *
+   * Only attempts with a record are listed: one that carried no name and was
+   * sent none, or ran before the record existed, is absent.
+   *
+   * `GET /payments/{paymentId}/statement-descriptors`
+   *
+   * @param paymentId - The payment intent ID.
+   * @param options - Optional per-call extras: extra `headers`, a `timeout`
+   *   override, and an `AbortSignal`.
+   *
+   * @example
+   * ```typescript
+   * const { attempts } = await delopay.payments.statementDescriptors('pay_abc123');
+   * const last = attempts.at(-1);
+   * if (last?.name_ignored) console.log(`Sent as ${last.sent_name}`);
+   * ```
+   */
+  async statementDescriptors(paymentId, options) {
+    return this.request(
+      "GET",
+      `/payments/${encodeURIComponent(paymentId)}/statement-descriptors`,
+      options
+    );
+  }
   /**
    * Open a playback of the payment's stored checkout recording: the audited
    * act of watching. Answers the manifest — which slices exist, how long the
@@ -3920,9 +3979,9 @@ var Projects = class {
    * @returns The project.
    */
   async retrieve(projectId, merchantId) {
-    const path = `/projects/${encodeURIComponent(projectId)}`;
-    if (merchantId === void 0) return this.request("GET", path);
-    return this.request("GET", path, { query: { merchant_id: merchantId } });
+    const path2 = `/projects/${encodeURIComponent(projectId)}`;
+    if (merchantId === void 0) return this.request("GET", path2);
+    return this.request("GET", path2, { query: { merchant_id: merchantId } });
   }
   /**
    * Update a project's details, or move it with `parent_id` (omitted keeps the
@@ -3940,9 +3999,9 @@ var Projects = class {
    * @returns The updated project.
    */
   async update(projectId, params, merchantId, options) {
-    const path = `/projects/${encodeURIComponent(projectId)}`;
-    if (merchantId === void 0) return this.request("PUT", path, { body: params, ...options });
-    return this.request("PUT", path, {
+    const path2 = `/projects/${encodeURIComponent(projectId)}`;
+    if (merchantId === void 0) return this.request("PUT", path2, { body: params, ...options });
+    return this.request("PUT", path2, {
       body: params,
       query: { merchant_id: merchantId },
       ...options
@@ -3959,9 +4018,9 @@ var Projects = class {
    * @returns The deleted project object.
    */
   async delete(projectId, merchantId) {
-    const path = `/projects/${encodeURIComponent(projectId)}`;
-    if (merchantId === void 0) return this.request("DELETE", path);
-    return this.request("DELETE", path, { query: { merchant_id: merchantId } });
+    const path2 = `/projects/${encodeURIComponent(projectId)}`;
+    if (merchantId === void 0) return this.request("DELETE", path2);
+    return this.request("DELETE", path2, { query: { merchant_id: merchantId } });
   }
   /**
    * List all projects for a merchant, at every level, as a flat array. Rebuild
@@ -4966,9 +5025,9 @@ var Shops = class {
    * ```
    */
   async stats(merchantId, shopId, period) {
-    const path = `/shops/${encodeURIComponent(merchantId)}/${encodeURIComponent(shopId)}/stats`;
-    if (period === void 0) return this.request("GET", path);
-    return this.request("GET", path, { query: { period: String(period) } });
+    const path2 = `/shops/${encodeURIComponent(merchantId)}/${encodeURIComponent(shopId)}/stats`;
+    if (period === void 0) return this.request("GET", path2);
+    return this.request("GET", path2, { query: { period: String(period) } });
   }
   /**
    * Upload a logo file for a shop. The file is stored in Delopay's configured
@@ -8253,6 +8312,69 @@ var Products = class {
   }
 };
 
+// src/resources/support.ts
+var path = (id) => `/support/conversations/${encodeURIComponent(id)}`;
+var Support = class {
+  constructor(request) {
+    this.request = request;
+  }
+  /** Start a conversation with its first message. `POST /support/conversations` */
+  async create(body) {
+    return this.request("POST", "/support/conversations", { body });
+  }
+  /** The conversations the caller may read. `GET /support/conversations` */
+  async list(query) {
+    return this.request("GET", "/support/conversations", {
+      query: query === void 0 ? void 0 : { ...query }
+    });
+  }
+  /** One conversation. `GET /support/conversations/{id}` */
+  async retrieve(id) {
+    return this.request("GET", path(id));
+  }
+  /** A conversation's messages. `GET /support/conversations/{id}/messages` */
+  async messages(id, query) {
+    return this.request("GET", `${path(id)}/messages`, {
+      query: query === void 0 ? void 0 : { ...query }
+    });
+  }
+  /** Answer in a conversation. `POST /support/conversations/{id}/messages` */
+  async reply(id, body) {
+    return this.request("POST", `${path(id)}/messages`, { body });
+  }
+  /**
+   * Upload a file for a message. PNG, JPEG, WebP, PDF, text, MP4 or WebM, read from the
+   * content; 10 MB, a video 25 MB. It belongs to the caller until a message names it in
+   * `attachments`. Uploading again with the same `clientUploadId` returns the same file.
+   * `POST /support/conversations/{id}/attachments`
+   */
+  async uploadAttachment(id, file, clientUploadId, fileName) {
+    const form = new FormData();
+    form.append("client_upload_id", clientUploadId);
+    if (fileName === void 0) form.append("file", file);
+    else form.append("file", file, fileName);
+    return this.request("POST", `${path(id)}/attachments`, { body: form });
+  }
+  /**
+   * Fetch a file once its scan is clean. Refused with `support_attachment_checking` while
+   * the scan runs, and `support_attachment_blocked` after a block.
+   * `GET /support/conversations/{id}/attachments/{fileId}`
+   */
+  async downloadAttachment(id, fileId) {
+    return this.request("GET", `${path(id)}/attachments/${encodeURIComponent(fileId)}`, {
+      responseType: "blob"
+    });
+  }
+  /**
+   * Clear the merchant's unread mark and read the conversation as it is now.
+   * Someone acting as somebody else leaves the mark in place.
+   * `POST /support/conversations/{id}/read`
+   */
+  async markRead(id) {
+    return this.request("POST", `${path(id)}/read`);
+  }
+};
+
 // src/resources/invoices.ts
 var Invoices = class {
   constructor(request) {
@@ -10721,8 +10843,8 @@ var LiveEventStream = class {
     return toLiveStreamEvent(dispatch.event, this._lastEventId, this._retry);
   }
 };
-async function openLiveStream(openStream, path, options = {}) {
-  const connection = await openStream(path, {
+async function openLiveStream(openStream, path2, options = {}) {
+  const connection = await openStream(path2, {
     ...options.lastEventId ? { lastEventId: options.lastEventId } : {},
     ...options.signal ? { signal: options.signal } : {},
     ...options.idleTimeoutMs !== void 0 ? { idleTimeoutMs: options.idleTimeoutMs } : {},
@@ -10909,8 +11031,8 @@ var ProcessorImports = class {
 
 // src/resources/deploymentBranding.ts
 function brandingAssetPath(asset, version) {
-  const path = `/branding/assets/${encodeURIComponent(asset)}`;
-  return version ? `${path}?v=${encodeURIComponent(version)}` : path;
+  const path2 = `/branding/assets/${encodeURIComponent(asset)}`;
+  return version ? `${path2}?v=${encodeURIComponent(version)}` : path2;
 }
 var Branding = class {
   constructor(request, baseUrl) {
@@ -11244,6 +11366,7 @@ var Delopay = class {
     this.costRules = new CostRules(request);
     this.externalRecords = new ExternalRecords(request);
     this.products = new Products(request);
+    this.support = new Support(request);
     this.invoices = new Invoices(request);
     this.invoiceSettings = new InvoiceSettingsResource(request);
     this.processorCosts = new ProcessorCosts(request);
@@ -11304,8 +11427,8 @@ var Delopay = class {
     return response;
   }
   /** `path` on the base URL, with the query string `query` makes. */
-  buildUrl(path, query) {
-    let url = `${this.baseUrl}${path}`;
+  buildUrl(path2, query) {
+    let url = `${this.baseUrl}${path2}`;
     if (query) {
       const params = new URLSearchParams();
       for (const [key, value] of Object.entries(query)) {
@@ -11375,8 +11498,8 @@ var Delopay = class {
    * on a 2xx that is not `text/event-stream` (code `NOT_EVENT_STREAM`), and
    * with `TIMEOUT`, `NETWORK` or `ABORTED` like `request()`.
    */
-  async openEventStream(path, options = {}) {
-    const url = this.buildUrl(path, options.query);
+  async openEventStream(path2, options = {}) {
+    const url = this.buildUrl(path2, options.query);
     const lastEventId = options.lastEventId ?? "";
     const headers = {
       ...this.authHeaders(),
@@ -11416,7 +11539,7 @@ var Delopay = class {
       `Network error: ${cause instanceof Error ? cause.message : String(cause ?? "stream failed")}`,
       { status: 0, code: "NETWORK", type: "network_error" }
     );
-    this.log("request", { method: "GET", url: redactUrlForLogging(url), path });
+    this.log("request", { method: "GET", url: redactUrlForLogging(url), path: path2 });
     startIdleTimer();
     let response;
     try {
@@ -11428,7 +11551,7 @@ var Delopay = class {
       throw network(err);
     }
     const requestId = response.headers?.get("x-request-id") ?? response.headers?.get("x-trace-id") ?? void 0;
-    this.log("response", { status: response.status, method: "GET", path, requestId });
+    this.log("response", { status: response.status, method: "GET", path: path2, requestId });
     if (!response.ok) {
       const error = await errorFromResponse(response, requestId);
       release();
@@ -11514,8 +11637,8 @@ var Delopay = class {
    * @throws {DelopayAuthenticationError} On 401 responses.
    * @throws {DelopayError} On all other non-2xx responses, timeouts, and network errors.
    */
-  async request(method, path, options) {
-    const url = this.buildUrl(path, options?.query);
+  async request(method, path2, options) {
+    const url = this.buildUrl(path2, options?.query);
     let headers = {
       ...this.authHeaders(),
       ...this.profileHeaders(options?.headers),
@@ -11579,7 +11702,7 @@ var Delopay = class {
         const delay = Math.max(retryAfterOverrideMs ?? 0, jittered);
         retryAfterOverrideMs = null;
         await new Promise((resolve) => setTimeout(resolve, delay));
-        emit("retry", { attempt, maxRetries: this.maxRetries, method, path });
+        emit("retry", { attempt, maxRetries: this.maxRetries, method, path: path2 });
       }
       const timeoutCtrl = new AbortController();
       let timeoutId = setTimeout(() => timeoutCtrl.abort(), timeoutMs);
@@ -11592,7 +11715,7 @@ var Delopay = class {
         callerSignal ? [timeoutCtrl.signal, callerSignal] : [timeoutCtrl.signal]
       );
       try {
-        emit("request", { method, url: safeUrl(), path });
+        emit("request", { method, url: safeUrl(), path: path2 });
         const response = await fetch(url, {
           method,
           headers,
@@ -11601,7 +11724,7 @@ var Delopay = class {
           ...options?.keepalive !== void 0 ? { keepalive: options.keepalive } : {}
         });
         const requestId = response.headers?.get("x-request-id") ?? response.headers?.get("x-trace-id") ?? void 0;
-        emit("response", { status: response.status, method, path, requestId });
+        emit("response", { status: response.status, method, path: path2, requestId });
         if (!response.ok) {
           const error = await errorFromResponse(response, requestId);
           const isTransientStatus = response.status >= 500 || response.status === 429;
@@ -16933,7 +17056,7 @@ function encodePanes(panes) {
 var OPAQUE_PAYMENT_LINK_ID = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/;
 function focusedCheckoutUrl(params) {
   const base = params.checkoutBaseUrl.replace(/\/+$/, "");
-  const path = params.paymentLinkId && OPAQUE_PAYMENT_LINK_ID.test(params.paymentLinkId) ? `${base}/pay/${params.paymentLinkId}` : `${base}/pay/${encodeURIComponent(params.merchantId)}/${encodeURIComponent(
+  const path2 = params.paymentLinkId && OPAQUE_PAYMENT_LINK_ID.test(params.paymentLinkId) ? `${base}/pay/${params.paymentLinkId}` : `${base}/pay/${encodeURIComponent(params.merchantId)}/${encodeURIComponent(
     params.paymentId
   )}`;
   const query = new URLSearchParams({ pane: params.method });
@@ -16943,16 +17066,16 @@ function focusedCheckoutUrl(params) {
   if (merchantConnectorId) query.set("mca", merchantConnectorId);
   if (params.locale) query.set("locale", params.locale);
   if (params.customFieldsCollected) query.set("cf", "1");
-  return `${path}?${query.toString()}`;
+  return `${path2}?${query.toString()}`;
 }
 function checkoutEntryUrl(params) {
   const base = params.checkoutBaseUrl.replace(/\/+$/, "");
-  const path = params.paymentLinkId && OPAQUE_PAYMENT_LINK_ID.test(params.paymentLinkId) ? `${base}/pay/${params.paymentLinkId}` : `${base}/pay/${encodeURIComponent(params.merchantId)}/${encodeURIComponent(
+  const path2 = params.paymentLinkId && OPAQUE_PAYMENT_LINK_ID.test(params.paymentLinkId) ? `${base}/pay/${params.paymentLinkId}` : `${base}/pay/${encodeURIComponent(params.merchantId)}/${encodeURIComponent(
     params.paymentId
   )}`;
   const query = new URLSearchParams({ entry: params.entry.trim() });
   if (params.locale) query.set("locale", params.locale);
-  return `${path}?${query.toString()}`;
+  return `${path2}?${query.toString()}`;
 }
 function isCheckoutOpenEntryMessage(data) {
   if (typeof data !== "object" || data === null) return false;
@@ -17135,6 +17258,7 @@ var encodeNativePanes = encodePanes;
   Settlement,
   ShopLabels,
   Subscriptions,
+  Support,
   UNKNOWN_SECTION_ORDER,
   WCAG_AA_TEXT,
   WCAG_AA_UI,