@leadping/sdk 1.0.23 → 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.
- package/dist/businesses/me/index.d.ts +7 -2
- package/dist/businesses/me/index.d.ts.map +1 -1
- package/dist/businesses/me/index.js +5 -0
- package/dist/businesses/me/index.js.map +1 -1
- package/dist/businesses/me/oneZerodlc/index.d.ts +20 -0
- package/dist/businesses/me/oneZerodlc/index.d.ts.map +1 -0
- package/dist/businesses/me/oneZerodlc/index.js +20 -0
- package/dist/businesses/me/oneZerodlc/index.js.map +1 -0
- package/dist/businesses/me/oneZerodlc/notes/index.d.ts +32 -0
- package/dist/businesses/me/oneZerodlc/notes/index.d.ts.map +1 -0
- package/dist/businesses/me/oneZerodlc/notes/index.js +30 -0
- package/dist/businesses/me/oneZerodlc/notes/index.js.map +1 -0
- package/dist/leadStatuses/index.d.ts +4 -4
- package/dist/leadStatuses/item/index.d.ts +4 -4
- package/dist/models/index.d.ts +377 -162
- package/dist/models/index.d.ts.map +1 -1
- package/dist/models/index.js +334 -158
- package/dist/models/index.js.map +1 -1
- package/dist/notifications/index.d.ts +1 -1
- package/dist/notifications/index.d.ts.map +1 -1
- package/dist/notifications/index.js +2 -1
- package/dist/notifications/index.js.map +1 -1
- package/dist/notifications/item/index.d.ts +20 -1
- package/dist/notifications/item/index.d.ts.map +1 -1
- package/dist/notifications/item/index.js +17 -0
- package/dist/notifications/item/index.js.map +1 -1
- package/dist/notifications/me/index.d.ts +16 -3
- package/dist/notifications/me/index.d.ts.map +1 -1
- package/dist/notifications/me/index.js +1 -1
- package/dist/notifications/me/index.js.map +1 -1
- package/dist/paymentMethods/index.d.ts +2 -2
- package/dist/paymentMethods/index.d.ts.map +1 -1
- package/dist/paymentMethods/index.js +2 -1
- package/dist/paymentMethods/index.js.map +1 -1
- package/dist/paymentMethods/invoices/index.d.ts +14 -3
- package/dist/paymentMethods/invoices/index.d.ts.map +1 -1
- package/dist/paymentMethods/invoices/index.js +11 -0
- package/dist/paymentMethods/invoices/index.js.map +1 -1
- package/dist/paymentMethods/invoices/item/index.d.ts +20 -0
- package/dist/paymentMethods/invoices/item/index.d.ts.map +1 -0
- package/dist/paymentMethods/invoices/item/index.js +20 -0
- package/dist/paymentMethods/invoices/item/index.js.map +1 -0
- package/dist/paymentMethods/invoices/item/pdfAccess/index.d.ts +35 -0
- package/dist/paymentMethods/invoices/item/pdfAccess/index.d.ts.map +1 -0
- package/dist/paymentMethods/invoices/item/pdfAccess/index.js +26 -0
- package/dist/paymentMethods/invoices/item/pdfAccess/index.js.map +1 -0
- package/dist/paymentMethods/item/defaultEscaped/index.d.ts +2 -2
- package/dist/phoneNumbers/item/index.d.ts +2 -2
- package/dist/phoneNumbers/item/status/index.d.ts +3 -3
- package/dist/phoneNumbers/item/warmup/index.d.ts +3 -3
- package/package.json +1 -1
package/dist/models/index.d.ts
CHANGED
|
@@ -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
|
*/
|
|
@@ -2999,6 +3008,12 @@ export declare function createIdNameValueFromDiscriminatorValue(parseNode: Parse
|
|
|
2999
3008
|
* @returns {InitiateCallRequest}
|
|
3000
3009
|
*/
|
|
3001
3010
|
export declare function createInitiateCallRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
3011
|
+
/**
|
|
3012
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
3013
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
3014
|
+
* @returns {InvoicePdfAccessResponse}
|
|
3015
|
+
*/
|
|
3016
|
+
export declare function createInvoicePdfAccessResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
3002
3017
|
/**
|
|
3003
3018
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
3004
3019
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
@@ -3134,6 +3149,12 @@ export interface CreateNoteRequest extends AdditionalDataHolder, Parsable {
|
|
|
3134
3149
|
*/
|
|
3135
3150
|
text?: string | null;
|
|
3136
3151
|
}
|
|
3152
|
+
/**
|
|
3153
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
3154
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
3155
|
+
* @returns {NotificationResponse}
|
|
3156
|
+
*/
|
|
3157
|
+
export declare function createNotificationResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
3137
3158
|
/**
|
|
3138
3159
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
3139
3160
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
@@ -3308,6 +3329,12 @@ export declare function createPhoneNumberMessagingEventResponseFromDiscriminator
|
|
|
3308
3329
|
* @returns {PhoneNumberOptOutMetricsResponse}
|
|
3309
3330
|
*/
|
|
3310
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>);
|
|
3311
3338
|
/**
|
|
3312
3339
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
3313
3340
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
@@ -3398,12 +3425,6 @@ export declare function createPhoneNumberTrafficMetricsResponseFromDiscriminator
|
|
|
3398
3425
|
* @returns {PhoneNumberTrafficTrendPoint}
|
|
3399
3426
|
*/
|
|
3400
3427
|
export declare function createPhoneNumberTrafficTrendPointFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
3401
|
-
/**
|
|
3402
|
-
* Creates a new instance of the appropriate class based on discriminator value
|
|
3403
|
-
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
3404
|
-
* @returns {PhoneNumberWarmup}
|
|
3405
|
-
*/
|
|
3406
|
-
export declare function createPhoneNumberWarmupFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
3407
3428
|
/**
|
|
3408
3429
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
3409
3430
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
@@ -3437,21 +3458,21 @@ export declare function createSmsEventTableRowFromDiscriminatorValue(parseNode:
|
|
|
3437
3458
|
/**
|
|
3438
3459
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
3439
3460
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
3440
|
-
* @returns {
|
|
3461
|
+
* @returns {SmsReadinessStatusResponse}
|
|
3441
3462
|
*/
|
|
3442
|
-
export declare function
|
|
3463
|
+
export declare function createSmsReadinessStatusResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
3443
3464
|
/**
|
|
3444
3465
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
3445
3466
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
3446
|
-
* @returns {
|
|
3467
|
+
* @returns {SmsReadinessUiState}
|
|
3447
3468
|
*/
|
|
3448
|
-
export declare function
|
|
3469
|
+
export declare function createSmsReadinessUiStateFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
3449
3470
|
/**
|
|
3450
3471
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
3451
3472
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
3452
|
-
* @returns {
|
|
3473
|
+
* @returns {SmsResponse}
|
|
3453
3474
|
*/
|
|
3454
|
-
export declare function
|
|
3475
|
+
export declare function createSmsResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
3455
3476
|
/**
|
|
3456
3477
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
3457
3478
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
@@ -3614,6 +3635,12 @@ export declare function createTelephonyLoginResponseFromDiscriminatorValue(parse
|
|
|
3614
3635
|
* @returns {TenDlcApplicationDraft}
|
|
3615
3636
|
*/
|
|
3616
3637
|
export declare function createTenDlcApplicationDraftFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
3638
|
+
/**
|
|
3639
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
3640
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
3641
|
+
* @returns {TenDlcNotesRequest}
|
|
3642
|
+
*/
|
|
3643
|
+
export declare function createTenDlcNotesRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
3617
3644
|
/**
|
|
3618
3645
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
3619
3646
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
@@ -4863,6 +4890,12 @@ export declare function deserializeIntoIdNameValue(idNameValue?: Partial<IdNameV
|
|
|
4863
4890
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
4864
4891
|
*/
|
|
4865
4892
|
export declare function deserializeIntoInitiateCallRequest(initiateCallRequest?: Partial<InitiateCallRequest> | undefined): Record<string, (node: ParseNode) => void>;
|
|
4893
|
+
/**
|
|
4894
|
+
* The deserialization information for the current model
|
|
4895
|
+
* @param InvoicePdfAccessResponse The instance to deserialize into.
|
|
4896
|
+
* @returns {Record<string, (node: ParseNode) => void>}
|
|
4897
|
+
*/
|
|
4898
|
+
export declare function deserializeIntoInvoicePdfAccessResponse(invoicePdfAccessResponse?: Partial<InvoicePdfAccessResponse> | undefined): Record<string, (node: ParseNode) => void>;
|
|
4866
4899
|
/**
|
|
4867
4900
|
* The deserialization information for the current model
|
|
4868
4901
|
* @param LeadArchiveRequest The instance to deserialize into.
|
|
@@ -4989,6 +5022,12 @@ export declare function deserializeIntoLeadTagsRequest(leadTagsRequest?: Partial
|
|
|
4989
5022
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
4990
5023
|
*/
|
|
4991
5024
|
export declare function deserializeIntoMobileDevicePreferences(mobileDevicePreferences?: Partial<MobileDevicePreferences> | undefined): Record<string, (node: ParseNode) => void>;
|
|
5025
|
+
/**
|
|
5026
|
+
* The deserialization information for the current model
|
|
5027
|
+
* @param NotificationResponse The instance to deserialize into.
|
|
5028
|
+
* @returns {Record<string, (node: ParseNode) => void>}
|
|
5029
|
+
*/
|
|
5030
|
+
export declare function deserializeIntoNotificationResponse(notificationResponse?: Partial<NotificationResponse> | undefined): Record<string, (node: ParseNode) => void>;
|
|
4992
5031
|
/**
|
|
4993
5032
|
* The deserialization information for the current model
|
|
4994
5033
|
* @param NotificationTableRow The instance to deserialize into.
|
|
@@ -5163,6 +5202,12 @@ export declare function deserializeIntoPhoneNumberMessagingEventResponse(phoneNu
|
|
|
5163
5202
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
5164
5203
|
*/
|
|
5165
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>;
|
|
5166
5211
|
/**
|
|
5167
5212
|
* The deserialization information for the current model
|
|
5168
5213
|
* @param PhoneNumberRequest The instance to deserialize into.
|
|
@@ -5253,12 +5298,6 @@ export declare function deserializeIntoPhoneNumberTrafficMetricsResponse(phoneNu
|
|
|
5253
5298
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
5254
5299
|
*/
|
|
5255
5300
|
export declare function deserializeIntoPhoneNumberTrafficTrendPoint(phoneNumberTrafficTrendPoint?: Partial<PhoneNumberTrafficTrendPoint> | undefined): Record<string, (node: ParseNode) => void>;
|
|
5256
|
-
/**
|
|
5257
|
-
* The deserialization information for the current model
|
|
5258
|
-
* @param PhoneNumberWarmup The instance to deserialize into.
|
|
5259
|
-
* @returns {Record<string, (node: ParseNode) => void>}
|
|
5260
|
-
*/
|
|
5261
|
-
export declare function deserializeIntoPhoneNumberWarmup(phoneNumberWarmup?: Partial<PhoneNumberWarmup> | undefined): Record<string, (node: ParseNode) => void>;
|
|
5262
5301
|
/**
|
|
5263
5302
|
* The deserialization information for the current model
|
|
5264
5303
|
* @param ProblemDetails The instance to deserialize into.
|
|
@@ -5291,22 +5330,22 @@ export declare function deserializeIntoSendSmsRequest(sendSmsRequest?: Partial<S
|
|
|
5291
5330
|
export declare function deserializeIntoSmsEventTableRow(smsEventTableRow?: Partial<SmsEventTableRow> | undefined): Record<string, (node: ParseNode) => void>;
|
|
5292
5331
|
/**
|
|
5293
5332
|
* The deserialization information for the current model
|
|
5294
|
-
* @param
|
|
5333
|
+
* @param SmsReadinessStatusResponse The instance to deserialize into.
|
|
5295
5334
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
5296
5335
|
*/
|
|
5297
|
-
export declare function
|
|
5336
|
+
export declare function deserializeIntoSmsReadinessStatusResponse(smsReadinessStatusResponse?: Partial<SmsReadinessStatusResponse> | undefined): Record<string, (node: ParseNode) => void>;
|
|
5298
5337
|
/**
|
|
5299
5338
|
* The deserialization information for the current model
|
|
5300
|
-
* @param
|
|
5339
|
+
* @param SmsReadinessUiState The instance to deserialize into.
|
|
5301
5340
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
5302
5341
|
*/
|
|
5303
|
-
export declare function
|
|
5342
|
+
export declare function deserializeIntoSmsReadinessUiState(smsReadinessUiState?: Partial<SmsReadinessUiState> | undefined): Record<string, (node: ParseNode) => void>;
|
|
5304
5343
|
/**
|
|
5305
5344
|
* The deserialization information for the current model
|
|
5306
|
-
* @param
|
|
5345
|
+
* @param SmsResponse The instance to deserialize into.
|
|
5307
5346
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
5308
5347
|
*/
|
|
5309
|
-
export declare function
|
|
5348
|
+
export declare function deserializeIntoSmsResponse(smsResponse?: Partial<SmsResponse> | undefined): Record<string, (node: ParseNode) => void>;
|
|
5310
5349
|
/**
|
|
5311
5350
|
* The deserialization information for the current model
|
|
5312
5351
|
* @param SourceMetricsResponse The instance to deserialize into.
|
|
@@ -5469,6 +5508,12 @@ export declare function deserializeIntoTelephonyLoginResponse(telephonyLoginResp
|
|
|
5469
5508
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
5470
5509
|
*/
|
|
5471
5510
|
export declare function deserializeIntoTenDlcApplicationDraft(tenDlcApplicationDraft?: Partial<TenDlcApplicationDraft> | undefined): Record<string, (node: ParseNode) => void>;
|
|
5511
|
+
/**
|
|
5512
|
+
* The deserialization information for the current model
|
|
5513
|
+
* @param TenDlcNotesRequest The instance to deserialize into.
|
|
5514
|
+
* @returns {Record<string, (node: ParseNode) => void>}
|
|
5515
|
+
*/
|
|
5516
|
+
export declare function deserializeIntoTenDlcNotesRequest(tenDlcNotesRequest?: Partial<TenDlcNotesRequest> | undefined): Record<string, (node: ParseNode) => void>;
|
|
5472
5517
|
/**
|
|
5473
5518
|
* The deserialization information for the current model
|
|
5474
5519
|
* @param TransactionResponse The instance to deserialize into.
|
|
@@ -6005,7 +6050,7 @@ export interface EligibleOutgoingNumberResponse extends AdditionalDataHolder, Pa
|
|
|
6005
6050
|
*/
|
|
6006
6051
|
healthLabel?: string | null;
|
|
6007
6052
|
/**
|
|
6008
|
-
* Defines the supported SMS
|
|
6053
|
+
* Defines the supported SMS readiness health assessments.
|
|
6009
6054
|
*/
|
|
6010
6055
|
healthStatus?: EligibleOutgoingNumberResponse_healthStatus | null;
|
|
6011
6056
|
/**
|
|
@@ -6528,6 +6573,19 @@ export interface InitiateCallRequest extends AdditionalDataHolder, Parsable {
|
|
|
6528
6573
|
*/
|
|
6529
6574
|
wasManuallyOverridden?: boolean | null;
|
|
6530
6575
|
}
|
|
6576
|
+
/**
|
|
6577
|
+
* Short-lived access details for a private Leadping invoice PDF.
|
|
6578
|
+
*/
|
|
6579
|
+
export interface InvoicePdfAccessResponse extends AdditionalDataHolder, Parsable {
|
|
6580
|
+
/**
|
|
6581
|
+
* The expiresAt property
|
|
6582
|
+
*/
|
|
6583
|
+
expiresAt?: Date | null;
|
|
6584
|
+
/**
|
|
6585
|
+
* The url property
|
|
6586
|
+
*/
|
|
6587
|
+
url?: string | null;
|
|
6588
|
+
}
|
|
6531
6589
|
/**
|
|
6532
6590
|
* Request schema for the Leadping API lead archive request, including the fields clients can send.
|
|
6533
6591
|
*/
|
|
@@ -7220,6 +7278,71 @@ export interface MobileDevicePreferences extends AdditionalDataHolder, Parsable
|
|
|
7220
7278
|
updatedAt?: Date | null;
|
|
7221
7279
|
}
|
|
7222
7280
|
export type NotificationPriority = (typeof NotificationPriorityObject)[keyof typeof NotificationPriorityObject];
|
|
7281
|
+
/**
|
|
7282
|
+
* API DTO containing notification data used by Leadping API contracts.
|
|
7283
|
+
*/
|
|
7284
|
+
export interface NotificationResponse extends AdditionalDataHolder, Parsable {
|
|
7285
|
+
/**
|
|
7286
|
+
* The action button text value for this notification.
|
|
7287
|
+
*/
|
|
7288
|
+
actionButtonText?: string | null;
|
|
7289
|
+
/**
|
|
7290
|
+
* The URL associated with this notification.
|
|
7291
|
+
*/
|
|
7292
|
+
actionUrl?: string | null;
|
|
7293
|
+
/**
|
|
7294
|
+
* The date and time when the entity was created.
|
|
7295
|
+
*/
|
|
7296
|
+
createdAt?: Date | null;
|
|
7297
|
+
/**
|
|
7298
|
+
* The details value for this notification.
|
|
7299
|
+
*/
|
|
7300
|
+
details?: string | null;
|
|
7301
|
+
/**
|
|
7302
|
+
* The unique identifier for the entity.
|
|
7303
|
+
*/
|
|
7304
|
+
id?: string | null;
|
|
7305
|
+
/**
|
|
7306
|
+
* Whether this notification is read.
|
|
7307
|
+
*/
|
|
7308
|
+
isRead?: boolean | null;
|
|
7309
|
+
/**
|
|
7310
|
+
* The message value for this notification.
|
|
7311
|
+
*/
|
|
7312
|
+
message?: string | null;
|
|
7313
|
+
/**
|
|
7314
|
+
* The date and time when the entity was last modified, if applicable.
|
|
7315
|
+
*/
|
|
7316
|
+
modifiedAt?: Date | null;
|
|
7317
|
+
/**
|
|
7318
|
+
* The display name for the entity.
|
|
7319
|
+
*/
|
|
7320
|
+
name?: string | null;
|
|
7321
|
+
/**
|
|
7322
|
+
* The priority value for this notification.
|
|
7323
|
+
*/
|
|
7324
|
+
priority?: NotificationPriority | null;
|
|
7325
|
+
/**
|
|
7326
|
+
* The date and time for the read at value on this notification.
|
|
7327
|
+
*/
|
|
7328
|
+
readAt?: Date | null;
|
|
7329
|
+
/**
|
|
7330
|
+
* The related entity ID associated with this notification.
|
|
7331
|
+
*/
|
|
7332
|
+
relatedEntityId?: string | null;
|
|
7333
|
+
/**
|
|
7334
|
+
* The related entity type classification for this notification.
|
|
7335
|
+
*/
|
|
7336
|
+
relatedEntityType?: string | null;
|
|
7337
|
+
/**
|
|
7338
|
+
* The type classification for this notification.
|
|
7339
|
+
*/
|
|
7340
|
+
type?: NotificationType | null;
|
|
7341
|
+
/**
|
|
7342
|
+
* The user ID associated with this notification.
|
|
7343
|
+
*/
|
|
7344
|
+
userId?: string | null;
|
|
7345
|
+
}
|
|
7223
7346
|
/**
|
|
7224
7347
|
* API response containing notification data returned to callers.
|
|
7225
7348
|
*/
|
|
@@ -7344,6 +7467,10 @@ export type OutboundDeliveryStatus = (typeof OutboundDeliveryStatusObject)[keyof
|
|
|
7344
7467
|
* Represents outbound phone number capacity data used by Leadping.
|
|
7345
7468
|
*/
|
|
7346
7469
|
export interface OutboundPhoneNumberCapacity extends AdditionalDataHolder, Parsable {
|
|
7470
|
+
/**
|
|
7471
|
+
* Indicates whether Leadping successfully calculated capacity for this phone number.
|
|
7472
|
+
*/
|
|
7473
|
+
capacityAvailable?: boolean | null;
|
|
7347
7474
|
/**
|
|
7348
7475
|
* Current health status for this Leadping outbound phone number capacity.
|
|
7349
7476
|
*/
|
|
@@ -7356,6 +7483,14 @@ export interface OutboundPhoneNumberCapacity extends AdditionalDataHolder, Parsa
|
|
|
7356
7483
|
* Unique identifier of the phone number associated with this Leadping outbound phone number capacity.
|
|
7357
7484
|
*/
|
|
7358
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;
|
|
7359
7494
|
/**
|
|
7360
7495
|
* Number of SMS limit this hour represented by this Leadping outbound phone number capacity.
|
|
7361
7496
|
*/
|
|
@@ -7380,6 +7515,14 @@ export interface OutboundPhoneNumberCapacity extends AdditionalDataHolder, Parsa
|
|
|
7380
7515
|
* SMS used today for the applicable messaging or voice capacity window.
|
|
7381
7516
|
*/
|
|
7382
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;
|
|
7383
7526
|
/**
|
|
7384
7527
|
* Voice limit this hour associated with this Leadping outbound phone number capacity.
|
|
7385
7528
|
*/
|
|
@@ -7516,7 +7659,7 @@ export interface OutgoingNumberSelectionResponse extends AdditionalDataHolder, P
|
|
|
7516
7659
|
*/
|
|
7517
7660
|
healthLabel?: string | null;
|
|
7518
7661
|
/**
|
|
7519
|
-
* Defines the supported SMS
|
|
7662
|
+
* Defines the supported SMS readiness health assessments.
|
|
7520
7663
|
*/
|
|
7521
7664
|
healthStatus?: OutgoingNumberSelectionResponse_healthStatus | null;
|
|
7522
7665
|
/**
|
|
@@ -8066,6 +8209,33 @@ export interface PhoneNumberOptOutMetricsResponse extends AdditionalDataHolder,
|
|
|
8066
8209
|
windowStartedAt?: Date | null;
|
|
8067
8210
|
}
|
|
8068
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];
|
|
8069
8239
|
/**
|
|
8070
8240
|
* Request schema for the Leadping API phone number update request, including the fields clients can send.
|
|
8071
8241
|
*/
|
|
@@ -8136,9 +8306,9 @@ export interface PhoneNumberResponse extends AdditionalDataHolder, Parsable {
|
|
|
8136
8306
|
*/
|
|
8137
8307
|
routing?: PhoneNumberRoutingMetadata | null;
|
|
8138
8308
|
/**
|
|
8139
|
-
* SMS and
|
|
8309
|
+
* SMS and call warmup for this phone number.
|
|
8140
8310
|
*/
|
|
8141
|
-
warmup?:
|
|
8311
|
+
warmup?: PhoneNumberReadiness | null;
|
|
8142
8312
|
}
|
|
8143
8313
|
/**
|
|
8144
8314
|
* Business summary connected to this phone number.
|
|
@@ -8216,7 +8386,7 @@ export interface PhoneNumberSearchResult extends AdditionalDataHolder, Parsable
|
|
|
8216
8386
|
export interface PhoneNumberSearchResult_location extends Parsable, PhoneNumberLocation {
|
|
8217
8387
|
}
|
|
8218
8388
|
/**
|
|
8219
|
-
* Response schema for the Leadping API phone number
|
|
8389
|
+
* Response schema for the Leadping API phone number warmup status returned to authenticated clients.
|
|
8220
8390
|
*/
|
|
8221
8391
|
export interface PhoneNumberStatusResponse extends AdditionalDataHolder, Parsable {
|
|
8222
8392
|
/**
|
|
@@ -8228,7 +8398,7 @@ export interface PhoneNumberStatusResponse extends AdditionalDataHolder, Parsabl
|
|
|
8228
8398
|
*/
|
|
8229
8399
|
messagesPossible?: number | null;
|
|
8230
8400
|
/**
|
|
8231
|
-
* E.164 phone number exposed by this phone number
|
|
8401
|
+
* E.164 phone number exposed by this phone number warmup status.
|
|
8232
8402
|
*/
|
|
8233
8403
|
number?: string | null;
|
|
8234
8404
|
/**
|
|
@@ -8244,7 +8414,7 @@ export interface PhoneNumberStatusResponse extends AdditionalDataHolder, Parsabl
|
|
|
8244
8414
|
*/
|
|
8245
8415
|
recentEvents?: PhoneNumberMessagingEventResponse[] | null;
|
|
8246
8416
|
/**
|
|
8247
|
-
* SMS
|
|
8417
|
+
* SMS warmup status for this phone number.
|
|
8248
8418
|
*/
|
|
8249
8419
|
smsWarmup?: PhoneNumberStatusResponse_smsWarmup | null;
|
|
8250
8420
|
/**
|
|
@@ -8258,9 +8428,9 @@ export interface PhoneNumberStatusResponse extends AdditionalDataHolder, Parsabl
|
|
|
8258
8428
|
export interface PhoneNumberStatusResponse_outboundCapacity extends OutboundPhoneNumberCapacity, Parsable {
|
|
8259
8429
|
}
|
|
8260
8430
|
/**
|
|
8261
|
-
* SMS
|
|
8431
|
+
* SMS warmup status for this phone number.
|
|
8262
8432
|
*/
|
|
8263
|
-
export interface PhoneNumberStatusResponse_smsWarmup extends Parsable,
|
|
8433
|
+
export interface PhoneNumberStatusResponse_smsWarmup extends Parsable, SmsReadinessStatusResponse {
|
|
8264
8434
|
}
|
|
8265
8435
|
/**
|
|
8266
8436
|
* List item schema for Leadping API phone number table row results shown in searchable tables.
|
|
@@ -8283,7 +8453,7 @@ export interface PhoneNumberTableRow extends AdditionalDataHolder, Parsable {
|
|
|
8283
8453
|
*/
|
|
8284
8454
|
id?: string | null;
|
|
8285
8455
|
/**
|
|
8286
|
-
*
|
|
8456
|
+
* Optional display label for this phone number table row in the Leadping API.
|
|
8287
8457
|
*/
|
|
8288
8458
|
name?: string | null;
|
|
8289
8459
|
/**
|
|
@@ -8317,20 +8487,32 @@ export interface PhoneNumberTableRow extends AdditionalDataHolder, Parsable {
|
|
|
8317
8487
|
/**
|
|
8318
8488
|
* Warmup state for this phone number.
|
|
8319
8489
|
*/
|
|
8320
|
-
warmup?:
|
|
8490
|
+
warmup?: PhoneNumberReadiness | null;
|
|
8321
8491
|
}
|
|
8322
8492
|
/**
|
|
8323
8493
|
* Response schema for the Leadping API phone number traffic metrics response returned to authenticated clients.
|
|
8324
8494
|
*/
|
|
8325
8495
|
export interface PhoneNumberTrafficMetricsResponse extends AdditionalDataHolder, Parsable {
|
|
8496
|
+
/**
|
|
8497
|
+
* Number of outbound calls that connected during this metrics window.
|
|
8498
|
+
*/
|
|
8499
|
+
callConnectedCount?: number | null;
|
|
8326
8500
|
/**
|
|
8327
8501
|
* Number of outbound calls that failed during this metrics window.
|
|
8328
8502
|
*/
|
|
8329
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;
|
|
8330
8508
|
/**
|
|
8331
8509
|
* Number of outbound calls placed during this metrics window.
|
|
8332
8510
|
*/
|
|
8333
8511
|
callPlacedCount?: number | null;
|
|
8512
|
+
/**
|
|
8513
|
+
* Number of connected outbound calls shorter than 30 seconds during this metrics window.
|
|
8514
|
+
*/
|
|
8515
|
+
callShortCount?: number | null;
|
|
8334
8516
|
/**
|
|
8335
8517
|
* Number of SMS messages that failed during this metrics window.
|
|
8336
8518
|
*/
|
|
@@ -8385,33 +8567,6 @@ export interface PhoneNumberTrafficTrendPoint extends AdditionalDataHolder, Pars
|
|
|
8385
8567
|
*/
|
|
8386
8568
|
startAt?: Date | null;
|
|
8387
8569
|
}
|
|
8388
|
-
/**
|
|
8389
|
-
* Warmup state for a Leadping phone number.
|
|
8390
|
-
*/
|
|
8391
|
-
export interface PhoneNumberWarmup extends AdditionalDataHolder, Parsable {
|
|
8392
|
-
/**
|
|
8393
|
-
* Indicates whether the phone number warmup is enabled in Leadping.
|
|
8394
|
-
*/
|
|
8395
|
-
enabled?: boolean | null;
|
|
8396
|
-
/**
|
|
8397
|
-
* Current warmup health score used to assess phone number readiness.
|
|
8398
|
-
*/
|
|
8399
|
-
healthScore?: number | null;
|
|
8400
|
-
/**
|
|
8401
|
-
* Defines the supported SMS Warmup Health State values.
|
|
8402
|
-
*/
|
|
8403
|
-
healthStatus?: PhoneNumberWarmup_healthStatus | null;
|
|
8404
|
-
/**
|
|
8405
|
-
* Warmup completion percentage, from 0 through 100.
|
|
8406
|
-
*/
|
|
8407
|
-
progressPercent?: number | null;
|
|
8408
|
-
/**
|
|
8409
|
-
* Defines the supported SMS Warmup Health State values.
|
|
8410
|
-
*/
|
|
8411
|
-
state?: PhoneNumberWarmup_state | null;
|
|
8412
|
-
}
|
|
8413
|
-
export type PhoneNumberWarmup_healthStatus = (typeof PhoneNumberWarmup_healthStatusObject)[keyof typeof PhoneNumberWarmup_healthStatusObject];
|
|
8414
|
-
export type PhoneNumberWarmup_state = (typeof PhoneNumberWarmup_stateObject)[keyof typeof PhoneNumberWarmup_stateObject];
|
|
8415
8570
|
export interface ProblemDetails extends AdditionalDataHolder, ApiError, Parsable {
|
|
8416
8571
|
/**
|
|
8417
8572
|
* Human-readable explanation specific to this occurrence of the problem.
|
|
@@ -9279,6 +9434,13 @@ export declare function serializeIdNameValue(writer: SerializationWriter, idName
|
|
|
9279
9434
|
* @param writer Serialization writer to use to serialize this model
|
|
9280
9435
|
*/
|
|
9281
9436
|
export declare function serializeInitiateCallRequest(writer: SerializationWriter, initiateCallRequest?: Partial<InitiateCallRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
9437
|
+
/**
|
|
9438
|
+
* Serializes information the current object
|
|
9439
|
+
* @param InvoicePdfAccessResponse The instance to serialize from.
|
|
9440
|
+
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
9441
|
+
* @param writer Serialization writer to use to serialize this model
|
|
9442
|
+
*/
|
|
9443
|
+
export declare function serializeInvoicePdfAccessResponse(writer: SerializationWriter, invoicePdfAccessResponse?: Partial<InvoicePdfAccessResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
9282
9444
|
/**
|
|
9283
9445
|
* Serializes information the current object
|
|
9284
9446
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
@@ -9426,6 +9588,13 @@ export declare function serializeLeadTagsRequest(writer: SerializationWriter, le
|
|
|
9426
9588
|
* @param writer Serialization writer to use to serialize this model
|
|
9427
9589
|
*/
|
|
9428
9590
|
export declare function serializeMobileDevicePreferences(writer: SerializationWriter, mobileDevicePreferences?: Partial<MobileDevicePreferences> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
9591
|
+
/**
|
|
9592
|
+
* Serializes information the current object
|
|
9593
|
+
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
9594
|
+
* @param NotificationResponse The instance to serialize from.
|
|
9595
|
+
* @param writer Serialization writer to use to serialize this model
|
|
9596
|
+
*/
|
|
9597
|
+
export declare function serializeNotificationResponse(writer: SerializationWriter, notificationResponse?: Partial<NotificationResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
9429
9598
|
/**
|
|
9430
9599
|
* Serializes information the current object
|
|
9431
9600
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
@@ -9629,6 +9798,13 @@ export declare function serializePhoneNumberMessagingEventResponse(writer: Seria
|
|
|
9629
9798
|
* @param writer Serialization writer to use to serialize this model
|
|
9630
9799
|
*/
|
|
9631
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;
|
|
9632
9808
|
/**
|
|
9633
9809
|
* Serializes information the current object
|
|
9634
9810
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
@@ -9734,13 +9910,6 @@ export declare function serializePhoneNumberTrafficMetricsResponse(writer: Seria
|
|
|
9734
9910
|
* @param writer Serialization writer to use to serialize this model
|
|
9735
9911
|
*/
|
|
9736
9912
|
export declare function serializePhoneNumberTrafficTrendPoint(writer: SerializationWriter, phoneNumberTrafficTrendPoint?: Partial<PhoneNumberTrafficTrendPoint> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
9737
|
-
/**
|
|
9738
|
-
* Serializes information the current object
|
|
9739
|
-
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
9740
|
-
* @param PhoneNumberWarmup The instance to serialize from.
|
|
9741
|
-
* @param writer Serialization writer to use to serialize this model
|
|
9742
|
-
*/
|
|
9743
|
-
export declare function serializePhoneNumberWarmup(writer: SerializationWriter, phoneNumberWarmup?: Partial<PhoneNumberWarmup> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
9744
9913
|
/**
|
|
9745
9914
|
* Serializes information the current object
|
|
9746
9915
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
@@ -9779,24 +9948,24 @@ export declare function serializeSmsEventTableRow(writer: SerializationWriter, s
|
|
|
9779
9948
|
/**
|
|
9780
9949
|
* Serializes information the current object
|
|
9781
9950
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
9782
|
-
* @param
|
|
9951
|
+
* @param SmsReadinessStatusResponse The instance to serialize from.
|
|
9783
9952
|
* @param writer Serialization writer to use to serialize this model
|
|
9784
9953
|
*/
|
|
9785
|
-
export declare function
|
|
9954
|
+
export declare function serializeSmsReadinessStatusResponse(writer: SerializationWriter, smsReadinessStatusResponse?: Partial<SmsReadinessStatusResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
9786
9955
|
/**
|
|
9787
9956
|
* Serializes information the current object
|
|
9788
9957
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
9789
|
-
* @param
|
|
9958
|
+
* @param SmsReadinessUiState The instance to serialize from.
|
|
9790
9959
|
* @param writer Serialization writer to use to serialize this model
|
|
9791
9960
|
*/
|
|
9792
|
-
export declare function
|
|
9961
|
+
export declare function serializeSmsReadinessUiState(writer: SerializationWriter, smsReadinessUiState?: Partial<SmsReadinessUiState> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
9793
9962
|
/**
|
|
9794
9963
|
* Serializes information the current object
|
|
9795
9964
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
9796
|
-
* @param
|
|
9965
|
+
* @param SmsResponse The instance to serialize from.
|
|
9797
9966
|
* @param writer Serialization writer to use to serialize this model
|
|
9798
9967
|
*/
|
|
9799
|
-
export declare function
|
|
9968
|
+
export declare function serializeSmsResponse(writer: SerializationWriter, smsResponse?: Partial<SmsResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
9800
9969
|
/**
|
|
9801
9970
|
* Serializes information the current object
|
|
9802
9971
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
@@ -9986,6 +10155,13 @@ export declare function serializeTelephonyLoginResponse(writer: SerializationWri
|
|
|
9986
10155
|
* @param writer Serialization writer to use to serialize this model
|
|
9987
10156
|
*/
|
|
9988
10157
|
export declare function serializeTenDlcApplicationDraft(writer: SerializationWriter, tenDlcApplicationDraft?: Partial<TenDlcApplicationDraft> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
10158
|
+
/**
|
|
10159
|
+
* Serializes information the current object
|
|
10160
|
+
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
10161
|
+
* @param TenDlcNotesRequest The instance to serialize from.
|
|
10162
|
+
* @param writer Serialization writer to use to serialize this model
|
|
10163
|
+
*/
|
|
10164
|
+
export declare function serializeTenDlcNotesRequest(writer: SerializationWriter, tenDlcNotesRequest?: Partial<TenDlcNotesRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
9989
10165
|
/**
|
|
9990
10166
|
* Serializes information the current object
|
|
9991
10167
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
@@ -10360,6 +10536,62 @@ export interface SmsEventTableRow extends AdditionalDataHolder, Parsable {
|
|
|
10360
10536
|
export type SmsEventTableRow_outboundSource = (typeof SmsEventTableRow_outboundSourceObject)[keyof typeof SmsEventTableRow_outboundSourceObject];
|
|
10361
10537
|
export type SmsEventTableRow_status = (typeof SmsEventTableRow_statusObject)[keyof typeof SmsEventTableRow_statusObject];
|
|
10362
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
|
+
}
|
|
10363
10595
|
/**
|
|
10364
10596
|
* Response schema for the Leadping API SMS message returned to authenticated clients.
|
|
10365
10597
|
*/
|
|
@@ -10508,57 +10740,6 @@ export interface SmsResponse extends AdditionalDataHolder, Parsable {
|
|
|
10508
10740
|
export type SmsResponse_selectionReason = (typeof SmsResponse_selectionReasonObject)[keyof typeof SmsResponse_selectionReasonObject];
|
|
10509
10741
|
export type SmsResponse_status = (typeof SmsResponse_statusObject)[keyof typeof SmsResponse_statusObject];
|
|
10510
10742
|
export type SmsResponse_trafficType = (typeof SmsResponse_trafficTypeObject)[keyof typeof SmsResponse_trafficTypeObject];
|
|
10511
|
-
export type SmsWarmupHealthState = (typeof SmsWarmupHealthStateObject)[keyof typeof SmsWarmupHealthStateObject];
|
|
10512
|
-
/**
|
|
10513
|
-
* API response containing SMS warmup status data returned to callers.
|
|
10514
|
-
*/
|
|
10515
|
-
export interface SmsWarmupStatusResponse extends AdditionalDataHolder, Parsable {
|
|
10516
|
-
/**
|
|
10517
|
-
* The health score metric for this SMS warmup status.
|
|
10518
|
-
*/
|
|
10519
|
-
healthScore?: number | null;
|
|
10520
|
-
/**
|
|
10521
|
-
* The phone number associated with this SMS warmup status.
|
|
10522
|
-
*/
|
|
10523
|
-
phoneNumber?: string | null;
|
|
10524
|
-
/**
|
|
10525
|
-
* The phone number ID associated with this SMS warmup status.
|
|
10526
|
-
*/
|
|
10527
|
-
phoneNumberId?: string | null;
|
|
10528
|
-
/**
|
|
10529
|
-
* The progress percent metric for this SMS warmup status.
|
|
10530
|
-
*/
|
|
10531
|
-
progressPercent?: number | null;
|
|
10532
|
-
/**
|
|
10533
|
-
* The current status for this SMS warmup status.
|
|
10534
|
-
*/
|
|
10535
|
-
status?: SmsWarmupHealthState | null;
|
|
10536
|
-
/**
|
|
10537
|
-
* The current UI state for this SMS warmup status.
|
|
10538
|
-
*/
|
|
10539
|
-
uiState?: SmsWarmupUiState | null;
|
|
10540
|
-
/**
|
|
10541
|
-
* Whether warmup is enabled for this SMS warmup status.
|
|
10542
|
-
*/
|
|
10543
|
-
warmupEnabled?: boolean | null;
|
|
10544
|
-
}
|
|
10545
|
-
/**
|
|
10546
|
-
* API DTO containing SMS warmup ui state data used by Leadping API contracts.
|
|
10547
|
-
*/
|
|
10548
|
-
export interface SmsWarmupUiState extends AdditionalDataHolder, Parsable {
|
|
10549
|
-
/**
|
|
10550
|
-
* The human-readable description of this SMS warmup UI state.
|
|
10551
|
-
*/
|
|
10552
|
-
description?: string | null;
|
|
10553
|
-
/**
|
|
10554
|
-
* The human-readable label shown for this SMS warmup UI state.
|
|
10555
|
-
*/
|
|
10556
|
-
label?: SmsWarmupHealthState | null;
|
|
10557
|
-
/**
|
|
10558
|
-
* The tone value for this SMS warmup UI state.
|
|
10559
|
-
*/
|
|
10560
|
-
tone?: string | null;
|
|
10561
|
-
}
|
|
10562
10743
|
/**
|
|
10563
10744
|
* Response model containing source metrics data returned by the Leadping API.
|
|
10564
10745
|
*/
|
|
@@ -10592,6 +10773,10 @@ export interface SourceRequest extends AdditionalDataHolder, Parsable {
|
|
|
10592
10773
|
* State or region allowlist used to accept leads from this source.
|
|
10593
10774
|
*/
|
|
10594
10775
|
allowedStates?: string[] | null;
|
|
10776
|
+
/**
|
|
10777
|
+
* Source API key used to authenticate inbound lead delivery to Leadping.
|
|
10778
|
+
*/
|
|
10779
|
+
apiKey?: string | null;
|
|
10595
10780
|
/**
|
|
10596
10781
|
* Configured cost charged when this source creates a billable lead.
|
|
10597
10782
|
*/
|
|
@@ -10641,6 +10826,10 @@ export interface SourceResponse extends AdditionalDataHolder, Parsable {
|
|
|
10641
10826
|
* State or region allowlist used to accept leads from this source.
|
|
10642
10827
|
*/
|
|
10643
10828
|
allowedStates?: string[] | null;
|
|
10829
|
+
/**
|
|
10830
|
+
* Source API key used to authenticate inbound lead delivery to Leadping. Unlike a business API key, this value remains available to authorized source users.
|
|
10831
|
+
*/
|
|
10832
|
+
apiKey?: string | null;
|
|
10644
10833
|
/**
|
|
10645
10834
|
* Masked preview of the source API key for compact display.
|
|
10646
10835
|
*/
|
|
@@ -10746,6 +10935,10 @@ export interface SourceTableRow extends AdditionalDataHolder, Parsable {
|
|
|
10746
10935
|
* State or region allowlist used to accept leads from this source.
|
|
10747
10936
|
*/
|
|
10748
10937
|
allowedStates?: string[] | null;
|
|
10938
|
+
/**
|
|
10939
|
+
* Source API key used to authenticate inbound lead delivery to Leadping. Unlike a business API key, this value remains available to authorized source users.
|
|
10940
|
+
*/
|
|
10941
|
+
apiKey?: string | null;
|
|
10749
10942
|
/**
|
|
10750
10943
|
* UTC timestamp when the source API key was last used.
|
|
10751
10944
|
*/
|
|
@@ -10893,7 +11086,7 @@ export interface StreetAddress extends AdditionalDataHolder, Parsable {
|
|
|
10893
11086
|
state?: string | null;
|
|
10894
11087
|
}
|
|
10895
11088
|
/**
|
|
10896
|
-
* Customer-safe
|
|
11089
|
+
* Customer-safe Leadping invoice summary for billing.
|
|
10897
11090
|
*/
|
|
10898
11091
|
export interface StripeInvoiceResponse extends AdditionalDataHolder, Parsable {
|
|
10899
11092
|
/**
|
|
@@ -10905,9 +11098,9 @@ export interface StripeInvoiceResponse extends AdditionalDataHolder, Parsable {
|
|
|
10905
11098
|
*/
|
|
10906
11099
|
createdAt?: Date | null;
|
|
10907
11100
|
/**
|
|
10908
|
-
* The
|
|
11101
|
+
* The hasPdf property
|
|
10909
11102
|
*/
|
|
10910
|
-
|
|
11103
|
+
hasPdf?: boolean | null;
|
|
10911
11104
|
/**
|
|
10912
11105
|
* The id property
|
|
10913
11106
|
*/
|
|
@@ -11339,6 +11532,12 @@ export interface TenDlcApplicationDraft extends AdditionalDataHolder, Parsable {
|
|
|
11339
11532
|
websiteUrl?: string | null;
|
|
11340
11533
|
}
|
|
11341
11534
|
export type TenDlcApplicationStatus = (typeof TenDlcApplicationStatusObject)[keyof typeof TenDlcApplicationStatusObject];
|
|
11535
|
+
export interface TenDlcNotesRequest extends AdditionalDataHolder, Parsable {
|
|
11536
|
+
/**
|
|
11537
|
+
* The notes property
|
|
11538
|
+
*/
|
|
11539
|
+
notes?: string | null;
|
|
11540
|
+
}
|
|
11342
11541
|
/**
|
|
11343
11542
|
* Response schema for the Leadping API billing transaction response returned to authenticated clients.
|
|
11344
11543
|
*/
|
|
@@ -12375,6 +12574,22 @@ export declare const BusinessSwitchOption_businessStatusObject: {
|
|
|
12375
12574
|
readonly SetupCompleted: "SetupCompleted";
|
|
12376
12575
|
readonly Active: "Active";
|
|
12377
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
|
+
};
|
|
12378
12593
|
/**
|
|
12379
12594
|
* Defines the supported Customer Activation Status values.
|
|
12380
12595
|
*/
|
|
@@ -12636,16 +12851,14 @@ export declare const DispositionResponse_changeSourceObject: {
|
|
|
12636
12851
|
readonly API: "API";
|
|
12637
12852
|
};
|
|
12638
12853
|
/**
|
|
12639
|
-
* Defines the supported SMS
|
|
12854
|
+
* Defines the supported SMS readiness health assessments.
|
|
12640
12855
|
*/
|
|
12641
12856
|
export declare const EligibleOutgoingNumberResponse_healthStatusObject: {
|
|
12642
|
-
readonly
|
|
12643
|
-
readonly
|
|
12857
|
+
readonly NotEvaluated: "Not Evaluated";
|
|
12858
|
+
readonly Evaluating: "Evaluating";
|
|
12644
12859
|
readonly Healthy: "Healthy";
|
|
12645
12860
|
readonly NeedsAttention: "Needs Attention";
|
|
12646
|
-
readonly Paused: "Paused";
|
|
12647
12861
|
readonly Blocked: "Blocked";
|
|
12648
|
-
readonly Ready: "Ready";
|
|
12649
12862
|
};
|
|
12650
12863
|
/**
|
|
12651
12864
|
* Defines the supported Event status values.
|
|
@@ -12938,16 +13151,14 @@ export declare const OutgoingNumberSelectionRequest_channelObject: {
|
|
|
12938
13151
|
readonly Call: "call";
|
|
12939
13152
|
};
|
|
12940
13153
|
/**
|
|
12941
|
-
* Defines the supported SMS
|
|
13154
|
+
* Defines the supported SMS readiness health assessments.
|
|
12942
13155
|
*/
|
|
12943
13156
|
export declare const OutgoingNumberSelectionResponse_healthStatusObject: {
|
|
12944
|
-
readonly
|
|
12945
|
-
readonly
|
|
13157
|
+
readonly NotEvaluated: "Not Evaluated";
|
|
13158
|
+
readonly Evaluating: "Evaluating";
|
|
12946
13159
|
readonly Healthy: "Healthy";
|
|
12947
13160
|
readonly NeedsAttention: "Needs Attention";
|
|
12948
|
-
readonly Paused: "Paused";
|
|
12949
13161
|
readonly Blocked: "Blocked";
|
|
12950
|
-
readonly Ready: "Ready";
|
|
12951
13162
|
};
|
|
12952
13163
|
/**
|
|
12953
13164
|
* Defines the supported Outgoing Number Selection Reason values.
|
|
@@ -13014,25 +13225,21 @@ export declare const PhoneNumberOutboundHealthStatusObject: {
|
|
|
13014
13225
|
readonly Disabled: "disabled";
|
|
13015
13226
|
};
|
|
13016
13227
|
/**
|
|
13017
|
-
* Defines the supported SMS
|
|
13228
|
+
* Defines the supported SMS readiness health assessments.
|
|
13018
13229
|
*/
|
|
13019
|
-
export declare const
|
|
13020
|
-
readonly
|
|
13021
|
-
readonly
|
|
13230
|
+
export declare const PhoneNumberReadiness_healthStatusObject: {
|
|
13231
|
+
readonly NotEvaluated: "Not Evaluated";
|
|
13232
|
+
readonly Evaluating: "Evaluating";
|
|
13022
13233
|
readonly Healthy: "Healthy";
|
|
13023
13234
|
readonly NeedsAttention: "Needs Attention";
|
|
13024
|
-
readonly Paused: "Paused";
|
|
13025
13235
|
readonly Blocked: "Blocked";
|
|
13026
|
-
readonly Ready: "Ready";
|
|
13027
13236
|
};
|
|
13028
13237
|
/**
|
|
13029
|
-
* Defines the supported SMS
|
|
13238
|
+
* Defines the supported SMS readiness states.
|
|
13030
13239
|
*/
|
|
13031
|
-
export declare const
|
|
13240
|
+
export declare const PhoneNumberReadiness_stateObject: {
|
|
13032
13241
|
readonly NotStarted: "Not Started";
|
|
13033
|
-
readonly
|
|
13034
|
-
readonly Healthy: "Healthy";
|
|
13035
|
-
readonly NeedsAttention: "Needs Attention";
|
|
13242
|
+
readonly InProgress: "In Progress";
|
|
13036
13243
|
readonly Paused: "Paused";
|
|
13037
13244
|
readonly Blocked: "Blocked";
|
|
13038
13245
|
readonly Ready: "Ready";
|
|
@@ -13079,6 +13286,26 @@ export declare const SmsEventTableRow_trafficTypeObject: {
|
|
|
13079
13286
|
readonly SystemInternal: "SystemInternal";
|
|
13080
13287
|
readonly FailedAttempt: "FailedAttempt";
|
|
13081
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
|
+
};
|
|
13082
13309
|
/**
|
|
13083
13310
|
* Defines the supported Outgoing Number Selection Reason values.
|
|
13084
13311
|
*/
|
|
@@ -13121,18 +13348,6 @@ export declare const SmsResponse_trafficTypeObject: {
|
|
|
13121
13348
|
readonly SystemInternal: "SystemInternal";
|
|
13122
13349
|
readonly FailedAttempt: "FailedAttempt";
|
|
13123
13350
|
};
|
|
13124
|
-
/**
|
|
13125
|
-
* Defines the supported SMS Warmup Health State values.
|
|
13126
|
-
*/
|
|
13127
|
-
export declare const SmsWarmupHealthStateObject: {
|
|
13128
|
-
readonly NotStarted: "Not Started";
|
|
13129
|
-
readonly Warming: "Warming";
|
|
13130
|
-
readonly Healthy: "Healthy";
|
|
13131
|
-
readonly NeedsAttention: "Needs Attention";
|
|
13132
|
-
readonly Paused: "Paused";
|
|
13133
|
-
readonly Blocked: "Blocked";
|
|
13134
|
-
readonly Ready: "Ready";
|
|
13135
|
-
};
|
|
13136
13351
|
/**
|
|
13137
13352
|
* Defines the supported 10DLC Application Status values.
|
|
13138
13353
|
*/
|