@leadping/sdk 1.0.84 → 1.0.86
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 +148 -11
- package/dist/models/index.d.ts.map +1 -1
- package/dist/models/index.js +118 -6
- package/dist/models/index.js.map +1 -1
- package/dist/wallets/index.d.ts.map +1 -1
- package/dist/wallets/index.js +2 -1
- package/dist/wallets/index.js.map +1 -1
- package/dist/wallets/me/index.d.ts +10 -1
- package/dist/wallets/me/index.d.ts.map +1 -1
- package/dist/wallets/me/index.js +10 -0
- package/dist/wallets/me/index.js.map +1 -1
- package/dist/wallets/me/spendLimits/index.d.ts +48 -0
- package/dist/wallets/me/spendLimits/index.d.ts.map +1 -0
- package/dist/wallets/me/spendLimits/index.js +42 -0
- package/dist/wallets/me/spendLimits/index.js.map +1 -0
- package/package.json +1 -1
package/dist/models/index.d.ts
CHANGED
|
@@ -3241,6 +3241,18 @@ export declare function createSourceTableRow_userFromDiscriminatorValue(parseNod
|
|
|
3241
3241
|
* @returns {SourceTableRow}
|
|
3242
3242
|
*/
|
|
3243
3243
|
export declare function createSourceTableRowFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
3244
|
+
/**
|
|
3245
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
3246
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
3247
|
+
* @returns {SpendLimitsRequest}
|
|
3248
|
+
*/
|
|
3249
|
+
export declare function createSpendLimitsRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
3250
|
+
/**
|
|
3251
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
3252
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
3253
|
+
* @returns {SpendLimitsResponse}
|
|
3254
|
+
*/
|
|
3255
|
+
export declare function createSpendLimitsResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
3244
3256
|
/**
|
|
3245
3257
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
3246
3258
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
@@ -5706,6 +5718,18 @@ export declare function deserializeIntoSourceTableRow_organization(sourceTableRo
|
|
|
5706
5718
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
5707
5719
|
*/
|
|
5708
5720
|
export declare function deserializeIntoSourceTableRow_user(sourceTableRow_user?: Partial<SourceTableRow_user> | undefined): Record<string, (node: ParseNode) => void>;
|
|
5721
|
+
/**
|
|
5722
|
+
* The deserialization information for the current model
|
|
5723
|
+
* @param SpendLimitsRequest The instance to deserialize into.
|
|
5724
|
+
* @returns {Record<string, (node: ParseNode) => void>}
|
|
5725
|
+
*/
|
|
5726
|
+
export declare function deserializeIntoSpendLimitsRequest(spendLimitsRequest?: Partial<SpendLimitsRequest> | undefined): Record<string, (node: ParseNode) => void>;
|
|
5727
|
+
/**
|
|
5728
|
+
* The deserialization information for the current model
|
|
5729
|
+
* @param SpendLimitsResponse The instance to deserialize into.
|
|
5730
|
+
* @returns {Record<string, (node: ParseNode) => void>}
|
|
5731
|
+
*/
|
|
5732
|
+
export declare function deserializeIntoSpendLimitsResponse(spendLimitsResponse?: Partial<SpendLimitsResponse> | undefined): Record<string, (node: ParseNode) => void>;
|
|
5709
5733
|
/**
|
|
5710
5734
|
* The deserialization information for the current model
|
|
5711
5735
|
* @param StreetAddress The instance to deserialize into.
|
|
@@ -6182,6 +6206,10 @@ export interface EventTableRow extends AdditionalDataHolder, Parsable {
|
|
|
6182
6206
|
* Email address for the person who created this event timeline table row.
|
|
6183
6207
|
*/
|
|
6184
6208
|
actorEmail?: string | null;
|
|
6209
|
+
/**
|
|
6210
|
+
* The lead who performed this action.
|
|
6211
|
+
*/
|
|
6212
|
+
actorLeadId?: string | null;
|
|
6185
6213
|
/**
|
|
6186
6214
|
* User ID for the person or system that created this event timeline table row.
|
|
6187
6215
|
*/
|
|
@@ -7015,6 +7043,10 @@ export interface LeadMetadata extends AdditionalDataHolder, Parsable {
|
|
|
7015
7043
|
* Certificate URL used as proof of consumer consent.
|
|
7016
7044
|
*/
|
|
7017
7045
|
consentCertificateUrl?: string | null;
|
|
7046
|
+
/**
|
|
7047
|
+
* Server-issued time at which the source policy skipped certificate validation for this consent snapshot.
|
|
7048
|
+
*/
|
|
7049
|
+
consentValidationSkippedAt?: Date | null;
|
|
7018
7050
|
/**
|
|
7019
7051
|
* Leadping's assessment of the supporting consent evidence.
|
|
7020
7052
|
*/
|
|
@@ -7131,10 +7163,6 @@ export interface LeadMetadata extends AdditionalDataHolder, Parsable {
|
|
|
7131
7163
|
* Browser or client user agent captured when this lead attribution metadata was submitted.
|
|
7132
7164
|
*/
|
|
7133
7165
|
userAgent?: string | null;
|
|
7134
|
-
/**
|
|
7135
|
-
* User ID associated with this lead's attribution metadata.
|
|
7136
|
-
*/
|
|
7137
|
-
userId?: string | null;
|
|
7138
7166
|
/**
|
|
7139
7167
|
* UTM campaign parameter captured for lead attribution reporting.
|
|
7140
7168
|
*/
|
|
@@ -9066,6 +9094,10 @@ export interface OrganizationRequest extends AdditionalDataHolder, Parsable {
|
|
|
9066
9094
|
* Intended audience described during organization setup.
|
|
9067
9095
|
*/
|
|
9068
9096
|
targetAudience?: string | null;
|
|
9097
|
+
/**
|
|
9098
|
+
* Default timezone for organization reporting and display when a user has no personal preference.
|
|
9099
|
+
*/
|
|
9100
|
+
timeZoneId?: string | null;
|
|
9069
9101
|
/**
|
|
9070
9102
|
* Industry vertical used for lead routing, compliance review, and reporting.
|
|
9071
9103
|
*/
|
|
@@ -9204,6 +9236,10 @@ export interface OrganizationResponse extends AdditionalDataHolder, Parsable {
|
|
|
9204
9236
|
* Describes an organization's billing subscription lifecycle, including trial, active, delinquent, canceled, and expired states.
|
|
9205
9237
|
*/
|
|
9206
9238
|
subscriptionStatus?: OrganizationResponse_subscriptionStatus | null;
|
|
9239
|
+
/**
|
|
9240
|
+
* Default timezone for organization reporting and display when a user has no personal preference.
|
|
9241
|
+
*/
|
|
9242
|
+
timeZoneId?: string | null;
|
|
9207
9243
|
/**
|
|
9208
9244
|
* Provides a compact API reference to another resource using its stable identifier and human-readable display name.
|
|
9209
9245
|
*/
|
|
@@ -9318,6 +9354,10 @@ export interface OrganizationSwitchOption extends AdditionalDataHolder, Parsable
|
|
|
9318
9354
|
* Describes an organization's overall 10DLC registration lifecycle across brand and messaging campaign submission.
|
|
9319
9355
|
*/
|
|
9320
9356
|
tenDlcStatus?: OrganizationSwitchOption_tenDlcStatus | null;
|
|
9357
|
+
/**
|
|
9358
|
+
* Default timezone for organization reporting and display when a user has no personal preference.
|
|
9359
|
+
*/
|
|
9360
|
+
timeZoneId?: string | null;
|
|
9321
9361
|
}
|
|
9322
9362
|
export type OrganizationSwitchOption_activationStatus = (typeof OrganizationSwitchOption_activationStatusObject)[keyof typeof OrganizationSwitchOption_activationStatusObject];
|
|
9323
9363
|
export type OrganizationSwitchOption_organizationStatus = (typeof OrganizationSwitchOption_organizationStatusObject)[keyof typeof OrganizationSwitchOption_organizationStatusObject];
|
|
@@ -10552,6 +10592,7 @@ export interface PhoneNumberOptOutMetricsResponse extends AdditionalDataHolder,
|
|
|
10552
10592
|
windowStartedAt?: Date | null;
|
|
10553
10593
|
}
|
|
10554
10594
|
export type PhoneNumberOutboundHealthStatus = (typeof PhoneNumberOutboundHealthStatusObject)[keyof typeof PhoneNumberOutboundHealthStatusObject];
|
|
10595
|
+
export type PhoneNumberOwnership = (typeof PhoneNumberOwnershipObject)[keyof typeof PhoneNumberOwnershipObject];
|
|
10555
10596
|
/**
|
|
10556
10597
|
* Messaging and calling warmup for a Leadping phone number.
|
|
10557
10598
|
*/
|
|
@@ -10621,10 +10662,6 @@ export interface PhoneNumberResponse extends AdditionalDataHolder, Parsable {
|
|
|
10621
10662
|
* The isDemo property
|
|
10622
10663
|
*/
|
|
10623
10664
|
isDemo?: boolean | null;
|
|
10624
|
-
/**
|
|
10625
|
-
* Indicates whether Leadping provisions and manages this phone number.
|
|
10626
|
-
*/
|
|
10627
|
-
leadpingOwned?: boolean | null;
|
|
10628
10665
|
/**
|
|
10629
10666
|
* UTC timestamp when the resource was last modified, or null when it has not been updated.
|
|
10630
10667
|
*/
|
|
@@ -10645,6 +10682,10 @@ export interface PhoneNumberResponse extends AdditionalDataHolder, Parsable {
|
|
|
10645
10682
|
* Provides a compact API reference to another resource using its stable identifier and human-readable display name.
|
|
10646
10683
|
*/
|
|
10647
10684
|
organization?: PhoneNumberResponse_organization | null;
|
|
10685
|
+
/**
|
|
10686
|
+
* Identifies whose traffic a phone number serves, independently of provider control.
|
|
10687
|
+
*/
|
|
10688
|
+
ownership?: PhoneNumberOwnership | null;
|
|
10648
10689
|
/**
|
|
10649
10690
|
* Identifier of the canonical phone identity for this number.
|
|
10650
10691
|
*/
|
|
@@ -10838,9 +10879,9 @@ export interface PhoneNumberTableRow extends AdditionalDataHolder, Parsable {
|
|
|
10838
10879
|
*/
|
|
10839
10880
|
organizationId?: string | null;
|
|
10840
10881
|
/**
|
|
10841
|
-
*
|
|
10882
|
+
* Identifies whose traffic a phone number serves, independently of provider control.
|
|
10842
10883
|
*/
|
|
10843
|
-
ownership?:
|
|
10884
|
+
ownership?: PhoneNumberOwnership | null;
|
|
10844
10885
|
/**
|
|
10845
10886
|
* Human-readable routing summary for this phone number.
|
|
10846
10887
|
*/
|
|
@@ -12911,6 +12952,20 @@ export declare function serializeSourceTableRow_organization(writer: Serializati
|
|
|
12911
12952
|
* @param writer Serialization writer to use to serialize this model
|
|
12912
12953
|
*/
|
|
12913
12954
|
export declare function serializeSourceTableRow_user(writer: SerializationWriter, sourceTableRow_user?: Partial<SourceTableRow_user> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
12955
|
+
/**
|
|
12956
|
+
* Serializes information the current object
|
|
12957
|
+
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
12958
|
+
* @param SpendLimitsRequest The instance to serialize from.
|
|
12959
|
+
* @param writer Serialization writer to use to serialize this model
|
|
12960
|
+
*/
|
|
12961
|
+
export declare function serializeSpendLimitsRequest(writer: SerializationWriter, spendLimitsRequest?: Partial<SpendLimitsRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
12962
|
+
/**
|
|
12963
|
+
* Serializes information the current object
|
|
12964
|
+
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
12965
|
+
* @param SpendLimitsResponse The instance to serialize from.
|
|
12966
|
+
* @param writer Serialization writer to use to serialize this model
|
|
12967
|
+
*/
|
|
12968
|
+
export declare function serializeSpendLimitsResponse(writer: SerializationWriter, spendLimitsResponse?: Partial<SpendLimitsResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
12914
12969
|
/**
|
|
12915
12970
|
* Serializes information the current object
|
|
12916
12971
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
@@ -13220,6 +13275,10 @@ export interface SmsEventTableRow extends AdditionalDataHolder, Parsable {
|
|
|
13220
13275
|
* Display name for the actor that performed the action.
|
|
13221
13276
|
*/
|
|
13222
13277
|
actorDisplayName?: string | null;
|
|
13278
|
+
/**
|
|
13279
|
+
* The lead who performed this action.
|
|
13280
|
+
*/
|
|
13281
|
+
actorLeadId?: string | null;
|
|
13223
13282
|
/**
|
|
13224
13283
|
* User ID for the actor that performed the action.
|
|
13225
13284
|
*/
|
|
@@ -13536,6 +13595,10 @@ export interface SmsResponse extends AdditionalDataHolder, Parsable {
|
|
|
13536
13595
|
* UTC timestamp when Leadping will retry this SMS message.
|
|
13537
13596
|
*/
|
|
13538
13597
|
nextRetryAt?: Date | null;
|
|
13598
|
+
/**
|
|
13599
|
+
* The organization receiving this message status update.
|
|
13600
|
+
*/
|
|
13601
|
+
organizationId?: string | null;
|
|
13539
13602
|
/**
|
|
13540
13603
|
* Phone number ID selected for outbound delivery.
|
|
13541
13604
|
*/
|
|
@@ -13650,10 +13713,18 @@ export interface SourceMetricsResponse extends AdditionalDataHolder, Parsable {
|
|
|
13650
13713
|
* Defines the fields clients can send when working with lead source.
|
|
13651
13714
|
*/
|
|
13652
13715
|
export interface SourceRequest extends AdditionalDataHolder, Parsable {
|
|
13716
|
+
/**
|
|
13717
|
+
* Whether to validate consent certificates during intake. Skipped validation leaves consent unverified.
|
|
13718
|
+
*/
|
|
13719
|
+
automaticConsentValidation?: boolean | null;
|
|
13653
13720
|
/**
|
|
13654
13721
|
* Whether to look up lead phone numbers during intake. When disabled, lookup is required before calling or texting.
|
|
13655
13722
|
*/
|
|
13656
13723
|
automaticPhoneLookup?: boolean | null;
|
|
13724
|
+
/**
|
|
13725
|
+
* Maximum new leads accepted per UTC day. Null means unlimited; zero pauses intake.
|
|
13726
|
+
*/
|
|
13727
|
+
dailyLeadLimit?: number | null;
|
|
13657
13728
|
/**
|
|
13658
13729
|
* Tag IDs automatically assigned to leads created by this source.
|
|
13659
13730
|
*/
|
|
@@ -13687,6 +13758,10 @@ export interface SourceResponse extends AdditionalDataHolder, Parsable {
|
|
|
13687
13758
|
* UTC timestamp when the source credential was most recently rotated.
|
|
13688
13759
|
*/
|
|
13689
13760
|
apiKeyRotatedAt?: Date | null;
|
|
13761
|
+
/**
|
|
13762
|
+
* Whether to validate consent certificates during intake. Skipped validation leaves consent unverified.
|
|
13763
|
+
*/
|
|
13764
|
+
automaticConsentValidation?: boolean | null;
|
|
13690
13765
|
/**
|
|
13691
13766
|
* Whether to look up lead phone numbers during intake. When disabled, lookup is required before calling or texting.
|
|
13692
13767
|
*/
|
|
@@ -13711,6 +13786,10 @@ export interface SourceResponse extends AdditionalDataHolder, Parsable {
|
|
|
13711
13786
|
* Email used to resolve the creator's avatar.
|
|
13712
13787
|
*/
|
|
13713
13788
|
createdByUserEmail?: string | null;
|
|
13789
|
+
/**
|
|
13790
|
+
* Maximum new leads accepted per UTC day. Null means unlimited; zero pauses intake.
|
|
13791
|
+
*/
|
|
13792
|
+
dailyLeadLimit?: number | null;
|
|
13714
13793
|
/**
|
|
13715
13794
|
* Tag IDs automatically assigned to leads created by this source.
|
|
13716
13795
|
*/
|
|
@@ -13808,6 +13887,10 @@ export interface SourceTableRow extends AdditionalDataHolder, Parsable {
|
|
|
13808
13887
|
* Total number of authenticated requests made with this source API key.
|
|
13809
13888
|
*/
|
|
13810
13889
|
apiKeyTotalUses?: number | null;
|
|
13890
|
+
/**
|
|
13891
|
+
* Whether to validate consent certificates during intake. Skipped validation leaves consent unverified.
|
|
13892
|
+
*/
|
|
13893
|
+
automaticConsentValidation?: boolean | null;
|
|
13811
13894
|
/**
|
|
13812
13895
|
* Whether lead phone numbers are looked up automatically during intake.
|
|
13813
13896
|
*/
|
|
@@ -13909,6 +13992,52 @@ export interface SourceTableRow_organization extends IdNamePair, Parsable {
|
|
|
13909
13992
|
*/
|
|
13910
13993
|
export interface SourceTableRow_user extends IdNamePair, Parsable {
|
|
13911
13994
|
}
|
|
13995
|
+
/**
|
|
13996
|
+
* Organization usage budgets in USD. Null removes a limit; zero stops new paid usage.
|
|
13997
|
+
*/
|
|
13998
|
+
export interface SpendLimitsRequest extends AdditionalDataHolder, Parsable {
|
|
13999
|
+
/**
|
|
14000
|
+
* The dailyLimit property
|
|
14001
|
+
*/
|
|
14002
|
+
dailyLimit?: number | null;
|
|
14003
|
+
/**
|
|
14004
|
+
* The monthlyLimit property
|
|
14005
|
+
*/
|
|
14006
|
+
monthlyLimit?: number | null;
|
|
14007
|
+
}
|
|
14008
|
+
/**
|
|
14009
|
+
* UTC calendar usage budgets, settled spend, and pending usage reservations in USD.
|
|
14010
|
+
*/
|
|
14011
|
+
export interface SpendLimitsResponse extends AdditionalDataHolder, Parsable {
|
|
14012
|
+
/**
|
|
14013
|
+
* The dailyLimit property
|
|
14014
|
+
*/
|
|
14015
|
+
dailyLimit?: number | null;
|
|
14016
|
+
/**
|
|
14017
|
+
* The dailyResetsAt property
|
|
14018
|
+
*/
|
|
14019
|
+
dailyResetsAt?: Date | null;
|
|
14020
|
+
/**
|
|
14021
|
+
* The dailySpent property
|
|
14022
|
+
*/
|
|
14023
|
+
dailySpent?: number | null;
|
|
14024
|
+
/**
|
|
14025
|
+
* The monthlyLimit property
|
|
14026
|
+
*/
|
|
14027
|
+
monthlyLimit?: number | null;
|
|
14028
|
+
/**
|
|
14029
|
+
* The monthlyResetsAt property
|
|
14030
|
+
*/
|
|
14031
|
+
monthlyResetsAt?: Date | null;
|
|
14032
|
+
/**
|
|
14033
|
+
* The monthlySpent property
|
|
14034
|
+
*/
|
|
14035
|
+
monthlySpent?: number | null;
|
|
14036
|
+
/**
|
|
14037
|
+
* The reserved property
|
|
14038
|
+
*/
|
|
14039
|
+
reserved?: number | null;
|
|
14040
|
+
}
|
|
13912
14041
|
/**
|
|
13913
14042
|
* Describes a physical or mailing address using international locality, administrative-area, postal-code, and country fields.
|
|
13914
14043
|
*/
|
|
@@ -14998,7 +15127,7 @@ export interface UserNotificationPreferences extends AdditionalDataHolder, Parsa
|
|
|
14998
15127
|
*/
|
|
14999
15128
|
paymentFailedSmsEnabled?: boolean | null;
|
|
15000
15129
|
/**
|
|
15001
|
-
* Whether push and automation alerts wait until the user's daily quiet hours end.
|
|
15130
|
+
* Whether push, SMS, and automation alerts wait until the user's daily quiet hours end.
|
|
15002
15131
|
*/
|
|
15003
15132
|
quietHoursEnabled?: boolean | null;
|
|
15004
15133
|
/**
|
|
@@ -16188,6 +16317,14 @@ export declare const PhoneNumberOutboundHealthStatusObject: {
|
|
|
16188
16317
|
readonly Suspended: "suspended";
|
|
16189
16318
|
readonly Disabled: "disabled";
|
|
16190
16319
|
};
|
|
16320
|
+
/**
|
|
16321
|
+
* Identifies whose traffic a phone number serves, independently of provider control.
|
|
16322
|
+
*/
|
|
16323
|
+
export declare const PhoneNumberOwnershipObject: {
|
|
16324
|
+
readonly Unassigned: "Unassigned";
|
|
16325
|
+
readonly Leadping: "Leadping";
|
|
16326
|
+
readonly Organization: "Organization";
|
|
16327
|
+
};
|
|
16191
16328
|
/**
|
|
16192
16329
|
* Identifies the current traffic-ramp stage of controlled voice warmup for a Leadping-managed phone number.
|
|
16193
16330
|
*/
|