@leadping/sdk 1.0.24 → 1.0.26

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.
@@ -1183,6 +1183,10 @@ export interface BusinessActivationState extends AdditionalDataHolder, Parsable
1183
1183
  * The current telephony status for this business activation state.
1184
1184
  */
1185
1185
  telephonyStatus?: ActivationTelephonyStatus | null;
1186
+ /**
1187
+ * Identifier of the first-class 10DLC application entity for this business.
1188
+ */
1189
+ tenDlcApplicationId?: string | null;
1186
1190
  /**
1187
1191
  * The 10DLC draft value for this business activation state.
1188
1192
  */
@@ -1854,9 +1858,14 @@ export interface BusinessSwitchOption extends AdditionalDataHolder, Parsable {
1854
1858
  * The role value for this business switch option.
1855
1859
  */
1856
1860
  role?: BusinessUserRole | null;
1861
+ /**
1862
+ * Defines the supported 10DLC Application Status values.
1863
+ */
1864
+ tenDlcStatus?: BusinessSwitchOption_tenDlcStatus | null;
1857
1865
  }
1858
1866
  export type BusinessSwitchOption_activationStatus = (typeof BusinessSwitchOption_activationStatusObject)[keyof typeof BusinessSwitchOption_activationStatusObject];
1859
1867
  export type BusinessSwitchOption_businessStatus = (typeof BusinessSwitchOption_businessStatusObject)[keyof typeof BusinessSwitchOption_businessStatusObject];
1868
+ export type BusinessSwitchOption_tenDlcStatus = (typeof BusinessSwitchOption_tenDlcStatusObject)[keyof typeof BusinessSwitchOption_tenDlcStatusObject];
1860
1869
  /**
1861
1870
  * Request schema for the Leadping API business switch request, including the fields clients can send.
1862
1871
  */
