@leadping/sdk 1.0.76 → 1.0.77
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.
- package/dist/conversations/index.d.ts +1 -1
- package/dist/conversations/index.d.ts.map +1 -1
- package/dist/conversations/index.js +2 -1
- package/dist/conversations/index.js.map +1 -1
- package/dist/conversations/item/index.d.ts +27 -1
- package/dist/conversations/item/index.d.ts.map +1 -1
- package/dist/conversations/item/index.js +24 -0
- package/dist/conversations/item/index.js.map +1 -1
- package/dist/conversations/item/markRead/index.d.ts +14 -6
- package/dist/conversations/item/markRead/index.d.ts.map +1 -1
- package/dist/conversations/item/markRead/index.js +1 -2
- package/dist/conversations/item/markRead/index.js.map +1 -1
- package/dist/conversations/item/outboundReadiness/index.d.ts +41 -0
- package/dist/conversations/item/outboundReadiness/index.d.ts.map +1 -0
- package/dist/conversations/item/outboundReadiness/index.js +29 -0
- package/dist/conversations/item/outboundReadiness/index.js.map +1 -0
- package/dist/leads/followUps/index.d.ts +43 -0
- package/dist/leads/followUps/index.d.ts.map +1 -0
- package/dist/leads/followUps/index.js +28 -0
- package/dist/leads/followUps/index.js.map +1 -0
- package/dist/leads/index.d.ts +5 -0
- package/dist/leads/index.d.ts.map +1 -1
- package/dist/leads/index.js +5 -0
- package/dist/leads/index.js.map +1 -1
- package/dist/leads/item/followUp/index.d.ts +33 -0
- package/dist/leads/item/followUp/index.d.ts.map +1 -0
- package/dist/leads/item/followUp/index.js +31 -0
- package/dist/leads/item/followUp/index.js.map +1 -0
- package/dist/leads/item/index.d.ts +5 -0
- package/dist/leads/item/index.d.ts.map +1 -1
- package/dist/leads/item/index.js +5 -0
- package/dist/leads/item/index.js.map +1 -1
- package/dist/models/index.d.ts +133 -1
- package/dist/models/index.d.ts.map +1 -1
- package/dist/models/index.js +106 -0
- package/dist/models/index.js.map +1 -1
- package/package.json +1 -1
package/dist/models/index.d.ts
CHANGED
|
@@ -100,6 +100,23 @@ export interface AnalyticsComparison extends AdditionalDataHolder, Parsable {
|
|
|
100
100
|
*/
|
|
101
101
|
previous?: number | null;
|
|
102
102
|
}
|
|
103
|
+
/**
|
|
104
|
+
* States whether missing historical evidence can make reported counts incomplete.
|
|
105
|
+
*/
|
|
106
|
+
export interface AnalyticsCoverage extends AdditionalDataHolder, Parsable {
|
|
107
|
+
/**
|
|
108
|
+
* The completeFrom property
|
|
109
|
+
*/
|
|
110
|
+
completeFrom?: Date | null;
|
|
111
|
+
/**
|
|
112
|
+
* The detail property
|
|
113
|
+
*/
|
|
114
|
+
detail?: string | null;
|
|
115
|
+
/**
|
|
116
|
+
* The isPartial property
|
|
117
|
+
*/
|
|
118
|
+
isPartial?: boolean | null;
|
|
119
|
+
}
|
|
103
120
|
/**
|
|
104
121
|
* Defines the inclusive reporting window and comparison window used to calculate Leadping analytics.
|
|
105
122
|
*/
|
|
@@ -1557,6 +1574,10 @@ export interface ConversationResponse extends AdditionalDataHolder, Parsable {
|
|
|
1557
1574
|
* Email address used to resolve the lead's avatar when available.
|
|
1558
1575
|
*/
|
|
1559
1576
|
email?: string | null;
|
|
1577
|
+
/**
|
|
1578
|
+
* Monotonic event boundary. Mark-read requests must send the version the reader observed.
|
|
1579
|
+
*/
|
|
1580
|
+
eventVersion?: number | null;
|
|
1560
1581
|
/**
|
|
1561
1582
|
* First name of the lead, user, or contact represented by this conversation response.
|
|
1562
1583
|
*/
|
|
@@ -1670,6 +1691,12 @@ export declare function createActivationTimelineEventFromDiscriminatorValue(pars
|
|
|
1670
1691
|
* @returns {AnalyticsComparison}
|
|
1671
1692
|
*/
|
|
1672
1693
|
export declare function createAnalyticsComparisonFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
1694
|
+
/**
|
|
1695
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
1696
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
1697
|
+
* @returns {AnalyticsCoverage}
|
|
1698
|
+
*/
|
|
1699
|
+
export declare function createAnalyticsCoverageFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
1673
1700
|
/**
|
|
1674
1701
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
1675
1702
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
@@ -2180,6 +2207,12 @@ export declare function createLeadContact_streetAddressFromDiscriminatorValue(pa
|
|
|
2180
2207
|
* @returns {LeadContact}
|
|
2181
2208
|
*/
|
|
2182
2209
|
export declare function createLeadContactFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
2210
|
+
/**
|
|
2211
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
2212
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
2213
|
+
* @returns {LeadFollowUpUpdateRequest}
|
|
2214
|
+
*/
|
|
2215
|
+
export declare function createLeadFollowUpUpdateRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
2183
2216
|
/**
|
|
2184
2217
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
2185
2218
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
@@ -3341,6 +3374,14 @@ export interface CurrentLeadStatusSummary extends AdditionalDataHolder, Parsable
|
|
|
3341
3374
|
* Human-readable display name shown for this current lead status change summary.
|
|
3342
3375
|
*/
|
|
3343
3376
|
displayName?: string | null;
|
|
3377
|
+
/**
|
|
3378
|
+
* When this follow-up was completed; email/call activity alone does not complete it.
|
|
3379
|
+
*/
|
|
3380
|
+
followUpCompletedAt?: Date | null;
|
|
3381
|
+
/**
|
|
3382
|
+
* The earliest callback or task time for the current status.
|
|
3383
|
+
*/
|
|
3384
|
+
followUpDueAt?: Date | null;
|
|
3344
3385
|
/**
|
|
3345
3386
|
* Unique Leadping identifier for this current lead status change summary.
|
|
3346
3387
|
*/
|
|
@@ -3349,6 +3390,10 @@ export interface CurrentLeadStatusSummary extends AdditionalDataHolder, Parsable
|
|
|
3349
3390
|
* Current lead status change outcome assigned to the lead.
|
|
3350
3391
|
*/
|
|
3351
3392
|
outcome?: string | null;
|
|
3393
|
+
/**
|
|
3394
|
+
* Monotonic revision of the lead's current status and scheduling state.
|
|
3395
|
+
*/
|
|
3396
|
+
revision?: number | null;
|
|
3352
3397
|
/**
|
|
3353
3398
|
* Known sources that can change a lead's current lead status change.
|
|
3354
3399
|
*/
|
|
@@ -3561,6 +3606,10 @@ export interface CustomerAutomationHealth extends AdditionalDataHolder, Parsable
|
|
|
3561
3606
|
* Total number of automation records represented by this Leadping customer automation health.
|
|
3562
3607
|
*/
|
|
3563
3608
|
automationCount?: number | null;
|
|
3609
|
+
/**
|
|
3610
|
+
* States whether missing historical evidence can make reported counts incomplete.
|
|
3611
|
+
*/
|
|
3612
|
+
coverage?: AnalyticsCoverage | null;
|
|
3564
3613
|
/**
|
|
3565
3614
|
* Total number of enabled records represented by this Leadping customer automation health.
|
|
3566
3615
|
*/
|
|
@@ -3984,6 +4033,12 @@ export declare function deserializeIntoActivationTimelineEvent_actor(activationT
|
|
|
3984
4033
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
3985
4034
|
*/
|
|
3986
4035
|
export declare function deserializeIntoAnalyticsComparison(analyticsComparison?: Partial<AnalyticsComparison> | undefined): Record<string, (node: ParseNode) => void>;
|
|
4036
|
+
/**
|
|
4037
|
+
* The deserialization information for the current model
|
|
4038
|
+
* @param AnalyticsCoverage The instance to deserialize into.
|
|
4039
|
+
* @returns {Record<string, (node: ParseNode) => void>}
|
|
4040
|
+
*/
|
|
4041
|
+
export declare function deserializeIntoAnalyticsCoverage(analyticsCoverage?: Partial<AnalyticsCoverage> | undefined): Record<string, (node: ParseNode) => void>;
|
|
3987
4042
|
/**
|
|
3988
4043
|
* The deserialization information for the current model
|
|
3989
4044
|
* @param AnalyticsDateRange The instance to deserialize into.
|
|
@@ -4494,6 +4549,12 @@ export declare function deserializeIntoLeadContact_phone(leadContact_phone?: Par
|
|
|
4494
4549
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
4495
4550
|
*/
|
|
4496
4551
|
export declare function deserializeIntoLeadContact_streetAddress(leadContact_streetAddress?: Partial<LeadContact_streetAddress> | undefined): Record<string, (node: ParseNode) => void>;
|
|
4552
|
+
/**
|
|
4553
|
+
* The deserialization information for the current model
|
|
4554
|
+
* @param LeadFollowUpUpdateRequest The instance to deserialize into.
|
|
4555
|
+
* @returns {Record<string, (node: ParseNode) => void>}
|
|
4556
|
+
*/
|
|
4557
|
+
export declare function deserializeIntoLeadFollowUpUpdateRequest(leadFollowUpUpdateRequest?: Partial<LeadFollowUpUpdateRequest> | undefined): Record<string, (node: ParseNode) => void>;
|
|
4497
4558
|
/**
|
|
4498
4559
|
* The deserialization information for the current model
|
|
4499
4560
|
* @param LeadIntakeRequest The instance to deserialize into.
|
|
@@ -6024,6 +6085,10 @@ export interface EventTableRow extends AdditionalDataHolder, Parsable {
|
|
|
6024
6085
|
* UTC timestamp when the provider marked the message undeliverable.
|
|
6025
6086
|
*/
|
|
6026
6087
|
undeliverableAt?: Date | null;
|
|
6088
|
+
/**
|
|
6089
|
+
* Playable recording URL for voicemail events.
|
|
6090
|
+
*/
|
|
6091
|
+
voicemailUrl?: string | null;
|
|
6027
6092
|
/**
|
|
6028
6093
|
* Indicates whether a user manually overrode Leadping's automatic number selection for this event timeline table row.
|
|
6029
6094
|
*/
|
|
@@ -6281,6 +6346,23 @@ export interface LeadContact_phone extends Parsable, Phone {
|
|
|
6281
6346
|
*/
|
|
6282
6347
|
export interface LeadContact_streetAddress extends Parsable, StreetAddress {
|
|
6283
6348
|
}
|
|
6349
|
+
/**
|
|
6350
|
+
* Completes or reschedules exactly the follow-up version the operator viewed.
|
|
6351
|
+
*/
|
|
6352
|
+
export interface LeadFollowUpUpdateRequest extends AdditionalDataHolder, Parsable {
|
|
6353
|
+
/**
|
|
6354
|
+
* The new time, or null to complete the follow-up.
|
|
6355
|
+
*/
|
|
6356
|
+
dueAt?: Date | null;
|
|
6357
|
+
/**
|
|
6358
|
+
* The expectedRevision property
|
|
6359
|
+
*/
|
|
6360
|
+
expectedRevision?: number | null;
|
|
6361
|
+
/**
|
|
6362
|
+
* The expectedStatusId property
|
|
6363
|
+
*/
|
|
6364
|
+
expectedStatusId?: string | null;
|
|
6365
|
+
}
|
|
6284
6366
|
/**
|
|
6285
6367
|
* Defines the fields clients can send when working with lead intake.
|
|
6286
6368
|
*/
|
|
@@ -6969,6 +7051,18 @@ export interface LeadStatusChangeRequest extends AdditionalDataHolder, Parsable
|
|
|
6969
7051
|
* Controlled lead status change categories used for reporting, automation, and analytics.
|
|
6970
7052
|
*/
|
|
6971
7053
|
category?: LeadStatusChangeRequest_category | null;
|
|
7054
|
+
/**
|
|
7055
|
+
* Whether the scheduled follow-up is explicitly complete.
|
|
7056
|
+
*/
|
|
7057
|
+
completeFollowUp?: boolean | null;
|
|
7058
|
+
/**
|
|
7059
|
+
* Optional optimistic concurrency guard for the status currently displayed by the client.
|
|
7060
|
+
*/
|
|
7061
|
+
expectedCurrentStatusId?: string | null;
|
|
7062
|
+
/**
|
|
7063
|
+
* Optional revision guard, including when the lead has no persisted status history yet.
|
|
7064
|
+
*/
|
|
7065
|
+
expectedRevision?: number | null;
|
|
6972
7066
|
/**
|
|
6973
7067
|
* The current follow up status for this lead status change.
|
|
6974
7068
|
*/
|
|
@@ -7043,6 +7137,10 @@ export interface LeadStatusChangeResponse extends AdditionalDataHolder, Parsable
|
|
|
7043
7137
|
* UTC timestamp for created at on this lead status change.
|
|
7044
7138
|
*/
|
|
7045
7139
|
createdAt?: Date | null;
|
|
7140
|
+
/**
|
|
7141
|
+
* When this follow-up was completed; email/call activity alone does not complete it.
|
|
7142
|
+
*/
|
|
7143
|
+
followUpCompletedAt?: Date | null;
|
|
7046
7144
|
/**
|
|
7047
7145
|
* The current follow up status for this lead status change.
|
|
7048
7146
|
*/
|
|
@@ -7107,6 +7205,10 @@ export interface LeadStatusChangeResponse extends AdditionalDataHolder, Parsable
|
|
|
7107
7205
|
* The related call event ID associated with this lead status change.
|
|
7108
7206
|
*/
|
|
7109
7207
|
relatedCallEventId?: string | null;
|
|
7208
|
+
/**
|
|
7209
|
+
* Monotonic revision of the lead's current status and scheduling state.
|
|
7210
|
+
*/
|
|
7211
|
+
revision?: number | null;
|
|
7110
7212
|
/**
|
|
7111
7213
|
* The source ID associated with this lead status change.
|
|
7112
7214
|
*/
|
|
@@ -7399,6 +7501,10 @@ export interface NotificationResponse extends AdditionalDataHolder, Parsable {
|
|
|
7399
7501
|
* The URL associated with this notification.
|
|
7400
7502
|
*/
|
|
7401
7503
|
actionUrl?: string | null;
|
|
7504
|
+
/**
|
|
7505
|
+
* The mobile conversation destination.
|
|
7506
|
+
*/
|
|
7507
|
+
conversationId?: string | null;
|
|
7402
7508
|
/**
|
|
7403
7509
|
* UTC timestamp when the resource was created.
|
|
7404
7510
|
*/
|
|
@@ -7419,6 +7525,10 @@ export interface NotificationResponse extends AdditionalDataHolder, Parsable {
|
|
|
7419
7525
|
* Whether this notification is read.
|
|
7420
7526
|
*/
|
|
7421
7527
|
isRead?: boolean | null;
|
|
7528
|
+
/**
|
|
7529
|
+
* The lead used to resolve the conversation.
|
|
7530
|
+
*/
|
|
7531
|
+
leadId?: string | null;
|
|
7422
7532
|
/**
|
|
7423
7533
|
* Message for this notification.
|
|
7424
7534
|
*/
|
|
@@ -7431,6 +7541,10 @@ export interface NotificationResponse extends AdditionalDataHolder, Parsable {
|
|
|
7431
7541
|
* Human-readable display name of the resource.
|
|
7432
7542
|
*/
|
|
7433
7543
|
name?: string | null;
|
|
7544
|
+
/**
|
|
7545
|
+
* The organization selected before opening this notification.
|
|
7546
|
+
*/
|
|
7547
|
+
organizationId?: string | null;
|
|
7434
7548
|
/**
|
|
7435
7549
|
* Ranks the urgency and presentation importance of a Leadping user notification.
|
|
7436
7550
|
*/
|
|
@@ -9226,7 +9340,7 @@ export interface Phone extends AdditionalDataHolder, Parsable {
|
|
|
9226
9340
|
*/
|
|
9227
9341
|
number?: string | null;
|
|
9228
9342
|
/**
|
|
9229
|
-
*
|
|
9343
|
+
* Server-derived identifier of the canonical phone identity. Client-supplied linkage is ignored when creating or updating a lead.
|
|
9230
9344
|
*/
|
|
9231
9345
|
phoneIdentityId?: string | null;
|
|
9232
9346
|
/**
|
|
@@ -9306,6 +9420,10 @@ export interface PhoneCallResponse extends AdditionalDataHolder, Parsable {
|
|
|
9306
9420
|
* UTC timestamp when the resource was last modified, or null when it has not been updated.
|
|
9307
9421
|
*/
|
|
9308
9422
|
modifiedAt?: Date | null;
|
|
9423
|
+
/**
|
|
9424
|
+
* The organization context required to handle this call on a mobile device.
|
|
9425
|
+
*/
|
|
9426
|
+
organizationId?: string | null;
|
|
9309
9427
|
/**
|
|
9310
9428
|
* Phone number used by this phone call for calls, SMS, lookup, or routing.
|
|
9311
9429
|
*/
|
|
@@ -10452,6 +10570,13 @@ export declare function serializeActivationTimelineEvent_actor(writer: Serializa
|
|
|
10452
10570
|
* @param writer Serialization writer to use to serialize this model
|
|
10453
10571
|
*/
|
|
10454
10572
|
export declare function serializeAnalyticsComparison(writer: SerializationWriter, analyticsComparison?: Partial<AnalyticsComparison> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
10573
|
+
/**
|
|
10574
|
+
* Serializes information the current object
|
|
10575
|
+
* @param AnalyticsCoverage The instance to serialize from.
|
|
10576
|
+
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
10577
|
+
* @param writer Serialization writer to use to serialize this model
|
|
10578
|
+
*/
|
|
10579
|
+
export declare function serializeAnalyticsCoverage(writer: SerializationWriter, analyticsCoverage?: Partial<AnalyticsCoverage> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
10455
10580
|
/**
|
|
10456
10581
|
* Serializes information the current object
|
|
10457
10582
|
* @param AnalyticsDateRange The instance to serialize from.
|
|
@@ -11047,6 +11172,13 @@ export declare function serializeLeadContact_phone(writer: SerializationWriter,
|
|
|
11047
11172
|
* @param writer Serialization writer to use to serialize this model
|
|
11048
11173
|
*/
|
|
11049
11174
|
export declare function serializeLeadContact_streetAddress(writer: SerializationWriter, leadContact_streetAddress?: Partial<LeadContact_streetAddress> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
11175
|
+
/**
|
|
11176
|
+
* Serializes information the current object
|
|
11177
|
+
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
11178
|
+
* @param LeadFollowUpUpdateRequest The instance to serialize from.
|
|
11179
|
+
* @param writer Serialization writer to use to serialize this model
|
|
11180
|
+
*/
|
|
11181
|
+
export declare function serializeLeadFollowUpUpdateRequest(writer: SerializationWriter, leadFollowUpUpdateRequest?: Partial<LeadFollowUpUpdateRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
11050
11182
|
/**
|
|
11051
11183
|
* Serializes information the current object
|
|
11052
11184
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|