@leadping/sdk 1.0.55 → 1.0.57

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.
@@ -4,7 +4,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
4
4
  */
5
5
  export interface A2aRequestBuilder extends BaseRequestBuilder<A2aRequestBuilder> {
6
6
  /**
7
- * Accepts authenticated A2A JSON-RPC requests for Leadping's supported agent operations.
7
+ * Send authenticated A2A JSON-RPC requests to Leadping through the API to access supported agent operations and integrate them into your agent workflows.
8
8
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
9
9
  * @returns {Promise<ArrayBuffer>}
10
10
  * @throws {ProblemDetails} error when the service returns a 401 status code
@@ -13,7 +13,7 @@ export interface A2aRequestBuilder extends BaseRequestBuilder<A2aRequestBuilder>
13
13
  */
14
14
  post(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<ArrayBuffer | undefined>;
15
15
  /**
16
- * Accepts authenticated A2A JSON-RPC requests for Leadping's supported agent operations.
16
+ * Send authenticated A2A JSON-RPC requests to Leadping through the API to access supported agent operations and integrate them into your agent workflows.
17
17
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
18
18
  * @returns {RequestInformation}
19
19
  */
@@ -5,7 +5,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
5
5
  */
6
6
  export interface PreviewRequestBuilder extends BaseRequestBuilder<PreviewRequestBuilder> {
7
7
  /**
8
- * 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.
8
+ * Preview matched automation steps and messages for a sample lead without creating follow-up events, or use validate_only to check the automation configuration.
9
9
  * @param body Defines the fields clients can send when working with automation preview.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<AutomationPreviewResponse>}
@@ -16,7 +16,7 @@ export interface PreviewRequestBuilder extends BaseRequestBuilder<PreviewRequest
16
16
  */
17
17
  post(body: AutomationPreviewRequest, requestConfiguration?: RequestConfiguration<PreviewRequestBuilderPostQueryParameters> | undefined): Promise<AutomationPreviewResponse | undefined>;
18
18
  /**
19
- * 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.
19
+ * Preview matched automation steps and messages for a sample lead without creating follow-up events, or use validate_only to check the automation configuration.
20
20
  * @param body Defines the fields clients can send when working with automation preview.
21
21
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
22
22
  * @returns {RequestInformation}
@@ -24,7 +24,7 @@ export interface PreviewRequestBuilder extends BaseRequestBuilder<PreviewRequest
24
24
  toPostRequestInformation(body: AutomationPreviewRequest, requestConfiguration?: RequestConfiguration<PreviewRequestBuilderPostQueryParameters> | undefined): RequestInformation;
25
25
  }
26
26
  /**
27
- * 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.
27
+ * Preview matched automation steps and messages for a sample lead without creating follow-up events, or use validate_only to check the automation configuration.
28
28
  */
29
29
  export interface PreviewRequestBuilderPostQueryParameters {
30
30
  /**
@@ -12,14 +12,14 @@ export interface BlogRequestBuilder extends BaseRequestBuilder<BlogRequestBuilde
12
12
  */
13
13
  bySlug(slug: string): WithSlugItemRequestBuilder;
14
14
  /**
15
- * Returns the Leadping blog articles currently available to public readers.
15
+ * Retrieve the list of published Leadping blog articles through the public API. This endpoint returns articles available to readers without authentication.
16
16
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
17
17
  * @returns {Promise<BlogArticleResponse[]>}
18
18
  * @throws {ProblemDetails} error when the service returns a 429 status code
19
19
  */
20
20
  get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<BlogArticleResponse[] | undefined>;
21
21
  /**
22
- * Returns the Leadping blog articles currently available to public readers.
22
+ * Retrieve the list of published Leadping blog articles through the public API. This endpoint returns articles available to readers without authentication.
23
23
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
24
24
  * @returns {RequestInformation}
25
25
  */
@@ -24,7 +24,7 @@ export interface LeadStatusChangesItemRequestBuilder extends BaseRequestBuilder<
24
24
  */
25
25
  get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<LeadStatusChangeResponse | undefined>;
26
26
  /**
27
- * Updates a lead status history entry and, when it is current, updates the lead's current status.
27
+ * 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.
28
28
  * @param body Defines a lead status transition or correction, including its target status, effective time, source, and explanatory context.
29
29
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
30
30
  * @returns {Promise<LeadStatusChangeResponse>}
@@ -48,7 +48,7 @@ export interface LeadStatusChangesItemRequestBuilder extends BaseRequestBuilder<
48
48
  */
49
49
  toGetRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
50
50
  /**
51
- * Updates a lead status history entry and, when it is current, updates the lead's current status.
51
+ * 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.
52
52
  * @param body Defines a lead status transition or correction, including its target status, effective time, source, and explanatory context.
53
53
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
54
54
  * @returns {RequestInformation}
@@ -10,7 +10,7 @@ export interface ArchivePostRequestBody extends LeadArchiveRequest, Parsable {
10
10
  */
11
11
  export interface ArchiveRequestBuilder extends BaseRequestBuilder<ArchiveRequestBuilder> {
12
12
  /**
13
- * 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.
13
+ * Archive a lead to remove it from active pipeline views while preserving communication and event history. An optional request body supplies the archive reason.
14
14
  * @param body Defines the fields clients can send when working with lead archive.
15
15
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
16
16
  * @returns {Promise<LeadResponse>}
@@ -22,7 +22,7 @@ export interface ArchiveRequestBuilder extends BaseRequestBuilder<ArchiveRequest
22
22
  */
23
23
  post(body: ArchivePostRequestBody, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<LeadResponse | undefined>;
24
24
  /**
25
- * 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.
25
+ * Archive a lead to remove it from active pipeline views while preserving communication and event history. An optional request body supplies the archive reason.
26
26
  * @param body Defines the fields clients can send when working with lead archive.
27
27
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
28
28
  * @returns {RequestInformation}
@@ -40,7 +40,7 @@ export interface ItemRequestBuilder extends BaseRequestBuilder<ItemRequestBuilde
40
40
  */
41
41
  get workflowStatus(): WorkflowStatusRequestBuilder;
42
42
  /**
43
- * 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.
43
+ * Mark a lead as deleted to hide it from lead, conversation, routing, and event workflows while retaining the stored lead, conversation, and event records.
44
44
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
45
45
  * @throws {ProblemDetails} error when the service returns a 401 status code
46
46
  * @throws {ProblemDetails} error when the service returns a 403 status code
@@ -71,7 +71,7 @@ export interface ItemRequestBuilder extends BaseRequestBuilder<ItemRequestBuilde
71
71
  */
72
72
  put(body: LeadRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<LeadResponse | undefined>;
73
73
  /**
74
- * 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.
74
+ * Mark a lead as deleted to hide it from lead, conversation, routing, and event workflows while retaining the stored lead, conversation, and event records.
75
75
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
76
76
  * @returns {RequestInformation}
77
77
  */
@@ -645,6 +645,10 @@ export interface AutomationRunRecord extends AdditionalDataHolder, Parsable {
645
645
  * UTC timestamp when processing completed for this automation run record.
646
646
  */
647
647
  completedAt?: Date | null;
648
+ /**
649
+ * Results of condition nodes already visited by this run, preserved across waits and retries.
650
+ */
651
+ conditionResults?: AutomationRunRecord_conditionResults | null;
648
652
  /**
649
653
  * Execution mode used for automation preview or live workflow processing.
650
654
  */
@@ -685,11 +689,20 @@ export interface AutomationRunRecord extends AdditionalDataHolder, Parsable {
685
689
  * Current lifecycle status for this automation run record in the Leadping API.
686
690
  */
687
691
  status?: string | null;
692
+ /**
693
+ * Identifier of the trigger node selected when this run was queued.
694
+ */
695
+ triggerId?: string | null;
688
696
  /**
689
697
  * Automation trigger type that starts the workflow.
690
698
  */
691
699
  triggerType?: string | null;
692
700
  }
701
+ /**
702
+ * Results of condition nodes already visited by this run, preserved across waits and retries.
703
+ */
704
+ export interface AutomationRunRecord_conditionResults extends AdditionalDataHolder, Parsable {
705
+ }
693
706
  /**
694
707
  * Summarizes automation data in paginated and searchable results.
695
708
  */
@@ -1598,6 +1611,12 @@ export declare function createAutomationResponse_userFromDiscriminatorValue(pars
1598
1611
  * @returns {AutomationResponse}
1599
1612
  */
1600
1613
  export declare function createAutomationResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
1614
+ /**
1615
+ * Creates a new instance of the appropriate class based on discriminator value
1616
+ * @param parseNode The parse node to use to read the discriminator value and create the object
1617
+ * @returns {AutomationRunRecord_conditionResults}
1618
+ */
1619
+ export declare function createAutomationRunRecord_conditionResultsFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
1601
1620
  /**
1602
1621
  * Creates a new instance of the appropriate class based on discriminator value
1603
1622
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -3709,6 +3728,12 @@ export declare function deserializeIntoAutomationResponse_user(automationRespons
3709
3728
  * @returns {Record<string, (node: ParseNode) => void>}
3710
3729
  */
3711
3730
  export declare function deserializeIntoAutomationRunRecord(automationRunRecord?: Partial<AutomationRunRecord> | undefined): Record<string, (node: ParseNode) => void>;
3731
+ /**
3732
+ * The deserialization information for the current model
3733
+ * @param AutomationRunRecord_conditionResults The instance to deserialize into.
3734
+ * @returns {Record<string, (node: ParseNode) => void>}
3735
+ */
3736
+ export declare function deserializeIntoAutomationRunRecord_conditionResults(automationRunRecord_conditionResults?: Partial<AutomationRunRecord_conditionResults> | undefined): Record<string, (node: ParseNode) => void>;
3712
3737
  /**
3713
3738
  * The deserialization information for the current model
3714
3739
  * @param AutomationTableRow The instance to deserialize into.
@@ -9981,6 +10006,13 @@ export declare function serializeAutomationResponse_user(writer: SerializationWr
9981
10006
  * @param writer Serialization writer to use to serialize this model
9982
10007
  */
9983
10008
  export declare function serializeAutomationRunRecord(writer: SerializationWriter, automationRunRecord?: Partial<AutomationRunRecord> | undefined | null, isSerializingDerivedType?: boolean): void;
10009
+ /**
10010
+ * Serializes information the current object
10011
+ * @param AutomationRunRecord_conditionResults The instance to serialize from.
10012
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
10013
+ * @param writer Serialization writer to use to serialize this model
10014
+ */
10015
+ export declare function serializeAutomationRunRecord_conditionResults(writer: SerializationWriter, automationRunRecord_conditionResults?: Partial<AutomationRunRecord_conditionResults> | undefined | null, isSerializingDerivedType?: boolean): void;
9984
10016
  /**
9985
10017
  * Serializes information the current object
9986
10018
  * @param AutomationTableRow The instance to serialize from.