@salable/sdk 1.0.15 → 1.0.17

package/dist/sdk/api/cartItems/index.d.ts

@@ -60,7 +60,7 @@ export interface CartItemsRequestBuilder extends BaseRequestBuilder<CartItemsReq
      */
     byId(id: string): CartItemsItemRequestBuilder;
     /**
-     * Create a cart item which will be linked to a plan. The plan is a collection of line items. To set metadata for a specific line item, use the metadata object with the key as the line item slug.
+     * Adds a plan to an existing cart. Each cart item represents one plan a customer intends to purchase.
      * @param body The request body
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<CartItemsPostResponse>}
@@ -72,7 +72,7 @@ export interface CartItemsRequestBuilder extends BaseRequestBuilder<CartItemsReq
      */
     post(body: CreateCartItemRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<CartItemsPostResponse | undefined>;
     /**
-     * Create a cart item which will be linked to a plan. The plan is a collection of line items. To set metadata for a specific line item, use the metadata object with the key as the line item slug.
+     * Adds a plan to an existing cart. Each cart item represents one plan a customer intends to purchase.
      * @param body The request body
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}

package/dist/sdk/api/carts/index.d.ts

@@ -17,7 +17,7 @@ export interface CartsRequestBuilder extends BaseRequestBuilder<CartsRequestBuil
      */
     byId(id: string): CartsItemRequestBuilder;
     /**
-     * List Carts
+     * Returns a list of active carts in reverse chronological order by creation date.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<GetCartListSchema>}
      * @throws {ErrorResponseBody} error when the service returns a 401 status code
@@ -27,7 +27,7 @@ export interface CartsRequestBuilder extends BaseRequestBuilder<CartsRequestBuil
      */
     get(requestConfiguration?: RequestConfiguration<CartsRequestBuilderGetQueryParameters> | undefined): Promise<GetCartListSchema | undefined>;
     /**
-     * Create Cart
+     * Creates a new Cart for the specified owner. A Cart supports multi-Plan purchases on a single Subscription which enables plugin and add-on pricing models. Carts may also be created without a grantee, this allows customer to assemble a purchase before signing up; the Cart can then be attached to their account at sign-in.
      * @param body The request body
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<CreateCartResponseSchema>}
@@ -39,13 +39,13 @@ export interface CartsRequestBuilder extends BaseRequestBuilder<CartsRequestBuil
      */
     post(body: CreateCartRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<CreateCartResponseSchema | undefined>;
     /**
-     * List Carts
+     * Returns a list of active carts in reverse chronological order by creation date.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}
      */
     toGetRequestInformation(requestConfiguration?: RequestConfiguration<CartsRequestBuilderGetQueryParameters> | undefined): RequestInformation;
     /**
-     * Create Cart
+     * Creates a new Cart for the specified owner. A Cart supports multi-Plan purchases on a single Subscription which enables plugin and add-on pricing models. Carts may also be created without a grantee, this allows customer to assemble a purchase before signing up; the Cart can then be attached to their account at sign-in.
      * @param body The request body
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}
@@ -53,21 +53,36 @@ export interface CartsRequestBuilder extends BaseRequestBuilder<CartsRequestBuil
     toPostRequestInformation(body: CreateCartRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
 }
 /**
- * List Carts
+ * Returns a list of active carts in reverse chronological order by creation date.
  */
 export interface CartsRequestBuilderGetQueryParameters {
+    /**
+     * Return records after this cursor for forward pagination. Use the `nextCursor` from a previous response.
+     */
     after?: string;
+    /**
+     * Return records before this cursor for backwards pagination. Use the `previousCursor` from a previous response.
+     */
     before?: string;
+    /**
+     * Expand related resources inline. Accepts a comma-separated list. Supported values: `owner`.
+     */
     expand?: GetExpandQueryParameterType[];
     /**
      * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
      */
     limit?: string;
+    /**
+     * Filter by owner ID. Accepts a comma-separated list of owner IDs.
+     */
     ownerId?: string[];
     /**
-     * Search by cart id
+     * Search carts by ID.
      */
     search?: string;
+    /**
+     * Filter by cart status. Accepts a comma-separated list. One of `active`, `abandoned`, `complete`.
+     */
     status?: GetStatusQueryParameterType[];
 }
 export type GetExpandQueryParameterType = (typeof GetExpandQueryParameterTypeObject)[keyof typeof GetExpandQueryParameterTypeObject];

package/dist/sdk/api/carts/item/checkout/index.d.ts

@@ -5,7 +5,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
  */
 export interface CheckoutRequestBuilder extends BaseRequestBuilder<CheckoutRequestBuilder> {
     /**
-     * Generate Checkout Link
+     * Generates a Stripe checkout link for the items in the Cart.
      * @param body The request body
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<GenerateCheckoutLinkSchema>}
@@ -18,7 +18,7 @@ export interface CheckoutRequestBuilder extends BaseRequestBuilder<CheckoutReque
      */
     post(body: GenerateCheckoutLinkRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<GenerateCheckoutLinkSchema | undefined>;
     /**
-     * Generate Checkout Link
+     * Generates a Stripe checkout link for the items in the Cart.
      * @param body The request body
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}

package/dist/sdk/api/carts/item/index.d.ts

@@ -10,7 +10,7 @@ export interface CartsItemRequestBuilder extends BaseRequestBuilder<CartsItemReq
      */
     get checkout(): CheckoutRequestBuilder;
     /**
-     * Abandon Cart
+     * Marks the specified Cart as abandoned. The Cart record is preserved with its status set to abandoned, after which it can no longer be modified or checked out. Only active Carts can be abandoned.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @throws {ErrorResponseBody} error when the service returns a 400 status code
      * @throws {ErrorResponseBody} error when the service returns a 401 status code
@@ -21,7 +21,7 @@ export interface CartsItemRequestBuilder extends BaseRequestBuilder<CartsItemReq
      */
     delete(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
     /**
-     * Retrieve Cart
+     * Retrieves the details of a Cart.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<GetCartDetailSchema>}
      * @throws {ErrorResponseBody} error when the service returns a 400 status code
@@ -33,7 +33,7 @@ export interface CartsItemRequestBuilder extends BaseRequestBuilder<CartsItemReq
      */
     get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<GetCartDetailSchema | undefined>;
     /**
-     * Update Cart
+     * Updates the specified Cart, only active Carts can be updated. The `cartItems` array updates existing items by ID; pass `granteeId` to change the Grantee, or metadata keyed by Line Item slug to set quantities. To add or remove Cart Items, use the Cart Items endpoints.
      * @param body The request body
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @throws {ErrorResponseBody} error when the service returns a 400 status code
@@ -45,19 +45,19 @@ export interface CartsItemRequestBuilder extends BaseRequestBuilder<CartsItemReq
      */
     put(body: UpdateCartRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
     /**
-     * Abandon Cart
+     * Marks the specified Cart as abandoned. The Cart record is preserved with its status set to abandoned, after which it can no longer be modified or checked out. Only active Carts can be abandoned.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}
      */
     toDeleteRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
     /**
-     * Retrieve Cart
+     * Retrieves the details of a Cart.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}
      */
     toGetRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
     /**
-     * Update Cart
+     * Updates the specified Cart, only active Carts can be updated. The `cartItems` array updates existing items by ID; pass `granteeId` to change the Grantee, or metadata keyed by Line Item slug to set quantities. To add or remove Cart Items, use the Cart Items endpoints.
      * @param body The request body
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}

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

@@ -364,51 +364,51 @@ export declare function createBatchSubscriptionActionsResponseSchema_dataFromDis
 export declare function createBatchSubscriptionActionsResponseSchemaFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
 export interface CreateCartItemRequestSchema extends Parsable {
     /**
-     * The cartId property
+     * The ID of the cart to add this item to. The cart's status must be active.
      */
     cartId?: string | null;
     /**
-     * The grantee property
+     * The grantee to assign this cart item to. Pass any identifier like a user ID to assign to an individual grantee. If the value is not provided, the cart `owner` is used. To assign to a group, pass a group ID prefixed with `grp_`, useful for onboarding entire teams (only applicable to per-seat). The grantee will receive access to the plan's when the subscription is active.
      */
     grantee?: string | null;
     /**
-     * The interval property
+     * The billing interval for this cart item. One of `day`, `week`, `month`, `year`. If the cart already has an interval set, this value must match it.
      */
     interval?: CreateCartItemRequestSchema_interval | null;
     /**
-     * The intervalCount property
+     * The number of intervals between billing cycles. If the cart already has an interval count set, this value must match it.
      */
     intervalCount?: number | null;
     /**
-     * Optionally set config for each cart item by using the line item slug as the key in the object
+     * Optional per-line-item configuration, keyed by line item slug. Use this to set the quantity for per-seat line items. Not applicable to metered line items or per-seat line items with a flat-rate billing scheme.
      */
     metadata?: CreateCartItemRequestSchema_metadata | null;
     /**
-     * The planId property
+     * The ID of the plan to add to the cart. Each plan can only appear once per cart.
      */
     planId?: string | null;
 }
 export type CreateCartItemRequestSchema_interval = (typeof CreateCartItemRequestSchema_intervalObject)[keyof typeof CreateCartItemRequestSchema_intervalObject];
 /**
- * Optionally set config for each cart item by using the line item slug as the key in the object
+ * Optional per-line-item configuration, keyed by line item slug. Use this to set the quantity for per-seat line items. Not applicable to metered line items or per-seat line items with a flat-rate billing scheme.
  */
 export interface CreateCartItemRequestSchema_metadata extends AdditionalDataHolder, Parsable {
 }
 export interface CreateCartRequestSchema extends Parsable {
     /**
-     * The currency property
+     * The three-letter ISO 4217 currency code for the cart. If currency is not provided and all line items have the same default currency, the cart will use Geolocation.
      */
     currency?: CreateCartRequestSchema_currency | null;
     /**
-     * The interval property
+     * The billing interval for the cart. If set to one of `day`, `week`, `month`, `year`. Must be set alongside `intervalCount`. If set to `null` the cart will be treated as a one off purchase.
      */
     interval?: CreateCartRequestSchema_interval | null;
     /**
-     * The intervalCount property
+     * The number of intervals between billing cycles. Must be set if `interval` is not `null`.
      */
     intervalCount?: number | null;
     /**
-     * The owner property
+     * An owner is an identifier used to scope Subscriptions, carts, and usage records in Salable. Typically a user ID for individual subscriptions or organization ID for team subscriptions.
      */
     owner?: string | null;
 }
@@ -17414,12 +17414,18 @@ export declare const BatchSubscriptionActionsRequestSchema_actionObject: {
     readonly DisableAutoRenew: "disable-auto-renew";
     readonly Delete: "delete";
 };
+/**
+ * The billing interval for this cart item. One of `day`, `week`, `month`, `year`. If the cart already has an interval set, this value must match it.
+ */
 export declare const CreateCartItemRequestSchema_intervalObject: {
     readonly Day: "day";
     readonly Week: "week";
     readonly Month: "month";
     readonly Year: "year";
 };
+/**
+ * The three-letter ISO 4217 currency code for the cart. If currency is not provided and all line items have the same default currency, the cart will use Geolocation.
+ */
 export declare const CreateCartRequestSchema_currencyObject: {
     readonly USD: "USD";
     readonly AED: "AED";
@@ -17560,6 +17566,9 @@ export declare const CreateCartRequestSchema_currencyObject: {
     readonly KWD: "KWD";
     readonly OMR: "OMR";
 };
+/**
+ * The billing interval for the cart. If set to one of `day`, `week`, `month`, `year`. Must be set alongside `intervalCount`. If set to `null` the cart will be treated as a one off purchase.
+ */
 export declare const CreateCartRequestSchema_intervalObject: {
     readonly Day: "day";
     readonly Week: "week";

package/package.json

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