@leadping/sdk 1.0.75 → 1.0.77

package/dist/models/index.d.ts

@@ -100,6 +100,23 @@ export interface AnalyticsComparison extends AdditionalDataHolder, Parsable {
      */
     previous?: number | null;
 }
+/**
+ * States whether missing historical evidence can make reported counts incomplete.
+ */
+export interface AnalyticsCoverage extends AdditionalDataHolder, Parsable {
+    /**
+     * The completeFrom property
+     */
+    completeFrom?: Date | null;
+    /**
+     * The detail property
+     */
+    detail?: string | null;
+    /**
+     * The isPartial property
+     */
+    isPartial?: boolean | null;
+}
 /**
  * Defines the inclusive reporting window and comparison window used to calculate Leadping analytics.
  */
@@ -340,6 +357,31 @@ export interface AutomationConsoleResponse extends AdditionalDataHolder, Parsabl
      */
     runs?: AutomationWorkflowRunResponse[] | null;
 }
+/**
+ * Persisted origin of an automation run and the events produced by its actions.
+ */
+export interface AutomationLineage extends AdditionalDataHolder, Parsable {
+    /**
+     * The actionId property
+     */
+    actionId?: string | null;
+    /**
+     * Automation IDs in execution order, including the run that produced this event.
+     */
+    automationIds?: string[] | null;
+    /**
+     * The rootEventId property
+     */
+    rootEventId?: string | null;
+    /**
+     * The runId property
+     */
+    runId?: string | null;
+    /**
+     * The triggerEventId property
+     */
+    triggerEventId?: string | null;
+}
 /**
  * Result schema for the Leadping API automation preview action result returned by lookup and validation endpoints.
  */
