@delopay/sdk 0.211.0 → 0.213.0

package/dist/index.cjs

@@ -57,6 +57,7 @@ __export(index_exports, {
   CUSTOM_FIELD_VALUELESS_OPERATORS: () => CUSTOM_FIELD_VALUELESS_OPERATORS,
   Cards: () => Cards,
   CheckoutMethods: () => CheckoutMethods,
+  CheckoutRecovery: () => CheckoutRecovery,
   CheckoutSession: () => CheckoutSession,
   CostRules: () => CostRules,
   DEFAULT_BADGES: () => DEFAULT_BADGES,
@@ -5270,6 +5271,94 @@ var SellToRestrictions = class {
   }
 };
 
+// src/resources/checkoutRecovery.ts
+var CheckoutRecovery = class {
+  constructor(request) {
+    this.request = request;
+  }
+  /**
+   * A checkout's recovery: whether and when the rule reminds it, every reason
+   * it does not, every message about it, and where its link goes. Any payment
+   * of the checkout may be named.
+   * `GET /checkout-recovery/payments/{payment_id}`
+   */
+  async retrieve(paymentId) {
+    return this.request("GET", `/checkout-recovery/payments/${encodeURIComponent(paymentId)}`);
+  }
+  /**
+   * No automatic reminder about this checkout from now on.
+   * `POST /checkout-recovery/payments/{payment_id}/stop`
+   */
+  async stop(paymentId) {
+    return this.request(
+      "POST",
+      `/checkout-recovery/payments/${encodeURIComponent(paymentId)}/stop`
+    );
+  }
+  /**
+   * Undo `stop`.
+   * `POST /checkout-recovery/payments/{payment_id}/resume`
+   */
+  async resume(paymentId) {
+    return this.request(
+      "POST",
+      `/checkout-recovery/payments/${encodeURIComponent(paymentId)}/resume`
+    );
+  }
+  /**
+   * A message by hand as it would be sent now: recipient, sender, text, link
+   * and destination, and why it would be refused. Nothing is sent.
+   * `POST /checkout-recovery/payments/{payment_id}/email/preview`
+   */
+  async previewEmail(paymentId, params) {
+    return this.request(
+      "POST",
+      `/checkout-recovery/payments/${encodeURIComponent(paymentId)}/email/preview`,
+      { body: params }
+    );
+  }
+  /**
+   * Send a message by hand, once per `idempotency_key`, composed again from
+   * the checkout as it is now. Refused when the checkout was paid or is being
+   * paid, was cancelled, the buyer unsubscribed, or no payment method could
+   * pay it.
+   * `POST /checkout-recovery/payments/{payment_id}/email`
+   */
+  async sendEmail(paymentId, params) {
+    return this.request(
+      "POST",
+      `/checkout-recovery/payments/${encodeURIComponent(paymentId)}/email`,
+      { body: params, bodyIdempotencyKey: params.idempotency_key ?? null }
+    );
+  }
+  /**
+   * Messages to buyers, newest first.
+   * `GET /checkout-recovery/reminders`
+   */
+  async listReminders(params) {
+    if (params) {
+      return this.request("GET", "/checkout-recovery/reminders", { query: { ...params } });
+    }
+    return this.request("GET", "/checkout-recovery/reminders");
+  }
+  /**
+   * The shop's recent checkouts judged under a rule (the stored one, or the
+   * one given) as if switched on, with every reason. Nothing is sent.
+   * `POST /checkout-recovery/candidates`
+   */
+  async previewCandidates(params = {}) {
+    return this.request("POST", "/checkout-recovery/candidates", { body: params });
+  }
+  /**
+   * A reminder with sample values, to the signed-in user's own address.
+   * Dashboard sessions only.
+   * `POST /checkout-recovery/test-email`
+   */
+  async sendTestEmail(params) {
+    return this.request("POST", "/checkout-recovery/test-email", { body: params });
+  }
+};
+
 // src/resources/costRules.ts
 var CostRules = class {
   constructor(request) {
@@ -6024,6 +6113,36 @@ var Invoices = class {
       ...options
     });
   }
+  /**
+   * Mail an issued invoice to the buyer address it carries, its PDF attached,
+   * in the document's language. Each call is a new message (the next
+   * `revision`) and resolves with what became of it: `sent`, or `failed` with
+   * `error_code`. Refused (`IR_16`) with `not_an_invoice` (a credit note),
+   * `not_issued`, `no_buyer_email`, `send_in_progress` (an earlier message is
+   * queued or being sent) and `send_limit_reached` (5 sends by hand in 24
+   * hours). Shops with the `email.invoice_auto_send` setting mail every
+   * invoice they issue without this call.
+   *
+   * The merchant's daily sending limit is **not** a refusal: the call answers
+   * with the message `failed` and `error_code: 'merchant_limit_reached'`.
+   * Check `status` on the result, not only that the call succeeded.
+   * `POST /invoices/{invoice_id}/email`
+   */
+  async sendEmail(invoiceId, options) {
+    return this.request("POST", `/invoices/${encodeURIComponent(invoiceId)}/email`, {
+      ...options
+    });
+  }
+  /**
+   * Every message about a document to its buyer, automatic and by hand,
+   * newest first, with its delivery status. The recipient is masked.
+   * `GET /invoices/{invoice_id}/emails`
+   */
+  async listEmails(invoiceId, options) {
+    return this.request("GET", `/invoices/${encodeURIComponent(invoiceId)}/emails`, {
+      ...options
+    });
+  }
 };
 
 // src/resources/invoiceSettings.ts
@@ -7702,6 +7821,7 @@ var Delopay = class {
     this.regions = new Regions(request);
     this.availabilityOverrides = new AvailabilityOverrides(request);
     this.sellToRestrictions = new SellToRestrictions(request);
+    this.checkoutRecovery = new CheckoutRecovery(request);
     this.costRules = new CostRules(request);
     this.externalRecords = new ExternalRecords(request);
     this.products = new Products(request);
@@ -11722,6 +11842,7 @@ var encodeNativePanes = encodePanes;
   CUSTOM_FIELD_VALUELESS_OPERATORS,
   Cards,
   CheckoutMethods,
+  CheckoutRecovery,
   CheckoutSession,
   CostRules,
   DEFAULT_BADGES,