@leadping/sdk 1.0.25 → 1.0.26
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/models/index.d.ts +417 -0
- package/dist/models/index.d.ts.map +1 -1
- package/dist/models/index.js +432 -0
- package/dist/models/index.js.map +1 -1
- package/package.json +1 -1
package/dist/models/index.d.ts
CHANGED
|
@@ -1183,6 +1183,10 @@ export interface BusinessActivationState extends AdditionalDataHolder, Parsable
|
|
|
1183
1183
|
* The current telephony status for this business activation state.
|
|
1184
1184
|
*/
|
|
1185
1185
|
telephonyStatus?: ActivationTelephonyStatus | null;
|
|
1186
|
+
/**
|
|
1187
|
+
* Identifier of the first-class 10DLC application entity for this business.
|
|
1188
|
+
*/
|
|
1189
|
+
tenDlcApplicationId?: string | null;
|
|
1186
1190
|
/**
|
|
1187
1191
|
* The 10DLC draft value for this business activation state.
|
|
1188
1192
|
*/
|
|
@@ -3086,6 +3090,12 @@ export declare function createLeadRequestFromDiscriminatorValue(parseNode: Parse
|
|
|
3086
3090
|
* @returns {LeadResponse_currentDisposition}
|
|
3087
3091
|
*/
|
|
3088
3092
|
export declare function createLeadResponse_currentDispositionFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
3093
|
+
/**
|
|
3094
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
3095
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
3096
|
+
* @returns {LeadResponse_phoneIdentity}
|
|
3097
|
+
*/
|
|
3098
|
+
export declare function createLeadResponse_phoneIdentityFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
3089
3099
|
/**
|
|
3090
3100
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
3091
3101
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
@@ -3287,6 +3297,48 @@ export declare function createPhoneCallResponseFromDiscriminatorValue(parseNode:
|
|
|
3287
3297
|
* @returns {Phone}
|
|
3288
3298
|
*/
|
|
3289
3299
|
export declare function createPhoneFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
3300
|
+
/**
|
|
3301
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
3302
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
3303
|
+
* @returns {PhoneIdentityResponse_lookup}
|
|
3304
|
+
*/
|
|
3305
|
+
export declare function createPhoneIdentityResponse_lookupFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
3306
|
+
/**
|
|
3307
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
3308
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
3309
|
+
* @returns {PhoneIdentityResponse}
|
|
3310
|
+
*/
|
|
3311
|
+
export declare function createPhoneIdentityResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
3312
|
+
/**
|
|
3313
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
3314
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
3315
|
+
* @returns {PhoneLocationSource}
|
|
3316
|
+
*/
|
|
3317
|
+
export declare function createPhoneLocationSourceFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
3318
|
+
/**
|
|
3319
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
3320
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
3321
|
+
* @returns {PhoneLookup_carrier}
|
|
3322
|
+
*/
|
|
3323
|
+
export declare function createPhoneLookup_carrierFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
3324
|
+
/**
|
|
3325
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
3326
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
3327
|
+
* @returns {PhoneLookup_location}
|
|
3328
|
+
*/
|
|
3329
|
+
export declare function createPhoneLookup_locationFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
3330
|
+
/**
|
|
3331
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
3332
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
3333
|
+
* @returns {PhoneLookupCarrier}
|
|
3334
|
+
*/
|
|
3335
|
+
export declare function createPhoneLookupCarrierFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
3336
|
+
/**
|
|
3337
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
3338
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
3339
|
+
* @returns {PhoneLookup}
|
|
3340
|
+
*/
|
|
3341
|
+
export declare function createPhoneLookupFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
3290
3342
|
/**
|
|
3291
3343
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
3292
3344
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
@@ -3311,6 +3363,18 @@ export declare function createPhoneNumberAvailabilityResponseFromDiscriminatorVa
|
|
|
3311
3363
|
* @returns {PhoneNumberLocation_coordinate}
|
|
3312
3364
|
*/
|
|
3313
3365
|
export declare function createPhoneNumberLocation_coordinateFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
3366
|
+
/**
|
|
3367
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
3368
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
3369
|
+
* @returns {PhoneNumberLocation_coordinateSource}
|
|
3370
|
+
*/
|
|
3371
|
+
export declare function createPhoneNumberLocation_coordinateSourceFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
3372
|
+
/**
|
|
3373
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
3374
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
3375
|
+
* @returns {PhoneNumberLocation_timeZoneSource}
|
|
3376
|
+
*/
|
|
3377
|
+
export declare function createPhoneNumberLocation_timeZoneSourceFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
3314
3378
|
/**
|
|
3315
3379
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
3316
3380
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
@@ -4974,6 +5038,12 @@ export declare function deserializeIntoLeadResponse(leadResponse?: Partial<LeadR
|
|
|
4974
5038
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
4975
5039
|
*/
|
|
4976
5040
|
export declare function deserializeIntoLeadResponse_currentDisposition(leadResponse_currentDisposition?: Partial<LeadResponse_currentDisposition> | undefined): Record<string, (node: ParseNode) => void>;
|
|
5041
|
+
/**
|
|
5042
|
+
* The deserialization information for the current model
|
|
5043
|
+
* @param LeadResponse_phoneIdentity The instance to deserialize into.
|
|
5044
|
+
* @returns {Record<string, (node: ParseNode) => void>}
|
|
5045
|
+
*/
|
|
5046
|
+
export declare function deserializeIntoLeadResponse_phoneIdentity(leadResponse_phoneIdentity?: Partial<LeadResponse_phoneIdentity> | undefined): Record<string, (node: ParseNode) => void>;
|
|
4977
5047
|
/**
|
|
4978
5048
|
* The deserialization information for the current model
|
|
4979
5049
|
* @param LeadStatusRequest The instance to deserialize into.
|
|
@@ -5160,6 +5230,48 @@ export declare function deserializeIntoPhone(phone?: Partial<Phone> | undefined)
|
|
|
5160
5230
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
5161
5231
|
*/
|
|
5162
5232
|
export declare function deserializeIntoPhoneCallResponse(phoneCallResponse?: Partial<PhoneCallResponse> | undefined): Record<string, (node: ParseNode) => void>;
|
|
5233
|
+
/**
|
|
5234
|
+
* The deserialization information for the current model
|
|
5235
|
+
* @param PhoneIdentityResponse The instance to deserialize into.
|
|
5236
|
+
* @returns {Record<string, (node: ParseNode) => void>}
|
|
5237
|
+
*/
|
|
5238
|
+
export declare function deserializeIntoPhoneIdentityResponse(phoneIdentityResponse?: Partial<PhoneIdentityResponse> | undefined): Record<string, (node: ParseNode) => void>;
|
|
5239
|
+
/**
|
|
5240
|
+
* The deserialization information for the current model
|
|
5241
|
+
* @param PhoneIdentityResponse_lookup The instance to deserialize into.
|
|
5242
|
+
* @returns {Record<string, (node: ParseNode) => void>}
|
|
5243
|
+
*/
|
|
5244
|
+
export declare function deserializeIntoPhoneIdentityResponse_lookup(phoneIdentityResponse_lookup?: Partial<PhoneIdentityResponse_lookup> | undefined): Record<string, (node: ParseNode) => void>;
|
|
5245
|
+
/**
|
|
5246
|
+
* The deserialization information for the current model
|
|
5247
|
+
* @param PhoneLocationSource The instance to deserialize into.
|
|
5248
|
+
* @returns {Record<string, (node: ParseNode) => void>}
|
|
5249
|
+
*/
|
|
5250
|
+
export declare function deserializeIntoPhoneLocationSource(phoneLocationSource?: Partial<PhoneLocationSource> | undefined): Record<string, (node: ParseNode) => void>;
|
|
5251
|
+
/**
|
|
5252
|
+
* The deserialization information for the current model
|
|
5253
|
+
* @param PhoneLookup The instance to deserialize into.
|
|
5254
|
+
* @returns {Record<string, (node: ParseNode) => void>}
|
|
5255
|
+
*/
|
|
5256
|
+
export declare function deserializeIntoPhoneLookup(phoneLookup?: Partial<PhoneLookup> | undefined): Record<string, (node: ParseNode) => void>;
|
|
5257
|
+
/**
|
|
5258
|
+
* The deserialization information for the current model
|
|
5259
|
+
* @param PhoneLookup_carrier The instance to deserialize into.
|
|
5260
|
+
* @returns {Record<string, (node: ParseNode) => void>}
|
|
5261
|
+
*/
|
|
5262
|
+
export declare function deserializeIntoPhoneLookup_carrier(phoneLookup_carrier?: Partial<PhoneLookup_carrier> | undefined): Record<string, (node: ParseNode) => void>;
|
|
5263
|
+
/**
|
|
5264
|
+
* The deserialization information for the current model
|
|
5265
|
+
* @param PhoneLookup_location The instance to deserialize into.
|
|
5266
|
+
* @returns {Record<string, (node: ParseNode) => void>}
|
|
5267
|
+
*/
|
|
5268
|
+
export declare function deserializeIntoPhoneLookup_location(phoneLookup_location?: Partial<PhoneLookup_location> | undefined): Record<string, (node: ParseNode) => void>;
|
|
5269
|
+
/**
|
|
5270
|
+
* The deserialization information for the current model
|
|
5271
|
+
* @param PhoneLookupCarrier The instance to deserialize into.
|
|
5272
|
+
* @returns {Record<string, (node: ParseNode) => void>}
|
|
5273
|
+
*/
|
|
5274
|
+
export declare function deserializeIntoPhoneLookupCarrier(phoneLookupCarrier?: Partial<PhoneLookupCarrier> | undefined): Record<string, (node: ParseNode) => void>;
|
|
5163
5275
|
/**
|
|
5164
5276
|
* The deserialization information for the current model
|
|
5165
5277
|
* @param PhoneNumberAvailabilityRequest The instance to deserialize into.
|
|
@@ -5190,6 +5302,18 @@ export declare function deserializeIntoPhoneNumberLocation(phoneNumberLocation?:
|
|
|
5190
5302
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
5191
5303
|
*/
|
|
5192
5304
|
export declare function deserializeIntoPhoneNumberLocation_coordinate(phoneNumberLocation_coordinate?: Partial<PhoneNumberLocation_coordinate> | undefined): Record<string, (node: ParseNode) => void>;
|
|
5305
|
+
/**
|
|
5306
|
+
* The deserialization information for the current model
|
|
5307
|
+
* @param PhoneNumberLocation_coordinateSource The instance to deserialize into.
|
|
5308
|
+
* @returns {Record<string, (node: ParseNode) => void>}
|
|
5309
|
+
*/
|
|
5310
|
+
export declare function deserializeIntoPhoneNumberLocation_coordinateSource(phoneNumberLocation_coordinateSource?: Partial<PhoneNumberLocation_coordinateSource> | undefined): Record<string, (node: ParseNode) => void>;
|
|
5311
|
+
/**
|
|
5312
|
+
* The deserialization information for the current model
|
|
5313
|
+
* @param PhoneNumberLocation_timeZoneSource The instance to deserialize into.
|
|
5314
|
+
* @returns {Record<string, (node: ParseNode) => void>}
|
|
5315
|
+
*/
|
|
5316
|
+
export declare function deserializeIntoPhoneNumberLocation_timeZoneSource(phoneNumberLocation_timeZoneSource?: Partial<PhoneNumberLocation_timeZoneSource> | undefined): Record<string, (node: ParseNode) => void>;
|
|
5193
5317
|
/**
|
|
5194
5318
|
* The deserialization information for the current model
|
|
5195
5319
|
* @param PhoneNumberMessagingEventResponse The instance to deserialize into.
|
|
@@ -6235,6 +6359,10 @@ export interface EventTableRow extends AdditionalDataHolder, Parsable {
|
|
|
6235
6359
|
* Display name for the person or system that created this event timeline table row.
|
|
6236
6360
|
*/
|
|
6237
6361
|
actorDisplayName?: string | null;
|
|
6362
|
+
/**
|
|
6363
|
+
* Email address for the person who created this event timeline table row.
|
|
6364
|
+
*/
|
|
6365
|
+
actorEmail?: string | null;
|
|
6238
6366
|
/**
|
|
6239
6367
|
* User ID for the person or system that created this event timeline table row.
|
|
6240
6368
|
*/
|
|
@@ -7084,6 +7212,10 @@ export interface LeadResponse extends AdditionalDataHolder, Parsable {
|
|
|
7084
7212
|
* The date and time when the entity was last modified, if applicable.
|
|
7085
7213
|
*/
|
|
7086
7214
|
modifiedAt?: Date | null;
|
|
7215
|
+
/**
|
|
7216
|
+
* Canonical phone identity and provider lookup details for this lead.
|
|
7217
|
+
*/
|
|
7218
|
+
phoneIdentity?: LeadResponse_phoneIdentity | null;
|
|
7087
7219
|
/**
|
|
7088
7220
|
* Tags currently attached to this lead, source, or record.
|
|
7089
7221
|
*/
|
|
@@ -7094,6 +7226,11 @@ export interface LeadResponse extends AdditionalDataHolder, Parsable {
|
|
|
7094
7226
|
*/
|
|
7095
7227
|
export interface LeadResponse_currentDisposition extends CurrentDispositionSummary, Parsable {
|
|
7096
7228
|
}
|
|
7229
|
+
/**
|
|
7230
|
+
* Canonical phone identity and provider lookup details for this lead.
|
|
7231
|
+
*/
|
|
7232
|
+
export interface LeadResponse_phoneIdentity extends Parsable, PhoneIdentityResponse {
|
|
7233
|
+
}
|
|
7097
7234
|
export interface LeadStatusRequest extends AdditionalDataHolder, Parsable {
|
|
7098
7235
|
/**
|
|
7099
7236
|
* Controlled disposition categories used for reporting, automation, and analytics.
|
|
@@ -8073,6 +8210,135 @@ export interface PhoneCallResponse extends AdditionalDataHolder, Parsable {
|
|
|
8073
8210
|
}
|
|
8074
8211
|
export type PhoneCallResponse_selectionReason = (typeof PhoneCallResponse_selectionReasonObject)[keyof typeof PhoneCallResponse_selectionReasonObject];
|
|
8075
8212
|
export type PhoneCallStatus = (typeof PhoneCallStatusObject)[keyof typeof PhoneCallStatusObject];
|
|
8213
|
+
/**
|
|
8214
|
+
* Response schema for a canonical phone identity returned by the Leadping API.
|
|
8215
|
+
*/
|
|
8216
|
+
export interface PhoneIdentityResponse extends AdditionalDataHolder, Parsable {
|
|
8217
|
+
/**
|
|
8218
|
+
* The date and time when the entity was created.
|
|
8219
|
+
*/
|
|
8220
|
+
createdAt?: Date | null;
|
|
8221
|
+
/**
|
|
8222
|
+
* The unique identifier for the entity.
|
|
8223
|
+
*/
|
|
8224
|
+
id?: string | null;
|
|
8225
|
+
/**
|
|
8226
|
+
* The most recent time lookup data was enriched.
|
|
8227
|
+
*/
|
|
8228
|
+
lastEnrichedAt?: Date | null;
|
|
8229
|
+
/**
|
|
8230
|
+
* Provider lookup and enrichment data for the number.
|
|
8231
|
+
*/
|
|
8232
|
+
lookup?: PhoneIdentityResponse_lookup | null;
|
|
8233
|
+
/**
|
|
8234
|
+
* The date and time when the entity was last modified, if applicable.
|
|
8235
|
+
*/
|
|
8236
|
+
modifiedAt?: Date | null;
|
|
8237
|
+
/**
|
|
8238
|
+
* The display name for the entity.
|
|
8239
|
+
*/
|
|
8240
|
+
name?: string | null;
|
|
8241
|
+
/**
|
|
8242
|
+
* The canonical E.164 phone number.
|
|
8243
|
+
*/
|
|
8244
|
+
number?: string | null;
|
|
8245
|
+
}
|
|
8246
|
+
/**
|
|
8247
|
+
* Provider lookup and enrichment data for the number.
|
|
8248
|
+
*/
|
|
8249
|
+
export interface PhoneIdentityResponse_lookup extends Parsable, PhoneLookup {
|
|
8250
|
+
}
|
|
8251
|
+
/**
|
|
8252
|
+
* Describes how a phone location value was resolved.
|
|
8253
|
+
*/
|
|
8254
|
+
export interface PhoneLocationSource extends AdditionalDataHolder, Parsable {
|
|
8255
|
+
/**
|
|
8256
|
+
* The resolution method, such as telnyx-city-state, coordinates, phone-number, or state-default.
|
|
8257
|
+
*/
|
|
8258
|
+
method?: string | null;
|
|
8259
|
+
/**
|
|
8260
|
+
* The city, state, coordinates, phone number, or representative ZIP used by the method.
|
|
8261
|
+
*/
|
|
8262
|
+
query?: string | null;
|
|
8263
|
+
}
|
|
8264
|
+
/**
|
|
8265
|
+
* Public Leadping API schema for phone lookup result data.
|
|
8266
|
+
*/
|
|
8267
|
+
export interface PhoneLookup extends AdditionalDataHolder, Parsable {
|
|
8268
|
+
/**
|
|
8269
|
+
* Complete carrier metadata reported for this phone number.
|
|
8270
|
+
*/
|
|
8271
|
+
carrier?: PhoneLookup_carrier | null;
|
|
8272
|
+
/**
|
|
8273
|
+
* Gets or sets created at.
|
|
8274
|
+
*/
|
|
8275
|
+
createdAt?: Date | null;
|
|
8276
|
+
/**
|
|
8277
|
+
* Gets or sets id.
|
|
8278
|
+
*/
|
|
8279
|
+
id?: string | null;
|
|
8280
|
+
/**
|
|
8281
|
+
* Indicates whether this phone lookup result passed validation.
|
|
8282
|
+
*/
|
|
8283
|
+
isValid?: boolean | null;
|
|
8284
|
+
/**
|
|
8285
|
+
* An enumerator describing phone line types
|
|
8286
|
+
*/
|
|
8287
|
+
lineType?: PhoneLookup_lineType | null;
|
|
8288
|
+
/**
|
|
8289
|
+
* Geographic location metadata for the phone number, lead, or lookup result.
|
|
8290
|
+
*/
|
|
8291
|
+
location?: PhoneLookup_location | null;
|
|
8292
|
+
/**
|
|
8293
|
+
* Gets or sets modified at.
|
|
8294
|
+
*/
|
|
8295
|
+
modifiedAt?: Date | null;
|
|
8296
|
+
/**
|
|
8297
|
+
* E.164 phone number exposed by this phone lookup result.
|
|
8298
|
+
*/
|
|
8299
|
+
number?: string | null;
|
|
8300
|
+
}
|
|
8301
|
+
/**
|
|
8302
|
+
* Complete carrier metadata reported for this phone number.
|
|
8303
|
+
*/
|
|
8304
|
+
export interface PhoneLookup_carrier extends Parsable, PhoneLookupCarrier {
|
|
8305
|
+
}
|
|
8306
|
+
export type PhoneLookup_lineType = (typeof PhoneLookup_lineTypeObject)[keyof typeof PhoneLookup_lineTypeObject];
|
|
8307
|
+
/**
|
|
8308
|
+
* Geographic location metadata for the phone number, lead, or lookup result.
|
|
8309
|
+
*/
|
|
8310
|
+
export interface PhoneLookup_location extends Parsable, PhoneNumberLocation {
|
|
8311
|
+
}
|
|
8312
|
+
/**
|
|
8313
|
+
* Complete carrier metadata returned by a phone number lookup provider.
|
|
8314
|
+
*/
|
|
8315
|
+
export interface PhoneLookupCarrier extends AdditionalDataHolder, Parsable {
|
|
8316
|
+
/**
|
|
8317
|
+
* Reason or diagnostic code that explains the current outcome for this Leadping phone lookup carrier.
|
|
8318
|
+
*/
|
|
8319
|
+
errorCode?: string | null;
|
|
8320
|
+
/**
|
|
8321
|
+
* Mobile country code (MCC) reported by the carrier lookup.
|
|
8322
|
+
*/
|
|
8323
|
+
mobileCountryCode?: string | null;
|
|
8324
|
+
/**
|
|
8325
|
+
* Mobile network code (MNC) reported by the carrier lookup.
|
|
8326
|
+
*/
|
|
8327
|
+
mobileNetworkCode?: string | null;
|
|
8328
|
+
/**
|
|
8329
|
+
* Human-readable name of the phone lookup carrier.
|
|
8330
|
+
*/
|
|
8331
|
+
name?: string | null;
|
|
8332
|
+
/**
|
|
8333
|
+
* Normalized carrier name used for consistent matching and reporting.
|
|
8334
|
+
*/
|
|
8335
|
+
normalizedCarrier?: string | null;
|
|
8336
|
+
/**
|
|
8337
|
+
* An enumerator describing carrier types
|
|
8338
|
+
*/
|
|
8339
|
+
type?: PhoneLookupCarrier_type | null;
|
|
8340
|
+
}
|
|
8341
|
+
export type PhoneLookupCarrier_type = (typeof PhoneLookupCarrier_typeObject)[keyof typeof PhoneLookupCarrier_typeObject];
|
|
8076
8342
|
/**
|
|
8077
8343
|
* Request schema for checking phone number availability before purchase or assignment.
|
|
8078
8344
|
*/
|
|
@@ -8116,10 +8382,22 @@ export interface PhoneNumberAvailabilityResponse_location extends Parsable, Phon
|
|
|
8116
8382
|
* Public Leadping API schema for phone number location data.
|
|
8117
8383
|
*/
|
|
8118
8384
|
export interface PhoneNumberLocation extends AdditionalDataHolder, Parsable {
|
|
8385
|
+
/**
|
|
8386
|
+
* Canonical city resolved by Leadping from its ZIP-code geography data.
|
|
8387
|
+
*/
|
|
8388
|
+
canonicalCity?: string | null;
|
|
8389
|
+
/**
|
|
8390
|
+
* Canonical state or territory abbreviation resolved by Leadping.
|
|
8391
|
+
*/
|
|
8392
|
+
canonicalState?: string | null;
|
|
8119
8393
|
/**
|
|
8120
8394
|
* Latitude and longitude coordinate for this phone number location.
|
|
8121
8395
|
*/
|
|
8122
8396
|
coordinate?: PhoneNumberLocation_coordinate | null;
|
|
8397
|
+
/**
|
|
8398
|
+
* Describes how the coordinate was resolved.
|
|
8399
|
+
*/
|
|
8400
|
+
coordinateSource?: PhoneNumberLocation_coordinateSource | null;
|
|
8123
8401
|
/**
|
|
8124
8402
|
* Country code for the phone number or location represented by this phone number location.
|
|
8125
8403
|
*/
|
|
@@ -8136,12 +8414,26 @@ export interface PhoneNumberLocation extends AdditionalDataHolder, Parsable {
|
|
|
8136
8414
|
* IANA or Windows time zone identifier used for local scheduling and reporting.
|
|
8137
8415
|
*/
|
|
8138
8416
|
timeZoneId?: string | null;
|
|
8417
|
+
/**
|
|
8418
|
+
* Describes how the time zone was resolved.
|
|
8419
|
+
*/
|
|
8420
|
+
timeZoneSource?: PhoneNumberLocation_timeZoneSource | null;
|
|
8139
8421
|
}
|
|
8140
8422
|
/**
|
|
8141
8423
|
* Latitude and longitude coordinate for this phone number location.
|
|
8142
8424
|
*/
|
|
8143
8425
|
export interface PhoneNumberLocation_coordinate extends Coordinate, Parsable {
|
|
8144
8426
|
}
|
|
8427
|
+
/**
|
|
8428
|
+
* Describes how the coordinate was resolved.
|
|
8429
|
+
*/
|
|
8430
|
+
export interface PhoneNumberLocation_coordinateSource extends Parsable, PhoneLocationSource {
|
|
8431
|
+
}
|
|
8432
|
+
/**
|
|
8433
|
+
* Describes how the time zone was resolved.
|
|
8434
|
+
*/
|
|
8435
|
+
export interface PhoneNumberLocation_timeZoneSource extends Parsable, PhoneLocationSource {
|
|
8436
|
+
}
|
|
8145
8437
|
/**
|
|
8146
8438
|
* Response schema for the Leadping API phone number messaging event returned to authenticated clients.
|
|
8147
8439
|
*/
|
|
@@ -8213,6 +8505,10 @@ export type PhoneNumberOutboundHealthStatus = (typeof PhoneNumberOutboundHealthS
|
|
|
8213
8505
|
* Messaging and calling warmup for a Leadping phone number.
|
|
8214
8506
|
*/
|
|
8215
8507
|
export interface PhoneNumberReadiness extends AdditionalDataHolder, Parsable {
|
|
8508
|
+
/**
|
|
8509
|
+
* Defines the supported voice call warmup stages for a Leadping-managed phone number.
|
|
8510
|
+
*/
|
|
8511
|
+
callStage?: PhoneNumberReadiness_callStage | null;
|
|
8216
8512
|
/**
|
|
8217
8513
|
* Indicates whether phone number warmup is enabled in Leadping.
|
|
8218
8514
|
*/
|
|
@@ -8234,6 +8530,7 @@ export interface PhoneNumberReadiness extends AdditionalDataHolder, Parsable {
|
|
|
8234
8530
|
*/
|
|
8235
8531
|
state?: PhoneNumberReadiness_state | null;
|
|
8236
8532
|
}
|
|
8533
|
+
export type PhoneNumberReadiness_callStage = (typeof PhoneNumberReadiness_callStageObject)[keyof typeof PhoneNumberReadiness_callStageObject];
|
|
8237
8534
|
export type PhoneNumberReadiness_healthStatus = (typeof PhoneNumberReadiness_healthStatusObject)[keyof typeof PhoneNumberReadiness_healthStatusObject];
|
|
8238
8535
|
export type PhoneNumberReadiness_state = (typeof PhoneNumberReadiness_stateObject)[keyof typeof PhoneNumberReadiness_stateObject];
|
|
8239
8536
|
/**
|
|
@@ -8335,6 +8632,10 @@ export interface PhoneNumberRoutingMetadata extends AdditionalDataHolder, Parsab
|
|
|
8335
8632
|
* Team ID used to route calls and messages for this phone number.
|
|
8336
8633
|
*/
|
|
8337
8634
|
teamId?: string | null;
|
|
8635
|
+
/**
|
|
8636
|
+
* Leadping 10DLC application entity associated with this phone number.
|
|
8637
|
+
*/
|
|
8638
|
+
tenDlcApplicationId?: string | null;
|
|
8338
8639
|
/**
|
|
8339
8640
|
* Indicates whether the phone number can be used for voice calls.
|
|
8340
8641
|
*/
|
|
@@ -9532,6 +9833,13 @@ export declare function serializeLeadResponse(writer: SerializationWriter, leadR
|
|
|
9532
9833
|
* @param writer Serialization writer to use to serialize this model
|
|
9533
9834
|
*/
|
|
9534
9835
|
export declare function serializeLeadResponse_currentDisposition(writer: SerializationWriter, leadResponse_currentDisposition?: Partial<LeadResponse_currentDisposition> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
9836
|
+
/**
|
|
9837
|
+
* Serializes information the current object
|
|
9838
|
+
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
9839
|
+
* @param LeadResponse_phoneIdentity The instance to serialize from.
|
|
9840
|
+
* @param writer Serialization writer to use to serialize this model
|
|
9841
|
+
*/
|
|
9842
|
+
export declare function serializeLeadResponse_phoneIdentity(writer: SerializationWriter, leadResponse_phoneIdentity?: Partial<LeadResponse_phoneIdentity> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
9535
9843
|
/**
|
|
9536
9844
|
* Serializes information the current object
|
|
9537
9845
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
@@ -9749,6 +10057,55 @@ export declare function serializePhone(writer: SerializationWriter, phone?: Part
|
|
|
9749
10057
|
* @param writer Serialization writer to use to serialize this model
|
|
9750
10058
|
*/
|
|
9751
10059
|
export declare function serializePhoneCallResponse(writer: SerializationWriter, phoneCallResponse?: Partial<PhoneCallResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
10060
|
+
/**
|
|
10061
|
+
* Serializes information the current object
|
|
10062
|
+
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
10063
|
+
* @param PhoneIdentityResponse The instance to serialize from.
|
|
10064
|
+
* @param writer Serialization writer to use to serialize this model
|
|
10065
|
+
*/
|
|
10066
|
+
export declare function serializePhoneIdentityResponse(writer: SerializationWriter, phoneIdentityResponse?: Partial<PhoneIdentityResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
10067
|
+
/**
|
|
10068
|
+
* Serializes information the current object
|
|
10069
|
+
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
10070
|
+
* @param PhoneIdentityResponse_lookup The instance to serialize from.
|
|
10071
|
+
* @param writer Serialization writer to use to serialize this model
|
|
10072
|
+
*/
|
|
10073
|
+
export declare function serializePhoneIdentityResponse_lookup(writer: SerializationWriter, phoneIdentityResponse_lookup?: Partial<PhoneIdentityResponse_lookup> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
10074
|
+
/**
|
|
10075
|
+
* Serializes information the current object
|
|
10076
|
+
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
10077
|
+
* @param PhoneLocationSource The instance to serialize from.
|
|
10078
|
+
* @param writer Serialization writer to use to serialize this model
|
|
10079
|
+
*/
|
|
10080
|
+
export declare function serializePhoneLocationSource(writer: SerializationWriter, phoneLocationSource?: Partial<PhoneLocationSource> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
10081
|
+
/**
|
|
10082
|
+
* Serializes information the current object
|
|
10083
|
+
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
10084
|
+
* @param PhoneLookup The instance to serialize from.
|
|
10085
|
+
* @param writer Serialization writer to use to serialize this model
|
|
10086
|
+
*/
|
|
10087
|
+
export declare function serializePhoneLookup(writer: SerializationWriter, phoneLookup?: Partial<PhoneLookup> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
10088
|
+
/**
|
|
10089
|
+
* Serializes information the current object
|
|
10090
|
+
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
10091
|
+
* @param PhoneLookup_carrier The instance to serialize from.
|
|
10092
|
+
* @param writer Serialization writer to use to serialize this model
|
|
10093
|
+
*/
|
|
10094
|
+
export declare function serializePhoneLookup_carrier(writer: SerializationWriter, phoneLookup_carrier?: Partial<PhoneLookup_carrier> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
10095
|
+
/**
|
|
10096
|
+
* Serializes information the current object
|
|
10097
|
+
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
10098
|
+
* @param PhoneLookup_location The instance to serialize from.
|
|
10099
|
+
* @param writer Serialization writer to use to serialize this model
|
|
10100
|
+
*/
|
|
10101
|
+
export declare function serializePhoneLookup_location(writer: SerializationWriter, phoneLookup_location?: Partial<PhoneLookup_location> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
10102
|
+
/**
|
|
10103
|
+
* Serializes information the current object
|
|
10104
|
+
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
10105
|
+
* @param PhoneLookupCarrier The instance to serialize from.
|
|
10106
|
+
* @param writer Serialization writer to use to serialize this model
|
|
10107
|
+
*/
|
|
10108
|
+
export declare function serializePhoneLookupCarrier(writer: SerializationWriter, phoneLookupCarrier?: Partial<PhoneLookupCarrier> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
9752
10109
|
/**
|
|
9753
10110
|
* Serializes information the current object
|
|
9754
10111
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
@@ -9784,6 +10141,20 @@ export declare function serializePhoneNumberLocation(writer: SerializationWriter
|
|
|
9784
10141
|
* @param writer Serialization writer to use to serialize this model
|
|
9785
10142
|
*/
|
|
9786
10143
|
export declare function serializePhoneNumberLocation_coordinate(writer: SerializationWriter, phoneNumberLocation_coordinate?: Partial<PhoneNumberLocation_coordinate> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
10144
|
+
/**
|
|
10145
|
+
* Serializes information the current object
|
|
10146
|
+
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
10147
|
+
* @param PhoneNumberLocation_coordinateSource The instance to serialize from.
|
|
10148
|
+
* @param writer Serialization writer to use to serialize this model
|
|
10149
|
+
*/
|
|
10150
|
+
export declare function serializePhoneNumberLocation_coordinateSource(writer: SerializationWriter, phoneNumberLocation_coordinateSource?: Partial<PhoneNumberLocation_coordinateSource> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
10151
|
+
/**
|
|
10152
|
+
* Serializes information the current object
|
|
10153
|
+
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
10154
|
+
* @param PhoneNumberLocation_timeZoneSource The instance to serialize from.
|
|
10155
|
+
* @param writer Serialization writer to use to serialize this model
|
|
10156
|
+
*/
|
|
10157
|
+
export declare function serializePhoneNumberLocation_timeZoneSource(writer: SerializationWriter, phoneNumberLocation_timeZoneSource?: Partial<PhoneNumberLocation_timeZoneSource> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
9787
10158
|
/**
|
|
9788
10159
|
* Serializes information the current object
|
|
9789
10160
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
@@ -12179,6 +12550,10 @@ export interface UserRequest extends AdditionalDataHolder, Parsable {
|
|
|
12179
12550
|
* Phone details for the lead, user, or business represented by this user profile request.
|
|
12180
12551
|
*/
|
|
12181
12552
|
phone?: string | null;
|
|
12553
|
+
/**
|
|
12554
|
+
* IANA time zone identifier used when displaying dates and times for this user.
|
|
12555
|
+
*/
|
|
12556
|
+
timeZoneId?: string | null;
|
|
12182
12557
|
}
|
|
12183
12558
|
export type UserRequest_billingPlan = (typeof UserRequest_billingPlanObject)[keyof typeof UserRequest_billingPlanObject];
|
|
12184
12559
|
/**
|
|
@@ -12288,6 +12663,10 @@ export interface UserResponse extends AdditionalDataHolder, Parsable {
|
|
|
12288
12663
|
* Defines the supported Subscription Status values.
|
|
12289
12664
|
*/
|
|
12290
12665
|
subscriptionStatus?: UserResponse_subscriptionStatus | null;
|
|
12666
|
+
/**
|
|
12667
|
+
* IANA time zone identifier used when displaying dates and times for this user.
|
|
12668
|
+
*/
|
|
12669
|
+
timeZoneId?: string | null;
|
|
12291
12670
|
}
|
|
12292
12671
|
export type UserResponse_billingPlan = (typeof UserResponse_billingPlanObject)[keyof typeof UserResponse_billingPlanObject];
|
|
12293
12672
|
/**
|
|
@@ -13211,6 +13590,34 @@ export declare const PhoneCallStatusObject: {
|
|
|
13211
13590
|
readonly Blocked_permission: "blocked_permission";
|
|
13212
13591
|
readonly Configuration_required: "configuration_required";
|
|
13213
13592
|
};
|
|
13593
|
+
/**
|
|
13594
|
+
* An enumerator describing phone line types
|
|
13595
|
+
*/
|
|
13596
|
+
export declare const PhoneLookup_lineTypeObject: {
|
|
13597
|
+
readonly Wireline: "Wireline";
|
|
13598
|
+
readonly Wireless: "Wireless";
|
|
13599
|
+
readonly VoWiFi: "VoWiFi";
|
|
13600
|
+
readonly VoIP: "VoIP";
|
|
13601
|
+
readonly PrePaidWireless: "PrePaidWireless";
|
|
13602
|
+
readonly Unknown: "Unknown";
|
|
13603
|
+
};
|
|
13604
|
+
/**
|
|
13605
|
+
* An enumerator describing carrier types
|
|
13606
|
+
*/
|
|
13607
|
+
export declare const PhoneLookupCarrier_typeObject: {
|
|
13608
|
+
readonly FixedLine: "FixedLine";
|
|
13609
|
+
readonly Mobile: "Mobile";
|
|
13610
|
+
readonly Voip: "Voip";
|
|
13611
|
+
readonly FixedLineOrMobile: "FixedLineOrMobile";
|
|
13612
|
+
readonly TollFree: "TollFree";
|
|
13613
|
+
readonly PremiumRate: "PremiumRate";
|
|
13614
|
+
readonly SharedCost: "SharedCost";
|
|
13615
|
+
readonly PersonalNumber: "PersonalNumber";
|
|
13616
|
+
readonly Pager: "Pager";
|
|
13617
|
+
readonly Uan: "Uan";
|
|
13618
|
+
readonly Voicemail: "Voicemail";
|
|
13619
|
+
readonly Unknown: "Unknown";
|
|
13620
|
+
};
|
|
13214
13621
|
/**
|
|
13215
13622
|
* Defines phone-number outbound health states used by pacing.
|
|
13216
13623
|
*/
|
|
@@ -13224,6 +13631,16 @@ export declare const PhoneNumberOutboundHealthStatusObject: {
|
|
|
13224
13631
|
readonly Suspended: "suspended";
|
|
13225
13632
|
readonly Disabled: "disabled";
|
|
13226
13633
|
};
|
|
13634
|
+
/**
|
|
13635
|
+
* Defines the supported voice call warmup stages for a Leadping-managed phone number.
|
|
13636
|
+
*/
|
|
13637
|
+
export declare const PhoneNumberReadiness_callStageObject: {
|
|
13638
|
+
readonly Stage0: "Stage 0";
|
|
13639
|
+
readonly Stage1: "Stage 1";
|
|
13640
|
+
readonly Stage2: "Stage 2";
|
|
13641
|
+
readonly Stage3: "Stage 3";
|
|
13642
|
+
readonly Stage4: "Stage 4";
|
|
13643
|
+
};
|
|
13227
13644
|
/**
|
|
13228
13645
|
* Defines the supported SMS readiness health assessments.
|
|
13229
13646
|
*/
|