@leadping/sdk 1.0.7 → 1.0.9

package/dist/phoneNumbers/index.d.ts

@@ -33,7 +33,7 @@ export interface PhoneNumbersRequestBuilder extends BaseRequestBuilder<PhoneNumb
     byPhoneNumberId(phoneNumberId: string): PhoneNumberItemRequestBuilder;
     /**
      * Purchases or creates a phone number for the current business so it can be assigned to messaging, calls, and lead follow-up.
-     * @param body Request payload for phone number.
+     * @param body Request schema for the Leadping API phone number update request, including the fields clients can send.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<PhoneNumberResponse>}
      * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -42,7 +42,7 @@ export interface PhoneNumbersRequestBuilder extends BaseRequestBuilder<PhoneNumb
     post(body: PhoneNumberRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<PhoneNumberResponse | undefined>;
     /**
      * Purchases or creates a phone number for the current business so it can be assigned to messaging, calls, and lead follow-up.
-     * @param body Request payload for phone number.
+     * @param body Request schema for the Leadping API phone number update 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/phoneNumbers/isAvailableForPurchase/index.d.ts

@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
 export interface IsAvailableForPurchaseRequestBuilder extends BaseRequestBuilder<IsAvailableForPurchaseRequestBuilder> {
     /**
      * Checks whether a phone number can be purchased for the current business before creating or assigning it.
-     * @param body Request payload for phone number availability.
+     * @param body Request schema for checking phone number availability before purchase or assignment.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<PhoneNumberAvailabilityResponse>}
      * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -15,7 +15,7 @@ export interface IsAvailableForPurchaseRequestBuilder extends BaseRequestBuilder
     post(body: PhoneNumberAvailabilityRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<PhoneNumberAvailabilityResponse | undefined>;
     /**
      * Checks whether a phone number can be purchased for the current business before creating or assigning it.
-     * @param body Request payload for phone number availability.
+     * @param body Request schema for checking phone number availability before purchase or assignment.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}
      */

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

