@leadping/sdk 1.0.56 → 1.0.57

package/dist/a2a/index.d.ts

@@ -4,7 +4,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
  */
 export interface A2aRequestBuilder extends BaseRequestBuilder<A2aRequestBuilder> {
     /**
-     * Accepts authenticated A2A JSON-RPC requests for Leadping's supported agent operations.
+     * Send authenticated A2A JSON-RPC requests to Leadping through the API to access supported agent operations and integrate them into your agent workflows.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<ArrayBuffer>}
      * @throws {ProblemDetails} error when the service returns a 401 status code
@@ -13,7 +13,7 @@ export interface A2aRequestBuilder extends BaseRequestBuilder<A2aRequestBuilder>
      */
     post(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<ArrayBuffer | undefined>;
     /**
-     * Accepts authenticated A2A JSON-RPC requests for Leadping's supported agent operations.
+     * Send authenticated A2A JSON-RPC requests to Leadping through the API to access supported agent operations and integrate them into your agent workflows.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}
      */

package/dist/automations/preview/index.d.ts

@@ -5,7 +5,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
  */
 export interface PreviewRequestBuilder extends BaseRequestBuilder<PreviewRequestBuilder> {
     /**
-     * Previews automation execution for a sample lead, showing matched steps and messages without creating follow-up events.Set `validate_only` to return configuration validation without evaluating conditions or actions and without writing a test audit event.
+     * Preview matched automation steps and messages for a sample lead without creating follow-up events, or use validate_only to check the automation configuration.
      * @param body Defines the fields clients can send when working with automation preview.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<AutomationPreviewResponse>}
@@ -16,7 +16,7 @@ export interface PreviewRequestBuilder extends BaseRequestBuilder<PreviewRequest
      */
     post(body: AutomationPreviewRequest, requestConfiguration?: RequestConfiguration<PreviewRequestBuilderPostQueryParameters> | undefined): Promise<AutomationPreviewResponse | undefined>;
     /**
-     * Previews automation execution for a sample lead, showing matched steps and messages without creating follow-up events.Set `validate_only` to return configuration validation without evaluating conditions or actions and without writing a test audit event.
+     * Preview matched automation steps and messages for a sample lead without creating follow-up events, or use validate_only to check the automation configuration.
      * @param body Defines the fields clients can send when working with automation preview.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}
@@ -24,7 +24,7 @@ export interface PreviewRequestBuilder extends BaseRequestBuilder<PreviewRequest
     toPostRequestInformation(body: AutomationPreviewRequest, requestConfiguration?: RequestConfiguration<PreviewRequestBuilderPostQueryParameters> | undefined): RequestInformation;
 }
 /**
- * Previews automation execution for a sample lead, showing matched steps and messages without creating follow-up events.Set `validate_only` to return configuration validation without evaluating conditions or actions and without writing a test audit event.
+ * Preview matched automation steps and messages for a sample lead without creating follow-up events, or use validate_only to check the automation configuration.
  */
 export interface PreviewRequestBuilderPostQueryParameters {
     /**

package/dist/blog/index.d.ts

@@ -12,14 +12,14 @@ export interface BlogRequestBuilder extends BaseRequestBuilder<BlogRequestBuilde
      */
     bySlug(slug: string): WithSlugItemRequestBuilder;
     /**
-     * Returns the Leadping blog articles currently available to public readers.
+     * Retrieve the list of published Leadping blog articles through the public API. This endpoint returns articles available to readers without authentication.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<BlogArticleResponse[]>}
      * @throws {ProblemDetails} error when the service returns a 429 status code
      */
     get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<BlogArticleResponse[] | undefined>;
     /**
-     * Returns the Leadping blog articles currently available to public readers.
+     * Retrieve the list of published Leadping blog articles through the public API. This endpoint returns articles available to readers without authentication.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}
      */

package/dist/leadStatusChanges/item/index.d.ts

@@ -24,7 +24,7 @@ export interface LeadStatusChangesItemRequestBuilder extends BaseRequestBuilder<
      */
     get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<LeadStatusChangeResponse | undefined>;
     /**
-     * Updates a lead status history entry and, when it is current, updates the lead's current status.
+     * Update a Leadping lead status history entry through the API. When the entry is current, the operation also updates the lead's current status to match.
      * @param body Defines a lead status transition or correction, including its target status, effective time, source, and explanatory context.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<LeadStatusChangeResponse>}
@@ -48,7 +48,7 @@ export interface LeadStatusChangesItemRequestBuilder extends BaseRequestBuilder<
      */
     toGetRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
     /**
-     * Updates a lead status history entry and, when it is current, updates the lead's current status.
+     * Update a Leadping lead status history entry through the API. When the entry is current, the operation also updates the lead's current status to match.
      * @param body Defines a lead status transition or correction, including its target status, effective time, source, and explanatory context.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}

package/dist/leads/item/archive/index.d.ts

@@ -10,7 +10,7 @@ export interface ArchivePostRequestBody extends LeadArchiveRequest, Parsable {
  */
 export interface ArchiveRequestBuilder extends BaseRequestBuilder<ArchiveRequestBuilder> {
     /**
-     * Archives a lead without deleting history, removing it from active pipeline views while preserving communication and event records.The request body is intentionally optional. An empty body archives the lead with the default manually-archived reason.
+     * Archive a lead to remove it from active pipeline views while preserving communication and event history. An optional request body supplies the archive reason.
      * @param body Defines the fields clients can send when working with lead archive.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<LeadResponse>}
@@ -22,7 +22,7 @@ export interface ArchiveRequestBuilder extends BaseRequestBuilder<ArchiveRequest
      */
     post(body: ArchivePostRequestBody, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<LeadResponse | undefined>;
     /**
-     * Archives a lead without deleting history, removing it from active pipeline views while preserving communication and event records.The request body is intentionally optional. An empty body archives the lead with the default manually-archived reason.
+     * Archive a lead to remove it from active pipeline views while preserving communication and event history. An optional request body supplies the archive reason.
      * @param body Defines the fields clients can send when working with lead archive.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}

package/dist/leads/item/index.d.ts

@@ -40,7 +40,7 @@ export interface ItemRequestBuilder extends BaseRequestBuilder<ItemRequestBuilde
      */
     get workflowStatus(): WorkflowStatusRequestBuilder;
     /**
-     * Marks a lead as deleted so it no longer appears in user-facing lead, conversation, routing, or event workflows. The stored lead,conversation, and event records are retained.
+     * Mark a lead as deleted to hide it from lead, conversation, routing, and event workflows while retaining the stored lead, conversation, and event records.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @throws {ProblemDetails} error when the service returns a 401 status code
      * @throws {ProblemDetails} error when the service returns a 403 status code
@@ -71,7 +71,7 @@ export interface ItemRequestBuilder extends BaseRequestBuilder<ItemRequestBuilde
      */
     put(body: LeadRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<LeadResponse | undefined>;
     /**
-     * Marks a lead as deleted so it no longer appears in user-facing lead, conversation, routing, or event workflows. The stored lead,conversation, and event records are retained.
+     * Mark a lead as deleted to hide it from lead, conversation, routing, and event workflows while retaining the stored lead, conversation, and event records.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}
      */

package/dist/sms/item/cancel/index.d.ts

@@ -5,7 +5,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
  */
 export interface CancelRequestBuilder extends BaseRequestBuilder<CancelRequestBuilder> {
     /**
-     * Cancels a scheduled SMS event before delivery, preserving the event record while preventing the queued message from being sent.The cancellation window remains open only while the SMS status is Scheduled and closes when delivery begins.
+     * Cancel a queued SMS message while its status is Scheduled to prevent sending and preserve the event record. Cancellation closes when message delivery begins.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<SmsResponse>}
      * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -16,7 +16,7 @@ export interface CancelRequestBuilder extends BaseRequestBuilder<CancelRequestBu
      */
     post(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<SmsResponse | undefined>;
     /**
-     * Cancels a scheduled SMS event before delivery, preserving the event record while preventing the queued message from being sent.The cancellation window remains open only while the SMS status is Scheduled and closes when delivery begins.
+     * Cancel a queued SMS message while its status is Scheduled to prevent sending and preserve the event record. Cancellation closes when message delivery begins.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}
      */

package/dist/users/me/notificationPreferences/index.d.ts

@@ -5,7 +5,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
  */
 export interface NotificationPreferencesRequestBuilder extends BaseRequestBuilder<NotificationPreferencesRequestBuilder> {
     /**
-     * Replaces the notification channel and delivery preferences stored for the authenticated user.
+     * Update notification channel and delivery preferences for the authenticated Leadping user through the API without submitting unrelated user profile fields.
      * @param body Describes user notification preferences data used in Leadping API requests and responses.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<UserResponse>}
@@ -15,7 +15,7 @@ export interface NotificationPreferencesRequestBuilder extends BaseRequestBuilde
      */
     put(body: UserNotificationPreferences, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<UserResponse | undefined>;
     /**
-     * Replaces the notification channel and delivery preferences stored for the authenticated user.
+     * Update notification channel and delivery preferences for the authenticated Leadping user through the API without submitting unrelated user profile fields.
      * @param body Describes user notification preferences data used in Leadping API requests and responses.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leadping/sdk",
-  "version": "1.0.56",
+  "version": "1.0.57",
   "description": "Typed TypeScript client for the Leadping API, generated from the Leadping OpenAPI document with Microsoft Kiota.",
   "type": "module",
   "license": "MIT",