@leadping/sdk 1.0.35 → 1.0.37

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.
@@ -331,6 +331,19 @@ export interface AutomationConnection extends AdditionalDataHolder, Parsable {
331
331
  */
332
332
  targetNodeId?: string | null;
333
333
  }
334
+ /**
335
+ * Recent persisted execution runs for an automation console.
336
+ */
337
+ export interface AutomationConsoleResponse extends AdditionalDataHolder, Parsable {
338
+ /**
339
+ * The automationId property
340
+ */
341
+ automationId?: string | null;
342
+ /**
343
+ * The runs property
344
+ */
345
+ runs?: AutomationWorkflowRunResponse[] | null;
346
+ }
334
347
  /**
335
348
  * Result schema for the Leadping API automation preview action result returned by lookup and validation endpoints.
336
349
  */
@@ -1116,6 +1129,10 @@ export interface CallEventTableRow extends AdditionalDataHolder, Parsable {
1116
1129
  * Caller ID phone number presented during the outbound call.
1117
1130
  */
1118
1131
  callerId?: string | null;
1132
+ /**
1133
+ * Ordered diagnostic entries recorded while Leadping processed this call.
1134
+ */
1135
+ consoleEntries?: CommunicationConsoleEntry[] | null;
1119
1136
  /**
1120
1137
  * Conversation ID that links this call event table row to the Leadping inbox thread.
1121
1138
  */
@@ -1188,10 +1205,18 @@ export interface CallEventTableRow extends AdditionalDataHolder, Parsable {
1188
1205
  * User summary connected to this call event table row.
1189
1206
  */
1190
1207
  user?: string | null;
1208
+ /**
1209
+ * Email address for the person or agent who initiated this call event.
1210
+ */
1211
+ userEmail?: string | null;
1191
1212
  /**
1192
1213
  * User ID associated with the person or agent who initiated this call event.
1193
1214
  */
1194
1215
  userId?: string | null;
1216
+ /**
1217
+ * Display name for the person or agent who initiated this call event.
1218
+ */
1219
+ userName?: string | null;
1195
1220
  }
1196
1221
  export type CallEventTableRow_status = (typeof CallEventTableRow_statusObject)[keyof typeof CallEventTableRow_statusObject];
1197
1222
  /**
@@ -1207,6 +1232,31 @@ export interface ChangeBillingPlanRequest extends AdditionalDataHolder, Parsable
1207
1232
  */
1208
1233
  userId?: string | null;
1209
1234
  }
1235
+ /**
1236
+ * Describes one durable diagnostic entry from the processing of a communication.
1237
+ */
1238
+ export interface CommunicationConsoleEntry extends AdditionalDataHolder, Parsable {
1239
+ /**
1240
+ * The id property
1241
+ */
1242
+ id?: string | null;
1243
+ /**
1244
+ * The message property
1245
+ */
1246
+ message?: string | null;
1247
+ /**
1248
+ * The occurredAt property
1249
+ */
1250
+ occurredAt?: Date | null;
1251
+ /**
1252
+ * The stage property
1253
+ */
1254
+ stage?: string | null;
1255
+ /**
1256
+ * The status property
1257
+ */
1258
+ status?: string | null;
1259
+ }
1210
1260
  /**
1211
1261
  * Defines the input used for compliance update.
1212
1262
  */
