@salable/sdk 1.0.7 → 1.0.8

package/dist/sdk/models/index.d.ts

@@ -117,11 +117,11 @@ export interface BatchReceiptActionsResponseSchema_data_results extends Parsable
 export type BatchReceiptActionsResponseSchema_data_results_status = string;
 export interface BatchSubscriptionActionsRequestSchema extends Parsable {
     /**
-     * The action property
+     * The action to perform on all provided subscriptions. One of `cancel`, `enable-auto-renew`, `disable-auto-renew`, `delete`. The `delete` action is only available in test mode.
      */
     action?: BatchSubscriptionActionsRequestSchema_action | null;
     /**
-     * The subscriptionIds property
+     * The IDs of the subscriptions to apply the action to. Maximum of 100 IDs per request.
      */
     subscriptionIds?: string[] | null;
 }
@@ -2780,21 +2780,24 @@ export interface CreatePlanResponseSchema_data extends Parsable {
 }
 export interface CreatePortalRequestSchema extends Parsable {
     /**
-     * The features property
+     * The portal features to enable for this session.
      */
     features?: CreatePortalRequestSchema_features | null;
     /**
-     * The returnUrl property
+     * The URL to redirect customers to after they have finished managing their subscription in the portal.
      */
     returnUrl?: string | null;
 }
+/**
+ * The portal features to enable for this session.
+ */
 export interface CreatePortalRequestSchema_features extends Parsable {
     /**
      * Enables a customer to update their personal information.
      */
     customerUpdate?: CreatePortalRequestSchema_features_customerUpdate | null;
     /**
-     * Enables a customer to view invoice history.
+     * Enables a customer to view their invoice history.
      */
     invoiceHistory?: CreatePortalRequestSchema_features_invoiceHistory | null;
     /**
@@ -2802,7 +2805,7 @@ export interface CreatePortalRequestSchema_features extends Parsable {
      */
     paymentMethodUpdate?: CreatePortalRequestSchema_features_paymentMethodUpdate | null;
     /**
-     * The subscriptionCancel property
+     * Enables a customer to cancel their subscription.
      */
     subscriptionCancel?: CreatePortalRequestSchema_features_subscriptionCancel | null;
 }
