@leadping/sdk 1.0.42 → 1.0.44

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
6
6
  export interface MyRequestBuilder extends BaseRequestBuilder<MyRequestBuilder> {
7
7
  /**
8
8
  * Lists current-user automations with paging, sorting, and filters for reviewing follow-up workflows and ownership.
9
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
9
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<PagedResultOfAutomationTableRow>}
12
12
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -17,7 +17,7 @@ export interface MyRequestBuilder extends BaseRequestBuilder<MyRequestBuilder> {
17
17
  post(body: RequestDataOptions, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<PagedResultOfAutomationTableRow | undefined>;
18
18
  /**
19
19
  * Lists current-user automations with paging, sorting, and filters for reviewing follow-up workflows and ownership.
20
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
20
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
21
21
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
22
22
  * @returns {RequestInformation}
23
23
  */
@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
6
6
  export interface WithLeadItemRequestBuilder extends BaseRequestBuilder<WithLeadItemRequestBuilder> {
7
7
  /**
8
8
  * Lists conversations for one lead, helping users inspect communication threads, recent follow-up, and related events.
9
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
9
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<PagedResultOfConversationResponse>}
12
12
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -18,7 +18,7 @@ export interface WithLeadItemRequestBuilder extends BaseRequestBuilder<WithLeadI
18
18
  post(body: RequestDataOptions, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<PagedResultOfConversationResponse | undefined>;
19
19
  /**
20
20
  * Lists conversations for one lead, helping users inspect communication threads, recent follow-up, and related events.
21
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
21
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
22
22
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
23
23
  * @returns {RequestInformation}
24
24
  */
@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
6
6
  export interface MyRequestBuilder extends BaseRequestBuilder<MyRequestBuilder> {
7
7
  /**
8
8
  * Lists the current user's lead conversations with paging and sorting for inbox views, recent follow-up, and communication history.
9
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
9
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<PagedResultOfConversationResponse>}
12
12
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -18,7 +18,7 @@ export interface MyRequestBuilder extends BaseRequestBuilder<MyRequestBuilder> {
18
18
  post(body: RequestDataOptions, requestConfiguration?: RequestConfiguration<MyRequestBuilderPostQueryParameters> | undefined): Promise<PagedResultOfConversationResponse | undefined>;
19
19
  /**
20
20
  * Lists the current user's lead conversations with paging and sorting for inbox views, recent follow-up, and communication history.
21
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
21
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
22
22
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
23
23
  * @returns {RequestInformation}
24
24
  */
@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
6
6
  export interface MyRequestBuilder extends BaseRequestBuilder<MyRequestBuilder> {
7
7
  /**
8
8
  * Lists event records visible to the current user with paging, sorting, and filters across lead, SMS, call, and automation events.
9
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
9
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<PagedResultOfEventTableRow>}
12
12
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -17,7 +17,7 @@ export interface MyRequestBuilder extends BaseRequestBuilder<MyRequestBuilder> {
17
17
  post(body: RequestDataOptions, requestConfiguration?: RequestConfiguration<MyRequestBuilderPostQueryParameters> | undefined): Promise<PagedResultOfEventTableRow | undefined>;
18
18
  /**
19
19
  * Lists event records visible to the current user with paging, sorting, and filters across lead, SMS, call, and automation events.
20
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
20
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
21
21
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
22
22
  * @returns {RequestInformation}
23
23
  */
@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
6
6
  export interface MyRequestBuilder extends BaseRequestBuilder<MyRequestBuilder> {
7
7
  /**
8
8
  * Lists call events visible to the current user with paging, sorting, and filters for call history and lead follow-up review.
9
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
9
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<PagedResultOfCallEventTableRow>}
12
12
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -17,7 +17,7 @@ export interface MyRequestBuilder extends BaseRequestBuilder<MyRequestBuilder> {
17
17
  post(body: RequestDataOptions, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<PagedResultOfCallEventTableRow | undefined>;
18
18
  /**
19
19
  * Lists call events visible to the current user with paging, sorting, and filters for call history and lead follow-up review.
20
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
20
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
21
21
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
22
22
  * @returns {RequestInformation}
23
23
  */
@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
6
6
  export interface WithLeadItemRequestBuilder extends BaseRequestBuilder<WithLeadItemRequestBuilder> {
7
7
  /**
8
8
  * Lists call events for one lead with paging, helping users review call attempts, outcomes, and follow-up history.
9
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
9
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<PagedResultOfCallEventTableRow>}
12
12
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -17,7 +17,7 @@ export interface WithLeadItemRequestBuilder extends BaseRequestBuilder<WithLeadI
17
17
  post(body: RequestDataOptions, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<PagedResultOfCallEventTableRow | undefined>;
18
18
  /**
19
19
  * Lists call events for one lead with paging, helping users review call attempts, outcomes, and follow-up history.
20
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
20
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
21
21
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
22
22
  * @returns {RequestInformation}
23
23
  */
@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
6
6
  export interface WithPhoneNumberItemRequestBuilder extends BaseRequestBuilder<WithPhoneNumberItemRequestBuilder> {
7
7
  /**
8
8
  * Lists call events for one phone number with paging, helping users review volume, outcomes, and communication history.
9
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
9
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<PagedResultOfCallEventTableRow>}
12
12
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -17,7 +17,7 @@ export interface WithPhoneNumberItemRequestBuilder extends BaseRequestBuilder<Wi
17
17
  post(body: RequestDataOptions, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<PagedResultOfCallEventTableRow | undefined>;
18
18
  /**
19
19
  * Lists call events for one phone number with paging, helping users review volume, outcomes, and communication history.
20
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
20
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
21
21
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
22
22
  * @returns {RequestInformation}
23
23
  */
@@ -11,7 +11,7 @@ export interface WithConversationItemRequestBuilder extends BaseRequestBuilder<W
11
11
  get notes(): NotesRequestBuilder;
12
12
  /**
13
13
  * Lists event records for one conversation with paging, including notes, messages, calls, and follow-up history.
14
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
14
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
15
15
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
16
16
  * @returns {Promise<PagedResultOfEventTableRow>}
17
17
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -22,7 +22,7 @@ export interface WithConversationItemRequestBuilder extends BaseRequestBuilder<W
22
22
  post(body: RequestDataOptions, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<PagedResultOfEventTableRow | undefined>;
23
23
  /**
24
24
  * Lists event records for one conversation with paging, including notes, messages, calls, and follow-up history.
25
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
25
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
26
26
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
27
27
  * @returns {RequestInformation}
28
28
  */
@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
6
6
  export interface WithLeadItemRequestBuilder extends BaseRequestBuilder<WithLeadItemRequestBuilder> {
7
7
  /**
8
8
  * Lists event records for one lead with paging, covering communication, routing, automation, and event changes.
9
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
9
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<PagedResultOfEventTableRow>}
12
12
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -17,7 +17,7 @@ export interface WithLeadItemRequestBuilder extends BaseRequestBuilder<WithLeadI
17
17
  post(body: RequestDataOptions, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<PagedResultOfEventTableRow | undefined>;
18
18
  /**
19
19
  * Lists event records for one lead with paging, covering communication, routing, automation, and event changes.
20
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
20
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
21
21
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
22
22
  * @returns {RequestInformation}
23
23
  */
@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
6
6
  export interface WithOrganizationItemRequestBuilder extends BaseRequestBuilder<WithOrganizationItemRequestBuilder> {
7
7
  /**
8
8
  * Lists event records for an organization with paging and filters so admins can review lead communication and automation events.
9
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
9
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<PagedResultOfEventTableRow>}
12
12
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -17,7 +17,7 @@ export interface WithOrganizationItemRequestBuilder extends BaseRequestBuilder<W
17
17
  post(body: RequestDataOptions, requestConfiguration?: RequestConfiguration<WithOrganizationItemRequestBuilderPostQueryParameters> | undefined): Promise<PagedResultOfEventTableRow | undefined>;
18
18
  /**
19
19
  * Lists event records for an organization with paging and filters so admins can review lead communication and automation events.
20
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
20
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
21
21
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
22
22
  * @returns {RequestInformation}
23
23
  */
@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
6
6
  export interface MyRequestBuilder extends BaseRequestBuilder<MyRequestBuilder> {
7
7
  /**
8
8
  * Lists SMS events visible to the current user with paging, sorting, and filters for message history and follow-up review.
9
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
9
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<PagedResultOfSmsEventTableRow>}
12
12
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -17,7 +17,7 @@ export interface MyRequestBuilder extends BaseRequestBuilder<MyRequestBuilder> {
17
17
  post(body: RequestDataOptions, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<PagedResultOfSmsEventTableRow | undefined>;
18
18
  /**
19
19
  * Lists SMS events visible to the current user with paging, sorting, and filters for message history and follow-up review.
20
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
20
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
21
21
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
22
22
  * @returns {RequestInformation}
23
23
  */
@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
6
6
  export interface WithLeadItemRequestBuilder extends BaseRequestBuilder<WithLeadItemRequestBuilder> {
7
7
  /**
8
8
  * Lists SMS events for one lead with paging, helping users review sent messages, scheduled messages, and delivery outcomes.
9
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
9
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<PagedResultOfSmsEventTableRow>}
12
12
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -17,7 +17,7 @@ export interface WithLeadItemRequestBuilder extends BaseRequestBuilder<WithLeadI
17
17
  post(body: RequestDataOptions, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<PagedResultOfSmsEventTableRow | undefined>;
18
18
  /**
19
19
  * Lists SMS events for one lead with paging, helping users review sent messages, scheduled messages, and delivery outcomes.
20
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
20
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
21
21
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
22
22
  * @returns {RequestInformation}
23
23
  */
@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
6
6
  export interface WithPhoneNumberItemRequestBuilder extends BaseRequestBuilder<WithPhoneNumberItemRequestBuilder> {
7
7
  /**
8
8
  * Lists SMS events for one phone number with paging, helping users review volume, delivery outcomes, and communication history.
9
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
9
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<PagedResultOfSmsEventTableRow>}
12
12
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -17,7 +17,7 @@ export interface WithPhoneNumberItemRequestBuilder extends BaseRequestBuilder<Wi
17
17
  post(body: RequestDataOptions, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<PagedResultOfSmsEventTableRow | undefined>;
18
18
  /**
19
19
  * Lists SMS events for one phone number with paging, helping users review volume, delivery outcomes, and communication history.
20
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
20
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
21
21
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
22
22
  * @returns {RequestInformation}
23
23
  */
@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
6
6
  export interface MyRequestBuilder extends BaseRequestBuilder<MyRequestBuilder> {
7
7
  /**
8
8
  * Returns a filtered, paginated history of lead status changes for the current organization for workflow analysis, reporting, and audit review.
9
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
9
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<PagedResultOfLeadStatusChangeResponse>}
12
12
  * @throws {ProblemDetails} error when the service returns a 401 status code
@@ -16,7 +16,7 @@ export interface MyRequestBuilder extends BaseRequestBuilder<MyRequestBuilder> {
16
16
  post(body: RequestDataOptions, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<PagedResultOfLeadStatusChangeResponse | undefined>;
17
17
  /**
18
18
  * Returns a filtered, paginated history of lead status changes for the current organization for workflow analysis, reporting, and audit review.
19
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
19
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
20
20
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
21
21
  * @returns {RequestInformation}
22
22
  */
@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
6
6
  export interface MyRequestBuilder extends BaseRequestBuilder<MyRequestBuilder> {
7
7
  /**
8
8
  * Lists leads visible to the current user with paging, sorting, filters, tags, and archive status for pipeline review.
9
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
9
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<PagedResultOfLeadTableRow>}
12
12
  * @throws {ProblemDetails} error when the service returns a 401 status code
@@ -16,7 +16,7 @@ export interface MyRequestBuilder extends BaseRequestBuilder<MyRequestBuilder> {
16
16
  post(body: RequestDataOptions, requestConfiguration?: RequestConfiguration<MyRequestBuilderPostQueryParameters> | undefined): Promise<PagedResultOfLeadTableRow | undefined>;
17
17
  /**
18
18
  * Lists leads visible to the current user with paging, sorting, filters, tags, and archive status for pipeline review.
19
- * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
19
+ * @param body Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.
20
20
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
21
21
  * @returns {RequestInformation}
22
22
  */