@leadping/sdk 1.0.24 → 1.0.25

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.
@@ -1854,9 +1854,14 @@ export interface BusinessSwitchOption extends AdditionalDataHolder, Parsable {
1854
1854
  * The role value for this business switch option.
1855
1855
  */
1856
1856
  role?: BusinessUserRole | null;
1857
+ /**
1858
+ * Defines the supported 10DLC Application Status values.
1859
+ */
1860
+ tenDlcStatus?: BusinessSwitchOption_tenDlcStatus | null;
1857
1861
  }
1858
1862
  export type BusinessSwitchOption_activationStatus = (typeof BusinessSwitchOption_activationStatusObject)[keyof typeof BusinessSwitchOption_activationStatusObject];
1859
1863
  export type BusinessSwitchOption_businessStatus = (typeof BusinessSwitchOption_businessStatusObject)[keyof typeof BusinessSwitchOption_businessStatusObject];
1864
+ export type BusinessSwitchOption_tenDlcStatus = (typeof BusinessSwitchOption_tenDlcStatusObject)[keyof typeof BusinessSwitchOption_tenDlcStatusObject];
1860
1865
  /**
1861
1866
  * Request schema for the Leadping API business switch request, including the fields clients can send.
1862
1867
  */
@@ -2282,6 +2287,10 @@ export interface ConversationResponse extends AdditionalDataHolder, Parsable {
2282
2287
  * Current disposition summary that describes the lead outcome.
2283
2288
  */
2284
2289
  currentDisposition?: ConversationResponse_currentDisposition | null;
2290
+ /**
2291
+ * Email address used to resolve the lead's avatar when available.
2292
+ */
2293
+ email?: string | null;
2285
2294
  /**
2286
2295
  * First name of the lead, user, or contact represented by this conversation response.
2287
2296
  */
@@ -3320,6 +3329,12 @@ export declare function createPhoneNumberMessagingEventResponseFromDiscriminator
3320
3329
  * @returns {PhoneNumberOptOutMetricsResponse}
3321
3330
  */
3322
3331
  export declare function createPhoneNumberOptOutMetricsResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3332
+ /**
3333
+ * Creates a new instance of the appropriate class based on discriminator value
3334
+ * @param parseNode The parse node to use to read the discriminator value and create the object
3335
+ * @returns {PhoneNumberReadiness}
3336
+ */
3337
+ export declare function createPhoneNumberReadinessFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3323
3338
  /**
3324
3339
  * Creates a new instance of the appropriate class based on discriminator value
3325
3340
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -3410,12 +3425,6 @@ export declare function createPhoneNumberTrafficMetricsResponseFromDiscriminator
3410
3425
  * @returns {PhoneNumberTrafficTrendPoint}
3411
3426
  */
3412
3427
  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
3428
  /**
3420
3429
  * Creates a new instance of the appropriate class based on discriminator value
3421
3430
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -3449,21 +3458,21 @@ export declare function createSmsEventTableRowFromDiscriminatorValue(parseNode:
3449
3458
  /**
3450
3459
  * Creates a new instance of the appropriate class based on discriminator value
3451
3460
  * @param parseNode The parse node to use to read the discriminator value and create the object
3452
- * @returns {SmsResponse}
3461
+ * @returns {SmsReadinessStatusResponse}
3453
3462
  */
3454
- export declare function createSmsResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3463
+ export declare function createSmsReadinessStatusResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3455
3464
  /**
3456
3465
  * Creates a new instance of the appropriate class based on discriminator value
3457
3466
  * @param parseNode The parse node to use to read the discriminator value and create the object
3458
- * @returns {SmsWarmupStatusResponse}
3467
+ * @returns {SmsReadinessUiState}
3459
3468
  */
3460
- export declare function createSmsWarmupStatusResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3469
+ export declare function createSmsReadinessUiStateFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3461
3470
  /**
3462
3471
  * Creates a new instance of the appropriate class based on discriminator value
3463
3472
  * @param parseNode The parse node to use to read the discriminator value and create the object
3464
- * @returns {SmsWarmupUiState}
3473
+ * @returns {SmsResponse}
3465
3474
  */
3466
- export declare function createSmsWarmupUiStateFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3475
+ export declare function createSmsResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3467
3476
  /**
3468
3477
  * Creates a new instance of the appropriate class based on discriminator value
3469
3478
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -5193,6 +5202,12 @@ export declare function deserializeIntoPhoneNumberMessagingEventResponse(phoneNu
5193
5202
  * @returns {Record<string, (node: ParseNode) => void>}
5194
5203
  */
5195
5204
  export declare function deserializeIntoPhoneNumberOptOutMetricsResponse(phoneNumberOptOutMetricsResponse?: Partial<PhoneNumberOptOutMetricsResponse> | undefined): Record<string, (node: ParseNode) => void>;
5205
+ /**
5206
+ * The deserialization information for the current model
5207
+ * @param PhoneNumberReadiness The instance to deserialize into.
5208
+ * @returns {Record<string, (node: ParseNode) => void>}
5209
+ */
5210
+ export declare function deserializeIntoPhoneNumberReadiness(phoneNumberReadiness?: Partial<PhoneNumberReadiness> | undefined): Record<string, (node: ParseNode) => void>;
5196
5211
  /**
5197
5212
  * The deserialization information for the current model
5198
5213
  * @param PhoneNumberRequest The instance to deserialize into.
@@ -5283,12 +5298,6 @@ export declare function deserializeIntoPhoneNumberTrafficMetricsResponse(phoneNu
5283
5298
  * @returns {Record<string, (node: ParseNode) => void>}
5284
5299
  */
5285
5300
  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
5301
  /**
5293
5302
  * The deserialization information for the current model
5294
5303
  * @param ProblemDetails The instance to deserialize into.
@@ -5321,22 +5330,22 @@ export declare function deserializeIntoSendSmsRequest(sendSmsRequest?: Partial<S
5321
5330
  export declare function deserializeIntoSmsEventTableRow(smsEventTableRow?: Partial<SmsEventTableRow> | undefined): Record<string, (node: ParseNode) => void>;
5322
5331
  /**
5323
5332
  * The deserialization information for the current model
5324
- * @param SmsResponse The instance to deserialize into.
5333
+ * @param SmsReadinessStatusResponse The instance to deserialize into.
5325
5334
  * @returns {Record<string, (node: ParseNode) => void>}
5326
5335
  */
5327
- export declare function deserializeIntoSmsResponse(smsResponse?: Partial<SmsResponse> | undefined): Record<string, (node: ParseNode) => void>;
5336
+ export declare function deserializeIntoSmsReadinessStatusResponse(smsReadinessStatusResponse?: Partial<SmsReadinessStatusResponse> | undefined): Record<string, (node: ParseNode) => void>;
5328
5337
  /**
5329
5338
  * The deserialization information for the current model
5330
- * @param SmsWarmupStatusResponse The instance to deserialize into.
5339
+ * @param SmsReadinessUiState The instance to deserialize into.
5331
5340
  * @returns {Record<string, (node: ParseNode) => void>}
5332
5341
  */
5333
- export declare function deserializeIntoSmsWarmupStatusResponse(smsWarmupStatusResponse?: Partial<SmsWarmupStatusResponse> | undefined): Record<string, (node: ParseNode) => void>;
5342
+ export declare function deserializeIntoSmsReadinessUiState(smsReadinessUiState?: Partial<SmsReadinessUiState> | undefined): Record<string, (node: ParseNode) => void>;
5334
5343
  /**
5335
5344
  * The deserialization information for the current model
5336
- * @param SmsWarmupUiState The instance to deserialize into.
5345
+ * @param SmsResponse The instance to deserialize into.
5337
5346
  * @returns {Record<string, (node: ParseNode) => void>}
5338
5347
  */
5339
- export declare function deserializeIntoSmsWarmupUiState(smsWarmupUiState?: Partial<SmsWarmupUiState> | undefined): Record<string, (node: ParseNode) => void>;
5348
+ export declare function deserializeIntoSmsResponse(smsResponse?: Partial<SmsResponse> | undefined): Record<string, (node: ParseNode) => void>;
5340
5349
  /**
5341
5350
  * The deserialization information for the current model
5342
5351
  * @param SourceMetricsResponse The instance to deserialize into.
@@ -6041,7 +6050,7 @@ export interface EligibleOutgoingNumberResponse extends AdditionalDataHolder, Pa
6041
6050
  */
6042
6051
  healthLabel?: string | null;
6043
6052
  /**
6044
- * Defines the supported SMS Warmup Health State values.
6053
+ * Defines the supported SMS readiness health assessments.
6045
6054
  */
6046
6055
  healthStatus?: EligibleOutgoingNumberResponse_healthStatus | null;
6047
6056
  /**
@@ -7474,6 +7483,14 @@ export interface OutboundPhoneNumberCapacity extends AdditionalDataHolder, Parsa
7474
7483
  * Unique identifier of the phone number associated with this Leadping outbound phone number capacity.
7475
7484
  */
7476
7485
  phoneNumberId?: string | null;
7486
+ /**
7487
+ * Next midnight Eastern time, when SMS daily capacity resets.
7488
+ */
7489
+ smsDailyResetsAt?: Date | null;
7490
+ /**
7491
+ * Start of the next Eastern time hour, when SMS hourly capacity resets.
7492
+ */
7493
+ smsHourlyResetsAt?: Date | null;
7477
7494
  /**
7478
7495
  * Number of SMS limit this hour represented by this Leadping outbound phone number capacity.
7479
7496
  */
@@ -7498,6 +7515,14 @@ export interface OutboundPhoneNumberCapacity extends AdditionalDataHolder, Parsa
7498
7515
  * SMS used today for the applicable messaging or voice capacity window.
7499
7516
  */
7500
7517
  smsUsedToday?: number | null;
7518
+ /**
7519
+ * Next midnight Eastern time, when voice daily capacity resets.
7520
+ */
7521
+ voiceDailyResetsAt?: Date | null;
7522
+ /**
7523
+ * Start of the next Eastern time hour, when voice hourly capacity resets.
7524
+ */
7525
+ voiceHourlyResetsAt?: Date | null;
7501
7526
  /**
7502
7527
  * Voice limit this hour associated with this Leadping outbound phone number capacity.
7503
7528
  */
@@ -7634,7 +7659,7 @@ export interface OutgoingNumberSelectionResponse extends AdditionalDataHolder, P
7634
7659
  */
7635
7660
  healthLabel?: string | null;
7636
7661
  /**
7637
- * Defines the supported SMS Warmup Health State values.
7662
+ * Defines the supported SMS readiness health assessments.
7638
7663
  */
7639
7664
  healthStatus?: OutgoingNumberSelectionResponse_healthStatus | null;
7640
7665
  /**
@@ -8184,6 +8209,33 @@ export interface PhoneNumberOptOutMetricsResponse extends AdditionalDataHolder,
8184
8209
  windowStartedAt?: Date | null;
8185
8210
  }
8186
8211
  export type PhoneNumberOutboundHealthStatus = (typeof PhoneNumberOutboundHealthStatusObject)[keyof typeof PhoneNumberOutboundHealthStatusObject];
8212
+ /**
8213
+ * Messaging and calling warmup for a Leadping phone number.
8214
+ */
8215
+ export interface PhoneNumberReadiness extends AdditionalDataHolder, Parsable {
8216
+ /**
8217
+ * Indicates whether phone number warmup is enabled in Leadping.
8218
+ */
8219
+ enabled?: boolean | null;
8220
+ /**
8221
+ * Current warmup health score used to assess phone number warmup.
8222
+ */
8223
+ healthScore?: number | null;
8224
+ /**
8225
+ * Defines the supported SMS readiness health assessments.
8226
+ */
8227
+ healthStatus?: PhoneNumberReadiness_healthStatus | null;
8228
+ /**
8229
+ * Warmup completion percentage, from 0 through 100.
8230
+ */
8231
+ progressPercent?: number | null;
8232
+ /**
8233
+ * Defines the supported SMS readiness states.
8234
+ */
8235
+ state?: PhoneNumberReadiness_state | null;
8236
+ }
8237
+ export type PhoneNumberReadiness_healthStatus = (typeof PhoneNumberReadiness_healthStatusObject)[keyof typeof PhoneNumberReadiness_healthStatusObject];
8238
+ export type PhoneNumberReadiness_state = (typeof PhoneNumberReadiness_stateObject)[keyof typeof PhoneNumberReadiness_stateObject];
8187
8239
  /**
8188
8240
  * Request schema for the Leadping API phone number update request, including the fields clients can send.
8189
8241
  */
@@ -8254,9 +8306,9 @@ export interface PhoneNumberResponse extends AdditionalDataHolder, Parsable {
8254
8306
  */
8255
8307
  routing?: PhoneNumberRoutingMetadata | null;
8256
8308
  /**
8257
- * SMS and voice warmup state for this phone number.
8309
+ * SMS and call warmup for this phone number.
8258
8310
  */
8259
- warmup?: PhoneNumberWarmup | null;
8311
+ warmup?: PhoneNumberReadiness | null;
8260
8312
  }
8261
8313
  /**
8262
8314
  * Business summary connected to this phone number.
@@ -8334,7 +8386,7 @@ export interface PhoneNumberSearchResult extends AdditionalDataHolder, Parsable
8334
8386
  export interface PhoneNumberSearchResult_location extends Parsable, PhoneNumberLocation {
8335
8387
  }
8336
8388
  /**
8337
- * Response schema for the Leadping API phone number readiness status returned to authenticated clients.
8389
+ * Response schema for the Leadping API phone number warmup status returned to authenticated clients.
8338
8390
  */
8339
8391
  export interface PhoneNumberStatusResponse extends AdditionalDataHolder, Parsable {
8340
8392
  /**
@@ -8346,7 +8398,7 @@ export interface PhoneNumberStatusResponse extends AdditionalDataHolder, Parsabl
8346
8398
  */
8347
8399
  messagesPossible?: number | null;
8348
8400
  /**
8349
- * E.164 phone number exposed by this phone number readiness status.
8401
+ * E.164 phone number exposed by this phone number warmup status.
8350
8402
  */
8351
8403
  number?: string | null;
8352
8404
  /**
@@ -8362,7 +8414,7 @@ export interface PhoneNumberStatusResponse extends AdditionalDataHolder, Parsabl
8362
8414
  */
8363
8415
  recentEvents?: PhoneNumberMessagingEventResponse[] | null;
8364
8416
  /**
8365
- * SMS sender warmup status for this phone number.
8417
+ * SMS warmup status for this phone number.
8366
8418
  */
8367
8419
  smsWarmup?: PhoneNumberStatusResponse_smsWarmup | null;
8368
8420
  /**
@@ -8376,9 +8428,9 @@ export interface PhoneNumberStatusResponse extends AdditionalDataHolder, Parsabl
8376
8428
  export interface PhoneNumberStatusResponse_outboundCapacity extends OutboundPhoneNumberCapacity, Parsable {
8377
8429
  }
8378
8430
  /**
8379
- * SMS sender warmup status for this phone number.
8431
+ * SMS warmup status for this phone number.
8380
8432
  */
8381
- export interface PhoneNumberStatusResponse_smsWarmup extends Parsable, SmsWarmupStatusResponse {
8433
+ export interface PhoneNumberStatusResponse_smsWarmup extends Parsable, SmsReadinessStatusResponse {
8382
8434
  }
8383
8435
  /**
8384
8436
  * List item schema for Leadping API phone number table row results shown in searchable tables.
@@ -8401,7 +8453,7 @@ export interface PhoneNumberTableRow extends AdditionalDataHolder, Parsable {
8401
8453
  */
8402
8454
  id?: string | null;
8403
8455
  /**
8404
- * Display name for this phone number table row in the Leadping API.
8456
+ * Optional display label for this phone number table row in the Leadping API.
8405
8457
  */
8406
8458
  name?: string | null;
8407
8459
  /**
@@ -8435,20 +8487,32 @@ export interface PhoneNumberTableRow extends AdditionalDataHolder, Parsable {
8435
8487
  /**
8436
8488
  * Warmup state for this phone number.
8437
8489
  */
8438
- warmup?: PhoneNumberWarmup | null;
8490
+ warmup?: PhoneNumberReadiness | null;
8439
8491
  }
8440
8492
  /**
8441
8493
  * Response schema for the Leadping API phone number traffic metrics response returned to authenticated clients.
8442
8494
  */
8443
8495
  export interface PhoneNumberTrafficMetricsResponse extends AdditionalDataHolder, Parsable {
8496
+ /**
8497
+ * Number of outbound calls that connected during this metrics window.
8498
+ */
8499
+ callConnectedCount?: number | null;
8444
8500
  /**
8445
8501
  * Number of outbound calls that failed during this metrics window.
8446
8502
  */
8447
8503
  callFailedCount?: number | null;
8504
+ /**
8505
+ * Number of outbound calls that failed because the destination number was invalid during this metrics window.
8506
+ */
8507
+ callInvalidNumberCount?: number | null;
8448
8508
  /**
8449
8509
  * Number of outbound calls placed during this metrics window.
8450
8510
  */
8451
8511
  callPlacedCount?: number | null;
8512
+ /**
8513
+ * Number of connected outbound calls shorter than 30 seconds during this metrics window.
8514
+ */
8515
+ callShortCount?: number | null;
8452
8516
  /**
8453
8517
  * Number of SMS messages that failed during this metrics window.
8454
8518
  */
@@ -8503,33 +8567,6 @@ export interface PhoneNumberTrafficTrendPoint extends AdditionalDataHolder, Pars
8503
8567
  */
8504
8568
  startAt?: Date | null;
8505
8569
  }
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
8570
  export interface ProblemDetails extends AdditionalDataHolder, ApiError, Parsable {
8534
8571
  /**
8535
8572
  * Human-readable explanation specific to this occurrence of the problem.
@@ -9761,6 +9798,13 @@ export declare function serializePhoneNumberMessagingEventResponse(writer: Seria
9761
9798
  * @param writer Serialization writer to use to serialize this model
9762
9799
  */
9763
9800
  export declare function serializePhoneNumberOptOutMetricsResponse(writer: SerializationWriter, phoneNumberOptOutMetricsResponse?: Partial<PhoneNumberOptOutMetricsResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
9801
+ /**
9802
+ * Serializes information the current object
9803
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
9804
+ * @param PhoneNumberReadiness The instance to serialize from.
9805
+ * @param writer Serialization writer to use to serialize this model
9806
+ */
9807
+ export declare function serializePhoneNumberReadiness(writer: SerializationWriter, phoneNumberReadiness?: Partial<PhoneNumberReadiness> | undefined | null, isSerializingDerivedType?: boolean): void;
9764
9808
  /**
9765
9809
  * Serializes information the current object
9766
9810
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -9866,13 +9910,6 @@ export declare function serializePhoneNumberTrafficMetricsResponse(writer: Seria
9866
9910
  * @param writer Serialization writer to use to serialize this model
9867
9911
  */
9868
9912
  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
9913
  /**
9877
9914
  * Serializes information the current object
9878
9915
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -9911,24 +9948,24 @@ export declare function serializeSmsEventTableRow(writer: SerializationWriter, s
9911
9948
  /**
9912
9949
  * Serializes information the current object
9913
9950
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
9914
- * @param SmsResponse The instance to serialize from.
9951
+ * @param SmsReadinessStatusResponse The instance to serialize from.
9915
9952
  * @param writer Serialization writer to use to serialize this model
9916
9953
  */
9917
- export declare function serializeSmsResponse(writer: SerializationWriter, smsResponse?: Partial<SmsResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
9954
+ export declare function serializeSmsReadinessStatusResponse(writer: SerializationWriter, smsReadinessStatusResponse?: Partial<SmsReadinessStatusResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
9918
9955
  /**
9919
9956
  * Serializes information the current object
9920
9957
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
9921
- * @param SmsWarmupStatusResponse The instance to serialize from.
9958
+ * @param SmsReadinessUiState The instance to serialize from.
9922
9959
  * @param writer Serialization writer to use to serialize this model
9923
9960
  */
9924
- export declare function serializeSmsWarmupStatusResponse(writer: SerializationWriter, smsWarmupStatusResponse?: Partial<SmsWarmupStatusResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
9961
+ export declare function serializeSmsReadinessUiState(writer: SerializationWriter, smsReadinessUiState?: Partial<SmsReadinessUiState> | undefined | null, isSerializingDerivedType?: boolean): void;
9925
9962
  /**
9926
9963
  * Serializes information the current object
9927
9964
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
9928
- * @param SmsWarmupUiState The instance to serialize from.
9965
+ * @param SmsResponse The instance to serialize from.
9929
9966
  * @param writer Serialization writer to use to serialize this model
9930
9967
  */
9931
- export declare function serializeSmsWarmupUiState(writer: SerializationWriter, smsWarmupUiState?: Partial<SmsWarmupUiState> | undefined | null, isSerializingDerivedType?: boolean): void;
9968
+ export declare function serializeSmsResponse(writer: SerializationWriter, smsResponse?: Partial<SmsResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
9932
9969
  /**
9933
9970
  * Serializes information the current object
9934
9971
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -10499,6 +10536,62 @@ export interface SmsEventTableRow extends AdditionalDataHolder, Parsable {
10499
10536
  export type SmsEventTableRow_outboundSource = (typeof SmsEventTableRow_outboundSourceObject)[keyof typeof SmsEventTableRow_outboundSourceObject];
10500
10537
  export type SmsEventTableRow_status = (typeof SmsEventTableRow_statusObject)[keyof typeof SmsEventTableRow_statusObject];
10501
10538
  export type SmsEventTableRow_trafficType = (typeof SmsEventTableRow_trafficTypeObject)[keyof typeof SmsEventTableRow_trafficTypeObject];
10539
+ export type SmsReadinessHealthStatus = (typeof SmsReadinessHealthStatusObject)[keyof typeof SmsReadinessHealthStatusObject];
10540
+ export type SmsReadinessState = (typeof SmsReadinessStateObject)[keyof typeof SmsReadinessStateObject];
10541
+ /**
10542
+ * API response containing SMS warmup status data returned to callers.
10543
+ */
10544
+ export interface SmsReadinessStatusResponse extends AdditionalDataHolder, Parsable {
10545
+ /**
10546
+ * The health score metric for this SMS warmup status.
10547
+ */
10548
+ healthScore?: number | null;
10549
+ /**
10550
+ * The current delivery-health assessment for this SMS warmup status.
10551
+ */
10552
+ healthStatus?: SmsReadinessHealthStatus | null;
10553
+ /**
10554
+ * The phone number associated with this SMS warmup status.
10555
+ */
10556
+ phoneNumber?: string | null;
10557
+ /**
10558
+ * The phone number ID associated with this SMS warmup status.
10559
+ */
10560
+ phoneNumberId?: string | null;
10561
+ /**
10562
+ * The progress percent metric for this SMS warmup status.
10563
+ */
10564
+ progressPercent?: number | null;
10565
+ /**
10566
+ * The current state for this SMS warmup status.
10567
+ */
10568
+ status?: SmsReadinessState | null;
10569
+ /**
10570
+ * The current UI state for this SMS warmup status.
10571
+ */
10572
+ uiState?: SmsReadinessUiState | null;
10573
+ /**
10574
+ * Whether warmup is enabled for this SMS warmup status.
10575
+ */
10576
+ warmupEnabled?: boolean | null;
10577
+ }
10578
+ /**
10579
+ * API DTO containing SMS readiness UI state data used by Leadping API contracts.
10580
+ */
10581
+ export interface SmsReadinessUiState extends AdditionalDataHolder, Parsable {
10582
+ /**
10583
+ * The human-readable description of this SMS readiness UI state.
10584
+ */
10585
+ description?: string | null;
10586
+ /**
10587
+ * The human-readable label shown for this SMS readiness UI state.
10588
+ */
10589
+ label?: SmsReadinessState | null;
10590
+ /**
10591
+ * The tone value for this SMS readiness UI state.
10592
+ */
10593
+ tone?: string | null;
10594
+ }
10502
10595
  /**
10503
10596
  * Response schema for the Leadping API SMS message returned to authenticated clients.
10504
10597
  */
@@ -10647,57 +10740,6 @@ export interface SmsResponse extends AdditionalDataHolder, Parsable {
10647
10740
  export type SmsResponse_selectionReason = (typeof SmsResponse_selectionReasonObject)[keyof typeof SmsResponse_selectionReasonObject];
10648
10741
  export type SmsResponse_status = (typeof SmsResponse_statusObject)[keyof typeof SmsResponse_statusObject];
10649
10742
  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
10743
  /**
10702
10744
  * Response model containing source metrics data returned by the Leadping API.
10703
10745
  */
@@ -12532,6 +12574,22 @@ export declare const BusinessSwitchOption_businessStatusObject: {
12532
12574
  readonly SetupCompleted: "SetupCompleted";
12533
12575
  readonly Active: "Active";
12534
12576
  };
12577
+ /**
12578
+ * Defines the supported 10DLC Application Status values.
12579
+ */
12580
+ export declare const BusinessSwitchOption_tenDlcStatusObject: {
12581
+ readonly NotStarted: "NotStarted";
12582
+ readonly DraftGenerated: "DraftGenerated";
12583
+ readonly DraftNeedsAdminReview: "DraftNeedsAdminReview";
12584
+ readonly ReadyToSubmit: "ReadyToSubmit";
12585
+ readonly Submitted: "Submitted";
12586
+ readonly PendingTelnyxReview: "PendingTelnyxReview";
12587
+ readonly Approved: "Approved";
12588
+ readonly Rejected: "Rejected";
12589
+ readonly NeedsChanges: "NeedsChanges";
12590
+ readonly ResubmissionReady: "ResubmissionReady";
12591
+ readonly Failed: "Failed";
12592
+ };
12535
12593
  /**
12536
12594
  * Defines the supported Customer Activation Status values.
12537
12595
  */
@@ -12793,16 +12851,14 @@ export declare const DispositionResponse_changeSourceObject: {
12793
12851
  readonly API: "API";
12794
12852
  };
12795
12853
  /**
12796
- * Defines the supported SMS Warmup Health State values.
12854
+ * Defines the supported SMS readiness health assessments.
12797
12855
  */
12798
12856
  export declare const EligibleOutgoingNumberResponse_healthStatusObject: {
12799
- readonly NotStarted: "Not Started";
12800
- readonly Warming: "Warming";
12857
+ readonly NotEvaluated: "Not Evaluated";
12858
+ readonly Evaluating: "Evaluating";
12801
12859
  readonly Healthy: "Healthy";
12802
12860
  readonly NeedsAttention: "Needs Attention";
12803
- readonly Paused: "Paused";
12804
12861
  readonly Blocked: "Blocked";
12805
- readonly Ready: "Ready";
12806
12862
  };
12807
12863
  /**
12808
12864
  * Defines the supported Event status values.
@@ -13095,16 +13151,14 @@ export declare const OutgoingNumberSelectionRequest_channelObject: {
13095
13151
  readonly Call: "call";
13096
13152
  };
13097
13153
  /**
13098
- * Defines the supported SMS Warmup Health State values.
13154
+ * Defines the supported SMS readiness health assessments.
13099
13155
  */
13100
13156
  export declare const OutgoingNumberSelectionResponse_healthStatusObject: {
13101
- readonly NotStarted: "Not Started";
13102
- readonly Warming: "Warming";
13157
+ readonly NotEvaluated: "Not Evaluated";
13158
+ readonly Evaluating: "Evaluating";
13103
13159
  readonly Healthy: "Healthy";
13104
13160
  readonly NeedsAttention: "Needs Attention";
13105
- readonly Paused: "Paused";
13106
13161
  readonly Blocked: "Blocked";
13107
- readonly Ready: "Ready";
13108
13162
  };
13109
13163
  /**
13110
13164
  * Defines the supported Outgoing Number Selection Reason values.
@@ -13171,25 +13225,21 @@ export declare const PhoneNumberOutboundHealthStatusObject: {
13171
13225
  readonly Disabled: "disabled";
13172
13226
  };
13173
13227
  /**
13174
- * Defines the supported SMS Warmup Health State values.
13228
+ * Defines the supported SMS readiness health assessments.
13175
13229
  */
13176
- export declare const PhoneNumberWarmup_healthStatusObject: {
13177
- readonly NotStarted: "Not Started";
13178
- readonly Warming: "Warming";
13230
+ export declare const PhoneNumberReadiness_healthStatusObject: {
13231
+ readonly NotEvaluated: "Not Evaluated";
13232
+ readonly Evaluating: "Evaluating";
13179
13233
  readonly Healthy: "Healthy";
13180
13234
  readonly NeedsAttention: "Needs Attention";
13181
- readonly Paused: "Paused";
13182
13235
  readonly Blocked: "Blocked";
13183
- readonly Ready: "Ready";
13184
13236
  };
13185
13237
  /**
13186
- * Defines the supported SMS Warmup Health State values.
13238
+ * Defines the supported SMS readiness states.
13187
13239
  */
13188
- export declare const PhoneNumberWarmup_stateObject: {
13240
+ export declare const PhoneNumberReadiness_stateObject: {
13189
13241
  readonly NotStarted: "Not Started";
13190
- readonly Warming: "Warming";
13191
- readonly Healthy: "Healthy";
13192
- readonly NeedsAttention: "Needs Attention";
13242
+ readonly InProgress: "In Progress";
13193
13243
  readonly Paused: "Paused";
13194
13244
  readonly Blocked: "Blocked";
13195
13245
  readonly Ready: "Ready";
@@ -13236,6 +13286,26 @@ export declare const SmsEventTableRow_trafficTypeObject: {
13236
13286
  readonly SystemInternal: "SystemInternal";
13237
13287
  readonly FailedAttempt: "FailedAttempt";
13238
13288
  };
13289
+ /**
13290
+ * Defines the supported SMS readiness health assessments.
13291
+ */
13292
+ export declare const SmsReadinessHealthStatusObject: {
13293
+ readonly NotEvaluated: "Not Evaluated";
13294
+ readonly Evaluating: "Evaluating";
13295
+ readonly Healthy: "Healthy";
13296
+ readonly NeedsAttention: "Needs Attention";
13297
+ readonly Blocked: "Blocked";
13298
+ };
13299
+ /**
13300
+ * Defines the supported SMS readiness states.
13301
+ */
13302
+ export declare const SmsReadinessStateObject: {
13303
+ readonly NotStarted: "Not Started";
13304
+ readonly InProgress: "In Progress";
13305
+ readonly Paused: "Paused";
13306
+ readonly Blocked: "Blocked";
13307
+ readonly Ready: "Ready";
13308
+ };
13239
13309
  /**
13240
13310
  * Defines the supported Outgoing Number Selection Reason values.
13241
13311
  */
@@ -13278,18 +13348,6 @@ export declare const SmsResponse_trafficTypeObject: {
13278
13348
  readonly SystemInternal: "SystemInternal";
13279
13349
  readonly FailedAttempt: "FailedAttempt";
13280
13350
  };
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
13351
  /**
13294
13352
  * Defines the supported 10DLC Application Status values.
13295
13353
  */