@@ -2811,21 +2814,21 @@ export interface CreatePortalRequestSchema_features extends Parsable {
  */
 export interface CreatePortalRequestSchema_features_customerUpdate extends Parsable {
     /**
-     * Define what you want to allow customers to be able to update.
+     * The customer fields that can be updated. Accepted values: `name`, `email`, `address`, `phone`, `shipping`.
      */
     allowedUpdates?: CreatePortalRequestSchema_features_customerUpdate_allowedUpdates[] | null;
     /**
-     * The enabled property
+     * Whether to enable this feature in the portal.
      */
     enabled?: boolean | null;
 }
 export type CreatePortalRequestSchema_features_customerUpdate_allowedUpdates = (typeof CreatePortalRequestSchema_features_customerUpdate_allowedUpdatesObject)[keyof typeof CreatePortalRequestSchema_features_customerUpdate_allowedUpdatesObject];
 /**
- * Enables a customer to view invoice history.
+ * Enables a customer to view their invoice history.
  */
 export interface CreatePortalRequestSchema_features_invoiceHistory extends Parsable {
     /**
-     * The enabled property
+     * Whether to enable this feature in the portal.
      */
     enabled?: boolean | null;
 }
@@ -2834,17 +2837,20 @@ export interface CreatePortalRequestSchema_features_invoiceHistory extends Parsa
  */
 export interface CreatePortalRequestSchema_features_paymentMethodUpdate extends Parsable {
     /**
-     * The enabled property
+     * Whether to enable this feature in the portal.
      */
     enabled?: boolean | null;
 }
+/**
+ * Enables a customer to cancel their subscription.
+ */
 export interface CreatePortalRequestSchema_features_subscriptionCancel extends Parsable {
     /**
-     * The enabled property
+     * Whether to enable this feature in the portal.
      */
     enabled?: boolean | null;
     /**
-     * "now" - cancels the subscription immediately. "end" - schedules the subscription to cancel at the end of the billing period.
+     * `now` cancels the subscription immediately. `end` schedules cancellation at the end of the current billing period.
      */
     when?: CreatePortalRequestSchema_features_subscriptionCancel_when | null;
 }
@@ -17620,73 +17626,79 @@ export interface UpdateProductResponseSchema_data extends Parsable {
 }
 export interface UpdateSubscriptionItemsRequestSchema extends Parsable {
     /**
-     * The items property
+     * The list of plan changes to apply to the subscription.
      */
     items?: (UpdateSubscriptionItemsRequestSchema_itemsMember1 | UpdateSubscriptionItemsRequestSchema_itemsMember2 | UpdateSubscriptionItemsRequestSchema_itemsMember3)[] | null;
     /**
-     * The proration property
+     * Controls how Stripe handles proration when items change mid-billing-period. Required for paid subscriptions; not applicable to Salable-only subscriptions. One of `always_invoice`, `create_prorations`, `none`.
      */
     proration?: UpdateSubscriptionItemsRequestSchema_proration | null;
 }
 export type UpdateSubscriptionItemsRequestSchema_items = UpdateSubscriptionItemsRequestSchema_itemsMember1 | UpdateSubscriptionItemsRequestSchema_itemsMember2 | UpdateSubscriptionItemsRequestSchema_itemsMember3;
 export interface UpdateSubscriptionItemsRequestSchema_itemsMember1 extends Parsable {
     /**
-     * The action property
+     * Remove the specified plan from the subscription.
      */
     action?: string | null;
     /**
-     * The planId property
+     * The ID of the plan to act on.
      */
     planId?: string | null;
 }
 export interface UpdateSubscriptionItemsRequestSchema_itemsMember2 extends Parsable {
     /**
-     * The action property
+     * Add a new plan to the subscription.
      */
     action?: string | null;
     /**
-     * The grantee property
+     * Your internal identifier for the entity that will receive access to the added plan. Required for non-per-seat plans.
      */
     grantee?: string | null;
     /**
-     * The metadata property
+     * Per-line-item quantity overrides, keyed by line item ID.
      */
     metadata?: UpdateSubscriptionItemsRequestSchema_itemsMember2_metadata | null;
     /**
-     * The planId property
+     * The ID of the plan to act on.
      */
     planId?: string | null;
 }
+/**
+ * Per-line-item quantity overrides, keyed by line item ID.
+ */
 export interface UpdateSubscriptionItemsRequestSchema_itemsMember2_metadata extends AdditionalDataHolder, Parsable {
 }
 export interface UpdateSubscriptionItemsRequestSchema_itemsMember3 extends Parsable {
     /**
-     * The action property
+     * Replace the specified plan with a different plan, preserving the existing grantee group.
      */
     action?: string | null;
     /**
-     * The metadata property
+     * Per-line-item quantity overrides, keyed by line item ID.
      */
     metadata?: UpdateSubscriptionItemsRequestSchema_itemsMember3_metadata | null;
     /**
-     * The newPlanId property
+     * The ID of the plan to replace the existing plan with.
      */
     newPlanId?: string | null;
     /**
-     * The planId property
+     * The ID of the plan to act on.
      */
     planId?: string | null;
 }
+/**
+ * Per-line-item quantity overrides, keyed by line item ID.
+ */
 export interface UpdateSubscriptionItemsRequestSchema_itemsMember3_metadata extends AdditionalDataHolder, Parsable {
 }
 export type UpdateSubscriptionItemsRequestSchema_proration = (typeof UpdateSubscriptionItemsRequestSchema_prorationObject)[keyof typeof UpdateSubscriptionItemsRequestSchema_prorationObject];
 export interface UpdateSubscriptionPlanLineItemSchema extends Parsable {
     /**
-     * The proration property
+     * Controls how Stripe handles proration when the quantity changes mid-billing-period. One of `always_invoice`, `create_prorations`, `none`.
      */
     proration?: UpdateSubscriptionPlanLineItemSchema_proration | null;
     /**
-     * The quantity property
+     * The new quantity for this subscription plan line item. Must be within the line item's minimum and maximum allowed quantities, and cannot be less than the number of current grantees on the attached group.
      */
     quantity?: number | null;
 }
@@ -17708,6 +17720,9 @@ export declare const BatchCartActionsRequestSchema_actionObject: {
 export declare const BatchReceiptActionsRequestSchema_actionObject: {
     readonly Delete: "delete";
 };
+/**
+ * The action to perform on all provided subscriptions. One of `cancel`, `enable-auto-renew`, `disable-auto-renew`, `delete`. The `delete` action is only available in test mode.
+ */
 export declare const BatchSubscriptionActionsRequestSchema_actionObject: {
     readonly Cancel: "cancel";
     readonly EnableAutoRenew: "enable-auto-renew";
@@ -17874,7 +17889,7 @@ export declare const CreatePortalRequestSchema_features_customerUpdate_allowedUp
     readonly Shipping: "shipping";
 };
 /**
- * "now" - cancels the subscription immediately. "end" - schedules the subscription to cancel at the end of the billing period.
+ * `now` cancels the subscription immediately. `end` schedules cancellation at the end of the current billing period.
  */
 export declare const CreatePortalRequestSchema_features_subscriptionCancel_whenObject: {
     readonly Now: "now";
@@ -18385,11 +18400,17 @@ export declare const UpdateProductRequestSchema_settings_cardPrefillPreferenceOb
     readonly Always: "always";
     readonly Choice: "choice";
 };
+/**
+ * Controls how Stripe handles proration when items change mid-billing-period. Required for paid subscriptions; not applicable to Salable-only subscriptions. One of `always_invoice`, `create_prorations`, `none`.
+ */
 export declare const UpdateSubscriptionItemsRequestSchema_prorationObject: {
     readonly Always_invoice: "always_invoice";
     readonly Create_prorations: "create_prorations";
     readonly None: "none";
 };
+/**
+ * Controls how Stripe handles proration when the quantity changes mid-billing-period. One of `always_invoice`, `create_prorations`, `none`.
+ */
 export declare const UpdateSubscriptionPlanLineItemSchema_prorationObject: {
     readonly Always_invoice: "always_invoice";
     readonly Create_prorations: "create_prorations";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salable/sdk",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "description": "",
   "main": "dist/index.js",
   "module": "dist/index.es.js",