@delopay/sdk 0.266.0 → 0.269.0

package/dist/index.cjs

@@ -44,6 +44,7 @@ __export(index_exports, {
   BUILTIN_PAYMENT_ICON_KEYS: () => BUILTIN_PAYMENT_ICON_KEYS,
   BuyerBlocklist: () => BuyerBlocklist,
   BuyerConversations: () => BuyerConversations,
+  BuyerEvidenceReviews: () => BuyerEvidenceReviews,
   CARD_FIELD_CHROMES: () => CARD_FIELD_CHROMES,
   CARD_FIELD_FONT_SIZES: () => CARD_FIELD_FONT_SIZES,
   CARD_FIELD_WEIGHTS: () => CARD_FIELD_WEIGHTS,
@@ -134,6 +135,7 @@ __export(index_exports, {
   SellToRestrictions: () => SellToRestrictions,
   Settings: () => Settings,
   Settlement: () => Settlement,
+  ShopLabels: () => ShopLabels,
   Subscriptions: () => Subscriptions,
   UNKNOWN_SECTION_ORDER: () => UNKNOWN_SECTION_ORDER,
   WCAG_AA_TEXT: () => WCAG_AA_TEXT,
@@ -2916,6 +2918,35 @@ var Payments = class {
       body: params
     });
   }
+  /**
+   * Abort a payment nobody has paid. The payment becomes `aborted`: its hosted
+   * checkout stops taking payments, a confirm is refused, and it can no longer
+   * be reactivated. Every processor object a buyer could still pay is closed
+   * where the processor allows it, and a `payment_aborted` webhook is sent.
+   *
+   * A success the processor confirms later still moves the payment to
+   * `succeeded`, so the order can be fulfilled or refunded. Aborting an
+   * aborted payment returns it unchanged. A payment that took money, holds an
+   * authorisation or awaits a merchant decision is refused with `IR_16`
+   * (HTTP 400).
+   *
+   * `POST /payments/{paymentId}/abort`
+   *
+   * @param paymentId - The payment intent ID to abort.
+   * @param params - Optional `reason`, at most 255 characters, stored as the
+   *   attempt's cancellation reason (`merchant_aborted` when absent).
+   * @returns The payment, with status `aborted`.
+   *
+   * @example
+   * ```typescript
+   * const payment = await delopay.payments.abort('pay_123', { reason: 'order_cancelled' });
+   * ```
+   */
+  async abort(paymentId, params) {
+    return this.request("POST", `/payments/${encodeURIComponent(paymentId)}/abort`, {
+      body: params ?? {}
+    });
+  }
   /**
    * List payment intents, optionally filtered by customer or date range.
    *
@@ -5925,6 +5956,63 @@ var BuyerBlocklist = class {
   }
 };
 
+// src/resources/shopLabels.ts
+var labelsPath = (merchantId) => `/account/${encodeURIComponent(merchantId)}/business-profile/labels`;
+var ShopLabels = class {
+  constructor(request) {
+    this.request = request;
+  }
+  /**
+   * Every label of the merchant, ordered by name, each with the ids of the
+   * shops that carry it. A shop with several labels appears under each of
+   * them; a shop with none appears under no label. A caller limited to one
+   * shop sees every label but only its own shop in `profile_ids`.
+   * `GET /account/{merchantId}/business-profile/labels`
+   */
+  async list(merchantId) {
+    return this.request("GET", labelsPath(merchantId));
+  }
+  /**
+   * Create a label. The name is trimmed and inner whitespace collapsed; a
+   * name that differs from an existing label only in letter case is refused
+   * (`IR_38`), so one category is never spelled two ways. A merchant holds at
+   * most 200 labels.
+   * `POST /account/{merchantId}/business-profile/labels`
+   */
+  async create(merchantId, params) {
+    return this.request("POST", labelsPath(merchantId), { body: params });
+  }
+  /**
+   * Rename a label on every shop that carries it.
+   * `PATCH /account/{merchantId}/business-profile/labels/{labelId}`
+   */
+  async update(merchantId, labelId, params) {
+    return this.request("PATCH", `${labelsPath(merchantId)}/${encodeURIComponent(labelId)}`, {
+      body: params
+    });
+  }
+  /**
+   * Delete a label and remove it from every shop. The shops are unchanged.
+   * `DELETE /account/{merchantId}/business-profile/labels/{labelId}`
+   */
+  async delete(merchantId, labelId) {
+    return this.request("DELETE", `${labelsPath(merchantId)}/${encodeURIComponent(labelId)}`);
+  }
+  /**
+   * Replace the labels of one shop: `label_ids` is the complete set
+   * afterwards, so a label left out is removed from the shop and an empty
+   * list removes them all. At most 20 per shop.
+   * `PUT /account/{merchantId}/business-profile/{profileId}/labels`
+   */
+  async setForShop(merchantId, profileId, params) {
+    return this.request(
+      "PUT",
+      `/account/${encodeURIComponent(merchantId)}/business-profile/${encodeURIComponent(profileId)}/labels`,
+      { body: params }
+    );
+  }
+};
+
 // src/resources/buyerConversations.ts
 var BuyerConversations = class {
   constructor(request) {
@@ -5992,6 +6080,60 @@ var BuyerConversations = class {
   }
 };
 
+// src/resources/buyerEvidenceReviews.ts
+var BuyerEvidenceReviews = class {
+  constructor(request) {
+    this.request = request;
+  }
+  /**
+   * The shop's cases with buyer evidence, the nearest target first.
+   * `merchant_id` and `reviewer` are ignored here. `GET /buyer-evidence`
+   */
+  async list(params) {
+    return this.request("GET", "/buyer-evidence", {
+      query: params
+    });
+  }
+  /** One case's evidence with its history and files. `GET /buyer-evidence/{id}` */
+  async retrieve(evidenceId) {
+    return this.request("GET", `/buyer-evidence/${encodeURIComponent(evidenceId)}`);
+  }
+  /** Download a file of a case's evidence. */
+  async downloadFile(evidenceId, fileId) {
+    return this.request(
+      "GET",
+      `/buyer-evidence/${encodeURIComponent(evidenceId)}/files/${encodeURIComponent(fileId)}`,
+      { responseType: "blob" }
+    );
+  }
+  /** Ask the buyer for more, by a cut-off. Refused once a result closed the review. */
+  async requestInformation(evidenceId, params) {
+    return this.request(
+      "POST",
+      `/buyer-evidence/${encodeURIComponent(evidenceId)}/information-requests`,
+      { body: params }
+    );
+  }
+  /** An answer the buyer sees. */
+  async reply(evidenceId, params) {
+    return this.request("POST", `/buyer-evidence/${encodeURIComponent(evidenceId)}/replies`, {
+      body: params
+    });
+  }
+  /** Record the result, which closes the review. */
+  async review(evidenceId, params) {
+    return this.request("POST", `/buyer-evidence/${encodeURIComponent(evidenceId)}/reviews`, {
+      body: params
+    });
+  }
+  /** A note the shop's team and DeloPay read, never the buyer. */
+  async note(evidenceId, params) {
+    return this.request("POST", `/buyer-evidence/${encodeURIComponent(evidenceId)}/notes`, {
+      body: params
+    });
+  }
+};
+
 // src/resources/checkoutRecovery.ts
 var CheckoutRecovery = class {
   constructor(request) {
@@ -7609,6 +7751,17 @@ var BuyerAccount = class {
   async getSession(options) {
     return this.request("GET", "/buyer-account/session", { ...options });
   }
+  /**
+   * What the buyer is mailed about: a reply from a shop's team they have not
+   * read, and news in their refund requests and disputes.
+   */
+  async noticeSettings(options) {
+    return this.request("GET", "/buyer-account/notice-settings", { ...options });
+  }
+  /** Turn either mail on or off for the buyer, at every shop. */
+  async setNoticeSettings(params, options) {
+    return this.request("PUT", "/buyer-account/notice-settings", { body: params, ...options });
+  }
   /** End the current session. */
   async signOut(options) {
     return this.request("DELETE", "/buyer-account/session", { ...options });
@@ -7743,6 +7896,78 @@ var BuyerAccount = class {
       ...options
     });
   }
+  /**
+   * A case's evidence: what may be handed in and by when, the files saved
+   * and handed in, and what the reviewer said. Opened on the first read
+   * while the case still waits.
+   * The case is one of a confirmed record's, named by the `record` its
+   * purchases carry and the case id the case list shows.
+   */
+  async caseEvidence(record, caseId, options) {
+    return this.request(
+      "GET",
+      `/buyer-account/records/${encodeURIComponent(record)}/cases/${encodeURIComponent(caseId)}/evidence`,
+      { ...options }
+    );
+  }
+  /**
+   * Upload a file for a case. It is saved, not handed in, until a
+   * submission takes it. Uploading again with the same `clientUploadId`
+   * returns the file the first upload stored, also after the cut-off.
+   */
+  async uploadEvidenceFile(record, caseId, file, clientUploadId, options) {
+    const { fileName, ...extras } = options ?? {};
+    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",
+      `/buyer-account/records/${encodeURIComponent(record)}/cases/${encodeURIComponent(caseId)}/evidence/files`,
+      { body: form, ...extras }
+    );
+  }
+  /** Download a file of the case's evidence. */
+  async downloadEvidenceFile(record, caseId, fileId, options) {
+    return this.request(
+      "GET",
+      `/buyer-account/records/${encodeURIComponent(record)}/cases/${encodeURIComponent(caseId)}/evidence/files/${encodeURIComponent(fileId)}`,
+      {
+        responseType: "blob",
+        ...options
+      }
+    );
+  }
+  /** Remove a saved file. A file a submission took stays. */
+  async removeEvidenceFile(record, caseId, fileId, options) {
+    return this.request(
+      "DELETE",
+      `/buyer-account/records/${encodeURIComponent(record)}/cases/${encodeURIComponent(caseId)}/evidence/files/${encodeURIComponent(fileId)}`,
+      {
+        ...options
+      }
+    );
+  }
+  /**
+   * Hand in an explanation, saved files or both, while the buyer's window
+   * is open. Sending again with the same `client_submission_id` returns the
+   * submission the first send stored.
+   */
+  async submitEvidence(record, caseId, params, options) {
+    return this.request(
+      "POST",
+      `/buyer-account/records/${encodeURIComponent(record)}/cases/${encodeURIComponent(caseId)}/evidence/submissions`,
+      { body: params, ...options }
+    );
+  }
+  /** Ask for more time, once until the cut-off is next set. */
+  async requestEvidenceExtension(record, caseId, params, options) {
+    return this.request(
+      "POST",
+      `/buyer-account/records/${encodeURIComponent(record)}/cases/${encodeURIComponent(caseId)}/evidence/extension-requests`,
+      { body: params, ...options }
+    );
+  }
 };
 
 // src/resources/buyerPortal.ts
@@ -7761,6 +7986,74 @@ var BuyerPortal = class {
   async listCases(options) {
     return this.request("GET", "/buyer-portal/cases", { ...options });
   }
+  /**
+   * A case's evidence: what may be handed in and by when, the files saved
+   * and handed in, and what the reviewer said. Opened on the first read
+   * while the case still waits.
+   */
+  async caseEvidence(caseId, options) {
+    return this.request("GET", `/buyer-portal/cases/${encodeURIComponent(caseId)}/evidence`, {
+      ...options
+    });
+  }
+  /**
+   * Upload a file for a case. It is saved, not handed in, until a
+   * submission takes it. Uploading again with the same `clientUploadId`
+   * returns the file the first upload stored, also after the cut-off.
+   */
+  async uploadEvidenceFile(caseId, file, clientUploadId, options) {
+    const { fileName, ...extras } = options ?? {};
+    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",
+      `/buyer-portal/cases/${encodeURIComponent(caseId)}/evidence/files`,
+      { body: form, ...extras }
+    );
+  }
+  /** Download a file of the case's evidence. */
+  async downloadEvidenceFile(caseId, fileId, options) {
+    return this.request(
+      "GET",
+      `/buyer-portal/cases/${encodeURIComponent(caseId)}/evidence/files/${encodeURIComponent(fileId)}`,
+      {
+        responseType: "blob",
+        ...options
+      }
+    );
+  }
+  /** Remove a saved file. A file a submission took stays. */
+  async removeEvidenceFile(caseId, fileId, options) {
+    return this.request(
+      "DELETE",
+      `/buyer-portal/cases/${encodeURIComponent(caseId)}/evidence/files/${encodeURIComponent(fileId)}`,
+      {
+        ...options
+      }
+    );
+  }
+  /**
+   * Hand in an explanation, saved files or both, while the buyer's window
+   * is open. Sending again with the same `client_submission_id` returns the
+   * submission the first send stored.
+   */
+  async submitEvidence(caseId, params, options) {
+    return this.request(
+      "POST",
+      `/buyer-portal/cases/${encodeURIComponent(caseId)}/evidence/submissions`,
+      { body: params, ...options }
+    );
+  }
+  /** Ask for more time, once until the cut-off is next set. */
+  async requestEvidenceExtension(caseId, params, options) {
+    return this.request(
+      "POST",
+      `/buyer-portal/cases/${encodeURIComponent(caseId)}/evidence/extension-requests`,
+      { body: params, ...options }
+    );
+  }
   /**
    * The buyer's conversations with the shop, the latest message first. A
    * portal link for the whole merchant lists one per shop and mode.
@@ -8922,7 +9215,9 @@ var Delopay = class {
     this.availabilityOverrides = new AvailabilityOverrides(request);
     this.sellToRestrictions = new SellToRestrictions(request);
     this.buyerBlocklist = new BuyerBlocklist(request);
+    this.shopLabels = new ShopLabels(request);
     this.buyerConversations = new BuyerConversations(request);
+    this.buyerEvidence = new BuyerEvidenceReviews(request);
     this.checkoutRecovery = new CheckoutRecovery(request);
     this.costRules = new CostRules(request);
     this.externalRecords = new ExternalRecords(request);
@@ -12708,15 +13003,11 @@ var CheckoutSession = class {
     });
   }
   /**
-   * The PayPal order for the payment's e-Payouts access code, from the PayPal
-   * SDK's `createOrder` on an experimental PayPal SDK pane — after the payment
-   * was confirmed through that pane, which mints the code.
-   *
-   * The router reads the order off e-Payouts' own PayPal page for the code, so
-   * `amount` and `currency` are what e-Payouts charges for it. Repeated calls
-   * answer the same order, so a cancelled PayPal popup is retried with the same
-   * code. When `captured` is `true` a capture was already reported: create no
-   * order and wait for the payment's status instead.
+   * The PayPal order e-Payouts created for the payment, for the PayPal SDK's
+   * `createOrder` on the PayPal Express or Pay with card pane, after the payment
+   * was confirmed through that pane. Return `order_id` from `createOrder` and
+   * send the buyer to `approve_url` once PayPal approved it; without an order,
+   * or when PayPal's button cannot be drawn, send the buyer to `redirect_url`.
    *
    * `POST /payment-link/{merchantId}/{paymentId}/epayouts/paypal-order`
    */
@@ -13743,6 +14034,7 @@ var encodeNativePanes = encodePanes;
   BUILTIN_PAYMENT_ICON_KEYS,
   BuyerBlocklist,
   BuyerConversations,
+  BuyerEvidenceReviews,
   CARD_FIELD_CHROMES,
   CARD_FIELD_FONT_SIZES,
   CARD_FIELD_WEIGHTS,
@@ -13833,6 +14125,7 @@ var encodeNativePanes = encodePanes;
   SellToRestrictions,
   Settings,
   Settlement,
+  ShopLabels,
   Subscriptions,
   UNKNOWN_SECTION_ORDER,
   WCAG_AA_TEXT,