@leadping/sdk 1.0.15 → 1.0.16

package/dist/businesses/apiKeys/my/index.d.ts

@@ -5,7 +5,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
  */
 export interface MyRequestBuilder extends BaseRequestBuilder<MyRequestBuilder> {
     /**
-     * Returns a paged result of current-business API keys.
+     * Retrieves a paged list of API keys owned by the caller's current Leadping business, with support for filtering, sorting, and pagination.
      * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<PagedResultOfBusinessTableRow>}
@@ -14,7 +14,7 @@ export interface MyRequestBuilder extends BaseRequestBuilder<MyRequestBuilder> {
      */
     post(body: RequestDataOptions, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<PagedResultOfBusinessTableRow | undefined>;
     /**
-     * Returns a paged result of current-business API keys.
+     * Retrieves a paged list of API keys owned by the caller's current Leadping business, with support for filtering, sorting, and pagination.
      * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}

package/dist/phoneCall/initiate/index.d.ts

@@ -5,7 +5,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
  */
 export interface InitiateRequestBuilder extends BaseRequestBuilder<InitiateRequestBuilder> {
     /**
-     * Returns the call details with a 200 status code.
+     * Starts an outbound Leadping phone call for an authenticated user and returns the provider call identifiers, status, and routing details.
      * @param body Request schema for the Leadping API phone call initiation request, including the fields clients can send.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<PhoneCallResponse>}
@@ -14,7 +14,7 @@ export interface InitiateRequestBuilder extends BaseRequestBuilder<InitiateReque
      */
     post(body: InitiateCallRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<PhoneCallResponse | undefined>;
     /**
-     * Returns the call details with a 200 status code.
+     * Starts an outbound Leadping phone call for an authenticated user and returns the provider call identifiers, status, and routing details.
      * @param body Request schema for the Leadping API phone call initiation request, including the fields clients can send.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}

package/dist/phoneCall/item/hangup/index.d.ts

@@ -5,7 +5,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
  */
 export interface HangupRequestBuilder extends BaseRequestBuilder<HangupRequestBuilder> {
     /**
-     * Returns the call details with a 200 status code.
+     * Ends an active Leadping phone call by call ID and returns the updated call record, including status and provider routing details.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<PhoneCallResponse>}
      * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -14,7 +14,7 @@ export interface HangupRequestBuilder extends BaseRequestBuilder<HangupRequestBu
      */
     post(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<PhoneCallResponse | undefined>;
     /**
-     * Returns the call details with a 200 status code.
+     * Ends an active Leadping phone call by call ID and returns the updated call record, including status and provider routing details.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}
      */

package/dist/phoneCall/item/status/index.d.ts

@@ -5,7 +5,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
  */
 export interface StatusRequestBuilder extends BaseRequestBuilder<StatusRequestBuilder> {
     /**
-     * Returns the call details with a 200 status code.
+     * Retrieves the latest status for a Leadping phone call by call ID, including provider state and call details for tracking progress.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<PhoneCallResponse>}
      * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -13,7 +13,7 @@ export interface StatusRequestBuilder extends BaseRequestBuilder<StatusRequestBu
      */
     get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<PhoneCallResponse | undefined>;
     /**
-     * Returns the call details with a 200 status code.
+     * Retrieves the latest status for a Leadping phone call by call ID, including provider state and call details for tracking progress.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}
      */

package/dist/phoneCall/item/transfer/index.d.ts

@@ -5,7 +5,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
  */
 export interface TransferRequestBuilder extends BaseRequestBuilder<TransferRequestBuilder> {
     /**
-     * Returns the call details with a 200 status code.
+     * Transfers an active Leadping phone call to a new phone number and returns the updated call record with status and routing details.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<PhoneCallResponse>}
      * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -14,14 +14,14 @@ export interface TransferRequestBuilder extends BaseRequestBuilder<TransferReque
      */
     post(requestConfiguration?: RequestConfiguration<TransferRequestBuilderPostQueryParameters> | undefined): Promise<PhoneCallResponse | undefined>;
     /**
-     * Returns the call details with a 200 status code.
+     * Transfers an active Leadping phone call to a new phone number and returns the updated call record with status and routing details.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}
      */
     toPostRequestInformation(requestConfiguration?: RequestConfiguration<TransferRequestBuilderPostQueryParameters> | undefined): RequestInformation;
 }
 /**
- * Returns the call details with a 200 status code.
+ * Transfers an active Leadping phone call to a new phone number and returns the updated call record with status and routing details.
  */
 export interface TransferRequestBuilderPostQueryParameters {
     /**

package/dist/suppressions/check/index.d.ts

@@ -5,7 +5,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
  */
 export interface CheckRequestBuilder extends BaseRequestBuilder<CheckRequestBuilder> {
     /**
-     * Returns the suppression check result.
+     * Checks whether a recipient is blocked by an active Leadping suppression entry before sending messages or placing calls through the selected channel.
      * @param body Request payload for suppression entry.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<SuppressionCheckResult>}
@@ -14,7 +14,7 @@ export interface CheckRequestBuilder extends BaseRequestBuilder<CheckRequestBuil
      */
     post(body: SuppressionEntryRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<SuppressionCheckResult | undefined>;
     /**
-     * Returns the suppression check result.
+     * Checks whether a recipient is blocked by an active Leadping suppression entry before sending messages or placing calls through the selected channel.
      * @param body Request payload for suppression entry.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}

package/dist/suppressions/index.d.ts

@@ -15,7 +15,7 @@ export interface SuppressionsRequestBuilder extends BaseRequestBuilder<Suppressi
      */
     get release(): ReleaseRequestBuilder;
     /**
-     * The suppression entry response was created successfully.
+     * Creates or reactivates a Leadping suppression entry that blocks future outreach to a recipient across the selected communication channel.
      * @param body Request payload for suppression entry.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<SuppressionEntryResponse>}
@@ -24,7 +24,7 @@ export interface SuppressionsRequestBuilder extends BaseRequestBuilder<Suppressi
      */
     post(body: SuppressionEntryRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<SuppressionEntryResponse | undefined>;
     /**
-     * The suppression entry response was created successfully.
+     * Creates or reactivates a Leadping suppression entry that blocks future outreach to a recipient across the selected communication channel.
      * @param body Request payload for suppression entry.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}

package/dist/suppressions/release/index.d.ts

@@ -5,7 +5,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
  */
 export interface ReleaseRequestBuilder extends BaseRequestBuilder<ReleaseRequestBuilder> {
     /**
-     * Returns the suppression entry response.
+     * Releases an active Leadping suppression entry so a recipient can be contacted again, returning the updated suppression record when available.
      * @param body Request payload for suppression entry.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<SuppressionEntryResponse>}
@@ -14,7 +14,7 @@ export interface ReleaseRequestBuilder extends BaseRequestBuilder<ReleaseRequest
      */
     post(body: SuppressionEntryRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<SuppressionEntryResponse | undefined>;
     /**
-     * Returns the suppression entry response.
+     * Releases an active Leadping suppression entry so a recipient can be contacted again, returning the updated suppression record when available.
      * @param body Request payload for suppression entry.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}

package/dist/telephony/login/index.d.ts

@@ -5,7 +5,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
  */
 export interface LoginRequestBuilder extends BaseRequestBuilder<LoginRequestBuilder> {
     /**
-     * Returns the telephony login response with a 200 status code.
+     * Generates a Leadping WebRTC login token so authenticated agents can connect to telephony services and place or receive browser-based calls.
      * @param body Request model for telephony login token generation.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<TelephonyLoginResponse>}
@@ -14,7 +14,7 @@ export interface LoginRequestBuilder extends BaseRequestBuilder<LoginRequestBuil
      */
     post(body: TelephonyLoginRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<TelephonyLoginResponse | undefined>;
     /**
-     * Returns the telephony login response with a 200 status code.
+     * Generates a Leadping WebRTC login token so authenticated agents can connect to telephony services and place or receive browser-based calls.
      * @param body Request model for telephony login token generation.
      * @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.15",
+  "version": "1.0.16",
   "description": "Typed TypeScript client for the Leadping API, generated from the Leadping OpenAPI document with Microsoft Kiota.",
   "type": "module",
   "license": "MIT",