@salable/sdk 1.0.4 → 1.0.5

package/dist/sdk/api/ai/conversations/index.d.ts

@@ -35,6 +35,9 @@ export interface ConversationsRequestBuilder extends BaseRequestBuilder<Conversa
 export interface ConversationsRequestBuilderGetQueryParameters {
     after?: string;
     before?: string;
+    /**
+     * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
+     */
     limit?: string;
 }
 /**

package/dist/sdk/api/ai/messages/index.d.ts

@@ -29,6 +29,9 @@ export interface MessagesRequestBuilderGetQueryParameters {
     after?: string;
     before?: string;
     conversationId?: string;
+    /**
+     * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
+     */
     limit?: string;
 }
 /**

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

@@ -50,6 +50,9 @@ export interface ApiKeysRequestBuilder extends BaseRequestBuilder<ApiKeysRequest
 export interface ApiKeysRequestBuilderGetQueryParameters {
     after?: string;
     before?: string;
+    /**
+     * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
+     */
     limit?: string;
 }
 /**

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

@@ -59,8 +59,14 @@ export interface CartsRequestBuilderGetQueryParameters {
     after?: string;
     before?: string;
     expand?: GetExpandQueryParameterType[];
+    /**
+     * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
+     */
     limit?: string;
     ownerId?: string[];
+    /**
+     * Search by cart id
+     */
     search?: string;
     status?: GetStatusQueryParameterType[];
 }

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

@@ -35,6 +35,9 @@ export interface CurrencyOptionsRequestBuilderGetQueryParameters {
     after?: string;
     before?: string;
     expand?: GetExpandQueryParameterType[];
+    /**
+     * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
+     */
     limit?: string;
     priceId?: string;
 }

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

@@ -36,6 +36,9 @@ export interface DestinationsRequestBuilderGetQueryParameters {
     after?: string;
     before?: string;
     eventId?: string;
+    /**
+     * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
+     */
     limit?: string;
 }
 /**

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

@@ -56,6 +56,9 @@ export interface EntitlementsRequestBuilder extends BaseRequestBuilder<Entitleme
 export interface EntitlementsRequestBuilderGetQueryParameters {
     after?: string;
     before?: string;
+    /**
+     * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
+     */
     limit?: string;
     planId?: string;
     search?: string;

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

@@ -45,6 +45,9 @@ export interface EventAttemptsRequestBuilderGetQueryParameters {
     after?: string;
     before?: string;
     destinationId?: string;
+    /**
+     * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
+     */
     limit?: string;
 }
 /**

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

@@ -33,6 +33,9 @@ export interface EventsRequestBuilder extends BaseRequestBuilder<EventsRequestBu
 export interface EventsRequestBuilderGetQueryParameters {
     after?: string;
     before?: string;
+    /**
+     * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
+     */
     limit?: string;
     types?: GetTypesQueryParameterType[];
 }

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

@@ -52,6 +52,9 @@ export interface GranteesRequestBuilderGetQueryParameters {
     after?: string;
     before?: string;
     groupId?: string;
+    /**
+     * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
+     */
     limit?: string;
 }
 /**

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

@@ -53,6 +53,9 @@ export interface GroupsRequestBuilderGetQueryParameters {
     after?: string;
     before?: string;
     expand?: GetExpandQueryParameterType[];
+    /**
+     * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
+     */
     limit?: string;
     owner?: string;
 }

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

