@delopay/sdk 0.32.0 → 0.33.0

package/dist/index.d.cts

@@ -1900,6 +1900,8 @@ interface SubscriptionInvoice {
     status: InvoiceStatus;
     /** ID of this invoice on the billing processor (Stripe Billing / PayPal). */
     billing_processor_invoice_id?: string | null;
+    /** Connector (billing processor) this invoice was raised through, e.g. `paypal`. */
+    provider_name?: Connector | null;
 }
 /** A purchasable price option for a subscription item (plan or addon). */
 interface SubscriptionItemPrice {
@@ -2133,6 +2135,10 @@ interface SubscriptionEstimateResponse {
     coupon_code?: string | null;
     customer_id?: string | null;
     line_items: SubscriptionLineItem[];
+    /** Billing interval unit, when the connector exposes it. */
+    interval?: SubscriptionPeriodUnit | null;
+    /** Number of interval units per cycle, when known. */
+    interval_count?: number | null;
 }
 interface RegionCreateRequest {
     region_name: string;
@@ -3705,6 +3711,12 @@ declare class Regions {
     list(): Promise<RegionResponse[]>;
 }
 
+/**
+ * Subscription endpoints are profile-scoped: the backend requires an
+ * `X-Profile-Id` header to resolve the shop / billing processor (`IR_04`
+ * otherwise). Pass it through the per-call `options.headers`, e.g.
+ * `subscriptions.list(params, { headers: { 'X-Profile-Id': profileId } })`.
+ */
 declare class Subscriptions {
     private readonly request;
     constructor(request: RequestFn);
@@ -3714,32 +3726,32 @@ declare class Subscriptions {
      * For billing processors that require buyer approval (e.g. PayPal), the
      * response carries a `redirect_url` the customer must be sent to.
      */
-    createAndConfirm(params: CreateAndConfirmSubscriptionRequest): Promise<ConfirmSubscriptionResponse>;
+    createAndConfirm(params: CreateAndConfirmSubscriptionRequest, options?: RequestExtras): Promise<ConfirmSubscriptionResponse>;
     /** Create a subscription without confirming it. `POST /subscriptions/create` */
-    create(params: CreateSubscriptionRequest): Promise<SubscriptionResponse>;
+    create(params: CreateSubscriptionRequest, options?: RequestExtras): Promise<SubscriptionResponse>;
     /** Retrieve a subscription by ID. `GET /subscriptions/{subscriptionId}` */
-    retrieve(subscriptionId: string): Promise<SubscriptionResponse>;
+    retrieve(subscriptionId: string, options?: RequestExtras): Promise<SubscriptionResponse>;
     /**
      * 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.
      */
-    confirm(subscriptionId: string, params: ConfirmSubscriptionRequest): Promise<ConfirmSubscriptionResponse>;
+    confirm(subscriptionId: string, params: ConfirmSubscriptionRequest, options?: RequestExtras): Promise<ConfirmSubscriptionResponse>;
     /** Update a subscription's plan/price. `PUT /subscriptions/{subscriptionId}/update` */
-    update(subscriptionId: string, params: UpdateSubscriptionRequest): Promise<SubscriptionResponse>;
+    update(subscriptionId: string, params: UpdateSubscriptionRequest, options?: RequestExtras): Promise<SubscriptionResponse>;
     /** List subscriptions for the profile. `GET /subscriptions/list` */
-    list(params?: SubscriptionListParams): Promise<SubscriptionResponse[]>;
+    list(params?: SubscriptionListParams, options?: RequestExtras): Promise<SubscriptionResponse[]>;
     /** Estimate the cost of a subscription before creating it. `GET /subscriptions/estimate` */
-    getEstimate(params: SubscriptionEstimateParams): Promise<SubscriptionEstimateResponse>;
+    getEstimate(params: SubscriptionEstimateParams, options?: RequestExtras): Promise<SubscriptionEstimateResponse>;
     /** List purchasable subscription items (plans/addons). `GET /subscriptions/items` */
-    getItems(params: GetSubscriptionItemsParams): Promise<GetSubscriptionItemsResponse[]>;
+    getItems(params: GetSubscriptionItemsParams, options?: RequestExtras): Promise<GetSubscriptionItemsResponse[]>;
     /** Pause a subscription. `POST /subscriptions/{subscriptionId}/pause` */
-    pause(subscriptionId: string, params?: PauseSubscriptionRequest): Promise<PauseSubscriptionResponse>;
+    pause(subscriptionId: string, params?: PauseSubscriptionRequest, options?: RequestExtras): Promise<PauseSubscriptionResponse>;
     /** Resume a paused subscription. `POST /subscriptions/{subscriptionId}/resume` */
-    resume(subscriptionId: string, params?: ResumeSubscriptionRequest): Promise<ResumeSubscriptionResponse>;
+    resume(subscriptionId: string, params?: ResumeSubscriptionRequest, options?: RequestExtras): Promise<ResumeSubscriptionResponse>;
     /** Cancel a subscription. `POST /subscriptions/{subscriptionId}/cancel` */
-    cancel(subscriptionId: string, params?: CancelSubscriptionRequest): Promise<CancelSubscriptionResponse>;
+    cancel(subscriptionId: string, params?: CancelSubscriptionRequest, options?: RequestExtras): Promise<CancelSubscriptionResponse>;
 }
 
 /**

package/dist/index.d.ts

@@ -1900,6 +1900,8 @@ interface SubscriptionInvoice {
     status: InvoiceStatus;
     /** ID of this invoice on the billing processor (Stripe Billing / PayPal). */
     billing_processor_invoice_id?: string | null;
+    /** Connector (billing processor) this invoice was raised through, e.g. `paypal`. */
+    provider_name?: Connector | null;
 }
 /** A purchasable price option for a subscription item (plan or addon). */
 interface SubscriptionItemPrice {
@@ -2133,6 +2135,10 @@ interface SubscriptionEstimateResponse {
     coupon_code?: string | null;
     customer_id?: string | null;
     line_items: SubscriptionLineItem[];
+    /** Billing interval unit, when the connector exposes it. */
+    interval?: SubscriptionPeriodUnit | null;
+    /** Number of interval units per cycle, when known. */
+    interval_count?: number | null;
 }
 interface RegionCreateRequest {
     region_name: string;
@@ -3705,6 +3711,12 @@ declare class Regions {
     list(): Promise<RegionResponse[]>;
 }
 
+/**
+ * Subscription endpoints are profile-scoped: the backend requires an
+ * `X-Profile-Id` header to resolve the shop / billing processor (`IR_04`
+ * otherwise). Pass it through the per-call `options.headers`, e.g.
+ * `subscriptions.list(params, { headers: { 'X-Profile-Id': profileId } })`.
+ */
 declare class Subscriptions {
     private readonly request;
     constructor(request: RequestFn);
@@ -3714,32 +3726,32 @@ declare class Subscriptions {
      * For billing processors that require buyer approval (e.g. PayPal), the
      * response carries a `redirect_url` the customer must be sent to.
      */
-    createAndConfirm(params: CreateAndConfirmSubscriptionRequest): Promise<ConfirmSubscriptionResponse>;
+    createAndConfirm(params: CreateAndConfirmSubscriptionRequest, options?: RequestExtras): Promise<ConfirmSubscriptionResponse>;
     /** Create a subscription without confirming it. `POST /subscriptions/create` */
-    create(params: CreateSubscriptionRequest): Promise<SubscriptionResponse>;
+    create(params: CreateSubscriptionRequest, options?: RequestExtras): Promise<SubscriptionResponse>;
     /** Retrieve a subscription by ID. `GET /subscriptions/{subscriptionId}` */
-    retrieve(subscriptionId: string): Promise<SubscriptionResponse>;
+    retrieve(subscriptionId: string, options?: RequestExtras): Promise<SubscriptionResponse>;
     /**
      * 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.
      */
-    confirm(subscriptionId: string, params: ConfirmSubscriptionRequest): Promise<ConfirmSubscriptionResponse>;
+    confirm(subscriptionId: string, params: ConfirmSubscriptionRequest, options?: RequestExtras): Promise<ConfirmSubscriptionResponse>;
     /** Update a subscription's plan/price. `PUT /subscriptions/{subscriptionId}/update` */
-    update(subscriptionId: string, params: UpdateSubscriptionRequest): Promise<SubscriptionResponse>;
+    update(subscriptionId: string, params: UpdateSubscriptionRequest, options?: RequestExtras): Promise<SubscriptionResponse>;
     /** List subscriptions for the profile. `GET /subscriptions/list` */
-    list(params?: SubscriptionListParams): Promise<SubscriptionResponse[]>;
+    list(params?: SubscriptionListParams, options?: RequestExtras): Promise<SubscriptionResponse[]>;
     /** Estimate the cost of a subscription before creating it. `GET /subscriptions/estimate` */
-    getEstimate(params: SubscriptionEstimateParams): Promise<SubscriptionEstimateResponse>;
+    getEstimate(params: SubscriptionEstimateParams, options?: RequestExtras): Promise<SubscriptionEstimateResponse>;
     /** List purchasable subscription items (plans/addons). `GET /subscriptions/items` */
-    getItems(params: GetSubscriptionItemsParams): Promise<GetSubscriptionItemsResponse[]>;
+    getItems(params: GetSubscriptionItemsParams, options?: RequestExtras): Promise<GetSubscriptionItemsResponse[]>;
     /** Pause a subscription. `POST /subscriptions/{subscriptionId}/pause` */
-    pause(subscriptionId: string, params?: PauseSubscriptionRequest): Promise<PauseSubscriptionResponse>;
+    pause(subscriptionId: string, params?: PauseSubscriptionRequest, options?: RequestExtras): Promise<PauseSubscriptionResponse>;
     /** Resume a paused subscription. `POST /subscriptions/{subscriptionId}/resume` */
-    resume(subscriptionId: string, params?: ResumeSubscriptionRequest): Promise<ResumeSubscriptionResponse>;
+    resume(subscriptionId: string, params?: ResumeSubscriptionRequest, options?: RequestExtras): Promise<ResumeSubscriptionResponse>;
     /** Cancel a subscription. `POST /subscriptions/{subscriptionId}/cancel` */
-    cancel(subscriptionId: string, params?: CancelSubscriptionRequest): Promise<CancelSubscriptionResponse>;
+    cancel(subscriptionId: string, params?: CancelSubscriptionRequest, options?: RequestExtras): Promise<CancelSubscriptionResponse>;
 }
 
 /**

package/dist/index.js

@@ -41,7 +41,7 @@ import {
   shadowFor,
   surfacePadValue,
   verticalGapValue
-} from "./chunk-ML3Z6JBP.js";
+} from "./chunk-33ZLHH3I.js";
 export {
   Analytics,
   AnalyticsDashboard,

package/dist/internal.cjs

@@ -2611,16 +2611,18 @@ var Subscriptions = class {
    * 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 });
+  async createAndConfirm(params, options) {
+    return this.request("POST", "/subscriptions", { body: params, ...options });
   }
   /** Create a subscription without confirming it. `POST /subscriptions/create` */
-  async create(params) {
-    return this.request("POST", "/subscriptions/create", { body: params });
+  async create(params, options) {
+    return this.request("POST", "/subscriptions/create", { body: params, ...options });
   }
   /** Retrieve a subscription by ID. `GET /subscriptions/{subscriptionId}` */
-  async retrieve(subscriptionId) {
-    return this.request("GET", `/subscriptions/${encodeURIComponent(subscriptionId)}`);
+  async retrieve(subscriptionId, options) {
+    return this.request("GET", `/subscriptions/${encodeURIComponent(subscriptionId)}`, {
+      ...options
+    });
   }
   /**
    * Confirm a previously created subscription. `POST /subscriptions/{subscriptionId}/confirm`
@@ -2628,51 +2630,59 @@ var Subscriptions = class {
    * Like {@link createAndConfirm}, the response may carry a `redirect_url` for
    * processors that require buyer approval.
    */
-  async confirm(subscriptionId, params) {
+  async confirm(subscriptionId, params, options) {
     return this.request("POST", `/subscriptions/${encodeURIComponent(subscriptionId)}/confirm`, {
-      body: params
+      body: params,
+      ...options
     });
   }
   /** Update a subscription's plan/price. `PUT /subscriptions/{subscriptionId}/update` */
-  async update(subscriptionId, params) {
+  async update(subscriptionId, params, options) {
     return this.request("PUT", `/subscriptions/${encodeURIComponent(subscriptionId)}/update`, {
-      body: params
+      body: params,
+      ...options
     });
   }
   /** List subscriptions for the profile. `GET /subscriptions/list` */
-  async list(params) {
+  async list(params, options) {
     return this.request("GET", "/subscriptions/list", {
-      query: params
+      query: params,
+      ...options
     });
   }
   /** Estimate the cost of a subscription before creating it. `GET /subscriptions/estimate` */
-  async getEstimate(params) {
+  async getEstimate(params, options) {
     return this.request("GET", "/subscriptions/estimate", {
-      query: params
+      query: params,
+      ...options
     });
   }
   /** List purchasable subscription items (plans/addons). `GET /subscriptions/items` */
-  async getItems(params) {
+  async getItems(params, options) {
     return this.request("GET", "/subscriptions/items", {
-      query: params
+      query: params,
+      ...options
     });
   }
   /** Pause a subscription. `POST /subscriptions/{subscriptionId}/pause` */
-  async pause(subscriptionId, params) {
+  async pause(subscriptionId, params, options) {
     return this.request("POST", `/subscriptions/${encodeURIComponent(subscriptionId)}/pause`, {
-      body: params
+      body: params,
+      ...options
     });
   }
   /** Resume a paused subscription. `POST /subscriptions/{subscriptionId}/resume` */
-  async resume(subscriptionId, params) {
+  async resume(subscriptionId, params, options) {
     return this.request("POST", `/subscriptions/${encodeURIComponent(subscriptionId)}/resume`, {
-      body: params
+      body: params,
+      ...options
     });
   }
   /** Cancel a subscription. `POST /subscriptions/{subscriptionId}/cancel` */
-  async cancel(subscriptionId, params) {
+  async cancel(subscriptionId, params, options) {
     return this.request("POST", `/subscriptions/${encodeURIComponent(subscriptionId)}/cancel`, {
-      body: params
+      body: params,
+      ...options
     });
   }
 };