@@ -666,6 +708,10 @@ export interface AutomationRunRecord extends AdditionalDataHolder, Parsable {
      * Automation ID connected to this workflow, run, or event.
      */
     automationId?: string | null;
+    /**
+     * Persisted origin of an automation run and the events produced by its actions.
+     */
+    automationLineage?: AutomationRunRecord_automationLineage | null;
     /**
      * UTC timestamp when processing completed for this automation run record.
      */
@@ -723,6 +769,11 @@ export interface AutomationRunRecord extends AdditionalDataHolder, Parsable {
      */
     triggerType?: string | null;
 }
+/**
+ * Persisted origin of an automation run and the events produced by its actions.
+ */
+export interface AutomationRunRecord_automationLineage extends AutomationLineage, Parsable {
+}
 /**
  * Results of condition nodes already visited by this run, preserved across waits and retries.
  */
@@ -1523,6 +1574,10 @@ export interface ConversationResponse extends AdditionalDataHolder, Parsable {
      * Email address used to resolve the lead's avatar when available.
      */
     email?: string | null;
+    /**
+     * Monotonic event boundary. Mark-read requests must send the version the reader observed.
+     */
+    eventVersion?: number | null;
     /**
      * First name of the lead, user, or contact represented by this conversation response.
      */
@@ -1636,6 +1691,12 @@ export declare function createActivationTimelineEventFromDiscriminatorValue(pars
  * @returns {AnalyticsComparison}
  */
 export declare function createAnalyticsComparisonFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
+/**
+ * Creates a new instance of the appropriate class based on discriminator value
+ * @param parseNode The parse node to use to read the discriminator value and create the object
+ * @returns {AnalyticsCoverage}
+ */
+export declare function createAnalyticsCoverageFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
 /**
  * Creates a new instance of the appropriate class based on discriminator value
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -1708,6 +1769,12 @@ export declare function createAutomationConnectionFromDiscriminatorValue(parseNo
  * @returns {AutomationConsoleResponse}
  */
 export declare function createAutomationConsoleResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
+/**
+ * Creates a new instance of the appropriate class based on discriminator value
+ * @param parseNode The parse node to use to read the discriminator value and create the object
+ * @returns {AutomationLineage}
+ */
+export declare function createAutomationLineageFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
 /**
  * Creates a new instance of the appropriate class based on discriminator value
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -1768,6 +1835,12 @@ export declare function createAutomationResponse_userFromDiscriminatorValue(pars
  * @returns {AutomationResponse}
  */
 export declare function createAutomationResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
+/**
+ * Creates a new instance of the appropriate class based on discriminator value
+ * @param parseNode The parse node to use to read the discriminator value and create the object
+ * @returns {AutomationRunRecord_automationLineage}
+ */
+export declare function createAutomationRunRecord_automationLineageFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
 /**
  * Creates a new instance of the appropriate class based on discriminator value
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -2134,6 +2207,12 @@ export declare function createLeadContact_streetAddressFromDiscriminatorValue(pa
  * @returns {LeadContact}
  */
 export declare function createLeadContactFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
+/**
+ * Creates a new instance of the appropriate class based on discriminator value
+ * @param parseNode The parse node to use to read the discriminator value and create the object
+ * @returns {LeadFollowUpUpdateRequest}
+ */
+export declare function createLeadFollowUpUpdateRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
 /**
  * Creates a new instance of the appropriate class based on discriminator value
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -3295,6 +3374,14 @@ export interface CurrentLeadStatusSummary extends AdditionalDataHolder, Parsable
      * Human-readable display name shown for this current lead status change summary.
      */
     displayName?: string | null;
+    /**
+     * When this follow-up was completed; email/call activity alone does not complete it.
+     */
+    followUpCompletedAt?: Date | null;
+    /**
+     * The earliest callback or task time for the current status.
+     */
+    followUpDueAt?: Date | null;
     /**
      * Unique Leadping identifier for this current lead status change summary.
      */
@@ -3303,6 +3390,10 @@ export interface CurrentLeadStatusSummary extends AdditionalDataHolder, Parsable
      * Current lead status change outcome assigned to the lead.
      */
     outcome?: string | null;
+    /**
+     * Monotonic revision of the lead's current status and scheduling state.
+     */
+    revision?: number | null;
     /**
      * Known sources that can change a lead's current lead status change.
      */
@@ -3515,6 +3606,10 @@ export interface CustomerAutomationHealth extends AdditionalDataHolder, Parsable
      * Total number of automation records represented by this Leadping customer automation health.
      */
     automationCount?: number | null;
+    /**
+     * States whether missing historical evidence can make reported counts incomplete.
+     */
+    coverage?: AnalyticsCoverage | null;
     /**
      * Total number of enabled records represented by this Leadping customer automation health.
      */
@@ -3938,6 +4033,12 @@ export declare function deserializeIntoActivationTimelineEvent_actor(activationT
  * @returns {Record<string, (node: ParseNode) => void>}
  */
 export declare function deserializeIntoAnalyticsComparison(analyticsComparison?: Partial<AnalyticsComparison> | undefined): Record<string, (node: ParseNode) => void>;
+/**
+ * The deserialization information for the current model
+ * @param AnalyticsCoverage The instance to deserialize into.
+ * @returns {Record<string, (node: ParseNode) => void>}
+ */
+export declare function deserializeIntoAnalyticsCoverage(analyticsCoverage?: Partial<AnalyticsCoverage> | undefined): Record<string, (node: ParseNode) => void>;
 /**
  * The deserialization information for the current model
  * @param AnalyticsDateRange The instance to deserialize into.
@@ -4010,6 +4111,12 @@ export declare function deserializeIntoAutomationConnection(automationConnection
  * @returns {Record<string, (node: ParseNode) => void>}
  */
 export declare function deserializeIntoAutomationConsoleResponse(automationConsoleResponse?: Partial<AutomationConsoleResponse> | undefined): Record<string, (node: ParseNode) => void>;
+/**
+ * The deserialization information for the current model
+ * @param AutomationLineage The instance to deserialize into.
+ * @returns {Record<string, (node: ParseNode) => void>}
+ */
+export declare function deserializeIntoAutomationLineage(automationLineage?: Partial<AutomationLineage> | undefined): Record<string, (node: ParseNode) => void>;
 /**
  * The deserialization information for the current model
  * @param AutomationPreviewActionResult The instance to deserialize into.
@@ -4076,6 +4183,12 @@ export declare function deserializeIntoAutomationResponse_user(automationRespons
  * @returns {Record<string, (node: ParseNode) => void>}
  */
 export declare function deserializeIntoAutomationRunRecord(automationRunRecord?: Partial<AutomationRunRecord> | undefined): Record<string, (node: ParseNode) => void>;
+/**
+ * The deserialization information for the current model
+ * @param AutomationRunRecord_automationLineage The instance to deserialize into.
+ * @returns {Record<string, (node: ParseNode) => void>}
+ */
+export declare function deserializeIntoAutomationRunRecord_automationLineage(automationRunRecord_automationLineage?: Partial<AutomationRunRecord_automationLineage> | undefined): Record<string, (node: ParseNode) => void>;
 /**
  * The deserialization information for the current model
  * @param AutomationRunRecord_conditionResults The instance to deserialize into.
@@ -4436,6 +4549,12 @@ export declare function deserializeIntoLeadContact_phone(leadContact_phone?: Par
  * @returns {Record<string, (node: ParseNode) => void>}
  */
 export declare function deserializeIntoLeadContact_streetAddress(leadContact_streetAddress?: Partial<LeadContact_streetAddress> | undefined): Record<string, (node: ParseNode) => void>;
+/**
+ * The deserialization information for the current model
+ * @param LeadFollowUpUpdateRequest The instance to deserialize into.
+ * @returns {Record<string, (node: ParseNode) => void>}
+ */
+export declare function deserializeIntoLeadFollowUpUpdateRequest(leadFollowUpUpdateRequest?: Partial<LeadFollowUpUpdateRequest> | undefined): Record<string, (node: ParseNode) => void>;
 /**
  * The deserialization information for the current model
  * @param LeadIntakeRequest The instance to deserialize into.
@@ -5966,6 +6085,10 @@ export interface EventTableRow extends AdditionalDataHolder, Parsable {
      * UTC timestamp when the provider marked the message undeliverable.
      */
     undeliverableAt?: Date | null;
+    /**
+     * Playable recording URL for voicemail events.
+     */
+    voicemailUrl?: string | null;
     /**
      * Indicates whether a user manually overrode Leadping's automatic number selection for this event timeline table row.
      */
@@ -6223,6 +6346,23 @@ export interface LeadContact_phone extends Parsable, Phone {
  */
 export interface LeadContact_streetAddress extends Parsable, StreetAddress {
 }
+/**
+ * Completes or reschedules exactly the follow-up version the operator viewed.
+ */
+export interface LeadFollowUpUpdateRequest extends AdditionalDataHolder, Parsable {
+    /**
+     * The new time, or null to complete the follow-up.
+     */
+    dueAt?: Date | null;
+    /**
+     * The expectedRevision property
+     */
+    expectedRevision?: number | null;
+    /**
+     * The expectedStatusId property
+     */
+    expectedStatusId?: string | null;
+}
 /**
  * Defines the fields clients can send when working with lead intake.
  */
@@ -6911,6 +7051,18 @@ export interface LeadStatusChangeRequest extends AdditionalDataHolder, Parsable
      * Controlled lead status change categories used for reporting, automation, and analytics.
      */
     category?: LeadStatusChangeRequest_category | null;
+    /**
+     * Whether the scheduled follow-up is explicitly complete.
+     */
+    completeFollowUp?: boolean | null;
+    /**
+     * Optional optimistic concurrency guard for the status currently displayed by the client.
+     */
+    expectedCurrentStatusId?: string | null;
+    /**
+     * Optional revision guard, including when the lead has no persisted status history yet.
+     */
+    expectedRevision?: number | null;
     /**
      * The current follow up status for this lead status change.
      */
@@ -6985,6 +7137,10 @@ export interface LeadStatusChangeResponse extends AdditionalDataHolder, Parsable
      * UTC timestamp for created at on this lead status change.
      */
     createdAt?: Date | null;
+    /**
+     * When this follow-up was completed; email/call activity alone does not complete it.
+     */
+    followUpCompletedAt?: Date | null;
     /**
      * The current follow up status for this lead status change.
      */
@@ -7049,6 +7205,10 @@ export interface LeadStatusChangeResponse extends AdditionalDataHolder, Parsable
      * The related call event ID associated with this lead status change.
      */
     relatedCallEventId?: string | null;
+    /**
+     * Monotonic revision of the lead's current status and scheduling state.
+     */
+    revision?: number | null;
     /**
      * The source ID associated with this lead status change.
      */
@@ -7341,6 +7501,10 @@ export interface NotificationResponse extends AdditionalDataHolder, Parsable {
      * The URL associated with this notification.
      */
     actionUrl?: string | null;
+    /**
+     * The mobile conversation destination.
+     */
+    conversationId?: string | null;
     /**
      * UTC timestamp when the resource was created.
      */
@@ -7361,6 +7525,10 @@ export interface NotificationResponse extends AdditionalDataHolder, Parsable {
      * Whether this notification is read.
      */
     isRead?: boolean | null;
+    /**
+     * The lead used to resolve the conversation.
+     */
+    leadId?: string | null;
     /**
      * Message for this notification.
      */
@@ -7373,6 +7541,10 @@ export interface NotificationResponse extends AdditionalDataHolder, Parsable {
      * Human-readable display name of the resource.
      */
     name?: string | null;
+    /**
+     * The organization selected before opening this notification.
+     */
+    organizationId?: string | null;
     /**
      * Ranks the urgency and presentation importance of a Leadping user notification.
      */
@@ -9168,7 +9340,7 @@ export interface Phone extends AdditionalDataHolder, Parsable {
      */
     number?: string | null;
     /**
-     * Identifier of the canonical phone identity stored by Leadping.
+     * Server-derived identifier of the canonical phone identity. Client-supplied linkage is ignored when creating or updating a lead.
      */
     phoneIdentityId?: string | null;
     /**
@@ -9248,6 +9420,10 @@ export interface PhoneCallResponse extends AdditionalDataHolder, Parsable {
      * UTC timestamp when the resource was last modified, or null when it has not been updated.
      */
     modifiedAt?: Date | null;
+    /**
+     * The organization context required to handle this call on a mobile device.
+     */
+    organizationId?: string | null;
     /**
      * Phone number used by this phone call for calls, SMS, lookup, or routing.
      */
@@ -10394,6 +10570,13 @@ export declare function serializeActivationTimelineEvent_actor(writer: Serializa
  * @param writer Serialization writer to use to serialize this model
  */
 export declare function serializeAnalyticsComparison(writer: SerializationWriter, analyticsComparison?: Partial<AnalyticsComparison> | undefined | null, isSerializingDerivedType?: boolean): void;
+/**
+ * Serializes information the current object
+ * @param AnalyticsCoverage The instance to serialize from.
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
+ * @param writer Serialization writer to use to serialize this model
+ */
+export declare function serializeAnalyticsCoverage(writer: SerializationWriter, analyticsCoverage?: Partial<AnalyticsCoverage> | undefined | null, isSerializingDerivedType?: boolean): void;
 /**
  * Serializes information the current object
  * @param AnalyticsDateRange The instance to serialize from.
@@ -10478,6 +10661,13 @@ export declare function serializeAutomationConnection(writer: SerializationWrite
  * @param writer Serialization writer to use to serialize this model
  */
 export declare function serializeAutomationConsoleResponse(writer: SerializationWriter, automationConsoleResponse?: Partial<AutomationConsoleResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
+/**
+ * Serializes information the current object
+ * @param AutomationLineage The instance to serialize from.
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
+ * @param writer Serialization writer to use to serialize this model
+ */
+export declare function serializeAutomationLineage(writer: SerializationWriter, automationLineage?: Partial<AutomationLineage> | undefined | null, isSerializingDerivedType?: boolean): void;
 /**
  * Serializes information the current object
  * @param AutomationPreviewActionResult The instance to serialize from.
@@ -10555,6 +10745,13 @@ export declare function serializeAutomationResponse_user(writer: SerializationWr
  * @param writer Serialization writer to use to serialize this model
  */
 export declare function serializeAutomationRunRecord(writer: SerializationWriter, automationRunRecord?: Partial<AutomationRunRecord> | undefined | null, isSerializingDerivedType?: boolean): void;
+/**
+ * Serializes information the current object
+ * @param AutomationRunRecord_automationLineage The instance to serialize from.
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
+ * @param writer Serialization writer to use to serialize this model
+ */
+export declare function serializeAutomationRunRecord_automationLineage(writer: SerializationWriter, automationRunRecord_automationLineage?: Partial<AutomationRunRecord_automationLineage> | undefined | null, isSerializingDerivedType?: boolean): void;
 /**
  * Serializes information the current object
  * @param AutomationRunRecord_conditionResults The instance to serialize from.
@@ -10975,6 +11172,13 @@ export declare function serializeLeadContact_phone(writer: SerializationWriter,
  * @param writer Serialization writer to use to serialize this model
  */
 export declare function serializeLeadContact_streetAddress(writer: SerializationWriter, leadContact_streetAddress?: Partial<LeadContact_streetAddress> | undefined | null, isSerializingDerivedType?: boolean): void;
+/**
+ * Serializes information the current object
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
+ * @param LeadFollowUpUpdateRequest The instance to serialize from.
+ * @param writer Serialization writer to use to serialize this model
+ */
+export declare function serializeLeadFollowUpUpdateRequest(writer: SerializationWriter, leadFollowUpUpdateRequest?: Partial<LeadFollowUpUpdateRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
 /**
  * Serializes information the current object
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.