@@ -2282,6 +2291,10 @@ export interface ConversationResponse extends AdditionalDataHolder, Parsable {
2282
2291
  * Current disposition summary that describes the lead outcome.
2283
2292
  */
2284
2293
  currentDisposition?: ConversationResponse_currentDisposition | null;
2294
+ /**
2295
+ * Email address used to resolve the lead's avatar when available.
2296
+ */
2297
+ email?: string | null;
2285
2298
  /**
2286
2299
  * First name of the lead, user, or contact represented by this conversation response.
2287
2300
  */
@@ -3077,6 +3090,12 @@ export declare function createLeadRequestFromDiscriminatorValue(parseNode: Parse
3077
3090
  * @returns {LeadResponse_currentDisposition}
3078
3091
  */
3079
3092
  export declare function createLeadResponse_currentDispositionFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3093
+ /**
3094
+ * Creates a new instance of the appropriate class based on discriminator value
3095
+ * @param parseNode The parse node to use to read the discriminator value and create the object
3096
+ * @returns {LeadResponse_phoneIdentity}
3097
+ */
3098
+ export declare function createLeadResponse_phoneIdentityFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3080
3099
  /**
3081
3100
  * Creates a new instance of the appropriate class based on discriminator value
3082
3101
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -3278,6 +3297,48 @@ export declare function createPhoneCallResponseFromDiscriminatorValue(parseNode:
3278
3297
  * @returns {Phone}
3279
3298
  */
3280
3299
  export declare function createPhoneFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3300
+ /**
3301
+ * Creates a new instance of the appropriate class based on discriminator value
3302
+ * @param parseNode The parse node to use to read the discriminator value and create the object
3303
+ * @returns {PhoneIdentityResponse_lookup}
3304
+ */
3305
+ export declare function createPhoneIdentityResponse_lookupFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3306
+ /**
3307
+ * Creates a new instance of the appropriate class based on discriminator value
3308
+ * @param parseNode The parse node to use to read the discriminator value and create the object
3309
+ * @returns {PhoneIdentityResponse}
3310
+ */
3311
+ export declare function createPhoneIdentityResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3312
+ /**
3313
+ * Creates a new instance of the appropriate class based on discriminator value
3314
+ * @param parseNode The parse node to use to read the discriminator value and create the object
3315
+ * @returns {PhoneLocationSource}
3316
+ */
3317
+ export declare function createPhoneLocationSourceFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3318
+ /**
3319
+ * Creates a new instance of the appropriate class based on discriminator value
3320
+ * @param parseNode The parse node to use to read the discriminator value and create the object
3321
+ * @returns {PhoneLookup_carrier}
3322
+ */
3323
+ export declare function createPhoneLookup_carrierFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3324
+ /**
3325
+ * Creates a new instance of the appropriate class based on discriminator value
3326
+ * @param parseNode The parse node to use to read the discriminator value and create the object
3327
+ * @returns {PhoneLookup_location}
3328
+ */
3329
+ export declare function createPhoneLookup_locationFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3330
+ /**
3331
+ * Creates a new instance of the appropriate class based on discriminator value
3332
+ * @param parseNode The parse node to use to read the discriminator value and create the object
3333
+ * @returns {PhoneLookupCarrier}
3334
+ */
3335
+ export declare function createPhoneLookupCarrierFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3336
+ /**
3337
+ * Creates a new instance of the appropriate class based on discriminator value
3338
+ * @param parseNode The parse node to use to read the discriminator value and create the object
3339
+ * @returns {PhoneLookup}
3340
+ */
3341
+ export declare function createPhoneLookupFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3281
3342
  /**
3282
3343
  * Creates a new instance of the appropriate class based on discriminator value
3283
3344
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -3302,6 +3363,18 @@ export declare function createPhoneNumberAvailabilityResponseFromDiscriminatorVa
3302
3363
  * @returns {PhoneNumberLocation_coordinate}
3303
3364
  */
3304
3365
  export declare function createPhoneNumberLocation_coordinateFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3366
+ /**
3367
+ * Creates a new instance of the appropriate class based on discriminator value
3368
+ * @param parseNode The parse node to use to read the discriminator value and create the object
3369
+ * @returns {PhoneNumberLocation_coordinateSource}
3370
+ */
3371
+ export declare function createPhoneNumberLocation_coordinateSourceFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3372
+ /**
3373
+ * Creates a new instance of the appropriate class based on discriminator value
3374
+ * @param parseNode The parse node to use to read the discriminator value and create the object
3375
+ * @returns {PhoneNumberLocation_timeZoneSource}
3376
+ */
3377
+ export declare function createPhoneNumberLocation_timeZoneSourceFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3305
3378
  /**
3306
3379
  * Creates a new instance of the appropriate class based on discriminator value
3307
3380
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -3320,6 +3393,12 @@ export declare function createPhoneNumberMessagingEventResponseFromDiscriminator
3320
3393
  * @returns {PhoneNumberOptOutMetricsResponse}
3321
3394
  */
3322
3395
  export declare function createPhoneNumberOptOutMetricsResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3396
+ /**
3397
+ * Creates a new instance of the appropriate class based on discriminator value
3398
+ * @param parseNode The parse node to use to read the discriminator value and create the object
3399
+ * @returns {PhoneNumberReadiness}
3400
+ */
3401
+ export declare function createPhoneNumberReadinessFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3323
3402
  /**
3324
3403
  * Creates a new instance of the appropriate class based on discriminator value
3325
3404
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -3410,12 +3489,6 @@ export declare function createPhoneNumberTrafficMetricsResponseFromDiscriminator
3410
3489
  * @returns {PhoneNumberTrafficTrendPoint}
3411
3490
  */
3412
3491
  export declare function createPhoneNumberTrafficTrendPointFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3413
- /**
3414
- * Creates a new instance of the appropriate class based on discriminator value
3415
- * @param parseNode The parse node to use to read the discriminator value and create the object
3416
- * @returns {PhoneNumberWarmup}
3417
- */
3418
- export declare function createPhoneNumberWarmupFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3419
3492
  /**
3420
3493
  * Creates a new instance of the appropriate class based on discriminator value
3421
3494
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -3449,21 +3522,21 @@ export declare function createSmsEventTableRowFromDiscriminatorValue(parseNode:
3449
3522
  /**
3450
3523
  * Creates a new instance of the appropriate class based on discriminator value
3451
3524
  * @param parseNode The parse node to use to read the discriminator value and create the object
3452
- * @returns {SmsResponse}
3525
+ * @returns {SmsReadinessStatusResponse}
3453
3526
  */
3454
- export declare function createSmsResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3527
+ export declare function createSmsReadinessStatusResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3455
3528
  /**
3456
3529
  * Creates a new instance of the appropriate class based on discriminator value
3457
3530
  * @param parseNode The parse node to use to read the discriminator value and create the object
3458
- * @returns {SmsWarmupStatusResponse}
3531
+ * @returns {SmsReadinessUiState}
3459
3532
  */
3460
- export declare function createSmsWarmupStatusResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3533
+ export declare function createSmsReadinessUiStateFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3461
3534
  /**
3462
3535
  * Creates a new instance of the appropriate class based on discriminator value
3463
3536
  * @param parseNode The parse node to use to read the discriminator value and create the object
3464
- * @returns {SmsWarmupUiState}
3537
+ * @returns {SmsResponse}
3465
3538
  */
3466
- export declare function createSmsWarmupUiStateFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3539
+ export declare function createSmsResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3467
3540
  /**
3468
3541
  * Creates a new instance of the appropriate class based on discriminator value
3469
3542
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -4965,6 +5038,12 @@ export declare function deserializeIntoLeadResponse(leadResponse?: Partial<LeadR
4965
5038
  * @returns {Record<string, (node: ParseNode) => void>}
4966
5039
  */
4967
5040
  export declare function deserializeIntoLeadResponse_currentDisposition(leadResponse_currentDisposition?: Partial<LeadResponse_currentDisposition> | undefined): Record<string, (node: ParseNode) => void>;
5041
+ /**
5042
+ * The deserialization information for the current model
5043
+ * @param LeadResponse_phoneIdentity The instance to deserialize into.
5044
+ * @returns {Record<string, (node: ParseNode) => void>}
5045
+ */
5046
+ export declare function deserializeIntoLeadResponse_phoneIdentity(leadResponse_phoneIdentity?: Partial<LeadResponse_phoneIdentity> | undefined): Record<string, (node: ParseNode) => void>;
4968
5047
  /**
4969
5048
  * The deserialization information for the current model
4970
5049
  * @param LeadStatusRequest The instance to deserialize into.
@@ -5151,6 +5230,48 @@ export declare function deserializeIntoPhone(phone?: Partial<Phone> | undefined)
5151
5230
  * @returns {Record<string, (node: ParseNode) => void>}
5152
5231
  */
5153
5232
  export declare function deserializeIntoPhoneCallResponse(phoneCallResponse?: Partial<PhoneCallResponse> | undefined): Record<string, (node: ParseNode) => void>;
5233
+ /**
5234
+ * The deserialization information for the current model
5235
+ * @param PhoneIdentityResponse The instance to deserialize into.
5236
+ * @returns {Record<string, (node: ParseNode) => void>}
5237
+ */
5238
+ export declare function deserializeIntoPhoneIdentityResponse(phoneIdentityResponse?: Partial<PhoneIdentityResponse> | undefined): Record<string, (node: ParseNode) => void>;
5239
+ /**
5240
+ * The deserialization information for the current model
5241
+ * @param PhoneIdentityResponse_lookup The instance to deserialize into.
5242
+ * @returns {Record<string, (node: ParseNode) => void>}
5243
+ */
5244
+ export declare function deserializeIntoPhoneIdentityResponse_lookup(phoneIdentityResponse_lookup?: Partial<PhoneIdentityResponse_lookup> | undefined): Record<string, (node: ParseNode) => void>;
5245
+ /**
5246
+ * The deserialization information for the current model
5247
+ * @param PhoneLocationSource The instance to deserialize into.
5248
+ * @returns {Record<string, (node: ParseNode) => void>}
5249
+ */
5250
+ export declare function deserializeIntoPhoneLocationSource(phoneLocationSource?: Partial<PhoneLocationSource> | undefined): Record<string, (node: ParseNode) => void>;
5251
+ /**
5252
+ * The deserialization information for the current model
5253
+ * @param PhoneLookup The instance to deserialize into.
5254
+ * @returns {Record<string, (node: ParseNode) => void>}
5255
+ */
5256
+ export declare function deserializeIntoPhoneLookup(phoneLookup?: Partial<PhoneLookup> | undefined): Record<string, (node: ParseNode) => void>;
5257
+ /**
5258
+ * The deserialization information for the current model
5259
+ * @param PhoneLookup_carrier The instance to deserialize into.
5260
+ * @returns {Record<string, (node: ParseNode) => void>}
5261
+ */
5262
+ export declare function deserializeIntoPhoneLookup_carrier(phoneLookup_carrier?: Partial<PhoneLookup_carrier> | undefined): Record<string, (node: ParseNode) => void>;
5263
+ /**
5264
+ * The deserialization information for the current model
5265
+ * @param PhoneLookup_location The instance to deserialize into.
5266
+ * @returns {Record<string, (node: ParseNode) => void>}
5267
+ */
5268
+ export declare function deserializeIntoPhoneLookup_location(phoneLookup_location?: Partial<PhoneLookup_location> | undefined): Record<string, (node: ParseNode) => void>;
5269
+ /**
5270
+ * The deserialization information for the current model
5271
+ * @param PhoneLookupCarrier The instance to deserialize into.
5272
+ * @returns {Record<string, (node: ParseNode) => void>}
5273
+ */
5274
+ export declare function deserializeIntoPhoneLookupCarrier(phoneLookupCarrier?: Partial<PhoneLookupCarrier> | undefined): Record<string, (node: ParseNode) => void>;
5154
5275
  /**
5155
5276
  * The deserialization information for the current model
5156
5277
  * @param PhoneNumberAvailabilityRequest The instance to deserialize into.
@@ -5181,6 +5302,18 @@ export declare function deserializeIntoPhoneNumberLocation(phoneNumberLocation?:
5181
5302
  * @returns {Record<string, (node: ParseNode) => void>}
5182
5303
  */
5183
5304
  export declare function deserializeIntoPhoneNumberLocation_coordinate(phoneNumberLocation_coordinate?: Partial<PhoneNumberLocation_coordinate> | undefined): Record<string, (node: ParseNode) => void>;
5305
+ /**
5306
+ * The deserialization information for the current model
5307
+ * @param PhoneNumberLocation_coordinateSource The instance to deserialize into.
5308
+ * @returns {Record<string, (node: ParseNode) => void>}
5309
+ */
5310
+ export declare function deserializeIntoPhoneNumberLocation_coordinateSource(phoneNumberLocation_coordinateSource?: Partial<PhoneNumberLocation_coordinateSource> | undefined): Record<string, (node: ParseNode) => void>;
5311
+ /**
5312
+ * The deserialization information for the current model
5313
+ * @param PhoneNumberLocation_timeZoneSource The instance to deserialize into.
5314
+ * @returns {Record<string, (node: ParseNode) => void>}
5315
+ */
5316
+ export declare function deserializeIntoPhoneNumberLocation_timeZoneSource(phoneNumberLocation_timeZoneSource?: Partial<PhoneNumberLocation_timeZoneSource> | undefined): Record<string, (node: ParseNode) => void>;
5184
5317
  /**
5185
5318
  * The deserialization information for the current model
5186
5319
  * @param PhoneNumberMessagingEventResponse The instance to deserialize into.
@@ -5193,6 +5326,12 @@ export declare function deserializeIntoPhoneNumberMessagingEventResponse(phoneNu
5193
5326
  * @returns {Record<string, (node: ParseNode) => void>}
5194
5327
  */
5195
5328
  export declare function deserializeIntoPhoneNumberOptOutMetricsResponse(phoneNumberOptOutMetricsResponse?: Partial<PhoneNumberOptOutMetricsResponse> | undefined): Record<string, (node: ParseNode) => void>;
5329
+ /**
5330
+ * The deserialization information for the current model
5331
+ * @param PhoneNumberReadiness The instance to deserialize into.
5332
+ * @returns {Record<string, (node: ParseNode) => void>}
5333
+ */
5334
+ export declare function deserializeIntoPhoneNumberReadiness(phoneNumberReadiness?: Partial<PhoneNumberReadiness> | undefined): Record<string, (node: ParseNode) => void>;
5196
5335
  /**
5197
5336
  * The deserialization information for the current model
5198
5337
  * @param PhoneNumberRequest The instance to deserialize into.
@@ -5283,12 +5422,6 @@ export declare function deserializeIntoPhoneNumberTrafficMetricsResponse(phoneNu
5283
5422
  * @returns {Record<string, (node: ParseNode) => void>}
5284
5423
  */
5285
5424
  export declare function deserializeIntoPhoneNumberTrafficTrendPoint(phoneNumberTrafficTrendPoint?: Partial<PhoneNumberTrafficTrendPoint> | undefined): Record<string, (node: ParseNode) => void>;
5286
- /**
5287
- * The deserialization information for the current model
5288
- * @param PhoneNumberWarmup The instance to deserialize into.
5289
- * @returns {Record<string, (node: ParseNode) => void>}
5290
- */
5291
- export declare function deserializeIntoPhoneNumberWarmup(phoneNumberWarmup?: Partial<PhoneNumberWarmup> | undefined): Record<string, (node: ParseNode) => void>;
5292
5425
  /**
5293
5426
  * The deserialization information for the current model
5294
5427
  * @param ProblemDetails The instance to deserialize into.
@@ -5321,22 +5454,22 @@ export declare function deserializeIntoSendSmsRequest(sendSmsRequest?: Partial<S
5321
5454
  export declare function deserializeIntoSmsEventTableRow(smsEventTableRow?: Partial<SmsEventTableRow> | undefined): Record<string, (node: ParseNode) => void>;
5322
5455
  /**
5323
5456
  * The deserialization information for the current model
5324
- * @param SmsResponse The instance to deserialize into.
5457
+ * @param SmsReadinessStatusResponse The instance to deserialize into.
5325
5458
  * @returns {Record<string, (node: ParseNode) => void>}
5326
5459
  */
5327
- export declare function deserializeIntoSmsResponse(smsResponse?: Partial<SmsResponse> | undefined): Record<string, (node: ParseNode) => void>;
5460
+ export declare function deserializeIntoSmsReadinessStatusResponse(smsReadinessStatusResponse?: Partial<SmsReadinessStatusResponse> | undefined): Record<string, (node: ParseNode) => void>;
5328
5461
  /**
5329
5462
  * The deserialization information for the current model
5330
- * @param SmsWarmupStatusResponse The instance to deserialize into.
5463
+ * @param SmsReadinessUiState The instance to deserialize into.
5331
5464
  * @returns {Record<string, (node: ParseNode) => void>}
5332
5465
  */
5333
- export declare function deserializeIntoSmsWarmupStatusResponse(smsWarmupStatusResponse?: Partial<SmsWarmupStatusResponse> | undefined): Record<string, (node: ParseNode) => void>;
5466
+ export declare function deserializeIntoSmsReadinessUiState(smsReadinessUiState?: Partial<SmsReadinessUiState> | undefined): Record<string, (node: ParseNode) => void>;
5334
5467
  /**
5335
5468
  * The deserialization information for the current model
5336
- * @param SmsWarmupUiState The instance to deserialize into.
5469
+ * @param SmsResponse The instance to deserialize into.
5337
5470
  * @returns {Record<string, (node: ParseNode) => void>}
5338
5471
  */
5339
- export declare function deserializeIntoSmsWarmupUiState(smsWarmupUiState?: Partial<SmsWarmupUiState> | undefined): Record<string, (node: ParseNode) => void>;
5472
+ export declare function deserializeIntoSmsResponse(smsResponse?: Partial<SmsResponse> | undefined): Record<string, (node: ParseNode) => void>;
5340
5473
  /**
5341
5474
  * The deserialization information for the current model
5342
5475
  * @param SourceMetricsResponse The instance to deserialize into.
@@ -6041,7 +6174,7 @@ export interface EligibleOutgoingNumberResponse extends AdditionalDataHolder, Pa
6041
6174
  */
6042
6175
  healthLabel?: string | null;
6043
6176
  /**
6044
- * Defines the supported SMS Warmup Health State values.
6177
+ * Defines the supported SMS readiness health assessments.
6045
6178
  */
6046
6179
  healthStatus?: EligibleOutgoingNumberResponse_healthStatus | null;
6047
6180
  /**
@@ -6226,6 +6359,10 @@ export interface EventTableRow extends AdditionalDataHolder, Parsable {
6226
6359
  * Display name for the person or system that created this event timeline table row.
6227
6360
  */
6228
6361
  actorDisplayName?: string | null;
6362
+ /**
6363
+ * Email address for the person who created this event timeline table row.
6364
+ */
6365
+ actorEmail?: string | null;
6229
6366
  /**
6230
6367
  * User ID for the person or system that created this event timeline table row.
6231
6368
  */
@@ -7075,6 +7212,10 @@ export interface LeadResponse extends AdditionalDataHolder, Parsable {
7075
7212
  * The date and time when the entity was last modified, if applicable.
7076
7213
  */
7077
7214
  modifiedAt?: Date | null;
7215
+ /**
7216
+ * Canonical phone identity and provider lookup details for this lead.
7217
+ */
7218
+ phoneIdentity?: LeadResponse_phoneIdentity | null;
7078
7219
  /**
7079
7220
  * Tags currently attached to this lead, source, or record.
7080
7221
  */
@@ -7085,6 +7226,11 @@ export interface LeadResponse extends AdditionalDataHolder, Parsable {
7085
7226
  */
7086
7227
  export interface LeadResponse_currentDisposition extends CurrentDispositionSummary, Parsable {
7087
7228
  }
7229
+ /**
7230
+ * Canonical phone identity and provider lookup details for this lead.
7231
+ */
7232
+ export interface LeadResponse_phoneIdentity extends Parsable, PhoneIdentityResponse {
7233
+ }
7088
7234
  export interface LeadStatusRequest extends AdditionalDataHolder, Parsable {
7089
7235
  /**
7090
7236
  * Controlled disposition categories used for reporting, automation, and analytics.
@@ -7474,6 +7620,14 @@ export interface OutboundPhoneNumberCapacity extends AdditionalDataHolder, Parsa
7474
7620
  * Unique identifier of the phone number associated with this Leadping outbound phone number capacity.
7475
7621
  */
7476
7622
  phoneNumberId?: string | null;
7623
+ /**
7624
+ * Next midnight Eastern time, when SMS daily capacity resets.
7625
+ */
7626
+ smsDailyResetsAt?: Date | null;
7627
+ /**
7628
+ * Start of the next Eastern time hour, when SMS hourly capacity resets.
7629
+ */
7630
+ smsHourlyResetsAt?: Date | null;
7477
7631
  /**
7478
7632
  * Number of SMS limit this hour represented by this Leadping outbound phone number capacity.
7479
7633
  */
@@ -7498,6 +7652,14 @@ export interface OutboundPhoneNumberCapacity extends AdditionalDataHolder, Parsa
7498
7652
  * SMS used today for the applicable messaging or voice capacity window.
7499
7653
  */
7500
7654
  smsUsedToday?: number | null;
7655
+ /**
7656
+ * Next midnight Eastern time, when voice daily capacity resets.
7657
+ */
7658
+ voiceDailyResetsAt?: Date | null;
7659
+ /**
7660
+ * Start of the next Eastern time hour, when voice hourly capacity resets.
7661
+ */
7662
+ voiceHourlyResetsAt?: Date | null;
7501
7663
  /**
7502
7664
  * Voice limit this hour associated with this Leadping outbound phone number capacity.
7503
7665
  */
@@ -7634,7 +7796,7 @@ export interface OutgoingNumberSelectionResponse extends AdditionalDataHolder, P
7634
7796
  */
7635
7797
  healthLabel?: string | null;
7636
7798
  /**
7637
- * Defines the supported SMS Warmup Health State values.
7799
+ * Defines the supported SMS readiness health assessments.
7638
7800
  */
7639
7801
  healthStatus?: OutgoingNumberSelectionResponse_healthStatus | null;
7640
7802
  /**
@@ -8048,6 +8210,135 @@ export interface PhoneCallResponse extends AdditionalDataHolder, Parsable {
8048
8210
  }
8049
8211
  export type PhoneCallResponse_selectionReason = (typeof PhoneCallResponse_selectionReasonObject)[keyof typeof PhoneCallResponse_selectionReasonObject];
8050
8212
  export type PhoneCallStatus = (typeof PhoneCallStatusObject)[keyof typeof PhoneCallStatusObject];
8213
+ /**
8214
+ * Response schema for a canonical phone identity returned by the Leadping API.
8215
+ */
8216
+ export interface PhoneIdentityResponse extends AdditionalDataHolder, Parsable {
8217
+ /**
8218
+ * The date and time when the entity was created.
8219
+ */
8220
+ createdAt?: Date | null;
8221
+ /**
8222
+ * The unique identifier for the entity.
8223
+ */
8224
+ id?: string | null;
8225
+ /**
8226
+ * The most recent time lookup data was enriched.
8227
+ */
8228
+ lastEnrichedAt?: Date | null;
8229
+ /**
8230
+ * Provider lookup and enrichment data for the number.
8231
+ */
8232
+ lookup?: PhoneIdentityResponse_lookup | null;
8233
+ /**
8234
+ * The date and time when the entity was last modified, if applicable.
8235
+ */
8236
+ modifiedAt?: Date | null;
8237
+ /**
8238
+ * The display name for the entity.
8239
+ */
8240
+ name?: string | null;
8241
+ /**
8242
+ * The canonical E.164 phone number.
8243
+ */
8244
+ number?: string | null;
8245
+ }
8246
+ /**
8247
+ * Provider lookup and enrichment data for the number.
8248
+ */
8249
+ export interface PhoneIdentityResponse_lookup extends Parsable, PhoneLookup {
8250
+ }
8251
+ /**
8252
+ * Describes how a phone location value was resolved.
8253
+ */
8254
+ export interface PhoneLocationSource extends AdditionalDataHolder, Parsable {
8255
+ /**
8256
+ * The resolution method, such as telnyx-city-state, coordinates, phone-number, or state-default.
8257
+ */
8258
+ method?: string | null;
8259
+ /**
8260
+ * The city, state, coordinates, phone number, or representative ZIP used by the method.
8261
+ */
8262
+ query?: string | null;
8263
+ }
8264
+ /**
8265
+ * Public Leadping API schema for phone lookup result data.
8266
+ */
8267
+ export interface PhoneLookup extends AdditionalDataHolder, Parsable {
8268
+ /**
8269
+ * Complete carrier metadata reported for this phone number.
8270
+ */
8271
+ carrier?: PhoneLookup_carrier | null;
8272
+ /**
8273
+ * Gets or sets created at.
8274
+ */
8275
+ createdAt?: Date | null;
8276
+ /**
8277
+ * Gets or sets id.
8278
+ */
8279
+ id?: string | null;
8280
+ /**
8281
+ * Indicates whether this phone lookup result passed validation.
8282
+ */
8283
+ isValid?: boolean | null;
8284
+ /**
8285
+ * An enumerator describing phone line types
8286
+ */
8287
+ lineType?: PhoneLookup_lineType | null;
8288
+ /**
8289
+ * Geographic location metadata for the phone number, lead, or lookup result.
8290
+ */
8291
+ location?: PhoneLookup_location | null;
8292
+ /**
8293
+ * Gets or sets modified at.
8294
+ */
8295
+ modifiedAt?: Date | null;
8296
+ /**
8297
+ * E.164 phone number exposed by this phone lookup result.
8298
+ */
8299
+ number?: string | null;
8300
+ }
8301
+ /**
8302
+ * Complete carrier metadata reported for this phone number.
8303
+ */
8304
+ export interface PhoneLookup_carrier extends Parsable, PhoneLookupCarrier {
8305
+ }
8306
+ export type PhoneLookup_lineType = (typeof PhoneLookup_lineTypeObject)[keyof typeof PhoneLookup_lineTypeObject];
8307
+ /**
8308
+ * Geographic location metadata for the phone number, lead, or lookup result.
8309
+ */
8310
+ export interface PhoneLookup_location extends Parsable, PhoneNumberLocation {
8311
+ }
8312
+ /**
8313
+ * Complete carrier metadata returned by a phone number lookup provider.
8314
+ */
8315
+ export interface PhoneLookupCarrier extends AdditionalDataHolder, Parsable {
8316
+ /**
8317
+ * Reason or diagnostic code that explains the current outcome for this Leadping phone lookup carrier.
8318
+ */
8319
+ errorCode?: string | null;
8320
+ /**
8321
+ * Mobile country code (MCC) reported by the carrier lookup.
8322
+ */
8323
+ mobileCountryCode?: string | null;
8324
+ /**
8325
+ * Mobile network code (MNC) reported by the carrier lookup.
8326
+ */
8327
+ mobileNetworkCode?: string | null;
8328
+ /**
8329
+ * Human-readable name of the phone lookup carrier.
8330
+ */
8331
+ name?: string | null;
8332
+ /**
8333
+ * Normalized carrier name used for consistent matching and reporting.
8334
+ */
8335
+ normalizedCarrier?: string | null;
8336
+ /**
8337
+ * An enumerator describing carrier types
8338
+ */
8339
+ type?: PhoneLookupCarrier_type | null;
8340
+ }
8341
+ export type PhoneLookupCarrier_type = (typeof PhoneLookupCarrier_typeObject)[keyof typeof PhoneLookupCarrier_typeObject];
8051
8342
  /**
8052
8343
  * Request schema for checking phone number availability before purchase or assignment.
8053
8344
  */
@@ -8091,10 +8382,22 @@ export interface PhoneNumberAvailabilityResponse_location extends Parsable, Phon
8091
8382
  * Public Leadping API schema for phone number location data.
8092
8383
  */
8093
8384
  export interface PhoneNumberLocation extends AdditionalDataHolder, Parsable {
8385
+ /**
8386
+ * Canonical city resolved by Leadping from its ZIP-code geography data.
8387
+ */
8388
+ canonicalCity?: string | null;
8389
+ /**
8390
+ * Canonical state or territory abbreviation resolved by Leadping.
8391
+ */
8392
+ canonicalState?: string | null;
8094
8393
  /**
8095
8394
  * Latitude and longitude coordinate for this phone number location.
8096
8395
  */
8097
8396
  coordinate?: PhoneNumberLocation_coordinate | null;
8397
+ /**
8398
+ * Describes how the coordinate was resolved.
8399
+ */
8400
+ coordinateSource?: PhoneNumberLocation_coordinateSource | null;
8098
8401
  /**
8099
8402
  * Country code for the phone number or location represented by this phone number location.
8100
8403
  */
@@ -8111,12 +8414,26 @@ export interface PhoneNumberLocation extends AdditionalDataHolder, Parsable {
8111
8414
  * IANA or Windows time zone identifier used for local scheduling and reporting.
8112
8415
  */
8113
8416
  timeZoneId?: string | null;
8417
+ /**
8418
+ * Describes how the time zone was resolved.
8419
+ */
8420
+ timeZoneSource?: PhoneNumberLocation_timeZoneSource | null;
8114
8421
  }
8115
8422
  /**
8116
8423
  * Latitude and longitude coordinate for this phone number location.
8117
8424
  */
8118
8425
  export interface PhoneNumberLocation_coordinate extends Coordinate, Parsable {
8119
8426
  }
8427
+ /**
8428
+ * Describes how the coordinate was resolved.
8429
+ */
8430
+ export interface PhoneNumberLocation_coordinateSource extends Parsable, PhoneLocationSource {
8431
+ }
8432
+ /**
8433
+ * Describes how the time zone was resolved.
8434
+ */
8435
+ export interface PhoneNumberLocation_timeZoneSource extends Parsable, PhoneLocationSource {
8436
+ }
8120
8437
  /**
8121
8438
  * Response schema for the Leadping API phone number messaging event returned to authenticated clients.
8122
8439
  */
@@ -8184,6 +8501,38 @@ export interface PhoneNumberOptOutMetricsResponse extends AdditionalDataHolder,
8184
8501
  windowStartedAt?: Date | null;
8185
8502
  }
8186
8503
  export type PhoneNumberOutboundHealthStatus = (typeof PhoneNumberOutboundHealthStatusObject)[keyof typeof PhoneNumberOutboundHealthStatusObject];
8504
+ /**
8505
+ * Messaging and calling warmup for a Leadping phone number.
8506
+ */
8507
+ export interface PhoneNumberReadiness extends AdditionalDataHolder, Parsable {
8508
+ /**
8509
+ * Defines the supported voice call warmup stages for a Leadping-managed phone number.
8510
+ */
8511
+ callStage?: PhoneNumberReadiness_callStage | null;
8512
+ /**
8513
+ * Indicates whether phone number warmup is enabled in Leadping.
8514
+ */
8515
+ enabled?: boolean | null;
8516
+ /**
8517
+ * Current warmup health score used to assess phone number warmup.
8518
+ */
8519
+ healthScore?: number | null;
8520
+ /**
8521
+ * Defines the supported SMS readiness health assessments.
8522
+ */
8523
+ healthStatus?: PhoneNumberReadiness_healthStatus | null;
8524
+ /**
8525
+ * Warmup completion percentage, from 0 through 100.
8526
+ */
8527
+ progressPercent?: number | null;
8528
+ /**
8529
+ * Defines the supported SMS readiness states.
8530
+ */
8531
+ state?: PhoneNumberReadiness_state | null;
8532
+ }
8533
+ export type PhoneNumberReadiness_callStage = (typeof PhoneNumberReadiness_callStageObject)[keyof typeof PhoneNumberReadiness_callStageObject];
8534
+ export type PhoneNumberReadiness_healthStatus = (typeof PhoneNumberReadiness_healthStatusObject)[keyof typeof PhoneNumberReadiness_healthStatusObject];
8535
+ export type PhoneNumberReadiness_state = (typeof PhoneNumberReadiness_stateObject)[keyof typeof PhoneNumberReadiness_stateObject];
8187
8536
  /**
8188
8537
  * Request schema for the Leadping API phone number update request, including the fields clients can send.
8189
8538
  */
@@ -8254,9 +8603,9 @@ export interface PhoneNumberResponse extends AdditionalDataHolder, Parsable {
8254
8603
  */
8255
8604
  routing?: PhoneNumberRoutingMetadata | null;
8256
8605
  /**
8257
- * SMS and voice warmup state for this phone number.
8606
+ * SMS and call warmup for this phone number.
8258
8607
  */
8259
- warmup?: PhoneNumberWarmup | null;
8608
+ warmup?: PhoneNumberReadiness | null;
8260
8609
  }
8261
8610
  /**
8262
8611
  * Business summary connected to this phone number.
@@ -8283,6 +8632,10 @@ export interface PhoneNumberRoutingMetadata extends AdditionalDataHolder, Parsab
8283
8632
  * Team ID used to route calls and messages for this phone number.
8284
8633
  */
8285
8634
  teamId?: string | null;
8635
+ /**
8636
+ * Leadping 10DLC application entity associated with this phone number.
8637
+ */
8638
+ tenDlcApplicationId?: string | null;
8286
8639
  /**
8287
8640
  * Indicates whether the phone number can be used for voice calls.
8288
8641
  */
@@ -8334,7 +8687,7 @@ export interface PhoneNumberSearchResult extends AdditionalDataHolder, Parsable
8334
8687
  export interface PhoneNumberSearchResult_location extends Parsable, PhoneNumberLocation {
8335
8688
  }
8336
8689
  /**
8337
- * Response schema for the Leadping API phone number readiness status returned to authenticated clients.
8690
+ * Response schema for the Leadping API phone number warmup status returned to authenticated clients.
8338
8691
  */
8339
8692
  export interface PhoneNumberStatusResponse extends AdditionalDataHolder, Parsable {
8340
8693
  /**
@@ -8346,7 +8699,7 @@ export interface PhoneNumberStatusResponse extends AdditionalDataHolder, Parsabl
8346
8699
  */
8347
8700
  messagesPossible?: number | null;
8348
8701
  /**
8349
- * E.164 phone number exposed by this phone number readiness status.
8702
+ * E.164 phone number exposed by this phone number warmup status.
8350
8703
  */
8351
8704
  number?: string | null;
8352
8705
  /**
@@ -8362,7 +8715,7 @@ export interface PhoneNumberStatusResponse extends AdditionalDataHolder, Parsabl
8362
8715
  */
8363
8716
  recentEvents?: PhoneNumberMessagingEventResponse[] | null;
8364
8717
  /**
8365
- * SMS sender warmup status for this phone number.
8718
+ * SMS warmup status for this phone number.
8366
8719
  */
8367
8720
  smsWarmup?: PhoneNumberStatusResponse_smsWarmup | null;
8368
8721
  /**
@@ -8376,9 +8729,9 @@ export interface PhoneNumberStatusResponse extends AdditionalDataHolder, Parsabl
8376
8729
  export interface PhoneNumberStatusResponse_outboundCapacity extends OutboundPhoneNumberCapacity, Parsable {
8377
8730
  }
8378
8731
  /**
8379
- * SMS sender warmup status for this phone number.
8732
+ * SMS warmup status for this phone number.
8380
8733
  */
8381
- export interface PhoneNumberStatusResponse_smsWarmup extends Parsable, SmsWarmupStatusResponse {
8734
+ export interface PhoneNumberStatusResponse_smsWarmup extends Parsable, SmsReadinessStatusResponse {
8382
8735
  }
8383
8736
  /**
8384
8737
  * List item schema for Leadping API phone number table row results shown in searchable tables.
@@ -8401,7 +8754,7 @@ export interface PhoneNumberTableRow extends AdditionalDataHolder, Parsable {
8401
8754
  */
8402
8755
  id?: string | null;
8403
8756
  /**
8404
- * Display name for this phone number table row in the Leadping API.
8757
+ * Optional display label for this phone number table row in the Leadping API.
8405
8758
  */
8406
8759
  name?: string | null;
8407
8760
  /**
@@ -8435,20 +8788,32 @@ export interface PhoneNumberTableRow extends AdditionalDataHolder, Parsable {
8435
8788
  /**
8436
8789
  * Warmup state for this phone number.
8437
8790
  */
8438
- warmup?: PhoneNumberWarmup | null;
8791
+ warmup?: PhoneNumberReadiness | null;
8439
8792
  }
8440
8793
  /**
8441
8794
  * Response schema for the Leadping API phone number traffic metrics response returned to authenticated clients.
8442
8795
  */
8443
8796
  export interface PhoneNumberTrafficMetricsResponse extends AdditionalDataHolder, Parsable {
8797
+ /**
8798
+ * Number of outbound calls that connected during this metrics window.
8799
+ */
8800
+ callConnectedCount?: number | null;
8444
8801
  /**
8445
8802
  * Number of outbound calls that failed during this metrics window.
8446
8803
  */
8447
8804
  callFailedCount?: number | null;
8805
+ /**
8806
+ * Number of outbound calls that failed because the destination number was invalid during this metrics window.
8807
+ */
8808
+ callInvalidNumberCount?: number | null;
8448
8809
  /**
8449
8810
  * Number of outbound calls placed during this metrics window.
8450
8811
  */
8451
8812
  callPlacedCount?: number | null;
8813
+ /**
8814
+ * Number of connected outbound calls shorter than 30 seconds during this metrics window.
8815
+ */
8816
+ callShortCount?: number | null;
8452
8817
  /**
8453
8818
  * Number of SMS messages that failed during this metrics window.
8454
8819
  */
@@ -8503,33 +8868,6 @@ export interface PhoneNumberTrafficTrendPoint extends AdditionalDataHolder, Pars
8503
8868
  */
8504
8869
  startAt?: Date | null;
8505
8870
  }
8506
- /**
8507
- * Warmup state for a Leadping phone number.
8508
- */
8509
- export interface PhoneNumberWarmup extends AdditionalDataHolder, Parsable {
8510
- /**
8511
- * Indicates whether the phone number warmup is enabled in Leadping.
8512
- */
8513
- enabled?: boolean | null;
8514
- /**
8515
- * Current warmup health score used to assess phone number readiness.
8516
- */
8517
- healthScore?: number | null;
8518
- /**
8519
- * Defines the supported SMS Warmup Health State values.
8520
- */
8521
- healthStatus?: PhoneNumberWarmup_healthStatus | null;
8522
- /**
8523
- * Warmup completion percentage, from 0 through 100.
8524
- */
8525
- progressPercent?: number | null;
8526
- /**
8527
- * Defines the supported SMS Warmup Health State values.
8528
- */
8529
- state?: PhoneNumberWarmup_state | null;
8530
- }
8531
- export type PhoneNumberWarmup_healthStatus = (typeof PhoneNumberWarmup_healthStatusObject)[keyof typeof PhoneNumberWarmup_healthStatusObject];
8532
- export type PhoneNumberWarmup_state = (typeof PhoneNumberWarmup_stateObject)[keyof typeof PhoneNumberWarmup_stateObject];
8533
8871
  export interface ProblemDetails extends AdditionalDataHolder, ApiError, Parsable {
8534
8872
  /**
8535
8873
  * Human-readable explanation specific to this occurrence of the problem.
@@ -9495,6 +9833,13 @@ export declare function serializeLeadResponse(writer: SerializationWriter, leadR
9495
9833
  * @param writer Serialization writer to use to serialize this model
9496
9834
  */
9497
9835
  export declare function serializeLeadResponse_currentDisposition(writer: SerializationWriter, leadResponse_currentDisposition?: Partial<LeadResponse_currentDisposition> | undefined | null, isSerializingDerivedType?: boolean): void;
9836
+ /**
9837
+ * Serializes information the current object
9838
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
9839
+ * @param LeadResponse_phoneIdentity The instance to serialize from.
9840
+ * @param writer Serialization writer to use to serialize this model
9841
+ */
9842
+ export declare function serializeLeadResponse_phoneIdentity(writer: SerializationWriter, leadResponse_phoneIdentity?: Partial<LeadResponse_phoneIdentity> | undefined | null, isSerializingDerivedType?: boolean): void;
9498
9843
  /**
9499
9844
  * Serializes information the current object
9500
9845
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -9712,6 +10057,55 @@ export declare function serializePhone(writer: SerializationWriter, phone?: Part
9712
10057
  * @param writer Serialization writer to use to serialize this model
9713
10058
  */
9714
10059
  export declare function serializePhoneCallResponse(writer: SerializationWriter, phoneCallResponse?: Partial<PhoneCallResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
10060
+ /**
10061
+ * Serializes information the current object
10062
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
10063
+ * @param PhoneIdentityResponse The instance to serialize from.
10064
+ * @param writer Serialization writer to use to serialize this model
10065
+ */
10066
+ export declare function serializePhoneIdentityResponse(writer: SerializationWriter, phoneIdentityResponse?: Partial<PhoneIdentityResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
10067
+ /**
10068
+ * Serializes information the current object
10069
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
10070
+ * @param PhoneIdentityResponse_lookup The instance to serialize from.
10071
+ * @param writer Serialization writer to use to serialize this model
10072
+ */
10073
+ export declare function serializePhoneIdentityResponse_lookup(writer: SerializationWriter, phoneIdentityResponse_lookup?: Partial<PhoneIdentityResponse_lookup> | undefined | null, isSerializingDerivedType?: boolean): void;
10074
+ /**
10075
+ * Serializes information the current object
10076
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
10077
+ * @param PhoneLocationSource The instance to serialize from.
10078
+ * @param writer Serialization writer to use to serialize this model
10079
+ */
10080
+ export declare function serializePhoneLocationSource(writer: SerializationWriter, phoneLocationSource?: Partial<PhoneLocationSource> | undefined | null, isSerializingDerivedType?: boolean): void;
10081
+ /**
10082
+ * Serializes information the current object
10083
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
10084
+ * @param PhoneLookup The instance to serialize from.
10085
+ * @param writer Serialization writer to use to serialize this model
10086
+ */
10087
+ export declare function serializePhoneLookup(writer: SerializationWriter, phoneLookup?: Partial<PhoneLookup> | undefined | null, isSerializingDerivedType?: boolean): void;
10088
+ /**
10089
+ * Serializes information the current object
10090
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
10091
+ * @param PhoneLookup_carrier The instance to serialize from.
10092
+ * @param writer Serialization writer to use to serialize this model
10093
+ */
10094
+ export declare function serializePhoneLookup_carrier(writer: SerializationWriter, phoneLookup_carrier?: Partial<PhoneLookup_carrier> | undefined | null, isSerializingDerivedType?: boolean): void;
10095
+ /**
10096
+ * Serializes information the current object
10097
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
10098
+ * @param PhoneLookup_location The instance to serialize from.
10099
+ * @param writer Serialization writer to use to serialize this model
10100
+ */
10101
+ export declare function serializePhoneLookup_location(writer: SerializationWriter, phoneLookup_location?: Partial<PhoneLookup_location> | undefined | null, isSerializingDerivedType?: boolean): void;
10102
+ /**
10103
+ * Serializes information the current object
10104
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
10105
+ * @param PhoneLookupCarrier The instance to serialize from.
10106
+ * @param writer Serialization writer to use to serialize this model
10107
+ */
10108
+ export declare function serializePhoneLookupCarrier(writer: SerializationWriter, phoneLookupCarrier?: Partial<PhoneLookupCarrier> | undefined | null, isSerializingDerivedType?: boolean): void;
9715
10109
  /**
9716
10110
  * Serializes information the current object
9717
10111
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -9747,6 +10141,20 @@ export declare function serializePhoneNumberLocation(writer: SerializationWriter
9747
10141
  * @param writer Serialization writer to use to serialize this model
9748
10142
  */
9749
10143
  export declare function serializePhoneNumberLocation_coordinate(writer: SerializationWriter, phoneNumberLocation_coordinate?: Partial<PhoneNumberLocation_coordinate> | undefined | null, isSerializingDerivedType?: boolean): void;
10144
+ /**
10145
+ * Serializes information the current object
10146
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
10147
+ * @param PhoneNumberLocation_coordinateSource The instance to serialize from.
10148
+ * @param writer Serialization writer to use to serialize this model
10149
+ */
10150
+ export declare function serializePhoneNumberLocation_coordinateSource(writer: SerializationWriter, phoneNumberLocation_coordinateSource?: Partial<PhoneNumberLocation_coordinateSource> | undefined | null, isSerializingDerivedType?: boolean): void;
10151
+ /**
10152
+ * Serializes information the current object
10153
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
10154
+ * @param PhoneNumberLocation_timeZoneSource The instance to serialize from.
10155
+ * @param writer Serialization writer to use to serialize this model
10156
+ */
10157
+ export declare function serializePhoneNumberLocation_timeZoneSource(writer: SerializationWriter, phoneNumberLocation_timeZoneSource?: Partial<PhoneNumberLocation_timeZoneSource> | undefined | null, isSerializingDerivedType?: boolean): void;
9750
10158
  /**
9751
10159
  * Serializes information the current object
9752
10160
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -9761,6 +10169,13 @@ export declare function serializePhoneNumberMessagingEventResponse(writer: Seria
9761
10169
  * @param writer Serialization writer to use to serialize this model
9762
10170
  */
9763
10171
  export declare function serializePhoneNumberOptOutMetricsResponse(writer: SerializationWriter, phoneNumberOptOutMetricsResponse?: Partial<PhoneNumberOptOutMetricsResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
10172
+ /**
10173
+ * Serializes information the current object
10174
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
10175
+ * @param PhoneNumberReadiness The instance to serialize from.
10176
+ * @param writer Serialization writer to use to serialize this model
10177
+ */
10178
+ export declare function serializePhoneNumberReadiness(writer: SerializationWriter, phoneNumberReadiness?: Partial<PhoneNumberReadiness> | undefined | null, isSerializingDerivedType?: boolean): void;
9764
10179
  /**
9765
10180
  * Serializes information the current object
9766
10181
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -9866,13 +10281,6 @@ export declare function serializePhoneNumberTrafficMetricsResponse(writer: Seria
9866
10281
  * @param writer Serialization writer to use to serialize this model
9867
10282
  */
9868
10283
  export declare function serializePhoneNumberTrafficTrendPoint(writer: SerializationWriter, phoneNumberTrafficTrendPoint?: Partial<PhoneNumberTrafficTrendPoint> | undefined | null, isSerializingDerivedType?: boolean): void;
9869
- /**
9870
- * Serializes information the current object
9871
- * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
9872
- * @param PhoneNumberWarmup The instance to serialize from.
9873
- * @param writer Serialization writer to use to serialize this model
9874
- */
9875
- export declare function serializePhoneNumberWarmup(writer: SerializationWriter, phoneNumberWarmup?: Partial<PhoneNumberWarmup> | undefined | null, isSerializingDerivedType?: boolean): void;
9876
10284
  /**
9877
10285
  * Serializes information the current object
9878
10286
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -9911,24 +10319,24 @@ export declare function serializeSmsEventTableRow(writer: SerializationWriter, s
9911
10319
  /**
9912
10320
  * Serializes information the current object
9913
10321
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
9914
- * @param SmsResponse The instance to serialize from.
10322
+ * @param SmsReadinessStatusResponse The instance to serialize from.
9915
10323
  * @param writer Serialization writer to use to serialize this model
9916
10324
  */
9917
- export declare function serializeSmsResponse(writer: SerializationWriter, smsResponse?: Partial<SmsResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
10325
+ export declare function serializeSmsReadinessStatusResponse(writer: SerializationWriter, smsReadinessStatusResponse?: Partial<SmsReadinessStatusResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
9918
10326
  /**
9919
10327
  * Serializes information the current object
9920
10328
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
9921
- * @param SmsWarmupStatusResponse The instance to serialize from.
10329
+ * @param SmsReadinessUiState The instance to serialize from.
9922
10330
  * @param writer Serialization writer to use to serialize this model
9923
10331
  */
9924
- export declare function serializeSmsWarmupStatusResponse(writer: SerializationWriter, smsWarmupStatusResponse?: Partial<SmsWarmupStatusResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
10332
+ export declare function serializeSmsReadinessUiState(writer: SerializationWriter, smsReadinessUiState?: Partial<SmsReadinessUiState> | undefined | null, isSerializingDerivedType?: boolean): void;
9925
10333
  /**
9926
10334
  * Serializes information the current object
9927
10335
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
9928
- * @param SmsWarmupUiState The instance to serialize from.
10336
+ * @param SmsResponse The instance to serialize from.
9929
10337
  * @param writer Serialization writer to use to serialize this model
9930
10338
  */
9931
- export declare function serializeSmsWarmupUiState(writer: SerializationWriter, smsWarmupUiState?: Partial<SmsWarmupUiState> | undefined | null, isSerializingDerivedType?: boolean): void;
10339
+ export declare function serializeSmsResponse(writer: SerializationWriter, smsResponse?: Partial<SmsResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
9932
10340
  /**
9933
10341
  * Serializes information the current object
9934
10342
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -10499,6 +10907,62 @@ export interface SmsEventTableRow extends AdditionalDataHolder, Parsable {
10499
10907
  export type SmsEventTableRow_outboundSource = (typeof SmsEventTableRow_outboundSourceObject)[keyof typeof SmsEventTableRow_outboundSourceObject];
10500
10908
  export type SmsEventTableRow_status = (typeof SmsEventTableRow_statusObject)[keyof typeof SmsEventTableRow_statusObject];
10501
10909
  export type SmsEventTableRow_trafficType = (typeof SmsEventTableRow_trafficTypeObject)[keyof typeof SmsEventTableRow_trafficTypeObject];
10910
+ export type SmsReadinessHealthStatus = (typeof SmsReadinessHealthStatusObject)[keyof typeof SmsReadinessHealthStatusObject];
10911
+ export type SmsReadinessState = (typeof SmsReadinessStateObject)[keyof typeof SmsReadinessStateObject];
10912
+ /**
10913
+ * API response containing SMS warmup status data returned to callers.
10914
+ */
10915
+ export interface SmsReadinessStatusResponse extends AdditionalDataHolder, Parsable {
10916
+ /**
10917
+ * The health score metric for this SMS warmup status.
10918
+ */
10919
+ healthScore?: number | null;
10920
+ /**
10921
+ * The current delivery-health assessment for this SMS warmup status.
10922
+ */
10923
+ healthStatus?: SmsReadinessHealthStatus | null;
10924
+ /**
10925
+ * The phone number associated with this SMS warmup status.
10926
+ */
10927
+ phoneNumber?: string | null;
10928
+ /**
10929
+ * The phone number ID associated with this SMS warmup status.
10930
+ */
10931
+ phoneNumberId?: string | null;
10932
+ /**
10933
+ * The progress percent metric for this SMS warmup status.
10934
+ */
10935
+ progressPercent?: number | null;
10936
+ /**
10937
+ * The current state for this SMS warmup status.
10938
+ */
10939
+ status?: SmsReadinessState | null;
10940
+ /**
10941
+ * The current UI state for this SMS warmup status.
10942
+ */
10943
+ uiState?: SmsReadinessUiState | null;
10944
+ /**
10945
+ * Whether warmup is enabled for this SMS warmup status.
10946
+ */
10947
+ warmupEnabled?: boolean | null;
10948
+ }
10949
+ /**
10950
+ * API DTO containing SMS readiness UI state data used by Leadping API contracts.
10951
+ */
10952
+ export interface SmsReadinessUiState extends AdditionalDataHolder, Parsable {
10953
+ /**
10954
+ * The human-readable description of this SMS readiness UI state.
10955
+ */
10956
+ description?: string | null;
10957
+ /**
10958
+ * The human-readable label shown for this SMS readiness UI state.
10959
+ */
10960
+ label?: SmsReadinessState | null;
10961
+ /**
10962
+ * The tone value for this SMS readiness UI state.
10963
+ */
10964
+ tone?: string | null;
10965
+ }
10502
10966
  /**
10503
10967
  * Response schema for the Leadping API SMS message returned to authenticated clients.
10504
10968
  */
@@ -10647,57 +11111,6 @@ export interface SmsResponse extends AdditionalDataHolder, Parsable {
10647
11111
  export type SmsResponse_selectionReason = (typeof SmsResponse_selectionReasonObject)[keyof typeof SmsResponse_selectionReasonObject];
10648
11112
  export type SmsResponse_status = (typeof SmsResponse_statusObject)[keyof typeof SmsResponse_statusObject];
10649
11113
  export type SmsResponse_trafficType = (typeof SmsResponse_trafficTypeObject)[keyof typeof SmsResponse_trafficTypeObject];
10650
- export type SmsWarmupHealthState = (typeof SmsWarmupHealthStateObject)[keyof typeof SmsWarmupHealthStateObject];
10651
- /**
10652
- * API response containing SMS warmup status data returned to callers.
10653
- */
10654
- export interface SmsWarmupStatusResponse extends AdditionalDataHolder, Parsable {
10655
- /**
10656
- * The health score metric for this SMS warmup status.
10657
- */
10658
- healthScore?: number | null;
10659
- /**
10660
- * The phone number associated with this SMS warmup status.
10661
- */
10662
- phoneNumber?: string | null;
10663
- /**
10664
- * The phone number ID associated with this SMS warmup status.
10665
- */
10666
- phoneNumberId?: string | null;
10667
- /**
10668
- * The progress percent metric for this SMS warmup status.
10669
- */
10670
- progressPercent?: number | null;
10671
- /**
10672
- * The current status for this SMS warmup status.
10673
- */
10674
- status?: SmsWarmupHealthState | null;
10675
- /**
10676
- * The current UI state for this SMS warmup status.
10677
- */
10678
- uiState?: SmsWarmupUiState | null;
10679
- /**
10680
- * Whether warmup is enabled for this SMS warmup status.
10681
- */
10682
- warmupEnabled?: boolean | null;
10683
- }
10684
- /**
10685
- * API DTO containing SMS warmup ui state data used by Leadping API contracts.
10686
- */
10687
- export interface SmsWarmupUiState extends AdditionalDataHolder, Parsable {
10688
- /**
10689
- * The human-readable description of this SMS warmup UI state.
10690
- */
10691
- description?: string | null;
10692
- /**
10693
- * The human-readable label shown for this SMS warmup UI state.
10694
- */
10695
- label?: SmsWarmupHealthState | null;
10696
- /**
10697
- * The tone value for this SMS warmup UI state.
10698
- */
10699
- tone?: string | null;
10700
- }
10701
11114
  /**
10702
11115
  * Response model containing source metrics data returned by the Leadping API.
10703
11116
  */
@@ -12137,6 +12550,10 @@ export interface UserRequest extends AdditionalDataHolder, Parsable {
12137
12550
  * Phone details for the lead, user, or business represented by this user profile request.
12138
12551
  */
12139
12552
  phone?: string | null;
12553
+ /**
12554
+ * IANA time zone identifier used when displaying dates and times for this user.
12555
+ */
12556
+ timeZoneId?: string | null;
12140
12557
  }
12141
12558
  export type UserRequest_billingPlan = (typeof UserRequest_billingPlanObject)[keyof typeof UserRequest_billingPlanObject];
12142
12559
  /**
@@ -12246,6 +12663,10 @@ export interface UserResponse extends AdditionalDataHolder, Parsable {
12246
12663
  * Defines the supported Subscription Status values.
12247
12664
  */
12248
12665
  subscriptionStatus?: UserResponse_subscriptionStatus | null;
12666
+ /**
12667
+ * IANA time zone identifier used when displaying dates and times for this user.
12668
+ */
12669
+ timeZoneId?: string | null;
12249
12670
  }
12250
12671
  export type UserResponse_billingPlan = (typeof UserResponse_billingPlanObject)[keyof typeof UserResponse_billingPlanObject];
12251
12672
  /**
@@ -12532,6 +12953,22 @@ export declare const BusinessSwitchOption_businessStatusObject: {
12532
12953
  readonly SetupCompleted: "SetupCompleted";
12533
12954
  readonly Active: "Active";
12534
12955
  };
12956
+ /**
12957
+ * Defines the supported 10DLC Application Status values.
12958
+ */
12959
+ export declare const BusinessSwitchOption_tenDlcStatusObject: {
12960
+ readonly NotStarted: "NotStarted";
12961
+ readonly DraftGenerated: "DraftGenerated";
12962
+ readonly DraftNeedsAdminReview: "DraftNeedsAdminReview";
12963
+ readonly ReadyToSubmit: "ReadyToSubmit";
12964
+ readonly Submitted: "Submitted";
12965
+ readonly PendingTelnyxReview: "PendingTelnyxReview";
12966
+ readonly Approved: "Approved";
12967
+ readonly Rejected: "Rejected";
12968
+ readonly NeedsChanges: "NeedsChanges";
12969
+ readonly ResubmissionReady: "ResubmissionReady";
12970
+ readonly Failed: "Failed";
12971
+ };
12535
12972
  /**
12536
12973
  * Defines the supported Customer Activation Status values.
12537
12974
  */
@@ -12793,16 +13230,14 @@ export declare const DispositionResponse_changeSourceObject: {
12793
13230
  readonly API: "API";
12794
13231
  };
12795
13232
  /**
12796
- * Defines the supported SMS Warmup Health State values.
13233
+ * Defines the supported SMS readiness health assessments.
12797
13234
  */
12798
13235
  export declare const EligibleOutgoingNumberResponse_healthStatusObject: {
12799
- readonly NotStarted: "Not Started";
12800
- readonly Warming: "Warming";
13236
+ readonly NotEvaluated: "Not Evaluated";
13237
+ readonly Evaluating: "Evaluating";
12801
13238
  readonly Healthy: "Healthy";
12802
13239
  readonly NeedsAttention: "Needs Attention";
12803
- readonly Paused: "Paused";
12804
13240
  readonly Blocked: "Blocked";
12805
- readonly Ready: "Ready";
12806
13241
  };
12807
13242
  /**
12808
13243
  * Defines the supported Event status values.
@@ -13095,16 +13530,14 @@ export declare const OutgoingNumberSelectionRequest_channelObject: {
13095
13530
  readonly Call: "call";
13096
13531
  };
13097
13532
  /**
13098
- * Defines the supported SMS Warmup Health State values.
13533
+ * Defines the supported SMS readiness health assessments.
13099
13534
  */
13100
13535
  export declare const OutgoingNumberSelectionResponse_healthStatusObject: {
13101
- readonly NotStarted: "Not Started";
13102
- readonly Warming: "Warming";
13536
+ readonly NotEvaluated: "Not Evaluated";
13537
+ readonly Evaluating: "Evaluating";
13103
13538
  readonly Healthy: "Healthy";
13104
13539
  readonly NeedsAttention: "Needs Attention";
13105
- readonly Paused: "Paused";
13106
13540
  readonly Blocked: "Blocked";
13107
- readonly Ready: "Ready";
13108
13541
  };
13109
13542
  /**
13110
13543
  * Defines the supported Outgoing Number Selection Reason values.
@@ -13157,6 +13590,34 @@ export declare const PhoneCallStatusObject: {
13157
13590
  readonly Blocked_permission: "blocked_permission";
13158
13591
  readonly Configuration_required: "configuration_required";
13159
13592
  };
13593
+ /**
13594
+ * An enumerator describing phone line types
13595
+ */
13596
+ export declare const PhoneLookup_lineTypeObject: {
13597
+ readonly Wireline: "Wireline";
13598
+ readonly Wireless: "Wireless";
13599
+ readonly VoWiFi: "VoWiFi";
13600
+ readonly VoIP: "VoIP";
13601
+ readonly PrePaidWireless: "PrePaidWireless";
13602
+ readonly Unknown: "Unknown";
13603
+ };
13604
+ /**
13605
+ * An enumerator describing carrier types
13606
+ */
13607
+ export declare const PhoneLookupCarrier_typeObject: {
13608
+ readonly FixedLine: "FixedLine";
13609
+ readonly Mobile: "Mobile";
13610
+ readonly Voip: "Voip";
13611
+ readonly FixedLineOrMobile: "FixedLineOrMobile";
13612
+ readonly TollFree: "TollFree";
13613
+ readonly PremiumRate: "PremiumRate";
13614
+ readonly SharedCost: "SharedCost";
13615
+ readonly PersonalNumber: "PersonalNumber";
13616
+ readonly Pager: "Pager";
13617
+ readonly Uan: "Uan";
13618
+ readonly Voicemail: "Voicemail";
13619
+ readonly Unknown: "Unknown";
13620
+ };
13160
13621
  /**
13161
13622
  * Defines phone-number outbound health states used by pacing.
13162
13623
  */
@@ -13171,25 +13632,31 @@ export declare const PhoneNumberOutboundHealthStatusObject: {
13171
13632
  readonly Disabled: "disabled";
13172
13633
  };
13173
13634
  /**
13174
- * Defines the supported SMS Warmup Health State values.
13635
+ * Defines the supported voice call warmup stages for a Leadping-managed phone number.
13175
13636
  */
13176
- export declare const PhoneNumberWarmup_healthStatusObject: {
13177
- readonly NotStarted: "Not Started";
13178
- readonly Warming: "Warming";
13637
+ export declare const PhoneNumberReadiness_callStageObject: {
13638
+ readonly Stage0: "Stage 0";
13639
+ readonly Stage1: "Stage 1";
13640
+ readonly Stage2: "Stage 2";
13641
+ readonly Stage3: "Stage 3";
13642
+ readonly Stage4: "Stage 4";
13643
+ };
13644
+ /**
13645
+ * Defines the supported SMS readiness health assessments.
13646
+ */
13647
+ export declare const PhoneNumberReadiness_healthStatusObject: {
13648
+ readonly NotEvaluated: "Not Evaluated";
13649
+ readonly Evaluating: "Evaluating";
13179
13650
  readonly Healthy: "Healthy";
13180
13651
  readonly NeedsAttention: "Needs Attention";
13181
- readonly Paused: "Paused";
13182
13652
  readonly Blocked: "Blocked";
13183
- readonly Ready: "Ready";
13184
13653
  };
13185
13654
  /**
13186
- * Defines the supported SMS Warmup Health State values.
13655
+ * Defines the supported SMS readiness states.
13187
13656
  */
13188
- export declare const PhoneNumberWarmup_stateObject: {
13657
+ export declare const PhoneNumberReadiness_stateObject: {
13189
13658
  readonly NotStarted: "Not Started";
13190
- readonly Warming: "Warming";
13191
- readonly Healthy: "Healthy";
13192
- readonly NeedsAttention: "Needs Attention";
13659
+ readonly InProgress: "In Progress";
13193
13660
  readonly Paused: "Paused";
13194
13661
  readonly Blocked: "Blocked";
13195
13662
  readonly Ready: "Ready";
@@ -13236,6 +13703,26 @@ export declare const SmsEventTableRow_trafficTypeObject: {
13236
13703
  readonly SystemInternal: "SystemInternal";
13237
13704
  readonly FailedAttempt: "FailedAttempt";
13238
13705
  };
13706
+ /**
13707
+ * Defines the supported SMS readiness health assessments.
13708
+ */
13709
+ export declare const SmsReadinessHealthStatusObject: {
13710
+ readonly NotEvaluated: "Not Evaluated";
13711
+ readonly Evaluating: "Evaluating";
13712
+ readonly Healthy: "Healthy";
13713
+ readonly NeedsAttention: "Needs Attention";
13714
+ readonly Blocked: "Blocked";
13715
+ };
13716
+ /**
13717
+ * Defines the supported SMS readiness states.
13718
+ */
13719
+ export declare const SmsReadinessStateObject: {
13720
+ readonly NotStarted: "Not Started";
13721
+ readonly InProgress: "In Progress";
13722
+ readonly Paused: "Paused";
13723
+ readonly Blocked: "Blocked";
13724
+ readonly Ready: "Ready";
13725
+ };
13239
13726
  /**
13240
13727
  * Defines the supported Outgoing Number Selection Reason values.
13241
13728
  */
@@ -13278,18 +13765,6 @@ export declare const SmsResponse_trafficTypeObject: {
13278
13765
  readonly SystemInternal: "SystemInternal";
13279
13766
  readonly FailedAttempt: "FailedAttempt";
13280
13767
  };
13281
- /**
13282
- * Defines the supported SMS Warmup Health State values.
13283
- */
13284
- export declare const SmsWarmupHealthStateObject: {
13285
- readonly NotStarted: "Not Started";
13286
- readonly Warming: "Warming";
13287
- readonly Healthy: "Healthy";
13288
- readonly NeedsAttention: "Needs Attention";
13289
- readonly Paused: "Paused";
13290
- readonly Blocked: "Blocked";
13291
- readonly Ready: "Ready";
13292
- };
13293
13768
  /**
13294
13769
  * Defines the supported 10DLC Application Status values.
13295
13770
  */