@delopay/sdk 0.189.0 → 0.190.0

package/dist/index.cjs

@@ -5278,6 +5278,25 @@ var Products = class {
       query: { ...query }
     });
   }
+  /**
+   * Which active prices of the named recurring products can start a
+   * subscription on the shop's billing processor account, in the environment
+   * the account is in now. `GET /products/billing-readiness`
+   *
+   * Reads only; subscribing still checks the processor's price before
+   * anything is billed. Unknown ids, one-time products and archived prices
+   * are left out of the answer.
+   *
+   * @param productIds - 1 to 100 product ids.
+   * @param profileId - The shop the products belong to.
+   */
+  async billingReadiness(productIds, profileId, options) {
+    return this.request("GET", "/products/billing-readiness", {
+      ...this.scoped(profileId, options),
+      // One comma-separated value, as the route reads it — not repeated keys.
+      query: { product_ids: productIds.join(",") }
+    });
+  }
   /**
    * Change a product's name, description, image, metadata or category
    * (`category_id: null` makes it uncategorized).
@@ -5927,6 +5946,31 @@ var Subscriptions = class {
       ...options
     });
   }
+  /**
+   * {@link getItems}, with whether the list is only the first part of what the
+   * processor holds. `GET /subscriptions/items`
+   *
+   * The backend states that in the `X-Delopay-Items-Truncated` response
+   * header (Stripe Billing lists its first 100 products), which the plain
+   * {@link getItems} cannot return. Without `limit` and `offset` every item
+   * the billing account offers is listed, up to 500.
+   */
+  async getItemsPage(params, options) {
+    let truncated = false;
+    const items = await this.request(
+      "GET",
+      "/subscriptions/items",
+      {
+        query: params,
+        ...options,
+        onDownloadProgress: (event) => {
+          truncated = event.headers.get("x-delopay-items-truncated")?.toLowerCase() === "true";
+          options?.onDownloadProgress?.(event);
+        }
+      }
+    );
+    return { items, truncated };
+  }
   /**
    * Pause a subscription. `POST /subscriptions/{subscriptionId}/pause`
    *
@@ -5947,13 +5991,64 @@ var Subscriptions = class {
       ...options
     });
   }
-  /** Cancel a subscription. `POST /subscriptions/{subscriptionId}/cancel` */
+  /**
+   * Cancel a subscription. `POST /subscriptions/{subscriptionId}/cancel`
+   *
+   * A subscription in a state it cannot be cancelled from is refused with
+   * `DE_11`; `error.data.reason` then names why (`SubscriptionActionRefusal`).
+   */
   async cancel(subscriptionId, params, options) {
     return this.request("POST", `/subscriptions/${encodeURIComponent(subscriptionId)}/cancel`, {
       body: params ?? {},
       ...options
     });
   }
+  /**
+   * Read 1 to 50 subscriptions back from their billing processor and mirror
+   * what it reports. `POST /subscriptions/sync`
+   *
+   * Nothing is written at the processor. A status is mirrored only with the
+   * time the processor stamped it with, and never over a newer event already
+   * recorded; a plan only with its own stamp. One result per id, in request
+   * order; one that fails does not stop the others.
+   */
+  async sync(params, options) {
+    return this.request("POST", "/subscriptions/sync", { body: params, ...options });
+  }
+  /**
+   * Read one subscription back from its billing processor and mirror what it
+   * reports, as {@link sync} does, with what the processor reported beside
+   * what the mirror now holds. `POST /subscriptions/{subscriptionId}/sync`
+   */
+  async syncOne(subscriptionId, options) {
+    return this.request("POST", `/subscriptions/${encodeURIComponent(subscriptionId)}/sync`, {
+      ...options
+    });
+  }
+  /**
+   * List the subscriptions a billing account holds at its processor, and how
+   * each relates to DeloPay's: already held, new (its buyer is a DeloPay
+   * customer), needing a customer, ended, or not adoptable here.
+   * `POST /subscriptions/import/preview`
+   *
+   * Reads only; nothing is written here or at the processor. Creem and
+   * Stripe Billing can be listed; PayPal cannot, which `capabilities` states
+   * (`reason_code: 'listing_unsupported'`).
+   */
+  async importPreview(params, options) {
+    return this.request("POST", "/subscriptions/import/preview", { body: params, ...options });
+  }
+  /**
+   * Take 1 to 25 processor subscriptions over, each through {@link adopt}
+   * with every one of its checks, one after another.
+   * `POST /subscriptions/import/apply`
+   *
+   * One result per selection, in request order; one refused does not stop
+   * the others.
+   */
+  async importApply(params, options) {
+    return this.request("POST", "/subscriptions/import/apply", { body: params, ...options });
+  }
   /**
    * Resolve which of the given payments were raised by a subscription.
    * `POST /subscriptions/payments/lookup`
@@ -10213,6 +10308,38 @@ var CheckoutSession = class {
       }
     );
   }
+  /**
+   * The status a buyer coming back from the processor's checkout may read:
+   * the subscription's status, and whether the processor has reported it yet
+   * (`awaiting_processor`). Construct the session with the `sub_…` id in the
+   * `paymentId` slot.
+   *
+   * Authenticated with the return token (`rt`) the return URL carried, sent as
+   * `Authorization: Bearer <rt>`. That token reads only this, for a day; it is
+   * never the client secret, which this call does not send.
+   *
+   * `GET /subscriptions/return-status/{merchantId}/{subscriptionId}`
+   */
+  async subscriptionReturnStatus(returnToken, options) {
+    if (!returnToken) {
+      throw new DelopayError("This call requires the return token (rt) from the return URL", {
+        status: 0,
+        code: "MISSING_CREDENTIAL",
+        type: "invalid_request"
+      });
+    }
+    return this.client.request(
+      "GET",
+      `/subscriptions/return-status/${encodeURIComponent(this.merchantId)}/${encodeURIComponent(this.paymentId)}`,
+      {
+        ...options,
+        headers: {
+          ...withoutCredentialHeaders(options?.headers),
+          Authorization: `Bearer ${returnToken}`
+        }
+      }
+    );
+  }
   /**
    * Confirm a subscription (PayPal approval rail). The client secret is
    * attached automatically; the shop's profile id travels as the