@delopay/sdk 0.31.0 → 0.32.0

package/dist/index.cjs

@@ -2594,11 +2594,16 @@ var Subscriptions = class {
   constructor(request) {
     this.request = request;
   }
-  /** Create and immediately confirm a subscription. `POST /subscriptions` */
+  /**
+   * Create and immediately confirm a subscription. `POST /subscriptions`
+   *
+   * For billing processors that require buyer approval (e.g. PayPal), the
+   * response carries a `redirect_url` the customer must be sent to.
+   */
   async createAndConfirm(params) {
     return this.request("POST", "/subscriptions", { body: params });
   }
-  /** Create a subscription (without confirming). `POST /subscriptions/create` */
+  /** Create a subscription without confirming it. `POST /subscriptions/create` */
   async create(params) {
     return this.request("POST", "/subscriptions/create", { body: params });
   }
@@ -2606,43 +2611,58 @@ var Subscriptions = class {
   async retrieve(subscriptionId) {
     return this.request("GET", `/subscriptions/${encodeURIComponent(subscriptionId)}`);
   }
-  /** Confirm a subscription. `POST /subscriptions/{subscriptionId}/confirm` */
+  /**
+   * Confirm a previously created subscription. `POST /subscriptions/{subscriptionId}/confirm`
+   *
+   * Like {@link createAndConfirm}, the response may carry a `redirect_url` for
+   * processors that require buyer approval.
+   */
   async confirm(subscriptionId, params) {
     return this.request("POST", `/subscriptions/${encodeURIComponent(subscriptionId)}/confirm`, {
       body: params
     });
   }
-  /** Update a subscription. `PUT /subscriptions/{subscriptionId}/update` */
+  /** Update a subscription's plan/price. `PUT /subscriptions/{subscriptionId}/update` */
   async update(subscriptionId, params) {
     return this.request("PUT", `/subscriptions/${encodeURIComponent(subscriptionId)}/update`, {
       body: params
     });
   }
-  /** List subscriptions. `GET /subscriptions/list` */
+  /** List subscriptions for the profile. `GET /subscriptions/list` */
   async list(params) {
     return this.request("GET", "/subscriptions/list", {
       query: params
     });
   }
-  /** Get subscription estimate. `GET /subscriptions/estimate` */
+  /** Estimate the cost of a subscription before creating it. `GET /subscriptions/estimate` */
   async getEstimate(params) {
-    return this.request("GET", "/subscriptions/estimate", { query: params });
+    return this.request("GET", "/subscriptions/estimate", {
+      query: params
+    });
   }
-  /** Get subscription items. `GET /subscriptions/items` */
+  /** List purchasable subscription items (plans/addons). `GET /subscriptions/items` */
   async getItems(params) {
-    return this.request("GET", "/subscriptions/items", { query: params });
+    return this.request("GET", "/subscriptions/items", {
+      query: params
+    });
   }
   /** Pause a subscription. `POST /subscriptions/{subscriptionId}/pause` */
-  async pause(subscriptionId) {
-    return this.request("POST", `/subscriptions/${encodeURIComponent(subscriptionId)}/pause`);
+  async pause(subscriptionId, params) {
+    return this.request("POST", `/subscriptions/${encodeURIComponent(subscriptionId)}/pause`, {
+      body: params
+    });
   }
-  /** Resume a subscription. `POST /subscriptions/{subscriptionId}/resume` */
-  async resume(subscriptionId) {
-    return this.request("POST", `/subscriptions/${encodeURIComponent(subscriptionId)}/resume`);
+  /** Resume a paused subscription. `POST /subscriptions/{subscriptionId}/resume` */
+  async resume(subscriptionId, params) {
+    return this.request("POST", `/subscriptions/${encodeURIComponent(subscriptionId)}/resume`, {
+      body: params
+    });
   }
   /** Cancel a subscription. `POST /subscriptions/{subscriptionId}/cancel` */
-  async cancel(subscriptionId) {
-    return this.request("POST", `/subscriptions/${encodeURIComponent(subscriptionId)}/cancel`);
+  async cancel(subscriptionId, params) {
+    return this.request("POST", `/subscriptions/${encodeURIComponent(subscriptionId)}/cancel`, {
+      body: params
+    });
   }
 };