@leadping/sdk 1.0.72 → 1.0.74
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/models/index.d.ts +70 -58
- package/dist/models/index.d.ts.map +1 -1
- package/dist/models/index.js +60 -54
- package/dist/models/index.js.map +1 -1
- package/package.json +1 -1
package/dist/models/index.d.ts
CHANGED
|
@@ -2146,6 +2146,12 @@ export declare function createLeadMetadata_sourceMetadataFromDiscriminatorValue(
|
|
|
2146
2146
|
* @returns {LeadMetadata}
|
|
2147
2147
|
*/
|
|
2148
2148
|
export declare function createLeadMetadataFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
2149
|
+
/**
|
|
2150
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
2151
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
2152
|
+
* @returns {LeadpingConsentCertificate}
|
|
2153
|
+
*/
|
|
2154
|
+
export declare function createLeadpingConsentCertificateFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
2149
2155
|
/**
|
|
2150
2156
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
2151
2157
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
@@ -3127,12 +3133,6 @@ export declare function createTransactionTableRow_organizationFromDiscriminatorV
|
|
|
3127
3133
|
* @returns {TransactionTableRow}
|
|
3128
3134
|
*/
|
|
3129
3135
|
export declare function createTransactionTableRowFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
3130
|
-
/**
|
|
3131
|
-
* Creates a new instance of the appropriate class based on discriminator value
|
|
3132
|
-
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
3133
|
-
* @returns {TrustedFormCertificate}
|
|
3134
|
-
*/
|
|
3135
|
-
export declare function createTrustedFormCertificateFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
3136
3136
|
/**
|
|
3137
3137
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
3138
3138
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
@@ -3202,9 +3202,9 @@ export declare function createUserDataExportResponseFromDiscriminatorValue(parse
|
|
|
3202
3202
|
/**
|
|
3203
3203
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
3204
3204
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
3205
|
-
* @returns {
|
|
3205
|
+
* @returns {UserNotificationPreferences_smsConsentCertificate}
|
|
3206
3206
|
*/
|
|
3207
|
-
export declare function
|
|
3207
|
+
export declare function createUserNotificationPreferences_smsConsentCertificateFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
3208
3208
|
/**
|
|
3209
3209
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
3210
3210
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
@@ -4448,6 +4448,12 @@ export declare function deserializeIntoLeadMetadata(leadMetadata?: Partial<LeadM
|
|
|
4448
4448
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
4449
4449
|
*/
|
|
4450
4450
|
export declare function deserializeIntoLeadMetadata_sourceMetadata(leadMetadata_sourceMetadata?: Partial<LeadMetadata_sourceMetadata> | undefined): Record<string, (node: ParseNode) => void>;
|
|
4451
|
+
/**
|
|
4452
|
+
* The deserialization information for the current model
|
|
4453
|
+
* @param LeadpingConsentCertificate The instance to deserialize into.
|
|
4454
|
+
* @returns {Record<string, (node: ParseNode) => void>}
|
|
4455
|
+
*/
|
|
4456
|
+
export declare function deserializeIntoLeadpingConsentCertificate(leadpingConsentCertificate?: Partial<LeadpingConsentCertificate> | undefined): Record<string, (node: ParseNode) => void>;
|
|
4451
4457
|
/**
|
|
4452
4458
|
* The deserialization information for the current model
|
|
4453
4459
|
* @param LeadProfile The instance to deserialize into.
|
|
@@ -5420,12 +5426,6 @@ export declare function deserializeIntoTransactionTableRow_lead(transactionTable
|
|
|
5420
5426
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
5421
5427
|
*/
|
|
5422
5428
|
export declare function deserializeIntoTransactionTableRow_organization(transactionTableRow_organization?: Partial<TransactionTableRow_organization> | undefined): Record<string, (node: ParseNode) => void>;
|
|
5423
|
-
/**
|
|
5424
|
-
* The deserialization information for the current model
|
|
5425
|
-
* @param TrustedFormCertificate The instance to deserialize into.
|
|
5426
|
-
* @returns {Record<string, (node: ParseNode) => void>}
|
|
5427
|
-
*/
|
|
5428
|
-
export declare function deserializeIntoTrustedFormCertificate(trustedFormCertificate?: Partial<TrustedFormCertificate> | undefined): Record<string, (node: ParseNode) => void>;
|
|
5429
5429
|
/**
|
|
5430
5430
|
* The deserialization information for the current model
|
|
5431
5431
|
* @param UsageCounterLine The instance to deserialize into.
|
|
@@ -5500,10 +5500,10 @@ export declare function deserializeIntoUserDataExportResponse(userDataExportResp
|
|
|
5500
5500
|
export declare function deserializeIntoUserNotificationPreferences(userNotificationPreferences?: Partial<UserNotificationPreferences> | undefined): Record<string, (node: ParseNode) => void>;
|
|
5501
5501
|
/**
|
|
5502
5502
|
* The deserialization information for the current model
|
|
5503
|
-
* @param
|
|
5503
|
+
* @param UserNotificationPreferences_smsConsentCertificate The instance to deserialize into.
|
|
5504
5504
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
5505
5505
|
*/
|
|
5506
|
-
export declare function
|
|
5506
|
+
export declare function deserializeIntoUserNotificationPreferences_smsConsentCertificate(userNotificationPreferences_smsConsentCertificate?: Partial<UserNotificationPreferences_smsConsentCertificate> | undefined): Record<string, (node: ParseNode) => void>;
|
|
5507
5507
|
/**
|
|
5508
5508
|
* The deserialization information for the current model
|
|
5509
5509
|
* @param UserRequest The instance to deserialize into.
|
|
@@ -6255,6 +6255,10 @@ export interface LeadIntakeRequest extends AdditionalDataHolder, Parsable {
|
|
|
6255
6255
|
* Lead gender supplied by intake sources and normalized when possible.
|
|
6256
6256
|
*/
|
|
6257
6257
|
gender?: string | null;
|
|
6258
|
+
/**
|
|
6259
|
+
* Stable delivery key reused when retrying the same lead submission to this source.
|
|
6260
|
+
*/
|
|
6261
|
+
idempotencyKey?: string | null;
|
|
6258
6262
|
/**
|
|
6259
6263
|
* Landing page URL where the lead submitted their information.
|
|
6260
6264
|
*/
|
|
@@ -6385,6 +6389,10 @@ export interface LeadMetadata extends AdditionalDataHolder, Parsable {
|
|
|
6385
6389
|
* Bulk import batch ID that created or updated this lead.
|
|
6386
6390
|
*/
|
|
6387
6391
|
importBatchId?: string | null;
|
|
6392
|
+
/**
|
|
6393
|
+
* Stable source operation key. Reuse for retries, and change for a new submission.
|
|
6394
|
+
*/
|
|
6395
|
+
intakeIdempotencyKey?: string | null;
|
|
6388
6396
|
/**
|
|
6389
6397
|
* IP address captured with the request for audit and compliance review.
|
|
6390
6398
|
*/
|
|
@@ -6397,6 +6405,14 @@ export interface LeadMetadata extends AdditionalDataHolder, Parsable {
|
|
|
6397
6405
|
* Landing page URL where the lead submitted their information.
|
|
6398
6406
|
*/
|
|
6399
6407
|
landingPage?: string | null;
|
|
6408
|
+
/**
|
|
6409
|
+
* Standalone Leadping Consent certificate identifier, accepted as an alternative to TrustedForm.
|
|
6410
|
+
*/
|
|
6411
|
+
leadpingConsentCertificateId?: string | null;
|
|
6412
|
+
/**
|
|
6413
|
+
* Server-issued timestamp for successful Leadping Consent evidence and recipient validation.
|
|
6414
|
+
*/
|
|
6415
|
+
leadpingConsentCheckedAt?: Date | null;
|
|
6400
6416
|
/**
|
|
6401
6417
|
* Organization ID that owns this lead's attribution metadata.
|
|
6402
6418
|
*/
|
|
@@ -6503,6 +6519,23 @@ export interface LeadMetadata extends AdditionalDataHolder, Parsable {
|
|
|
6503
6519
|
*/
|
|
6504
6520
|
export interface LeadMetadata_sourceMetadata extends AdditionalDataHolder, Parsable {
|
|
6505
6521
|
}
|
|
6522
|
+
/**
|
|
6523
|
+
* Describes Leadping Consent certificate data used in Leadping API requests and responses.
|
|
6524
|
+
*/
|
|
6525
|
+
export interface LeadpingConsentCertificate extends AdditionalDataHolder, Parsable {
|
|
6526
|
+
/**
|
|
6527
|
+
* UTC timestamp for created at on this Leadping Consent certificate.
|
|
6528
|
+
*/
|
|
6529
|
+
createdAt?: Date | null;
|
|
6530
|
+
/**
|
|
6531
|
+
* Unique Leadping identifier for this Leadping Consent certificate.
|
|
6532
|
+
*/
|
|
6533
|
+
id?: string | null;
|
|
6534
|
+
/**
|
|
6535
|
+
* Source for this Leadping Consent certificate.
|
|
6536
|
+
*/
|
|
6537
|
+
source?: string | null;
|
|
6538
|
+
}
|
|
6506
6539
|
/**
|
|
6507
6540
|
* Public Leadping API schema for lead demographic profile data.
|
|
6508
6541
|
*/
|
|
@@ -7841,7 +7874,7 @@ export interface OrganizationCompliancePolicy extends AdditionalDataHolder, Pars
|
|
|
7841
7874
|
*/
|
|
7842
7875
|
requireSourceComplianceApproval?: boolean | null;
|
|
7843
7876
|
/**
|
|
7844
|
-
* Whether this organization compliance policy requires TrustedForm for automations.
|
|
7877
|
+
* Whether this organization compliance policy requires TrustedForm or Leadping Consent evidence for automations.
|
|
7845
7878
|
*/
|
|
7846
7879
|
requireTrustedFormForAutomations?: boolean | null;
|
|
7847
7880
|
}
|
|
@@ -10958,6 +10991,13 @@ export declare function serializeLeadMetadata(writer: SerializationWriter, leadM
|
|
|
10958
10991
|
* @param writer Serialization writer to use to serialize this model
|
|
10959
10992
|
*/
|
|
10960
10993
|
export declare function serializeLeadMetadata_sourceMetadata(writer: SerializationWriter, leadMetadata_sourceMetadata?: Partial<LeadMetadata_sourceMetadata> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
10994
|
+
/**
|
|
10995
|
+
* Serializes information the current object
|
|
10996
|
+
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
10997
|
+
* @param LeadpingConsentCertificate The instance to serialize from.
|
|
10998
|
+
* @param writer Serialization writer to use to serialize this model
|
|
10999
|
+
*/
|
|
11000
|
+
export declare function serializeLeadpingConsentCertificate(writer: SerializationWriter, leadpingConsentCertificate?: Partial<LeadpingConsentCertificate> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
10961
11001
|
/**
|
|
10962
11002
|
* Serializes information the current object
|
|
10963
11003
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
@@ -12092,13 +12132,6 @@ export declare function serializeTransactionTableRow_lead(writer: SerializationW
|
|
|
12092
12132
|
* @param writer Serialization writer to use to serialize this model
|
|
12093
12133
|
*/
|
|
12094
12134
|
export declare function serializeTransactionTableRow_organization(writer: SerializationWriter, transactionTableRow_organization?: Partial<TransactionTableRow_organization> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
12095
|
-
/**
|
|
12096
|
-
* Serializes information the current object
|
|
12097
|
-
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
12098
|
-
* @param TrustedFormCertificate The instance to serialize from.
|
|
12099
|
-
* @param writer Serialization writer to use to serialize this model
|
|
12100
|
-
*/
|
|
12101
|
-
export declare function serializeTrustedFormCertificate(writer: SerializationWriter, trustedFormCertificate?: Partial<TrustedFormCertificate> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
12102
12135
|
/**
|
|
12103
12136
|
* Serializes information the current object
|
|
12104
12137
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
@@ -12186,10 +12219,10 @@ export declare function serializeUserNotificationPreferences(writer: Serializati
|
|
|
12186
12219
|
/**
|
|
12187
12220
|
* Serializes information the current object
|
|
12188
12221
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
12189
|
-
* @param
|
|
12222
|
+
* @param UserNotificationPreferences_smsConsentCertificate The instance to serialize from.
|
|
12190
12223
|
* @param writer Serialization writer to use to serialize this model
|
|
12191
12224
|
*/
|
|
12192
|
-
export declare function
|
|
12225
|
+
export declare function serializeUserNotificationPreferences_smsConsentCertificate(writer: SerializationWriter, userNotificationPreferences_smsConsentCertificate?: Partial<UserNotificationPreferences_smsConsentCertificate> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
12193
12226
|
/**
|
|
12194
12227
|
* Serializes information the current object
|
|
12195
12228
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
@@ -12709,7 +12742,7 @@ export interface SourceRequest extends AdditionalDataHolder, Parsable {
|
|
|
12709
12742
|
*/
|
|
12710
12743
|
name?: string | null;
|
|
12711
12744
|
/**
|
|
12712
|
-
* Indicates whether leads from this source must include a TrustedForm certificate for consent proof.
|
|
12745
|
+
* Indicates whether leads from this source must include a TrustedForm or Leadping Consent certificate for consent proof.
|
|
12713
12746
|
*/
|
|
12714
12747
|
requiresTrustedForm?: boolean | null;
|
|
12715
12748
|
}
|
|
@@ -12802,7 +12835,7 @@ export interface SourceResponse extends AdditionalDataHolder, Parsable {
|
|
|
12802
12835
|
*/
|
|
12803
12836
|
organization?: SourceResponse_organization | null;
|
|
12804
12837
|
/**
|
|
12805
|
-
* Indicates whether leads from this source must include a TrustedForm certificate for consent proof.
|
|
12838
|
+
* Indicates whether leads from this source must include a TrustedForm or Leadping Consent certificate for consent proof.
|
|
12806
12839
|
*/
|
|
12807
12840
|
requiresTrustedForm?: boolean | null;
|
|
12808
12841
|
/**
|
|
@@ -12927,7 +12960,7 @@ export interface SourceTableRow extends AdditionalDataHolder, Parsable {
|
|
|
12927
12960
|
*/
|
|
12928
12961
|
organizationId?: string | null;
|
|
12929
12962
|
/**
|
|
12930
|
-
* Indicates whether leads from this source must include a TrustedForm certificate for consent proof.
|
|
12963
|
+
* Indicates whether leads from this source must include a TrustedForm or Leadping Consent certificate for consent proof.
|
|
12931
12964
|
*/
|
|
12932
12965
|
requiresTrustedForm?: boolean | null;
|
|
12933
12966
|
/**
|
|
@@ -13661,27 +13694,6 @@ export interface TransactionTableRow_lead extends IdNamePair, Parsable {
|
|
|
13661
13694
|
export interface TransactionTableRow_organization extends IdNamePair, Parsable {
|
|
13662
13695
|
}
|
|
13663
13696
|
export type TransactionType = (typeof TransactionTypeObject)[keyof typeof TransactionTypeObject];
|
|
13664
|
-
/**
|
|
13665
|
-
* Describes trusted form certificate data used in Leadping API requests and responses.
|
|
13666
|
-
*/
|
|
13667
|
-
export interface TrustedFormCertificate extends AdditionalDataHolder, Parsable {
|
|
13668
|
-
/**
|
|
13669
|
-
* UTC timestamp for created at on this TrustedForm certificate.
|
|
13670
|
-
*/
|
|
13671
|
-
createdAt?: Date | null;
|
|
13672
|
-
/**
|
|
13673
|
-
* Unique Leadping identifier for this TrustedForm certificate.
|
|
13674
|
-
*/
|
|
13675
|
-
id?: string | null;
|
|
13676
|
-
/**
|
|
13677
|
-
* Source for this TrustedForm certificate.
|
|
13678
|
-
*/
|
|
13679
|
-
source?: string | null;
|
|
13680
|
-
/**
|
|
13681
|
-
* The URL associated with this TrustedForm certificate.
|
|
13682
|
-
*/
|
|
13683
|
-
url?: string | null;
|
|
13684
|
-
}
|
|
13685
13697
|
export type UsageChannel = (typeof UsageChannelObject)[keyof typeof UsageChannelObject];
|
|
13686
13698
|
/**
|
|
13687
13699
|
* Describes one named usage total displayed in organization billing and activity summaries.
|
|
@@ -13896,9 +13908,9 @@ export interface UserCompliance extends AdditionalDataHolder, Parsable {
|
|
|
13896
13908
|
*/
|
|
13897
13909
|
acceptedToSubscription?: boolean | null;
|
|
13898
13910
|
/**
|
|
13899
|
-
* The
|
|
13911
|
+
* The Leadping Consent certificates included with this user compliance.
|
|
13900
13912
|
*/
|
|
13901
|
-
|
|
13913
|
+
consentCertificates?: LeadpingConsentCertificate[] | null;
|
|
13902
13914
|
}
|
|
13903
13915
|
/**
|
|
13904
13916
|
* Provides the temporary download location and expiration details for a completed Leadping user-data export.
|
|
@@ -14065,13 +14077,13 @@ export interface UserNotificationPreferences extends AdditionalDataHolder, Parsa
|
|
|
14065
14077
|
*/
|
|
14066
14078
|
paymentFailedSmsEnabled?: boolean | null;
|
|
14067
14079
|
/**
|
|
14068
|
-
*
|
|
14080
|
+
* Describes Leadping Consent certificate data used in Leadping API requests and responses.
|
|
14069
14081
|
*/
|
|
14070
|
-
|
|
14082
|
+
smsConsentCertificate?: UserNotificationPreferences_smsConsentCertificate | null;
|
|
14071
14083
|
/**
|
|
14072
|
-
*
|
|
14084
|
+
* Whether the user has consented to receive Leadping account notification SMS messages.
|
|
14073
14085
|
*/
|
|
14074
|
-
|
|
14086
|
+
smsConsentOptedIn?: boolean | null;
|
|
14075
14087
|
/**
|
|
14076
14088
|
* When the user's Leadping notification SMS consent was last changed.
|
|
14077
14089
|
*/
|
|
@@ -14110,9 +14122,9 @@ export interface UserNotificationPreferences extends AdditionalDataHolder, Parsa
|
|
|
14110
14122
|
usageLimitHitEnabled?: boolean | null;
|
|
14111
14123
|
}
|
|
14112
14124
|
/**
|
|
14113
|
-
* Describes
|
|
14125
|
+
* Describes Leadping Consent certificate data used in Leadping API requests and responses.
|
|
14114
14126
|
*/
|
|
14115
|
-
export interface
|
|
14127
|
+
export interface UserNotificationPreferences_smsConsentCertificate extends LeadpingConsentCertificate, Parsable {
|
|
14116
14128
|
}
|
|
14117
14129
|
/**
|
|
14118
14130
|
* Defines the fields clients can send when working with user profile.
|