@@ -31,7 +31,7 @@ export interface PhoneNumberItemRequestBuilder extends BaseRequestBuilder<PhoneN
     get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<PhoneNumberResponse | undefined>;
     /**
      * Updates phone number settings such as display name, assignment, messaging options, or warmup configuration.
-     * @param body Request payload for phone number.
+     * @param body Request schema for the Leadping API phone number update request, including the fields clients can send.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<PhoneNumberResponse>}
      * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -53,7 +53,7 @@ export interface PhoneNumberItemRequestBuilder extends BaseRequestBuilder<PhoneN
     toGetRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
     /**
      * Updates phone number settings such as display name, assignment, messaging options, or warmup configuration.
-     * @param body Request payload for phone number.
+     * @param body Request schema for the Leadping API phone number update 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/phoneNumbers/outgoing/conversation/item/index.d.ts

@@ -11,7 +11,7 @@ export interface WithConversationItemRequestBuilder extends BaseRequestBuilder<W
     get override(): OverrideRequestBuilder;
     /**
      * Selects the outgoing phone number for an existing conversation, considering assignments, overrides, and delivery eligibility.
-     * @param body Request payload for outgoing number selection.
+     * @param body Request schema for the Leadping API outgoing number selection request, including the fields clients can send.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<OutgoingNumberSelectionResponse>}
      * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -19,7 +19,7 @@ export interface WithConversationItemRequestBuilder extends BaseRequestBuilder<W
     post(body: OutgoingNumberSelectionRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<OutgoingNumberSelectionResponse | undefined>;
     /**
      * Selects the outgoing phone number for an existing conversation, considering assignments, overrides, and delivery eligibility.
-     * @param body Request payload for outgoing number selection.
+     * @param body Request schema for the Leadping API outgoing number selection 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/phoneNumbers/outgoing/conversation/item/override/index.d.ts

@@ -13,7 +13,7 @@ export interface OverrideRequestBuilder extends BaseRequestBuilder<OverrideReque
     delete(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<OutgoingNumberSelectionResponse | undefined>;
     /**
      * Sets the outgoing phone number override for a conversation so future lead messages use the selected eligible number.
-     * @param body Request payload for outgoing number manual override.
+     * @param body Request schema for the Leadping API outgoing number manual override request, including the fields clients can send.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<OutgoingNumberSelectionResponse>}
      * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -27,7 +27,7 @@ export interface OverrideRequestBuilder extends BaseRequestBuilder<OverrideReque
     toDeleteRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
     /**
      * Sets the outgoing phone number override for a conversation so future lead messages use the selected eligible number.
-     * @param body Request payload for outgoing number manual override.
+     * @param body Request schema for the Leadping API outgoing number manual override 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/phoneNumbers/outgoing/manualOverride/index.d.ts

@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
 export interface ManualOverrideRequestBuilder extends BaseRequestBuilder<ManualOverrideRequestBuilder> {
     /**
      * Validates a manual outgoing-number override before use, checking ownership, destination, and delivery eligibility.
-     * @param body Request payload for outgoing number manual override.
+     * @param body Request schema for the Leadping API outgoing number manual override request, including the fields clients can send.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<OutgoingNumberSelectionResponse>}
      * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -14,7 +14,7 @@ export interface ManualOverrideRequestBuilder extends BaseRequestBuilder<ManualO
     post(body: OutgoingNumberManualOverrideRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<OutgoingNumberSelectionResponse | undefined>;
     /**
      * Validates a manual outgoing-number override before use, checking ownership, destination, and delivery eligibility.
-     * @param body Request payload for outgoing number manual override.
+     * @param body Request schema for the Leadping API outgoing number manual override 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/phoneNumbers/outgoing/newEscaped/index.d.ts

@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
 export interface NewRequestBuilder extends BaseRequestBuilder<NewRequestBuilder> {
     /**
      * Selects an outgoing phone number for a new outbound lead message using destination, source, and delivery eligibility rules.
-     * @param body Request payload for outgoing number selection.
+     * @param body Request schema for the Leadping API outgoing number selection request, including the fields clients can send.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<OutgoingNumberSelectionResponse>}
      * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -14,7 +14,7 @@ export interface NewRequestBuilder extends BaseRequestBuilder<NewRequestBuilder>
     post(body: OutgoingNumberSelectionRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<OutgoingNumberSelectionResponse | undefined>;
     /**
      * Selects an outgoing phone number for a new outbound lead message using destination, source, and delivery eligibility rules.
-     * @param body Request payload for outgoing number selection.
+     * @param body Request schema for the Leadping API outgoing number selection 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/phoneNumbers/search/index.d.ts

@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
 export interface SearchRequestBuilder extends BaseRequestBuilder<SearchRequestBuilder> {
     /**
      * Searches available phone numbers for purchase, applying country, area, and capability filters for lead communication setup.
-     * @param body Request payload for phone number search.
+     * @param body Request schema for the Leadping API phone number search request, including the fields clients can send.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<PhoneNumberSearchResponse>}
      * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -15,7 +15,7 @@ export interface SearchRequestBuilder extends BaseRequestBuilder<SearchRequestBu
     post(body: PhoneNumberSearchRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<PhoneNumberSearchResponse | undefined>;
     /**
      * Searches available phone numbers for purchase, applying country, area, and capability filters for lead communication setup.
-     * @param body Request payload for phone number search.
+     * @param body Request schema for the Leadping API phone number search 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/sms/send/index.d.ts

@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
 export interface SendRequestBuilder extends BaseRequestBuilder<SendRequestBuilder> {
     /**
      * Sends an SMS message to a lead or phone number, applying current-business sender selection, scheduling, and delivery rules.
-     * @param body Request payload for send SMS.
+     * @param body Request schema for the Leadping API SMS send request, including the fields clients can send.
      * @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
@@ -15,7 +15,7 @@ export interface SendRequestBuilder extends BaseRequestBuilder<SendRequestBuilde
     post(body: SendSmsRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<SmsResponse | undefined>;
     /**
      * Sends an SMS message to a lead or phone number, applying current-business sender selection, scheduling, and delivery rules.
-     * @param body Request payload for send SMS.
+     * @param body Request schema for the Leadping API SMS send 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/sources/index.d.ts

@@ -18,7 +18,7 @@ export interface SourcesRequestBuilder extends BaseRequestBuilder<SourcesRequest
     byId(id: string): SourcesItemRequestBuilder;
     /**
      * Creates a lead source for the current business, storing intake credentials and routing context for captured external leads.
-     * @param body Request payload for source.
+     * @param body Request schema for the Leadping API lead source request, including the fields clients can send.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<SourceResponse>}
      * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -26,7 +26,7 @@ export interface SourcesRequestBuilder extends BaseRequestBuilder<SourcesRequest
     post(body: SourceRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<SourceResponse | undefined>;
     /**
      * Creates a lead source for the current business, storing intake credentials and routing context for captured external leads.
-     * @param body Request payload for source.
+     * @param body Request schema for the Leadping API lead source 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/sources/item/index.d.ts

@@ -24,7 +24,7 @@ export interface SourcesItemRequestBuilder extends BaseRequestBuilder<SourcesIte
     get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<SourceResponse | undefined>;
     /**
      * Updates a lead source for the current business, changing intake settings, credentials, routing context, or active status.
-     * @param body Request payload for source.
+     * @param body Request schema for the Leadping API lead source request, including the fields clients can send.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<SourceResponse>}
      * @throws {ProblemDetails} error when the service returns a 404 status code
@@ -44,7 +44,7 @@ export interface SourcesItemRequestBuilder extends BaseRequestBuilder<SourcesIte
     toGetRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
     /**
      * Updates a lead source for the current business, changing intake settings, credentials, routing context, or active status.
-     * @param body Request payload for source.
+     * @param body Request schema for the Leadping API lead source 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/tags/index.d.ts

@@ -19,7 +19,7 @@ export interface TagsRequestBuilder extends BaseRequestBuilder<TagsRequestBuilde
     get(requestConfiguration?: RequestConfiguration<TagsRequestBuilderGetQueryParameters> | undefined): Promise<TagResponse[] | undefined>;
     /**
      * Creates a tag for the current business so leads can be segmented, filtered, routed, and reviewed by label.
-     * @param body Request payload for creating or updating a business tag.
+     * @param body Request schema for the Leadping API tag request, including the fields clients can send.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<TagResponse>}
      * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -33,7 +33,7 @@ export interface TagsRequestBuilder extends BaseRequestBuilder<TagsRequestBuilde
     toGetRequestInformation(requestConfiguration?: RequestConfiguration<TagsRequestBuilderGetQueryParameters> | undefined): RequestInformation;
     /**
      * Creates a tag for the current business so leads can be segmented, filtered, routed, and reviewed by label.
-     * @param body Request payload for creating or updating a business tag.
+     * @param body Request schema for the Leadping API tag 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/tags/item/index.d.ts

@@ -13,7 +13,7 @@ export interface TagsItemRequestBuilder extends BaseRequestBuilder<TagsItemReque
     delete(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<boolean | undefined>;
     /**
      * Updates a current-business tag's name, color, or archived state so lead segmentation and filters stay consistent.
-     * @param body Request payload for creating or updating a business tag.
+     * @param body Request schema for the Leadping API tag request, including the fields clients can send.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<TagResponse>}
      * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -28,7 +28,7 @@ export interface TagsItemRequestBuilder extends BaseRequestBuilder<TagsItemReque
     toDeleteRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
     /**
      * Updates a current-business tag's name, color, or archived state so lead segmentation and filters stay consistent.
-     * @param body Request payload for creating or updating a business tag.
+     * @param body Request schema for the Leadping API tag 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/users/me/index.d.ts

@@ -23,7 +23,7 @@ export interface MeRequestBuilder extends BaseRequestBuilder<MeRequestBuilder> {
     get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<UserResponse | undefined>;
     /**
      * Updates the current user's profile fields, contact details, preferences, or business context used across Leadping.
-     * @param body Request payload for user.
+     * @param body Request schema for the Leadping API user profile request, including the fields clients can send.
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<UserResponse>}
      * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -37,7 +37,7 @@ export interface MeRequestBuilder extends BaseRequestBuilder<MeRequestBuilder> {
     toGetRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
     /**
      * Updates the current user's profile fields, contact details, preferences, or business context used across Leadping.
-     * @param body Request payload for user.
+     * @param body Request schema for the Leadping API user profile request, including the fields clients can send.
      * @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.7",
+  "version": "1.0.9",
   "description": "Typed TypeScript client for the Leadping API, generated from the Leadping OpenAPI document with Microsoft Kiota.",
   "type": "module",
   "license": "MIT",