@@ -1458,6 +1508,12 @@ export declare function createAutomationConditionGroupFromDiscriminatorValue(par
1458
1508
  * @returns {AutomationConnection}
1459
1509
  */
1460
1510
  export declare function createAutomationConnectionFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
1511
+ /**
1512
+ * Creates a new instance of the appropriate class based on discriminator value
1513
+ * @param parseNode The parse node to use to read the discriminator value and create the object
1514
+ * @returns {AutomationConsoleResponse}
1515
+ */
1516
+ export declare function createAutomationConsoleResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
1461
1517
  /**
1462
1518
  * Creates a new instance of the appropriate class based on discriminator value
1463
1519
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -1608,6 +1664,12 @@ export declare function createCallEventTableRowFromDiscriminatorValue(parseNode:
1608
1664
  * @returns {ChangeBillingPlanRequest}
1609
1665
  */
1610
1666
  export declare function createChangeBillingPlanRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
1667
+ /**
1668
+ * Creates a new instance of the appropriate class based on discriminator value
1669
+ * @param parseNode The parse node to use to read the discriminator value and create the object
1670
+ * @returns {CommunicationConsoleEntry}
1671
+ */
1672
+ export declare function createCommunicationConsoleEntryFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
1611
1673
  /**
1612
1674
  * Creates a new instance of the appropriate class based on discriminator value
1613
1675
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -3478,6 +3540,12 @@ export declare function deserializeIntoAutomationConditionGroup(automationCondit
3478
3540
  * @returns {Record<string, (node: ParseNode) => void>}
3479
3541
  */
3480
3542
  export declare function deserializeIntoAutomationConnection(automationConnection?: Partial<AutomationConnection> | undefined): Record<string, (node: ParseNode) => void>;
3543
+ /**
3544
+ * The deserialization information for the current model
3545
+ * @param AutomationConsoleResponse The instance to deserialize into.
3546
+ * @returns {Record<string, (node: ParseNode) => void>}
3547
+ */
3548
+ export declare function deserializeIntoAutomationConsoleResponse(automationConsoleResponse?: Partial<AutomationConsoleResponse> | undefined): Record<string, (node: ParseNode) => void>;
3481
3549
  /**
3482
3550
  * The deserialization information for the current model
3483
3551
  * @param AutomationPreviewActionResult The instance to deserialize into.
@@ -3628,6 +3696,12 @@ export declare function deserializeIntoCallEventTableRow(callEventTableRow?: Par
3628
3696
  * @returns {Record<string, (node: ParseNode) => void>}
3629
3697
  */
3630
3698
  export declare function deserializeIntoChangeBillingPlanRequest(changeBillingPlanRequest?: Partial<ChangeBillingPlanRequest> | undefined): Record<string, (node: ParseNode) => void>;
3699
+ /**
3700
+ * The deserialization information for the current model
3701
+ * @param CommunicationConsoleEntry The instance to deserialize into.
3702
+ * @returns {Record<string, (node: ParseNode) => void>}
3703
+ */
3704
+ export declare function deserializeIntoCommunicationConsoleEntry(communicationConsoleEntry?: Partial<CommunicationConsoleEntry> | undefined): Record<string, (node: ParseNode) => void>;
3631
3705
  /**
3632
3706
  * The deserialization information for the current model
3633
3707
  * @param ComplianceUpdateRequest The instance to deserialize into.
@@ -5152,6 +5226,10 @@ export interface EventDetailResponse extends AdditionalDataHolder, Parsable {
5152
5226
  * User summary connected to this event detail response.
5153
5227
  */
5154
5228
  user?: EventDetailResponse_user | null;
5229
+ /**
5230
+ * Email address for the user connected to this event detail response.
5231
+ */
5232
+ userEmail?: string | null;
5155
5233
  /**
5156
5234
  * User ID associated with the activity that created this event.
5157
5235
  */
@@ -6017,6 +6095,14 @@ export interface LeadResponse extends AdditionalDataHolder, Parsable {
6017
6095
  * Demographic profile details for the lead represented by this lead response.
6018
6096
  */
6019
6097
  customer?: LeadProfile | null;
6098
+ /**
6099
+ * UTC timestamp when this lead was soft deleted.
6100
+ */
6101
+ deletedAt?: Date | null;
6102
+ /**
6103
+ * User ID of the person who soft deleted this lead.
6104
+ */
6105
+ deletedByUserId?: string | null;
6020
6106
  /**
6021
6107
  * Indicates whether this lead response is active and available in the Leadping API.
6022
6108
  */
@@ -6041,6 +6127,18 @@ export interface LeadResponse extends AdditionalDataHolder, Parsable {
6041
6127
  * Canonical phone identity and provider lookup details for this lead.
6042
6128
  */
6043
6129
  phoneIdentity?: LeadResponse_phoneIdentity | null;
6130
+ /**
6131
+ * Defines the asynchronous verification and enrichment lifecycle for a lead.
6132
+ */
6133
+ processingStatus?: LeadResponse_processingStatus | null;
6134
+ /**
6135
+ * UTC timestamp when the processing stage last changed.
6136
+ */
6137
+ processingStatusChangedAt?: Date | null;
6138
+ /**
6139
+ * Explanation when asynchronous lead processing is blocked or fails.
6140
+ */
6141
+ processingStatusReason?: string | null;
6044
6142
  /**
6045
6143
  * Tags currently attached to this lead, source, or record.
6046
6144
  */
@@ -6056,6 +6154,7 @@ export interface LeadResponse_currentLeadStatus extends CurrentLeadStatusSummary
6056
6154
  */
6057
6155
  export interface LeadResponse_phoneIdentity extends Parsable, PhoneIdentityResponse {
6058
6156
  }
6157
+ export type LeadResponse_processingStatus = (typeof LeadResponse_processingStatusObject)[keyof typeof LeadResponse_processingStatusObject];
6059
6158
  export type LeadStatusCategory = (typeof LeadStatusCategoryObject)[keyof typeof LeadStatusCategoryObject];
6060
6159
  /**
6061
6160
  * Describes lead status change export data returned by Leadping.
@@ -6510,6 +6609,18 @@ export interface LeadTableRow extends AdditionalDataHolder, Parsable {
6510
6609
  * Lead price or transaction price supplied to the Leadping API.
6511
6610
  */
6512
6611
  price?: UntypedNode | null;
6612
+ /**
6613
+ * Defines the asynchronous verification and enrichment lifecycle for a lead.
6614
+ */
6615
+ processingStatus?: LeadTableRow_processingStatus | null;
6616
+ /**
6617
+ * UTC timestamp when the processing stage last changed.
6618
+ */
6619
+ processingStatusChangedAt?: Date | null;
6620
+ /**
6621
+ * Explanation when asynchronous lead processing is blocked or fails.
6622
+ */
6623
+ processingStatusReason?: string | null;
6513
6624
  /**
6514
6625
  * Identifier and display name of the related source.
6515
6626
  */
@@ -6541,6 +6652,7 @@ export interface LeadTableRow_currentLeadStatus extends CurrentLeadStatusSummary
6541
6652
  */
6542
6653
  export interface LeadTableRow_organization extends IdNamePair, Parsable {
6543
6654
  }
6655
+ export type LeadTableRow_processingStatus = (typeof LeadTableRow_processingStatusObject)[keyof typeof LeadTableRow_processingStatusObject];
6544
6656
  /**
6545
6657
  * Identifier and display name of the related source.
6546
6658
  */
@@ -8506,6 +8618,10 @@ export interface PhoneCallResponse extends AdditionalDataHolder, Parsable {
8506
8618
  * Messaging campaign identifier associated with this phone call.
8507
8619
  */
8508
8620
  campaignId?: string | null;
8621
+ /**
8622
+ * Ordered diagnostic entries recorded while Leadping processed this call.
8623
+ */
8624
+ consoleEntries?: CommunicationConsoleEntry[] | null;
8509
8625
  /**
8510
8626
  * Conversation ID that links this phone call to the Leadping inbox thread.
8511
8627
  */
@@ -8605,6 +8721,14 @@ export interface PhoneIdentityLookupAction extends AdditionalDataHolder, Parsabl
8605
8721
  * The provider that performed the phone identity lookup.
8606
8722
  */
8607
8723
  provider?: string | null;
8724
+ /**
8725
+ * The provider cost incurred by this lookup action, in USD.
8726
+ */
8727
+ providerCostAmount?: UntypedNode | null;
8728
+ /**
8729
+ * The provider pricing version used to calculate the lookup cost.
8730
+ */
8731
+ providerPricingVersion?: string | null;
8608
8732
  /**
8609
8733
  * Identifies the outcome of a phone identity lookup action.
8610
8734
  */
@@ -9719,6 +9843,13 @@ export declare function serializeAutomationConditionGroup(writer: SerializationW
9719
9843
  * @param writer Serialization writer to use to serialize this model
9720
9844
  */
9721
9845
  export declare function serializeAutomationConnection(writer: SerializationWriter, automationConnection?: Partial<AutomationConnection> | undefined | null, isSerializingDerivedType?: boolean): void;
9846
+ /**
9847
+ * Serializes information the current object
9848
+ * @param AutomationConsoleResponse The instance to serialize from.
9849
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
9850
+ * @param writer Serialization writer to use to serialize this model
9851
+ */
9852
+ export declare function serializeAutomationConsoleResponse(writer: SerializationWriter, automationConsoleResponse?: Partial<AutomationConsoleResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
9722
9853
  /**
9723
9854
  * Serializes information the current object
9724
9855
  * @param AutomationPreviewActionResult The instance to serialize from.
@@ -9894,6 +10025,13 @@ export declare function serializeCallEventTableRow(writer: SerializationWriter,
9894
10025
  * @param writer Serialization writer to use to serialize this model
9895
10026
  */
9896
10027
  export declare function serializeChangeBillingPlanRequest(writer: SerializationWriter, changeBillingPlanRequest?: Partial<ChangeBillingPlanRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
10028
+ /**
10029
+ * Serializes information the current object
10030
+ * @param CommunicationConsoleEntry The instance to serialize from.
10031
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
10032
+ * @param writer Serialization writer to use to serialize this model
10033
+ */
10034
+ export declare function serializeCommunicationConsoleEntry(writer: SerializationWriter, communicationConsoleEntry?: Partial<CommunicationConsoleEntry> | undefined | null, isSerializingDerivedType?: boolean): void;
9897
10035
  /**
9898
10036
  * Serializes information the current object
9899
10037
  * @param ComplianceUpdateRequest The instance to serialize from.
@@ -11491,6 +11629,10 @@ export interface SmsEventTableRow extends AdditionalDataHolder, Parsable {
11491
11629
  * Compliance action applied to this message, lead, or sender.
11492
11630
  */
11493
11631
  complianceAction?: string | null;
11632
+ /**
11633
+ * Ordered diagnostic entries recorded while Leadping processed this message.
11634
+ */
11635
+ consoleEntries?: CommunicationConsoleEntry[] | null;
11494
11636
  /**
11495
11637
  * Conversation ID that links this SMS event table row to the Leadping inbox thread.
11496
11638
  */
@@ -11711,6 +11853,10 @@ export interface SmsResponse extends AdditionalDataHolder, Parsable {
11711
11853
  * Compliance action applied to this message, lead, or sender.
11712
11854
  */
11713
11855
  complianceAction?: string | null;
11856
+ /**
11857
+ * Ordered diagnostic entries recorded while Leadping processed this message.
11858
+ */
11859
+ consoleEntries?: CommunicationConsoleEntry[] | null;
11714
11860
  /**
11715
11861
  * Conversation ID that links this SMS message to the Leadping inbox thread.
11716
11862
  */
@@ -11941,6 +12087,10 @@ export interface SourceResponse extends AdditionalDataHolder, Parsable {
11941
12087
  * User summary for the person who created this lead source response.
11942
12088
  */
11943
12089
  createdByUser?: SourceResponse_createdByUser | null;
12090
+ /**
12091
+ * Email used to resolve the creator's avatar.
12092
+ */
12093
+ createdByUserEmail?: string | null;
11944
12094
  /**
11945
12095
  * Tag IDs automatically assigned to leads created by this source.
11946
12096
  */
@@ -13609,6 +13759,8 @@ export declare const BillableUnitObject: {
13609
13759
  readonly Openai_operation: "openai_operation";
13610
13760
  readonly Domain_registration: "domain_registration";
13611
13761
  readonly OneZerodlc_application: "10dlc_application";
13762
+ readonly OneZerodlc_campaign_month: "10dlc_campaign_month";
13763
+ readonly Payment_processing_fee: "payment_processing_fee";
13612
13764
  readonly Connection_action: "connection_action";
13613
13765
  readonly Automation_run: "automation_run";
13614
13766
  };
@@ -13870,6 +14022,17 @@ export declare const LeadProfile_maritalStatusObject: {
13870
14022
  readonly Separated: "Separated";
13871
14023
  readonly Divorced: "Divorced";
13872
14024
  };
14025
+ /**
14026
+ * Defines the asynchronous verification and enrichment lifecycle for a lead.
14027
+ */
14028
+ export declare const LeadResponse_processingStatusObject: {
14029
+ readonly Verifying: "Verifying";
14030
+ readonly Validating: "Validating";
14031
+ readonly Enriching: "Enriching";
14032
+ readonly Ready: "Ready";
14033
+ readonly Invalid: "Invalid";
14034
+ readonly Failed: "Failed";
14035
+ };
13873
14036
  /**
13874
14037
  * Controlled lead status change categories used for reporting, automation, and analytics.
13875
14038
  */
@@ -13955,6 +14118,17 @@ export declare const LeadStatusRequest_categoryObject: {
13955
14118
  readonly Invalid: "Invalid";
13956
14119
  readonly Duplicate: "Duplicate";
13957
14120
  };
14121
+ /**
14122
+ * Defines the asynchronous verification and enrichment lifecycle for a lead.
14123
+ */
14124
+ export declare const LeadTableRow_processingStatusObject: {
14125
+ readonly Verifying: "Verifying";
14126
+ readonly Validating: "Validating";
14127
+ readonly Enriching: "Enriching";
14128
+ readonly Ready: "Ready";
14129
+ readonly Invalid: "Invalid";
14130
+ readonly Failed: "Failed";
14131
+ };
13958
14132
  /**
13959
14133
  * Defines the supported Notification Priority values.
13960
14134
  */
@@ -14610,6 +14784,8 @@ export declare const TransactionResponse_billableUnitObject: {
14610
14784
  readonly Openai_operation: "openai_operation";
14611
14785
  readonly Domain_registration: "domain_registration";
14612
14786
  readonly OneZerodlc_application: "10dlc_application";
14787
+ readonly OneZerodlc_campaign_month: "10dlc_campaign_month";
14788
+ readonly Payment_processing_fee: "payment_processing_fee";
14613
14789
  readonly Connection_action: "connection_action";
14614
14790
  readonly Automation_run: "automation_run";
14615
14791
  };
@@ -14628,6 +14804,7 @@ export declare const TransactionResponse_billingChannelObject: {
14628
14804
  readonly Openai: "openai";
14629
14805
  readonly Domain: "domain";
14630
14806
  readonly OneZerodlc: "10dlc";
14807
+ readonly Payment: "payment";
14631
14808
  readonly Connection: "connection";
14632
14809
  readonly Automation: "automation";
14633
14810
  };
@@ -14656,6 +14833,8 @@ export declare const TransactionTableRow_billableUnitObject: {
14656
14833
  readonly Openai_operation: "openai_operation";
14657
14834
  readonly Domain_registration: "domain_registration";
14658
14835
  readonly OneZerodlc_application: "10dlc_application";
14836
+ readonly OneZerodlc_campaign_month: "10dlc_campaign_month";
14837
+ readonly Payment_processing_fee: "payment_processing_fee";
14659
14838
  readonly Connection_action: "connection_action";
14660
14839
  readonly Automation_run: "automation_run";
14661
14840
  };
@@ -14674,6 +14853,7 @@ export declare const TransactionTableRow_billingChannelObject: {
14674
14853
  readonly Openai: "openai";
14675
14854
  readonly Domain: "domain";
14676
14855
  readonly OneZerodlc: "10dlc";
14856
+ readonly Payment: "payment";
14677
14857
  readonly Connection: "connection";
14678
14858
  readonly Automation: "automation";
14679
14859
  };
@@ -14700,6 +14880,7 @@ export declare const UsageChannelObject: {
14700
14880
  readonly Openai: "openai";
14701
14881
  readonly Domain: "domain";
14702
14882
  readonly OneZerodlc: "10dlc";
14883
+ readonly Payment: "payment";
14703
14884
  readonly Connection: "connection";
14704
14885
  readonly Automation: "automation";
14705
14886
  };