@leadping/sdk 1.0.40 → 1.0.42

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.
@@ -101,7 +101,7 @@ export interface ActivationTimelineEvent extends AdditionalDataHolder, Parsable
101
101
  export interface ActivationTimelineEvent_actor extends IdNamePair, Parsable {
102
102
  }
103
103
  /**
104
- * Represents analytics comparison data exposed by Leadping analytics.
104
+ * Compares a metric with the preceding period and reports its absolute and percentage change.
105
105
  */
106
106
  export interface AnalyticsComparison extends AdditionalDataHolder, Parsable {
107
107
  /**
@@ -122,7 +122,7 @@ export interface AnalyticsComparison extends AdditionalDataHolder, Parsable {
122
122
  previous?: number | null;
123
123
  }
124
124
  /**
125
- * Represents analytics date range data exposed by Leadping analytics.
125
+ * Defines the inclusive reporting window and comparison window used to calculate Leadping analytics.
126
126
  */
127
127
  export interface AnalyticsDateRange extends AdditionalDataHolder, Parsable {
128
128
  /**
@@ -139,7 +139,7 @@ export interface AnalyticsDateRange extends AdditionalDataHolder, Parsable {
139
139
  startAt?: Date | null;
140
140
  }
141
141
  /**
142
- * Represents analytics trend point data exposed by Leadping analytics.
142
+ * Associates a typed analytics value with one normalized time bucket in a trend series.
143
143
  */
144
144
  export interface AnalyticsTrendPointOfdecimal extends AdditionalDataHolder, Parsable {
145
145
  /**
@@ -160,7 +160,7 @@ export interface AnalyticsTrendPointOfdecimal extends AdditionalDataHolder, Pars
160
160
  value?: number | null;
161
161
  }
162
162
  /**
163
- * Represents analytics trend point data exposed by Leadping analytics.
163
+ * Associates a typed analytics value with one normalized time bucket in a trend series.
164
164
  */
165
165
  export interface AnalyticsTrendPointOfint extends AdditionalDataHolder, Parsable {
166
166
  /**
@@ -1190,7 +1190,7 @@ export interface CallEventTableRow extends AdditionalDataHolder, Parsable {
1190
1190
  */
1191
1191
  recordingUrl?: string | null;
1192
1192
  /**
1193
- * Defines the supported Phone Call Status values.
1193
+ * Describes the durable business outcome of a Leadping phone call after provider status normalization.
1194
1194
  */
1195
1195
  status?: CallEventTableRow_status | null;
1196
1196
  /**
@@ -3057,7 +3057,7 @@ export interface CurrentLeadStatusSummary extends AdditionalDataHolder, Parsable
3057
3057
  export type CurrentLeadStatusSummary_category = (typeof CurrentLeadStatusSummary_categoryObject)[keyof typeof CurrentLeadStatusSummary_categoryObject];
3058
3058
  export type CurrentLeadStatusSummary_source = (typeof CurrentLeadStatusSummary_sourceObject)[keyof typeof CurrentLeadStatusSummary_sourceObject];
3059
3059
  /**
3060
- * Represents customer activation health data exposed by Leadping analytics.
3060
+ * Summarizes an organization's progress and blockers across onboarding, billing, telephony, compliance, and launch readiness.
3061
3061
  */
3062
3062
  export interface CustomerActivationHealth extends AdditionalDataHolder, Parsable {
3063
3063
  /**
@@ -3070,7 +3070,7 @@ export interface CustomerActivationHealth extends AdditionalDataHolder, Parsable
3070
3070
  overallStatus?: string | null;
3071
3071
  }
3072
3072
  /**
3073
- * Represents customer activation health item data exposed by Leadping analytics.
3073
+ * Describes the state, severity, and recommended next action for one organization activation requirement.
3074
3074
  */
3075
3075
  export interface CustomerActivationHealthItem extends AdditionalDataHolder, Parsable {
3076
3076
  /**
@@ -3096,7 +3096,7 @@ export interface CustomerActivationHealthItem extends AdditionalDataHolder, Pars
3096
3096
  }
3097
3097
  export type CustomerActivationStatus = (typeof CustomerActivationStatusObject)[keyof typeof CustomerActivationStatusObject];
3098
3098
  /**
3099
- * Response model containing customer analytics data returned by the Leadping API.
3099
+ * Aggregates an organization's lead performance, response speed, communication usage, automation health, and activation insights.
3100
3100
  */
3101
3101
  export interface CustomerAnalyticsResponse extends AdditionalDataHolder, Parsable {
3102
3102
  /**
@@ -3141,7 +3141,7 @@ export interface CustomerAnalyticsResponse extends AdditionalDataHolder, Parsabl
3141
3141
  summary?: CustomerAnalyticsSummary | null;
3142
3142
  }
3143
3143
  /**
3144
- * Represents customer analytics summary data exposed by Leadping analytics.
3144
+ * Summarizes an organization's primary lead, response, communication, and conversion KPIs for the selected period.
3145
3145
  */
3146
3146
  export interface CustomerAnalyticsSummary extends AdditionalDataHolder, Parsable {
3147
3147
  /**
@@ -3214,7 +3214,7 @@ export interface CustomerAnalyticsSummary extends AdditionalDataHolder, Parsable
3214
3214
  walletStatus?: string | null;
3215
3215
  }
3216
3216
  /**
3217
- * Represents customer automation health data exposed by Leadping analytics.
3217
+ * Summarizes automation coverage, execution success, failures, and workflows requiring organization attention.
3218
3218
  */
3219
3219
  export interface CustomerAutomationHealth extends AdditionalDataHolder, Parsable {
3220
3220
  /**
@@ -3252,7 +3252,7 @@ export interface CustomerAutomationHealth extends AdditionalDataHolder, Parsable
3252
3252
  export interface CustomerAutomationHealth_lastFailure extends CustomerFailingAutomation, Parsable {
3253
3253
  }
3254
3254
  /**
3255
- * Represents customer communication usage data exposed by Leadping analytics.
3255
+ * Aggregates an organization's SMS, MMS, and calling activity, delivery outcomes, and billable usage over time.
3256
3256
  */
3257
3257
  export interface CustomerCommunicationUsage extends AdditionalDataHolder, Parsable {
3258
3258
  /**
@@ -3297,7 +3297,7 @@ export interface CustomerCommunicationUsage extends AdditionalDataHolder, Parsab
3297
3297
  usageSpend?: number | null;
3298
3298
  }
3299
3299
  /**
3300
- * Represents customer communication usage point data exposed by Leadping analytics.
3300
+ * Measures organization messaging and calling activity within one analytics time bucket.
3301
3301
  */
3302
3302
  export interface CustomerCommunicationUsagePoint extends AdditionalDataHolder, Parsable {
3303
3303
  /**
@@ -3334,7 +3334,7 @@ export interface CustomerCommunicationUsagePoint extends AdditionalDataHolder, P
3334
3334
  startAt?: Date | null;
3335
3335
  }
3336
3336
  /**
3337
- * Represents customer failing automation data exposed by Leadping analytics.
3337
+ * Identifies an automation with recent execution failures and summarizes its affected leads and failure context.
3338
3338
  */
3339
3339
  export interface CustomerFailingAutomation extends AdditionalDataHolder, Parsable {
3340
3340
  /**
@@ -3355,7 +3355,7 @@ export interface CustomerFailingAutomation extends AdditionalDataHolder, Parsabl
3355
3355
  name?: string | null;
3356
3356
  }
3357
3357
  /**
3358
- * Represents customer lead source breakdown data exposed by Leadping analytics.
3358
+ * Attributes an organization's lead volume, qualification, and conversion outcomes to a specific acquisition source.
3359
3359
  */
3360
3360
  export interface CustomerLeadSourceBreakdown extends AdditionalDataHolder, Parsable {
3361
3361
  /**
@@ -3372,7 +3372,7 @@ export interface CustomerLeadSourceBreakdown extends AdditionalDataHolder, Parsa
3372
3372
  source?: string | null;
3373
3373
  }
3374
3374
  /**
3375
- * Represents customer lead trend data exposed by Leadping analytics.
3375
+ * Measures lead creation, qualification, and conversion activity within one reporting time bucket.
3376
3376
  */
3377
3377
  export interface CustomerLeadTrend extends AdditionalDataHolder, Parsable {
3378
3378
  /**
@@ -3389,7 +3389,7 @@ export interface CustomerLeadTrend extends AdditionalDataHolder, Parsable {
3389
3389
  total?: number | null;
3390
3390
  }
3391
3391
  /**
3392
- * Represents customer needs attention item data exposed by Leadping analytics.
3392
+ * Identifies an organization-level issue or opportunity and provides severity, supporting context, and a recommended action.
3393
3393
  */
3394
3394
  export interface CustomerNeedsAttentionItem extends AdditionalDataHolder, Parsable {
3395
3395
  /**
@@ -3414,7 +3414,7 @@ export interface CustomerNeedsAttentionItem extends AdditionalDataHolder, Parsab
3414
3414
  title?: string | null;
3415
3415
  }
3416
3416
  /**
3417
- * Represents customer response metrics data exposed by Leadping analytics.
3417
+ * Measures how quickly and consistently an organization responds to leads across supported communication channels.
3418
3418
  */
3419
3419
  export interface CustomerResponseMetrics extends AdditionalDataHolder, Parsable {
3420
3420
  /**
@@ -5061,7 +5061,7 @@ export interface EligibleOutgoingNumberResponse extends AdditionalDataHolder, Pa
5061
5061
  */
5062
5062
  healthLabel?: string | null;
5063
5063
  /**
5064
- * Defines the supported SMS readiness health assessments.
5064
+ * Summarizes the severity of conditions affecting an organization's ability to send compliant SMS or MMS traffic.
5065
5065
  */
5066
5066
  healthStatus?: EligibleOutgoingNumberResponse_healthStatus | null;
5067
5067
  /**
@@ -5195,7 +5195,7 @@ export interface EventDetailResponse extends AdditionalDataHolder, Parsable {
5195
5195
  */
5196
5196
  sentAt?: Date | null;
5197
5197
  /**
5198
- * Defines the supported Event status values.
5198
+ * Describes whether a Leadping event is pending, processing, completed, failed, or otherwise resolved.
5199
5199
  */
5200
5200
  status?: EventDetailResponse_status | null;
5201
5201
  /**
@@ -5211,7 +5211,7 @@ export interface EventDetailResponse extends AdditionalDataHolder, Parsable {
5211
5211
  */
5212
5212
  timelineCategory?: string | null;
5213
5213
  /**
5214
- * Defines the supported Event timeline type values.
5214
+ * Classifies the kind of activity displayed in a lead or conversation event timeline.
5215
5215
  */
5216
5216
  timelineType?: EventDetailResponse_timelineType | null;
5217
5217
  /**
@@ -5383,7 +5383,7 @@ export interface EventTableRow extends AdditionalDataHolder, Parsable {
5383
5383
  */
5384
5384
  scheduledReason?: string | null;
5385
5385
  /**
5386
- * Defines the supported Outgoing Number Selection Reason values.
5386
+ * Explains why Leadping selected, rejected, or substituted an outgoing caller or messaging number.
5387
5387
  */
5388
5388
  selectionReason?: EventTableRow_selectionReason | null;
5389
5389
  /**
@@ -5399,7 +5399,7 @@ export interface EventTableRow extends AdditionalDataHolder, Parsable {
5399
5399
  */
5400
5400
  sourceId?: string | null;
5401
5401
  /**
5402
- * Defines the supported Event timeline status values.
5402
+ * Provides the customer-facing outcome shown for an item in a lead or conversation timeline.
5403
5403
  */
5404
5404
  status?: EventTableRow_status | null;
5405
5405
  /**
@@ -5423,7 +5423,7 @@ export interface EventTableRow extends AdditionalDataHolder, Parsable {
5423
5423
  */
5424
5424
  toPhoneNumber?: string | null;
5425
5425
  /**
5426
- * Defines the supported SMS Traffic Type values.
5426
+ * Classifies messaging traffic by conversational, informational, marketing, or other compliance-relevant purpose.
5427
5427
  */
5428
5428
  trafficType?: EventTableRow_trafficType | null;
5429
5429
  /**
@@ -5979,11 +5979,11 @@ export interface LeadProfile extends AdditionalDataHolder, Parsable {
5979
5979
  */
5980
5980
  creditScore?: number | null;
5981
5981
  /**
5982
- * Defines the supported Employment Type values.
5982
+ * Classifies a lead's reported employment arrangement for qualification and demographic workflows.
5983
5983
  */
5984
5984
  employmentType?: LeadProfile_employmentType | null;
5985
5985
  /**
5986
- * Represents a gender classification used for demographic or identification purposes.
5986
+ * Classifies a lead's self-reported gender when required by a qualification, demographic, or integration workflow.
5987
5987
  */
5988
5988
  gender?: LeadProfile_gender | null;
5989
5989
  /**
@@ -6007,7 +6007,7 @@ export interface LeadProfile extends AdditionalDataHolder, Parsable {
6007
6007
  */
6008
6008
  isHomeowner?: boolean | null;
6009
6009
  /**
6010
- * Defines the supported Marital Status Type values.
6010
+ * Classifies a lead's reported marital status when required by a qualification or integration workflow.
6011
6011
  */
6012
6012
  maritalStatus?: LeadProfile_maritalStatus | null;
6013
6013
  /**
@@ -6289,7 +6289,7 @@ export interface LeadStatusChangeExportRow extends AdditionalDataHolder, Parsabl
6289
6289
  export type LeadStatusChangeExportRow_category = (typeof LeadStatusChangeExportRow_categoryObject)[keyof typeof LeadStatusChangeExportRow_categoryObject];
6290
6290
  export type LeadStatusChangeExportRow_changeSource = (typeof LeadStatusChangeExportRow_changeSourceObject)[keyof typeof LeadStatusChangeExportRow_changeSourceObject];
6291
6291
  /**
6292
- * Request model for creating or updating a lead status change.
6292
+ * Defines a lead status transition or correction, including its target status, effective time, source, and explanatory context.
6293
6293
  */
6294
6294
  export interface LeadStatusChangeRequest extends AdditionalDataHolder, Parsable {
6295
6295
  /**
@@ -6368,7 +6368,7 @@ export interface LeadStatusChangeRequest extends AdditionalDataHolder, Parsable
6368
6368
  export type LeadStatusChangeRequest_category = (typeof LeadStatusChangeRequest_categoryObject)[keyof typeof LeadStatusChangeRequest_categoryObject];
6369
6369
  export type LeadStatusChangeRequest_changeSource = (typeof LeadStatusChangeRequest_changeSourceObject)[keyof typeof LeadStatusChangeRequest_changeSourceObject];
6370
6370
  /**
6371
- * Response model for lead status change data.
6371
+ * Describes an auditable lead status transition, including the previous and new status, source, actor, and effective time.
6372
6372
  */
6373
6373
  export interface LeadStatusChangeResponse extends AdditionalDataHolder, Parsable {
6374
6374
  /**
@@ -6513,7 +6513,7 @@ export interface LeadStatusRequest extends AdditionalDataHolder, Parsable {
6513
6513
  }
6514
6514
  export type LeadStatusRequest_category = (typeof LeadStatusRequest_categoryObject)[keyof typeof LeadStatusRequest_categoryObject];
6515
6515
  /**
6516
- * Represents a configurable status that can be assigned to leads.
6516
+ * Describes an organization-defined lead status used to classify pipeline progress, drive automation, and report lifecycle outcomes.
6517
6517
  */
6518
6518
  export interface LeadStatusResponse extends AdditionalDataHolder, Parsable {
6519
6519
  /**
@@ -7087,7 +7087,7 @@ export interface OrganizationBillingState extends AdditionalDataHolder, Parsable
7087
7087
  */
7088
7088
  organizationMemberQuantity?: number | null;
7089
7089
  /**
7090
- * Defines the supported Billing Plan values.
7090
+ * Identifies the Leadping subscription plan that determines organization features, allowances, and billing behavior.
7091
7091
  */
7092
7092
  pendingBillingPlan?: OrganizationBillingState_pendingBillingPlan | null;
7093
7093
  /**
@@ -7548,7 +7548,7 @@ export interface OrganizationRequest extends AdditionalDataHolder, Parsable {
7548
7548
  */
7549
7549
  secondaryName?: string | null;
7550
7550
  /**
7551
- * Defines the supported Organization Status values.
7551
+ * Describes an organization's account lifecycle and whether it can actively use Leadping services.
7552
7552
  */
7553
7553
  status?: OrganizationRequest_status | null;
7554
7554
  /**
@@ -7618,7 +7618,7 @@ export interface OrganizationResponse extends AdditionalDataHolder, Parsable {
7618
7618
  */
7619
7619
  billingName?: string | null;
7620
7620
  /**
7621
- * Defines the supported Billing Plan values.
7621
+ * Identifies the Leadping subscription plan that determines organization features, allowances, and billing behavior.
7622
7622
  */
7623
7623
  billingPlan?: OrganizationResponse_billingPlan | null;
7624
7624
  /**
@@ -7682,11 +7682,11 @@ export interface OrganizationResponse extends AdditionalDataHolder, Parsable {
7682
7682
  */
7683
7683
  secondaryName?: string | null;
7684
7684
  /**
7685
- * Defines the supported User Setup Status values.
7685
+ * Describes a user's progress through required Leadping profile and account setup tasks.
7686
7686
  */
7687
7687
  setupStatus?: OrganizationResponse_setupStatus | null;
7688
7688
  /**
7689
- * Defines the supported Organization Setup Step values.
7689
+ * Identifies a discrete billing, telephony, compliance, or configuration stage in organization provisioning.
7690
7690
  */
7691
7691
  setupStep?: OrganizationResponse_setupStep | null;
7692
7692
  /**
@@ -7694,11 +7694,11 @@ export interface OrganizationResponse extends AdditionalDataHolder, Parsable {
7694
7694
  */
7695
7695
  site?: OrganizationResponse_site | null;
7696
7696
  /**
7697
- * Defines the supported Organization Status values.
7697
+ * Describes an organization's account lifecycle and whether it can actively use Leadping services.
7698
7698
  */
7699
7699
  status?: OrganizationResponse_status | null;
7700
7700
  /**
7701
- * Defines the supported Subscription Status values.
7701
+ * Describes an organization's billing subscription lifecycle, including trial, active, delinquent, canceled, and expired states.
7702
7702
  */
7703
7703
  subscriptionStatus?: OrganizationResponse_subscriptionStatus | null;
7704
7704
  /**
@@ -7764,7 +7764,7 @@ export interface OrganizationResponse_user extends IdNamePair, Parsable {
7764
7764
  */
7765
7765
  export interface OrganizationSwitchOption extends AdditionalDataHolder, Parsable {
7766
7766
  /**
7767
- * Defines the supported Customer Activation Status values.
7767
+ * Summarizes an organization's overall progress from initial Leadping onboarding through launch readiness.
7768
7768
  */
7769
7769
  activationStatus?: OrganizationSwitchOption_activationStatus | null;
7770
7770
  /**
@@ -7796,7 +7796,7 @@ export interface OrganizationSwitchOption extends AdditionalDataHolder, Parsable
7796
7796
  */
7797
7797
  needsAdminReview?: boolean | null;
7798
7798
  /**
7799
- * Defines the supported Organization Status values.
7799
+ * Describes an organization's account lifecycle and whether it can actively use Leadping services.
7800
7800
  */
7801
7801
  organizationStatus?: OrganizationSwitchOption_organizationStatus | null;
7802
7802
  /**
@@ -7808,7 +7808,7 @@ export interface OrganizationSwitchOption extends AdditionalDataHolder, Parsable
7808
7808
  */
7809
7809
  role?: OrganizationMemberRole | null;
7810
7810
  /**
7811
- * Defines the supported 10DLC Application Status values.
7811
+ * Describes an organization's overall 10DLC registration lifecycle across brand and messaging campaign submission.
7812
7812
  */
7813
7813
  tenDlcStatus?: OrganizationSwitchOption_tenDlcStatus | null;
7814
7814
  }
@@ -7833,7 +7833,7 @@ export interface OrganizationTableRow extends AdditionalDataHolder, Parsable {
7833
7833
  */
7834
7834
  accountBalance?: number | null;
7835
7835
  /**
7836
- * Defines the supported Customer Activation Status values.
7836
+ * Summarizes an organization's overall progress from initial Leadping onboarding through launch readiness.
7837
7837
  */
7838
7838
  activationStatus?: OrganizationTableRow_activationStatus | null;
7839
7839
  /**
@@ -7865,7 +7865,7 @@ export interface OrganizationTableRow extends AdditionalDataHolder, Parsable {
7865
7865
  */
7866
7866
  apiKeyTotalUses?: number | null;
7867
7867
  /**
7868
- * Defines the supported Billing Plan values.
7868
+ * Identifies the Leadping subscription plan that determines organization features, allowances, and billing behavior.
7869
7869
  */
7870
7870
  billingPlan?: OrganizationTableRow_billingPlan | null;
7871
7871
  /**
@@ -7909,11 +7909,11 @@ export interface OrganizationTableRow extends AdditionalDataHolder, Parsable {
7909
7909
  */
7910
7910
  phone?: string | null;
7911
7911
  /**
7912
- * Defines the supported Organization Setup Step values.
7912
+ * Identifies a discrete billing, telephony, compliance, or configuration stage in organization provisioning.
7913
7913
  */
7914
7914
  setupStep?: OrganizationTableRow_setupStep | null;
7915
7915
  /**
7916
- * Defines the supported Organization Status values.
7916
+ * Describes an organization's account lifecycle and whether it can actively use Leadping services.
7917
7917
  */
7918
7918
  status?: OrganizationTableRow_status | null;
7919
7919
  /**
@@ -7921,11 +7921,11 @@ export interface OrganizationTableRow extends AdditionalDataHolder, Parsable {
7921
7921
  */
7922
7922
  subscriptionCancelAt?: Date | null;
7923
7923
  /**
7924
- * Defines the supported Subscription Status values.
7924
+ * Describes an organization's billing subscription lifecycle, including trial, active, delinquent, canceled, and expired states.
7925
7925
  */
7926
7926
  subscriptionStatus?: OrganizationTableRow_subscriptionStatus | null;
7927
7927
  /**
7928
- * Defines the supported 10DLC Application Status values.
7928
+ * Describes an organization's overall 10DLC registration lifecycle across brand and messaging campaign submission.
7929
7929
  */
7930
7930
  tenDlcStatus?: OrganizationTableRow_tenDlcStatus | null;
7931
7931
  /**
@@ -7937,7 +7937,7 @@ export interface OrganizationTableRow extends AdditionalDataHolder, Parsable {
7937
7937
  */
7938
7938
  website?: string | null;
7939
7939
  /**
7940
- * Defines the supported Website Lifecycle Status values.
7940
+ * Describes an organization website's lifecycle from discovery and verification through activation, suspension, or removal.
7941
7941
  */
7942
7942
  websiteStatus?: OrganizationTableRow_websiteStatus | null;
7943
7943
  }
@@ -7954,7 +7954,7 @@ export type OrganizationTableRow_subscriptionStatus = (typeof OrganizationTableR
7954
7954
  export type OrganizationTableRow_tenDlcStatus = (typeof OrganizationTableRow_tenDlcStatusObject)[keyof typeof OrganizationTableRow_tenDlcStatusObject];
7955
7955
  export type OrganizationTableRow_websiteStatus = (typeof OrganizationTableRow_websiteStatusObject)[keyof typeof OrganizationTableRow_websiteStatusObject];
7956
7956
  /**
7957
- * Represents outbound capacity overview data used by Leadping.
7957
+ * Summarizes organization-wide SMS and voice sending capacity, phone-number health, and recent outbound pacing decisions.
7958
7958
  */
7959
7959
  export interface OutboundCapacityOverview extends AdditionalDataHolder, Parsable {
7960
7960
  /**
@@ -8002,7 +8002,7 @@ export type OutboundDeliveryChannel = (typeof OutboundDeliveryChannelObject)[key
8002
8002
  export type OutboundDeliverySource = (typeof OutboundDeliverySourceObject)[keyof typeof OutboundDeliverySourceObject];
8003
8003
  export type OutboundDeliveryStatus = (typeof OutboundDeliveryStatusObject)[keyof typeof OutboundDeliveryStatusObject];
8004
8004
  /**
8005
- * Represents outbound phone number capacity data used by Leadping.
8005
+ * Reports the sending capacity, current load, and availability of a phone number considered for outbound delivery.
8006
8006
  */
8007
8007
  export interface OutboundPhoneNumberCapacity extends AdditionalDataHolder, Parsable {
8008
8008
  /**
@@ -8135,7 +8135,7 @@ export interface OutboundPhoneNumberCapacity extends AdditionalDataHolder, Parsa
8135
8135
  voiceUsedToday?: number | null;
8136
8136
  }
8137
8137
  /**
8138
- * Represents outbound queue item data used by Leadping.
8138
+ * Describes a queued or recently evaluated outbound delivery request and the pacing decision that controls when it may be sent.
8139
8139
  */
8140
8140
  export interface OutboundQueueItem extends AdditionalDataHolder, Parsable {
8141
8141
  /**
@@ -8195,7 +8195,7 @@ export interface OutgoingNumberSelectionRequest extends AdditionalDataHolder, Pa
8195
8195
  */
8196
8196
  campaignId?: string | null;
8197
8197
  /**
8198
- * Defines the supported Outgoing Number Channel values.
8198
+ * Identifies whether an outgoing phone number is eligible for voice, SMS, MMS, or another communication channel.
8199
8199
  */
8200
8200
  channel?: OutgoingNumberSelectionRequest_channel | null;
8201
8201
  /**
@@ -8245,7 +8245,7 @@ export interface OutgoingNumberSelectionResponse extends AdditionalDataHolder, P
8245
8245
  */
8246
8246
  healthLabel?: string | null;
8247
8247
  /**
8248
- * Defines the supported SMS readiness health assessments.
8248
+ * Summarizes the severity of conditions affecting an organization's ability to send compliant SMS or MMS traffic.
8249
8249
  */
8250
8250
  healthStatus?: OutgoingNumberSelectionResponse_healthStatus | null;
8251
8251
  /**
@@ -8265,7 +8265,7 @@ export interface OutgoingNumberSelectionResponse extends AdditionalDataHolder, P
8265
8265
  */
8266
8266
  reasonLabel?: string | null;
8267
8267
  /**
8268
- * Defines the supported Outgoing Number Selection Reason values.
8268
+ * Explains why Leadping selected, rejected, or substituted an outgoing caller or messaging number.
8269
8269
  */
8270
8270
  selectionReason?: OutgoingNumberSelectionResponse_selectionReason | null;
8271
8271
  /**
@@ -8679,7 +8679,7 @@ export interface PhoneCallResponse extends AdditionalDataHolder, Parsable {
8679
8679
  */
8680
8680
  ringingAt?: Date | null;
8681
8681
  /**
8682
- * Defines the supported Outgoing Number Selection Reason values.
8682
+ * Explains why Leadping selected, rejected, or substituted an outgoing caller or messaging number.
8683
8683
  */
8684
8684
  selectionReason?: PhoneCallResponse_selectionReason | null;
8685
8685
  /**
@@ -8730,11 +8730,11 @@ export interface PhoneIdentityLookupAction extends AdditionalDataHolder, Parsabl
8730
8730
  */
8731
8731
  providerPricingVersion?: string | null;
8732
8732
  /**
8733
- * Identifies the outcome of a phone identity lookup action.
8733
+ * The processing outcome reported for the phone identity lookup.
8734
8734
  */
8735
8735
  status?: PhoneIdentityLookupActionStatus | null;
8736
8736
  /**
8737
- * Identifies the kind of lookup action performed for a phone identity.
8737
+ * The category of enrichment, validation, or reputation lookup that was performed.
8738
8738
  */
8739
8739
  type?: PhoneIdentityLookupActionType | null;
8740
8740
  }
@@ -9174,7 +9174,7 @@ export type PhoneNumberOutboundHealthStatus = (typeof PhoneNumberOutboundHealthS
9174
9174
  */
9175
9175
  export interface PhoneNumberReadiness extends AdditionalDataHolder, Parsable {
9176
9176
  /**
9177
- * Defines the supported voice call warmup stages for a Leadping-managed phone number.
9177
+ * Identifies the current traffic-ramp stage of controlled voice warmup for a Leadping-managed phone number.
9178
9178
  */
9179
9179
  callStage?: PhoneNumberReadiness_callStage | null;
9180
9180
  /**
@@ -9186,7 +9186,7 @@ export interface PhoneNumberReadiness extends AdditionalDataHolder, Parsable {
9186
9186
  */
9187
9187
  healthScore?: number | null;
9188
9188
  /**
9189
- * Defines the supported SMS readiness health assessments.
9189
+ * Summarizes the severity of conditions affecting an organization's ability to send compliant SMS or MMS traffic.
9190
9190
  */
9191
9191
  healthStatus?: PhoneNumberReadiness_healthStatus | null;
9192
9192
  /**
@@ -9194,7 +9194,7 @@ export interface PhoneNumberReadiness extends AdditionalDataHolder, Parsable {
9194
9194
  */
9195
9195
  progressPercent?: number | null;
9196
9196
  /**
9197
- * Defines the supported SMS readiness states.
9197
+ * Describes whether an organization is configured and permitted to send SMS or MMS traffic through Leadping.
9198
9198
  */
9199
9199
  state?: PhoneNumberReadiness_state | null;
9200
9200
  }
@@ -11730,7 +11730,7 @@ export interface SmsEventTableRow extends AdditionalDataHolder, Parsable {
11730
11730
  */
11731
11731
  sentAt?: Date | null;
11732
11732
  /**
11733
- * Defines the supported SMS Message Status values.
11733
+ * Describes the normalized lifecycle of an SMS or MMS message from scheduling through delivery or failure.
11734
11734
  */
11735
11735
  status?: SmsEventTableRow_status | null;
11736
11736
  /**
@@ -11746,7 +11746,7 @@ export interface SmsEventTableRow extends AdditionalDataHolder, Parsable {
11746
11746
  */
11747
11747
  toPhoneNumber?: string | null;
11748
11748
  /**
11749
- * Defines the supported SMS Traffic Type values.
11749
+ * Classifies messaging traffic by conversational, informational, marketing, or other compliance-relevant purpose.
11750
11750
  */
11751
11751
  trafficType?: SmsEventTableRow_trafficType | null;
11752
11752
  /**
@@ -11934,7 +11934,7 @@ export interface SmsResponse extends AdditionalDataHolder, Parsable {
11934
11934
  */
11935
11935
  scheduledReason?: string | null;
11936
11936
  /**
11937
- * Defines the supported Outgoing Number Selection Reason values.
11937
+ * Explains why Leadping selected, rejected, or substituted an outgoing caller or messaging number.
11938
11938
  */
11939
11939
  selectionReason?: SmsResponse_selectionReason | null;
11940
11940
  /**
@@ -11950,7 +11950,7 @@ export interface SmsResponse extends AdditionalDataHolder, Parsable {
11950
11950
  */
11951
11951
  sourceId?: string | null;
11952
11952
  /**
11953
- * Defines the supported SMS Message Status values.
11953
+ * Describes the normalized lifecycle of an SMS or MMS message from scheduling through delivery or failure.
11954
11954
  */
11955
11955
  status?: SmsResponse_status | null;
11956
11956
  /**
@@ -11962,7 +11962,7 @@ export interface SmsResponse extends AdditionalDataHolder, Parsable {
11962
11962
  */
11963
11963
  text?: string | null;
11964
11964
  /**
11965
- * Defines the supported SMS Traffic Type values.
11965
+ * Classifies messaging traffic by conversational, informational, marketing, or other compliance-relevant purpose.
11966
11966
  */
11967
11967
  trafficType?: SmsResponse_trafficType | null;
11968
11968
  /**
@@ -11978,7 +11978,7 @@ export type SmsResponse_selectionReason = (typeof SmsResponse_selectionReasonObj
11978
11978
  export type SmsResponse_status = (typeof SmsResponse_statusObject)[keyof typeof SmsResponse_statusObject];
11979
11979
  export type SmsResponse_trafficType = (typeof SmsResponse_trafficTypeObject)[keyof typeof SmsResponse_trafficTypeObject];
11980
11980
  /**
11981
- * Response model containing source metrics data returned by the Leadping API.
11981
+ * Aggregates lead volume, conversion, delivery, and activity metrics attributed to a Leadping source over the requested reporting period.
11982
11982
  */
11983
11983
  export interface SourceMetricsResponse extends AdditionalDataHolder, Parsable {
11984
11984
  /**
@@ -12645,7 +12645,7 @@ export interface TagSummary extends AdditionalDataHolder, Parsable {
12645
12645
  normalizedName?: string | null;
12646
12646
  }
12647
12647
  /**
12648
- * Request model for telephony login token generation.
12648
+ * Identifies the Leadping user and calling context for which a short-lived telephony client token should be issued.
12649
12649
  */
12650
12650
  export interface TelephonyLoginRequest extends AdditionalDataHolder, Parsable {
12651
12651
  /**
@@ -12659,7 +12659,7 @@ export interface TelephonyLoginRequest extends AdditionalDataHolder, Parsable {
12659
12659
  export interface TelephonyLoginRequest_device extends IdNamePair, Parsable {
12660
12660
  }
12661
12661
  /**
12662
- * Response model for telephony login token generation.
12662
+ * Provides the short-lived access token and client configuration required to initialize an authenticated Leadping calling session.
12663
12663
  */
12664
12664
  export interface TelephonyLoginResponse extends AdditionalDataHolder, Parsable {
12665
12665
  /**
@@ -12796,7 +12796,7 @@ export interface TransactionResponse extends AdditionalDataHolder, Parsable {
12796
12796
  */
12797
12797
  amount?: number | null;
12798
12798
  /**
12799
- * Defines the supported Billable Unit values.
12799
+ * Identifies the metered unit used to price Leadping usage, such as a message, call minute, lookup, or phone number.
12800
12800
  */
12801
12801
  billableUnit?: TransactionResponse_billableUnit | null;
12802
12802
  /**
@@ -12804,7 +12804,7 @@ export interface TransactionResponse extends AdditionalDataHolder, Parsable {
12804
12804
  */
12805
12805
  billedAmount?: number | null;
12806
12806
  /**
12807
- * Defines the supported Usage Channel values.
12807
+ * Identifies the messaging, calling, phone-number, lookup, or platform channel that generated billable usage.
12808
12808
  */
12809
12809
  billingChannel?: TransactionResponse_billingChannel | null;
12810
12810
  /**
@@ -12886,7 +12886,7 @@ export interface TransactionTableRow extends AdditionalDataHolder, Parsable {
12886
12886
  */
12887
12887
  amount?: number | null;
12888
12888
  /**
12889
- * Defines the supported Billable Unit values.
12889
+ * Identifies the metered unit used to price Leadping usage, such as a message, call minute, lookup, or phone number.
12890
12890
  */
12891
12891
  billableUnit?: TransactionTableRow_billableUnit | null;
12892
12892
  /**
@@ -12894,7 +12894,7 @@ export interface TransactionTableRow extends AdditionalDataHolder, Parsable {
12894
12894
  */
12895
12895
  billedAmount?: number | null;
12896
12896
  /**
12897
- * Defines the supported Usage Channel values.
12897
+ * Identifies the messaging, calling, phone-number, lookup, or platform channel that generated billable usage.
12898
12898
  */
12899
12899
  billingChannel?: TransactionTableRow_billingChannel | null;
12900
12900
  /**
@@ -13207,7 +13207,7 @@ export interface UserCompliance extends AdditionalDataHolder, Parsable {
13207
13207
  trustedFormCertificates?: TrustedFormCertificate[] | null;
13208
13208
  }
13209
13209
  /**
13210
- * Response model containing user data export file data returned by the Leadping API.
13210
+ * Describes a file included in a user-data export, including its logical category, media type, size, and integrity metadata.
13211
13211
  */
13212
13212
  export interface UserDataExportFile extends AdditionalDataHolder, Parsable {
13213
13213
  /**
@@ -13228,7 +13228,7 @@ export interface UserDataExportFile extends AdditionalDataHolder, Parsable {
13228
13228
  rowCount?: number | null;
13229
13229
  }
13230
13230
  /**
13231
- * Response model containing user data export data returned by the Leadping API.
13231
+ * Describes the lifecycle, scope, progress, retention, and downloadable artifacts of a Leadping user-data export request.
13232
13232
  */
13233
13233
  export interface UserDataExportResponse extends AdditionalDataHolder, Parsable {
13234
13234
  /**
@@ -13294,7 +13294,7 @@ export interface UserDataExportResponse extends AdditionalDataHolder, Parsable {
13294
13294
  }
13295
13295
  export type UserDataExportStatuses = (typeof UserDataExportStatusesObject)[keyof typeof UserDataExportStatusesObject];
13296
13296
  /**
13297
- * Represents a user's sign-in identity, including information about the identity provider and method of authentication.
13297
+ * Identifies an external sign-in identity linked to a Leadping user, including its provider, provider-assigned user identifier, and authentication method.
13298
13298
  */
13299
13299
  export interface UserIdentity extends AdditionalDataHolder, Parsable {
13300
13300
  /**
@@ -13433,7 +13433,7 @@ export interface UserNotificationPreferences_smsConsentTrustedFormCertificate ex
13433
13433
  */
13434
13434
  export interface UserRequest extends AdditionalDataHolder, Parsable {
13435
13435
  /**
13436
- * Defines the supported Billing Plan values.
13436
+ * Identifies the Leadping subscription plan that determines organization features, allowances, and billing behavior.
13437
13437
  */
13438
13438
  billingPlan?: UserRequest_billingPlan | null;
13439
13439
  /**
@@ -13502,7 +13502,7 @@ export interface UserRequest_notificationPreferences extends Parsable, UserNotif
13502
13502
  */
13503
13503
  export interface UserResponse extends AdditionalDataHolder, Parsable {
13504
13504
  /**
13505
- * Defines the supported Billing Plan values.
13505
+ * Identifies the Leadping subscription plan that determines organization features, allowances, and billing behavior.
13506
13506
  */
13507
13507
  billingPlan?: UserResponse_billingPlan | null;
13508
13508
  /**
@@ -13586,7 +13586,7 @@ export interface UserResponse extends AdditionalDataHolder, Parsable {
13586
13586
  */
13587
13587
  roles?: string[] | null;
13588
13588
  /**
13589
- * Defines the supported Subscription Status values.
13589
+ * Describes an organization's billing subscription lifecycle, including trial, active, delinquent, canceled, and expired states.
13590
13590
  */
13591
13591
  subscriptionStatus?: UserResponse_subscriptionStatus | null;
13592
13592
  /**
@@ -13697,7 +13697,7 @@ export type WalletResponse_creditStatus = (typeof WalletResponse_creditStatusObj
13697
13697
  export type WalletResponse_sourceType = (typeof WalletResponse_sourceTypeObject)[keyof typeof WalletResponse_sourceTypeObject];
13698
13698
  export type WebsiteLifecycleStatus = (typeof WebsiteLifecycleStatusObject)[keyof typeof WebsiteLifecycleStatusObject];
13699
13699
  /**
13700
- * Defines the supported Activation Launch Review Status values.
13700
+ * Describes the administrative review decision that determines whether an organization can launch Leadping workflows.
13701
13701
  */
13702
13702
  export declare const ActivationLaunchReviewStatusObject: {
13703
13703
  readonly NotReady: "NotReady";
@@ -13707,7 +13707,7 @@ export declare const ActivationLaunchReviewStatusObject: {
13707
13707
  readonly Blocked: "Blocked";
13708
13708
  };
13709
13709
  /**
13710
- * Defines the supported Activation Onboarding Status values.
13710
+ * Describes completion and blocking state for an organization's core Leadping onboarding requirements.
13711
13711
  */
13712
13712
  export declare const ActivationOnboardingStatusObject: {
13713
13713
  readonly Draft: "Draft";
@@ -13715,7 +13715,7 @@ export declare const ActivationOnboardingStatusObject: {
13715
13715
  readonly Failed: "Failed";
13716
13716
  };
13717
13717
  /**
13718
- * Defines the supported Activation Payment Status values.
13718
+ * Describes whether valid funding and payment prerequisites are satisfied during organization activation.
13719
13719
  */
13720
13720
  export declare const ActivationPaymentStatusObject: {
13721
13721
  readonly PaymentMethodPending: "PaymentMethodPending";
@@ -13723,7 +13723,7 @@ export declare const ActivationPaymentStatusObject: {
13723
13723
  readonly Failed: "Failed";
13724
13724
  };
13725
13725
  /**
13726
- * Defines the supported Activation Subscription Status values.
13726
+ * Describes whether an organization's subscription is ready, blocked, or still incomplete during activation.
13727
13727
  */
13728
13728
  export declare const ActivationSubscriptionStatusObject: {
13729
13729
  readonly Pending: "Pending";
@@ -13732,7 +13732,7 @@ export declare const ActivationSubscriptionStatusObject: {
13732
13732
  readonly Canceled: "Canceled";
13733
13733
  };
13734
13734
  /**
13735
- * Defines the supported Activation Telephony Status values.
13735
+ * Describes whether phone numbers, calling, messaging, and provider resources are ready for organization launch.
13736
13736
  */
13737
13737
  export declare const ActivationTelephonyStatusObject: {
13738
13738
  readonly NotStarted: "NotStarted";
@@ -13743,7 +13743,7 @@ export declare const ActivationTelephonyStatusObject: {
13743
13743
  readonly BlockedRequiresOperatorAction: "BlockedRequiresOperatorAction";
13744
13744
  };
13745
13745
  /**
13746
- * Defines the supported Billable Unit values.
13746
+ * Identifies the metered unit used to price Leadping usage, such as a message, call minute, lookup, or phone number.
13747
13747
  */
13748
13748
  export declare const BillableUnitObject: {
13749
13749
  readonly Lead_received: "lead_received";
@@ -13765,14 +13765,14 @@ export declare const BillableUnitObject: {
13765
13765
  readonly Automation_run: "automation_run";
13766
13766
  };
13767
13767
  /**
13768
- * Defines the supported Billing Plan values.
13768
+ * Identifies the Leadping subscription plan that determines organization features, allowances, and billing behavior.
13769
13769
  */
13770
13770
  export declare const BillingPlanObject: {
13771
13771
  readonly Annual: "Annual";
13772
13772
  readonly Monthly: "Monthly";
13773
13773
  };
13774
13774
  /**
13775
- * Defines the supported Phone Call Status values.
13775
+ * Describes the durable business outcome of a Leadping phone call after provider status normalization.
13776
13776
  */
13777
13777
  export declare const CallEventTableRow_statusObject: {
13778
13778
  readonly Scheduled: "scheduled";
@@ -13827,7 +13827,7 @@ export declare const CurrentLeadStatusSummary_sourceObject: {
13827
13827
  readonly API: "API";
13828
13828
  };
13829
13829
  /**
13830
- * Defines the supported Customer Activation Status values.
13830
+ * Summarizes an organization's overall progress from initial Leadping onboarding through launch readiness.
13831
13831
  */
13832
13832
  export declare const CustomerActivationStatusObject: {
13833
13833
  readonly DraftOnboarding: "DraftOnboarding";
@@ -13852,7 +13852,7 @@ export declare const CustomerActivationStatusObject: {
13852
13852
  readonly ManuallyBypassed: "ManuallyBypassed";
13853
13853
  };
13854
13854
  /**
13855
- * Defines the supported SMS readiness health assessments.
13855
+ * Summarizes the severity of conditions affecting an organization's ability to send compliant SMS or MMS traffic.
13856
13856
  */
13857
13857
  export declare const EligibleOutgoingNumberResponse_healthStatusObject: {
13858
13858
  readonly NotEvaluated: "Not Evaluated";
@@ -13862,7 +13862,7 @@ export declare const EligibleOutgoingNumberResponse_healthStatusObject: {
13862
13862
  readonly Blocked: "Blocked";
13863
13863
  };
13864
13864
  /**
13865
- * Defines the supported Event status values.
13865
+ * Describes whether a Leadping event is pending, processing, completed, failed, or otherwise resolved.
13866
13866
  */
13867
13867
  export declare const EventDetailResponse_statusObject: {
13868
13868
  readonly Pending: "Pending";
@@ -13872,7 +13872,7 @@ export declare const EventDetailResponse_statusObject: {
13872
13872
  readonly Cancelled: "Cancelled";
13873
13873
  };
13874
13874
  /**
13875
- * Defines the supported Event timeline type values.
13875
+ * Classifies the kind of activity displayed in a lead or conversation event timeline.
13876
13876
  */
13877
13877
  export declare const EventDetailResponse_timelineTypeObject: {
13878
13878
  readonly Message: "Message";
@@ -13889,7 +13889,7 @@ export declare const EventDetailResponse_timelineTypeObject: {
13889
13889
  readonly Warmup: "Warmup";
13890
13890
  };
13891
13891
  /**
13892
- * Defines the supported Outgoing Number Selection Reason values.
13892
+ * Explains why Leadping selected, rejected, or substituted an outgoing caller or messaging number.
13893
13893
  */
13894
13894
  export declare const EventTableRow_selectionReasonObject: {
13895
13895
  readonly StickyConversation: "StickyConversation";
@@ -13902,7 +13902,7 @@ export declare const EventTableRow_selectionReasonObject: {
13902
13902
  readonly ManualOverride: "ManualOverride";
13903
13903
  };
13904
13904
  /**
13905
- * Defines the supported Event timeline status values.
13905
+ * Provides the customer-facing outcome shown for an item in a lead or conversation timeline.
13906
13906
  */
13907
13907
  export declare const EventTableRow_statusObject: {
13908
13908
  readonly Pending: "Pending";
@@ -13928,7 +13928,7 @@ export declare const EventTableRow_statusObject: {
13928
13928
  readonly Canceled: "Canceled";
13929
13929
  };
13930
13930
  /**
13931
- * Defines the supported SMS Traffic Type values.
13931
+ * Classifies messaging traffic by conversational, informational, marketing, or other compliance-relevant purpose.
13932
13932
  */
13933
13933
  export declare const EventTableRow_trafficTypeObject: {
13934
13934
  readonly RealLead: "RealLead";
@@ -13938,7 +13938,7 @@ export declare const EventTableRow_trafficTypeObject: {
13938
13938
  readonly FailedAttempt: "FailedAttempt";
13939
13939
  };
13940
13940
  /**
13941
- * Defines the supported Event timeline type values.
13941
+ * Classifies the kind of activity displayed in a lead or conversation event timeline.
13942
13942
  */
13943
13943
  export declare const EventTimelineTypeObject: {
13944
13944
  readonly Message: "Message";
@@ -13987,7 +13987,7 @@ export declare const FeedbackTypeObject: {
13987
13987
  readonly Other: "other";
13988
13988
  };
13989
13989
  /**
13990
- * Defines the supported Employment Type values.
13990
+ * Classifies a lead's reported employment arrangement for qualification and demographic workflows.
13991
13991
  */
13992
13992
  export declare const LeadProfile_employmentTypeObject: {
13993
13993
  readonly Employed: "Employed";
@@ -14003,7 +14003,7 @@ export declare const LeadProfile_employmentTypeObject: {
14003
14003
  readonly Other: "Other";
14004
14004
  };
14005
14005
  /**
14006
- * Represents a gender classification used for demographic or identification purposes.
14006
+ * Classifies a lead's self-reported gender when required by a qualification, demographic, or integration workflow.
14007
14007
  */
14008
14008
  export declare const LeadProfile_genderObject: {
14009
14009
  readonly M: "M";
@@ -14013,7 +14013,7 @@ export declare const LeadProfile_genderObject: {
14013
14013
  readonly Other: "Other";
14014
14014
  };
14015
14015
  /**
14016
- * Defines the supported Marital Status Type values.
14016
+ * Classifies a lead's reported marital status when required by a qualification or integration workflow.
14017
14017
  */
14018
14018
  export declare const LeadProfile_maritalStatusObject: {
14019
14019
  readonly Married: "Married";
@@ -14130,7 +14130,7 @@ export declare const LeadTableRow_processingStatusObject: {
14130
14130
  readonly Failed: "Failed";
14131
14131
  };
14132
14132
  /**
14133
- * Defines the supported Notification Priority values.
14133
+ * Ranks the urgency and presentation importance of a Leadping user notification.
14134
14134
  */
14135
14135
  export declare const NotificationPriorityObject: {
14136
14136
  readonly Low: "Low";
@@ -14139,7 +14139,7 @@ export declare const NotificationPriorityObject: {
14139
14139
  readonly Critical: "Critical";
14140
14140
  };
14141
14141
  /**
14142
- * Defines the supported Notification Type values.
14142
+ * Identifies the Leadping workflow or account event communicated by a user notification.
14143
14143
  */
14144
14144
  export declare const NotificationTypeObject: {
14145
14145
  readonly General: "General";
@@ -14174,14 +14174,14 @@ export declare const OrganizationActivationState_domainSearchStageObject: {
14174
14174
  readonly Failed: "Failed";
14175
14175
  };
14176
14176
  /**
14177
- * Defines the supported Billing Plan values.
14177
+ * Identifies the Leadping subscription plan that determines organization features, allowances, and billing behavior.
14178
14178
  */
14179
14179
  export declare const OrganizationBillingState_pendingBillingPlanObject: {
14180
14180
  readonly Annual: "Annual";
14181
14181
  readonly Monthly: "Monthly";
14182
14182
  };
14183
14183
  /**
14184
- * Defines the supported Organization Invitation Status values.
14184
+ * Describes the lifecycle of an organization membership invitation from issuance through acceptance, expiration, or revocation.
14185
14185
  */
14186
14186
  export declare const OrganizationInvitationStatusObject: {
14187
14187
  readonly Pending: "Pending";
@@ -14192,7 +14192,7 @@ export declare const OrganizationInvitationStatusObject: {
14192
14192
  readonly FailedToSend: "Failed to send";
14193
14193
  };
14194
14194
  /**
14195
- * Defines the supported Organization User Role values.
14195
+ * Identifies an organization member's access level and permission scope within Leadping.
14196
14196
  */
14197
14197
  export declare const OrganizationMemberRoleObject: {
14198
14198
  readonly Owner: "Owner";
@@ -14200,7 +14200,7 @@ export declare const OrganizationMemberRoleObject: {
14200
14200
  readonly Agent: "Agent";
14201
14201
  };
14202
14202
  /**
14203
- * Defines the supported Organization Status values.
14203
+ * Describes an organization's account lifecycle and whether it can actively use Leadping services.
14204
14204
  */
14205
14205
  export declare const OrganizationRequest_statusObject: {
14206
14206
  readonly SettingUp: "SettingUp";
@@ -14208,14 +14208,14 @@ export declare const OrganizationRequest_statusObject: {
14208
14208
  readonly Active: "Active";
14209
14209
  };
14210
14210
  /**
14211
- * Defines the supported Billing Plan values.
14211
+ * Identifies the Leadping subscription plan that determines organization features, allowances, and billing behavior.
14212
14212
  */
14213
14213
  export declare const OrganizationResponse_billingPlanObject: {
14214
14214
  readonly Annual: "Annual";
14215
14215
  readonly Monthly: "Monthly";
14216
14216
  };
14217
14217
  /**
14218
- * Defines the supported User Setup Status values.
14218
+ * Describes a user's progress through required Leadping profile and account setup tasks.
14219
14219
  */
14220
14220
  export declare const OrganizationResponse_setupStatusObject: {
14221
14221
  readonly Personal: "Personal";
@@ -14229,7 +14229,7 @@ export declare const OrganizationResponse_setupStatusObject: {
14229
14229
  readonly Complete: "Complete";
14230
14230
  };
14231
14231
  /**
14232
- * Defines the supported Organization Setup Step values.
14232
+ * Identifies a discrete billing, telephony, compliance, or configuration stage in organization provisioning.
14233
14233
  */
14234
14234
  export declare const OrganizationResponse_setupStepObject: {
14235
14235
  readonly DomainFinding: "DomainFinding";
@@ -14245,7 +14245,7 @@ export declare const OrganizationResponse_setupStepObject: {
14245
14245
  readonly Complete: "Complete";
14246
14246
  };
14247
14247
  /**
14248
- * Defines the supported Organization Status values.
14248
+ * Describes an organization's account lifecycle and whether it can actively use Leadping services.
14249
14249
  */
14250
14250
  export declare const OrganizationResponse_statusObject: {
14251
14251
  readonly SettingUp: "SettingUp";
@@ -14253,7 +14253,7 @@ export declare const OrganizationResponse_statusObject: {
14253
14253
  readonly Active: "Active";
14254
14254
  };
14255
14255
  /**
14256
- * Defines the supported Subscription Status values.
14256
+ * Describes an organization's billing subscription lifecycle, including trial, active, delinquent, canceled, and expired states.
14257
14257
  */
14258
14258
  export declare const OrganizationResponse_subscriptionStatusObject: {
14259
14259
  readonly Pending: "Pending";
@@ -14262,7 +14262,7 @@ export declare const OrganizationResponse_subscriptionStatusObject: {
14262
14262
  readonly Canceled: "Canceled";
14263
14263
  };
14264
14264
  /**
14265
- * Defines the supported Customer Activation Status values.
14265
+ * Summarizes an organization's overall progress from initial Leadping onboarding through launch readiness.
14266
14266
  */
14267
14267
  export declare const OrganizationSwitchOption_activationStatusObject: {
14268
14268
  readonly DraftOnboarding: "DraftOnboarding";
@@ -14287,7 +14287,7 @@ export declare const OrganizationSwitchOption_activationStatusObject: {
14287
14287
  readonly ManuallyBypassed: "ManuallyBypassed";
14288
14288
  };
14289
14289
  /**
14290
- * Defines the supported Organization Status values.
14290
+ * Describes an organization's account lifecycle and whether it can actively use Leadping services.
14291
14291
  */
14292
14292
  export declare const OrganizationSwitchOption_organizationStatusObject: {
14293
14293
  readonly SettingUp: "SettingUp";
@@ -14295,7 +14295,7 @@ export declare const OrganizationSwitchOption_organizationStatusObject: {
14295
14295
  readonly Active: "Active";
14296
14296
  };
14297
14297
  /**
14298
- * Defines the supported 10DLC Application Status values.
14298
+ * Describes an organization's overall 10DLC registration lifecycle across brand and messaging campaign submission.
14299
14299
  */
14300
14300
  export declare const OrganizationSwitchOption_tenDlcStatusObject: {
14301
14301
  readonly NotStarted: "NotStarted";
@@ -14311,7 +14311,7 @@ export declare const OrganizationSwitchOption_tenDlcStatusObject: {
14311
14311
  readonly Failed: "Failed";
14312
14312
  };
14313
14313
  /**
14314
- * Defines the supported Customer Activation Status values.
14314
+ * Summarizes an organization's overall progress from initial Leadping onboarding through launch readiness.
14315
14315
  */
14316
14316
  export declare const OrganizationTableRow_activationStatusObject: {
14317
14317
  readonly DraftOnboarding: "DraftOnboarding";
@@ -14336,14 +14336,14 @@ export declare const OrganizationTableRow_activationStatusObject: {
14336
14336
  readonly ManuallyBypassed: "ManuallyBypassed";
14337
14337
  };
14338
14338
  /**
14339
- * Defines the supported Billing Plan values.
14339
+ * Identifies the Leadping subscription plan that determines organization features, allowances, and billing behavior.
14340
14340
  */
14341
14341
  export declare const OrganizationTableRow_billingPlanObject: {
14342
14342
  readonly Annual: "Annual";
14343
14343
  readonly Monthly: "Monthly";
14344
14344
  };
14345
14345
  /**
14346
- * Defines the supported Organization Setup Step values.
14346
+ * Identifies a discrete billing, telephony, compliance, or configuration stage in organization provisioning.
14347
14347
  */
14348
14348
  export declare const OrganizationTableRow_setupStepObject: {
14349
14349
  readonly DomainFinding: "DomainFinding";
@@ -14359,7 +14359,7 @@ export declare const OrganizationTableRow_setupStepObject: {
14359
14359
  readonly Complete: "Complete";
14360
14360
  };
14361
14361
  /**
14362
- * Defines the supported Organization Status values.
14362
+ * Describes an organization's account lifecycle and whether it can actively use Leadping services.
14363
14363
  */
14364
14364
  export declare const OrganizationTableRow_statusObject: {
14365
14365
  readonly SettingUp: "SettingUp";
@@ -14367,7 +14367,7 @@ export declare const OrganizationTableRow_statusObject: {
14367
14367
  readonly Active: "Active";
14368
14368
  };
14369
14369
  /**
14370
- * Defines the supported Subscription Status values.
14370
+ * Describes an organization's billing subscription lifecycle, including trial, active, delinquent, canceled, and expired states.
14371
14371
  */
14372
14372
  export declare const OrganizationTableRow_subscriptionStatusObject: {
14373
14373
  readonly Pending: "Pending";
@@ -14376,7 +14376,7 @@ export declare const OrganizationTableRow_subscriptionStatusObject: {
14376
14376
  readonly Canceled: "Canceled";
14377
14377
  };
14378
14378
  /**
14379
- * Defines the supported 10DLC Application Status values.
14379
+ * Describes an organization's overall 10DLC registration lifecycle across brand and messaging campaign submission.
14380
14380
  */
14381
14381
  export declare const OrganizationTableRow_tenDlcStatusObject: {
14382
14382
  readonly NotStarted: "NotStarted";
@@ -14392,7 +14392,7 @@ export declare const OrganizationTableRow_tenDlcStatusObject: {
14392
14392
  readonly Failed: "Failed";
14393
14393
  };
14394
14394
  /**
14395
- * Defines the supported Website Lifecycle Status values.
14395
+ * Describes an organization website's lifecycle from discovery and verification through activation, suspension, or removal.
14396
14396
  */
14397
14397
  export declare const OrganizationTableRow_websiteStatusObject: {
14398
14398
  readonly NotStarted: "NotStarted";
@@ -14471,7 +14471,7 @@ export declare const OutboundQueueItem_reasonCodeObject: {
14471
14471
  readonly Reservation_unavailable: "reservation_unavailable";
14472
14472
  };
14473
14473
  /**
14474
- * Defines the supported Outgoing Number Selection Reason values.
14474
+ * Explains why Leadping selected, rejected, or substituted an outgoing caller or messaging number.
14475
14475
  */
14476
14476
  export declare const OutgoingNumberSelectionReasonObject: {
14477
14477
  readonly StickyConversation: "StickyConversation";
@@ -14484,14 +14484,14 @@ export declare const OutgoingNumberSelectionReasonObject: {
14484
14484
  readonly ManualOverride: "ManualOverride";
14485
14485
  };
14486
14486
  /**
14487
- * Defines the supported Outgoing Number Channel values.
14487
+ * Identifies whether an outgoing phone number is eligible for voice, SMS, MMS, or another communication channel.
14488
14488
  */
14489
14489
  export declare const OutgoingNumberSelectionRequest_channelObject: {
14490
14490
  readonly Sms: "sms";
14491
14491
  readonly Call: "call";
14492
14492
  };
14493
14493
  /**
14494
- * Defines the supported SMS readiness health assessments.
14494
+ * Summarizes the severity of conditions affecting an organization's ability to send compliant SMS or MMS traffic.
14495
14495
  */
14496
14496
  export declare const OutgoingNumberSelectionResponse_healthStatusObject: {
14497
14497
  readonly NotEvaluated: "Not Evaluated";
@@ -14501,7 +14501,7 @@ export declare const OutgoingNumberSelectionResponse_healthStatusObject: {
14501
14501
  readonly Blocked: "Blocked";
14502
14502
  };
14503
14503
  /**
14504
- * Defines the supported Outgoing Number Selection Reason values.
14504
+ * Explains why Leadping selected, rejected, or substituted an outgoing caller or messaging number.
14505
14505
  */
14506
14506
  export declare const OutgoingNumberSelectionResponse_selectionReasonObject: {
14507
14507
  readonly StickyConversation: "StickyConversation";
@@ -14514,7 +14514,7 @@ export declare const OutgoingNumberSelectionResponse_selectionReasonObject: {
14514
14514
  readonly ManualOverride: "ManualOverride";
14515
14515
  };
14516
14516
  /**
14517
- * Defines the supported Outgoing Number Selection Reason values.
14517
+ * Explains why Leadping selected, rejected, or substituted an outgoing caller or messaging number.
14518
14518
  */
14519
14519
  export declare const PhoneCallResponse_selectionReasonObject: {
14520
14520
  readonly StickyConversation: "StickyConversation";
@@ -14527,7 +14527,7 @@ export declare const PhoneCallResponse_selectionReasonObject: {
14527
14527
  readonly ManualOverride: "ManualOverride";
14528
14528
  };
14529
14529
  /**
14530
- * Defines the supported Phone Call Status values.
14530
+ * Describes the durable business outcome of a Leadping phone call after provider status normalization.
14531
14531
  */
14532
14532
  export declare const PhoneCallStatusObject: {
14533
14533
  readonly Scheduled: "scheduled";
@@ -14608,7 +14608,7 @@ export declare const PhoneNumberOutboundHealthStatusObject: {
14608
14608
  readonly Disabled: "disabled";
14609
14609
  };
14610
14610
  /**
14611
- * Defines the supported voice call warmup stages for a Leadping-managed phone number.
14611
+ * Identifies the current traffic-ramp stage of controlled voice warmup for a Leadping-managed phone number.
14612
14612
  */
14613
14613
  export declare const PhoneNumberReadiness_callStageObject: {
14614
14614
  readonly Stage0: "Stage 0";
@@ -14618,7 +14618,7 @@ export declare const PhoneNumberReadiness_callStageObject: {
14618
14618
  readonly Stage4: "Stage 4";
14619
14619
  };
14620
14620
  /**
14621
- * Defines the supported SMS readiness health assessments.
14621
+ * Summarizes the severity of conditions affecting an organization's ability to send compliant SMS or MMS traffic.
14622
14622
  */
14623
14623
  export declare const PhoneNumberReadiness_healthStatusObject: {
14624
14624
  readonly NotEvaluated: "Not Evaluated";
@@ -14628,7 +14628,7 @@ export declare const PhoneNumberReadiness_healthStatusObject: {
14628
14628
  readonly Blocked: "Blocked";
14629
14629
  };
14630
14630
  /**
14631
- * Defines the supported SMS readiness states.
14631
+ * Describes whether an organization is configured and permitted to send SMS or MMS traffic through Leadping.
14632
14632
  */
14633
14633
  export declare const PhoneNumberReadiness_stateObject: {
14634
14634
  readonly NotStarted: "Not Started";
@@ -14651,7 +14651,7 @@ export declare const SmsEventTableRow_outboundSourceObject: {
14651
14651
  readonly Retry: "retry";
14652
14652
  };
14653
14653
  /**
14654
- * Defines the supported SMS Message Status values.
14654
+ * Describes the normalized lifecycle of an SMS or MMS message from scheduling through delivery or failure.
14655
14655
  */
14656
14656
  export declare const SmsEventTableRow_statusObject: {
14657
14657
  readonly Draft: "draft";
@@ -14670,7 +14670,7 @@ export declare const SmsEventTableRow_statusObject: {
14670
14670
  readonly Canceled: "canceled";
14671
14671
  };
14672
14672
  /**
14673
- * Defines the supported SMS Traffic Type values.
14673
+ * Classifies messaging traffic by conversational, informational, marketing, or other compliance-relevant purpose.
14674
14674
  */
14675
14675
  export declare const SmsEventTableRow_trafficTypeObject: {
14676
14676
  readonly RealLead: "RealLead";
@@ -14680,7 +14680,7 @@ export declare const SmsEventTableRow_trafficTypeObject: {
14680
14680
  readonly FailedAttempt: "FailedAttempt";
14681
14681
  };
14682
14682
  /**
14683
- * Defines the supported SMS readiness health assessments.
14683
+ * Summarizes the severity of conditions affecting an organization's ability to send compliant SMS or MMS traffic.
14684
14684
  */
14685
14685
  export declare const SmsReadinessHealthStatusObject: {
14686
14686
  readonly NotEvaluated: "Not Evaluated";
@@ -14690,7 +14690,7 @@ export declare const SmsReadinessHealthStatusObject: {
14690
14690
  readonly Blocked: "Blocked";
14691
14691
  };
14692
14692
  /**
14693
- * Defines the supported SMS readiness states.
14693
+ * Describes whether an organization is configured and permitted to send SMS or MMS traffic through Leadping.
14694
14694
  */
14695
14695
  export declare const SmsReadinessStateObject: {
14696
14696
  readonly NotStarted: "Not Started";
@@ -14700,7 +14700,7 @@ export declare const SmsReadinessStateObject: {
14700
14700
  readonly Ready: "Ready";
14701
14701
  };
14702
14702
  /**
14703
- * Defines the supported Outgoing Number Selection Reason values.
14703
+ * Explains why Leadping selected, rejected, or substituted an outgoing caller or messaging number.
14704
14704
  */
14705
14705
  export declare const SmsResponse_selectionReasonObject: {
14706
14706
  readonly StickyConversation: "StickyConversation";
@@ -14713,7 +14713,7 @@ export declare const SmsResponse_selectionReasonObject: {
14713
14713
  readonly ManualOverride: "ManualOverride";
14714
14714
  };
14715
14715
  /**
14716
- * Defines the supported SMS Message Status values.
14716
+ * Describes the normalized lifecycle of an SMS or MMS message from scheduling through delivery or failure.
14717
14717
  */
14718
14718
  export declare const SmsResponse_statusObject: {
14719
14719
  readonly Draft: "draft";
@@ -14732,7 +14732,7 @@ export declare const SmsResponse_statusObject: {
14732
14732
  readonly Canceled: "canceled";
14733
14733
  };
14734
14734
  /**
14735
- * Defines the supported SMS Traffic Type values.
14735
+ * Classifies messaging traffic by conversational, informational, marketing, or other compliance-relevant purpose.
14736
14736
  */
14737
14737
  export declare const SmsResponse_trafficTypeObject: {
14738
14738
  readonly RealLead: "RealLead";
@@ -14742,7 +14742,7 @@ export declare const SmsResponse_trafficTypeObject: {
14742
14742
  readonly FailedAttempt: "FailedAttempt";
14743
14743
  };
14744
14744
  /**
14745
- * Defines the supported 10DLC Application Status values.
14745
+ * Describes an organization's overall 10DLC registration lifecycle across brand and messaging campaign submission.
14746
14746
  */
14747
14747
  export declare const TenDlcApplicationStatusObject: {
14748
14748
  readonly NotStarted: "NotStarted";
@@ -14768,7 +14768,7 @@ export declare const TenDlcRegistrationStatusObject: {
14768
14768
  readonly Failed: "Failed";
14769
14769
  };
14770
14770
  /**
14771
- * Defines the supported Billable Unit values.
14771
+ * Identifies the metered unit used to price Leadping usage, such as a message, call minute, lookup, or phone number.
14772
14772
  */
14773
14773
  export declare const TransactionResponse_billableUnitObject: {
14774
14774
  readonly Lead_received: "lead_received";
@@ -14790,7 +14790,7 @@ export declare const TransactionResponse_billableUnitObject: {
14790
14790
  readonly Automation_run: "automation_run";
14791
14791
  };
14792
14792
  /**
14793
- * Defines the supported Usage Channel values.
14793
+ * Identifies the messaging, calling, phone-number, lookup, or platform channel that generated billable usage.
14794
14794
  */
14795
14795
  export declare const TransactionResponse_billingChannelObject: {
14796
14796
  readonly Lead: "lead";
@@ -14809,7 +14809,7 @@ export declare const TransactionResponse_billingChannelObject: {
14809
14809
  readonly Automation: "automation";
14810
14810
  };
14811
14811
  /**
14812
- * Defines the supported Transaction Status values.
14812
+ * Describes the processing and settlement lifecycle of a Leadping wallet or billing transaction.
14813
14813
  */
14814
14814
  export declare const TransactionStatusObject: {
14815
14815
  readonly Pending: "Pending";
@@ -14817,7 +14817,7 @@ export declare const TransactionStatusObject: {
14817
14817
  readonly Failed: "Failed";
14818
14818
  };
14819
14819
  /**
14820
- * Defines the supported Billable Unit values.
14820
+ * Identifies the metered unit used to price Leadping usage, such as a message, call minute, lookup, or phone number.
14821
14821
  */
14822
14822
  export declare const TransactionTableRow_billableUnitObject: {
14823
14823
  readonly Lead_received: "lead_received";
@@ -14839,7 +14839,7 @@ export declare const TransactionTableRow_billableUnitObject: {
14839
14839
  readonly Automation_run: "automation_run";
14840
14840
  };
14841
14841
  /**
14842
- * Defines the supported Usage Channel values.
14842
+ * Identifies the messaging, calling, phone-number, lookup, or platform channel that generated billable usage.
14843
14843
  */
14844
14844
  export declare const TransactionTableRow_billingChannelObject: {
14845
14845
  readonly Lead: "lead";
@@ -14858,7 +14858,7 @@ export declare const TransactionTableRow_billingChannelObject: {
14858
14858
  readonly Automation: "automation";
14859
14859
  };
14860
14860
  /**
14861
- * Defines the supported Transaction Type values.
14861
+ * Classifies a wallet transaction as a debit, credit, refund, adjustment, deposit, or other balance movement.
14862
14862
  */
14863
14863
  export declare const TransactionTypeObject: {
14864
14864
  readonly Debit: "Debit";
@@ -14866,7 +14866,7 @@ export declare const TransactionTypeObject: {
14866
14866
  readonly Deposit: "Deposit";
14867
14867
  };
14868
14868
  /**
14869
- * Defines the supported Usage Channel values.
14869
+ * Identifies the messaging, calling, phone-number, lookup, or platform channel that generated billable usage.
14870
14870
  */
14871
14871
  export declare const UsageChannelObject: {
14872
14872
  readonly Lead: "lead";
@@ -14885,7 +14885,7 @@ export declare const UsageChannelObject: {
14885
14885
  readonly Automation: "automation";
14886
14886
  };
14887
14887
  /**
14888
- * Defines the supported Usage Record Status values.
14888
+ * Describes whether a metered usage record is pending, rated, billed, reconciled, excluded, or failed.
14889
14889
  */
14890
14890
  export declare const UsageStatusObject: {
14891
14891
  readonly Recorded: "recorded";
@@ -14899,7 +14899,7 @@ export declare const UsageStatusObject: {
14899
14899
  readonly Blocked_due_to_billing: "blocked_due_to_billing";
14900
14900
  };
14901
14901
  /**
14902
- * Defines the supported user data export statuses values.
14902
+ * Identifies the preparation, availability, failure, expiration, or deletion stage of a Leadping user-data export.
14903
14903
  */
14904
14904
  export declare const UserDataExportStatusesObject: {
14905
14905
  readonly Pending: "Pending";
@@ -14909,21 +14909,21 @@ export declare const UserDataExportStatusesObject: {
14909
14909
  readonly Expired: "Expired";
14910
14910
  };
14911
14911
  /**
14912
- * Defines the supported Billing Plan values.
14912
+ * Identifies the Leadping subscription plan that determines organization features, allowances, and billing behavior.
14913
14913
  */
14914
14914
  export declare const UserRequest_billingPlanObject: {
14915
14915
  readonly Annual: "Annual";
14916
14916
  readonly Monthly: "Monthly";
14917
14917
  };
14918
14918
  /**
14919
- * Defines the supported Billing Plan values.
14919
+ * Identifies the Leadping subscription plan that determines organization features, allowances, and billing behavior.
14920
14920
  */
14921
14921
  export declare const UserResponse_billingPlanObject: {
14922
14922
  readonly Annual: "Annual";
14923
14923
  readonly Monthly: "Monthly";
14924
14924
  };
14925
14925
  /**
14926
- * Defines the supported Subscription Status values.
14926
+ * Describes an organization's billing subscription lifecycle, including trial, active, delinquent, canceled, and expired states.
14927
14927
  */
14928
14928
  export declare const UserResponse_subscriptionStatusObject: {
14929
14929
  readonly Pending: "Pending";
@@ -14954,7 +14954,7 @@ export declare const WalletResponse_sourceTypeObject: {
14954
14954
  readonly Compromise_restoration: "compromise_restoration";
14955
14955
  };
14956
14956
  /**
14957
- * Defines the supported Website Lifecycle Status values.
14957
+ * Describes an organization website's lifecycle from discovery and verification through activation, suspension, or removal.
14958
14958
  */
14959
14959
  export declare const WebsiteLifecycleStatusObject: {
14960
14960
  readonly NotStarted: "NotStarted";