@@ -33,6 +33,9 @@ export interface LineItemsRequestBuilder extends BaseRequestBuilder<LineItemsReq
 export interface LineItemsRequestBuilderGetQueryParameters {
     after?: string;
     before?: string;
+    /**
+     * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
+     */
     limit?: string;
     planId?: string;
     search?: string;

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

@@ -26,6 +26,9 @@ export interface MetersRequestBuilder extends BaseRequestBuilder<MetersRequestBu
 export interface MetersRequestBuilderGetQueryParameters {
     after?: string;
     before?: string;
+    /**
+     * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
+     */
     limit?: string;
     search?: string;
 }

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

@@ -35,6 +35,9 @@ export interface OwnersRequestBuilderGetQueryParameters {
     after?: string;
     before?: string;
     expand?: GetExpandQueryParameterType[];
+    /**
+     * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
+     */
     limit?: string;
     search?: string;
     stripeCustomerId?: string;

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

@@ -68,6 +68,9 @@ export interface PaymentIntegrationsRequestBuilder extends BaseRequestBuilder<Pa
 export interface PaymentIntegrationsRequestBuilderGetQueryParameters {
     after?: string;
     before?: string;
+    /**
+     * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
+     */
     limit?: string;
 }
 /**

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

@@ -66,6 +66,9 @@ export interface PlansRequestBuilderGetQueryParameters {
     interval?: GetIntervalQueryParameterType;
     intervalCount?: string;
     isActive?: string;
+    /**
+     * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
+     */
     limit?: string;
     productId?: string;
     search?: string;

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

@@ -33,6 +33,9 @@ export interface PricesRequestBuilder extends BaseRequestBuilder<PricesRequestBu
 export interface PricesRequestBuilderGetQueryParameters {
     after?: string;
     before?: string;
+    /**
+     * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
+     */
     limit?: string;
 }
 /**

package/dist/sdk/api/products/copyToLiveMode/index.d.ts

@@ -0,0 +1,35 @@
+import { type CopyProductToLiveModeRequestSchema, type CopyToLiveModeSchema } from '../../../models/index.js';
+import { type BaseRequestBuilder, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
+/**
+ * Builds and executes requests for operations under /api/products/copy-to-live-mode
+ */
+export interface CopyToLiveModeRequestBuilder extends BaseRequestBuilder<CopyToLiveModeRequestBuilder> {
+    /**
+     * Copies a test mode product and all its associated plans, line items, prices, and entitlements to live mode. This endpoint must be called using a test mode API key.
+     * @param body The request body
+     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
+     * @returns {Promise<CopyToLiveModeSchema>}
+     * @throws {ErrorResponseBody} error when the service returns a 400 status code
+     * @throws {ErrorResponseBody} error when the service returns a 401 status code
+     * @throws {ErrorResponseBody} error when the service returns a 403 status code
+     * @throws {ErrorResponseBody} error when the service returns a 404 status code
+     * @throws {ErrorResponseBody} error when the service returns a 405 status code
+     * @throws {ErrorResponseBody} error when the service returns a 500 status code
+     */
+    post(body: CopyProductToLiveModeRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<CopyToLiveModeSchema | undefined>;
+    /**
+     * Copies a test mode product and all its associated plans, line items, prices, and entitlements to live mode. This endpoint must be called using a test mode API key.
+     * @param body The request body
+     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
+     * @returns {RequestInformation}
+     */
+    toPostRequestInformation(body: CopyProductToLiveModeRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
+}
+/**
+ * Uri template for the request builder.
+ */
+export declare const CopyToLiveModeRequestBuilderUriTemplate = "{+baseurl}/api/products/copy-to-live-mode";
+/**
+ * Metadata for all the requests in the request builder.
+ */
+export declare const CopyToLiveModeRequestBuilderRequestsMetadata: RequestsMetadata;

package/dist/sdk/api/products/exportEscaped/item/index.d.ts

@@ -4,7 +4,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
  */
 export interface ExportItemRequestBuilder extends BaseRequestBuilder<ExportItemRequestBuilder> {
     /**
-     * Export Product as YAML
+     * Exports a product and all its associated plans, line items, prices, and entitlements as a YAML file.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<ArrayBuffer>}
      * @throws {ErrorResponseBody} error when the service returns a 400 status code
@@ -16,7 +16,7 @@ export interface ExportItemRequestBuilder extends BaseRequestBuilder<ExportItemR
      */
     get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<ArrayBuffer | undefined>;
     /**
-     * Export Product as YAML
+     * Exports a product and all its associated plans, line items, prices, and entitlements as a YAML file.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}
      */

package/dist/sdk/api/products/importEscaped/index.d.ts

@@ -4,7 +4,7 @@ import { MultipartBody, type BaseRequestBuilder, type RequestConfiguration, type
  */
 export interface ImportRequestBuilder extends BaseRequestBuilder<ImportRequestBuilder> {
     /**
-     * Import Product from YAML
+     * Imports a product from a YAML file. Only `.yaml` and `.yml` files are accepted. Only one file can be submitted per request.
      * @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
@@ -15,7 +15,7 @@ export interface ImportRequestBuilder extends BaseRequestBuilder<ImportRequestBu
      */
     post(body: MultipartBody, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
     /**
-     * Import Product from YAML
+     * Imports a product from a YAML file. Only `.yaml` and `.yml` files are accepted. Only one file can be submitted per request.
      * @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/products/index.d.ts

@@ -1,4 +1,5 @@
 import { type CreateProductRequestSchema, type CreateProductResponseSchema, type GetProductListSchema } from '../../models/index.js';
+import { type CopyToLiveModeRequestBuilder } from './copyToLiveMode/index.js';
 import { type ExportRequestBuilder } from './exportEscaped/index.js';
 import { type ImportRequestBuilder } from './importEscaped/index.js';
 import { type ProductsItemRequestBuilder } from './item/index.js';
@@ -9,6 +10,10 @@ export type GetIncludeArchivedQueryParameterType = (typeof GetIncludeArchivedQue
  * Builds and executes requests for operations under /api/products
  */
 export interface ProductsRequestBuilder extends BaseRequestBuilder<ProductsRequestBuilder> {
+    /**
+     * The copyToLiveMode property
+     */
+    get copyToLiveMode(): CopyToLiveModeRequestBuilder;
     /**
      * The export property
      */
@@ -24,7 +29,7 @@ export interface ProductsRequestBuilder extends BaseRequestBuilder<ProductsReque
      */
     byId(id: string): ProductsItemRequestBuilder;
     /**
-     * List Products
+     * Returns a list of your products. The products are returned sorted by `createdAt`, with the most recently created products appearing first.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<GetProductListSchema>}
      * @throws {ErrorResponseBody} error when the service returns a 401 status code
@@ -34,7 +39,7 @@ export interface ProductsRequestBuilder extends BaseRequestBuilder<ProductsReque
      */
     get(requestConfiguration?: RequestConfiguration<ProductsRequestBuilderGetQueryParameters> | undefined): Promise<GetProductListSchema | undefined>;
     /**
-     * Create Product
+     * Creates a new product.
      * @param body The request body
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<CreateProductResponseSchema>}
@@ -46,13 +51,13 @@ export interface ProductsRequestBuilder extends BaseRequestBuilder<ProductsReque
      */
     post(body: CreateProductRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<CreateProductResponseSchema | undefined>;
     /**
-     * List Products
+     * Returns a list of your products. The products are returned sorted by `createdAt`, with the most recently created products appearing first.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}
      */
     toGetRequestInformation(requestConfiguration?: RequestConfiguration<ProductsRequestBuilderGetQueryParameters> | undefined): RequestInformation;
     /**
-     * Create Product
+     * Creates a new product.
      * @param body The request body
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}
@@ -60,14 +65,32 @@ export interface ProductsRequestBuilder extends BaseRequestBuilder<ProductsReque
     toPostRequestInformation(body: CreateProductRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
 }
 /**
- * List Products
+ * Returns a list of your products. The products are returned sorted by `createdAt`, with the most recently created products appearing first.
  */
 export interface ProductsRequestBuilderGetQueryParameters {
+    /**
+     * 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: `plans`, `settings`.
+     */
     expand?: GetExpandQueryParameterType[];
+    /**
+     * When set to `true`, includes archived products in the results. Defaults to `false`.
+     */
     includeArchived?: GetIncludeArchivedQueryParameterType;
+    /**
+     * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
+     */
     limit?: string;
+    /**
+     * Filter products by name.
+     */
     search?: string;
 }
 /**

package/dist/sdk/api/products/item/archive/index.d.ts

@@ -4,7 +4,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
  */
 export interface ArchiveRequestBuilder extends BaseRequestBuilder<ArchiveRequestBuilder> {
     /**
-     * Archives a product. Archived products cannot be modified.
+     * Archives a product. Archived products are excluded from list responses by default, cannot be modified, and will not accept new subscriptions. Active subscriptions will remain unaffected.
      * @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
@@ -16,7 +16,7 @@ export interface ArchiveRequestBuilder extends BaseRequestBuilder<ArchiveRequest
      */
     post(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
     /**
-     * Archives a product. Archived products cannot be modified.
+     * Archives a product. Archived products are excluded from list responses by default, cannot be modified, and will not accept new subscriptions. Active subscriptions will remain unaffected.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}
      */

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

@@ -11,7 +11,7 @@ export interface ProductsItemRequestBuilder extends BaseRequestBuilder<ProductsI
      */
     get archive(): ArchiveRequestBuilder;
     /**
-     * Delete Product
+     * Permanently deletes a product. A product cannot be deleted if it has been subscribed to.
      * @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
@@ -22,7 +22,7 @@ export interface ProductsItemRequestBuilder extends BaseRequestBuilder<ProductsI
      */
     delete(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
     /**
-     * Retrieve Product
+     * Retrieves the details of an existing product.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<GetProductDetailSchema>}
      * @throws {ErrorResponseBody} error when the service returns a 400 status code
@@ -34,7 +34,7 @@ export interface ProductsItemRequestBuilder extends BaseRequestBuilder<ProductsI
      */
     get(requestConfiguration?: RequestConfiguration<ProductsItemRequestBuilderGetQueryParameters> | undefined): Promise<GetProductDetailSchema | undefined>;
     /**
-     * Update Product
+     * Updates the specified product. Only the fields provided in the request body will be updated.
      * @param body The request body
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<UpdateProductResponseSchema>}
@@ -47,19 +47,19 @@ export interface ProductsItemRequestBuilder extends BaseRequestBuilder<ProductsI
      */
     put(body: UpdateProductRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<UpdateProductResponseSchema | undefined>;
     /**
-     * Delete Product
+     * Permanently deletes a product. A product cannot be deleted if it has been subscribed to.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}
      */
     toDeleteRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
     /**
-     * Retrieve Product
+     * Retrieves the details of an existing product.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}
      */
     toGetRequestInformation(requestConfiguration?: RequestConfiguration<ProductsItemRequestBuilderGetQueryParameters> | undefined): RequestInformation;
     /**
-     * Update Product
+     * Updates the specified product. Only the fields provided in the request body will be updated.
      * @param body The request body
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}
@@ -67,9 +67,12 @@ export interface ProductsItemRequestBuilder extends BaseRequestBuilder<ProductsI
     toPutRequestInformation(body: UpdateProductRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
 }
 /**
- * Retrieve Product
+ * Retrieves the details of an existing product.
  */
 export interface ProductsItemRequestBuilderGetQueryParameters {
+    /**
+     * Expand related resources inline. Accepts a comma-separated list. Supported values: `settings`, `plans`.
+     */
     expand?: GetExpandQueryParameterType[];
 }
 /**

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

@@ -35,6 +35,9 @@ export interface ReceiptsRequestBuilderGetQueryParameters {
     after?: string;
     before?: string;
     expand?: GetExpandQueryParameterType[];
+    /**
+     * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
+     */
     limit?: string;
     lineItems?: string[];
     owner?: string[];

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

@@ -420,6 +420,9 @@ export interface SubscriptionPlansRequestBuilderGetQueryParameters {
     after?: string;
     before?: string;
     expand?: GetExpandQueryParameterType[];
+    /**
+     * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
+     */
     limit?: string;
     owner?: string;
     plans?: string;

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

@@ -278,6 +278,9 @@ export interface SubscriptionsRequestBuilderGetQueryParameters {
     before?: string;
     expand?: GetExpandQueryParameterType[];
     id?: string;
+    /**
+     * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
+     */
     limit?: string;
     owner?: string;
     plans?: string[];

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

@@ -45,6 +45,9 @@ export interface TierTagsRequestBuilder extends BaseRequestBuilder<TierTagsReque
 export interface TierTagsRequestBuilderGetQueryParameters {
     after?: string;
     before?: string;
+    /**
+     * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
+     */
     limit?: string;
     search?: string;
 }

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

@@ -34,6 +34,9 @@ export interface TiersRequestBuilder extends BaseRequestBuilder<TiersRequestBuil
 export interface TiersRequestBuilderGetQueryParameters {
     after?: string;
     before?: string;
+    /**
+     * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
+     */
     limit?: string;
 }
 /**

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

@@ -30,6 +30,9 @@ export interface UsageRecordsRequestBuilder extends BaseRequestBuilder<UsageReco
 export interface UsageRecordsRequestBuilderGetQueryParameters {
     after?: string;
     before?: string;
+    /**
+     * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
+     */
     limit?: string;
     meterSlug?: string;
     owner?: string;