@leadping/sdk 1.0.54 → 1.0.56

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.
@@ -42,7 +42,7 @@ export type ActivationTelephonyStatus = (typeof ActivationTelephonyStatusObject)
42
42
  */
43
43
  export interface ActivationTimelineEvent extends AdditionalDataHolder, Parsable {
44
44
  /**
45
- * Identifier and display name of the related actor.
45
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
46
46
  */
47
47
  actor?: ActivationTimelineEvent_actor | null;
48
48
  /**
@@ -75,7 +75,7 @@ export interface ActivationTimelineEvent extends AdditionalDataHolder, Parsable
75
75
  type?: string | null;
76
76
  }
77
77
  /**
78
- * Identifier and display name of the related actor.
78
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
79
79
  */
80
80
  export interface ActivationTimelineEvent_actor extends IdNamePair, Parsable {
81
81
  }
@@ -105,7 +105,7 @@ export interface AnalyticsComparison extends AdditionalDataHolder, Parsable {
105
105
  */
106
106
  export interface AnalyticsDateRange extends AdditionalDataHolder, Parsable {
107
107
  /**
108
- * Bucket size associated with this Leadping analytics date range.
108
+ * Selects the time interval used to aggregate points in a Leadping analytics trend series.
109
109
  */
110
110
  bucketSize?: number | null;
111
111
  /**
@@ -378,7 +378,7 @@ export interface AutomationPreviewConditionResult extends AdditionalDataHolder,
378
378
  */
379
379
  export interface AutomationPreviewRequest extends AdditionalDataHolder, Parsable {
380
380
  /**
381
- * Automation configuration to evaluate without executing live actions.
381
+ * Public Leadping API schema for automation request snapshot data.
382
382
  */
383
383
  automation?: AutomationRequestSnapshot | null;
384
384
  /**
@@ -407,7 +407,7 @@ export interface AutomationPreviewResponse extends AdditionalDataHolder, Parsabl
407
407
  */
408
408
  triggerType?: string | null;
409
409
  /**
410
- * Validation result returned for the automation configuration.
410
+ * Result schema for the Leadping API automation validation result returned by lookup and validation endpoints.
411
411
  */
412
412
  validation?: AutomationValidationResult | null;
413
413
  /**
@@ -591,7 +591,7 @@ export interface AutomationResponse extends AdditionalDataHolder, Parsable {
591
591
  */
592
592
  name?: string | null;
593
593
  /**
594
- * Organization summary connected to this automation configuration response.
594
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
595
595
  */
596
596
  organization?: AutomationResponse_organization | null;
597
597
  /**
@@ -607,7 +607,7 @@ export interface AutomationResponse extends AdditionalDataHolder, Parsable {
607
607
  */
608
608
  triggers?: AutomationTrigger[] | null;
609
609
  /**
610
- * User summary connected to this automation configuration response.
610
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
611
611
  */
612
612
  user?: AutomationResponse_user | null;
613
613
  /**
@@ -620,12 +620,12 @@ export interface AutomationResponse extends AdditionalDataHolder, Parsable {
620
620
  visibility?: string | null;
621
621
  }
622
622
  /**
623
- * Organization summary connected to this automation configuration response.
623
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
624
624
  */
625
625
  export interface AutomationResponse_organization extends IdNamePair, Parsable {
626
626
  }
627
627
  /**
628
- * User summary connected to this automation configuration response.
628
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
629
629
  */
630
630
  export interface AutomationResponse_user extends IdNamePair, Parsable {
631
631
  }
@@ -645,6 +645,10 @@ export interface AutomationRunRecord extends AdditionalDataHolder, Parsable {
645
645
  * UTC timestamp when processing completed for this automation run record.
646
646
  */
647
647
  completedAt?: Date | null;
648
+ /**
649
+ * Results of condition nodes already visited by this run, preserved across waits and retries.
650
+ */
651
+ conditionResults?: AutomationRunRecord_conditionResults | null;
648
652
  /**
649
653
  * Execution mode used for automation preview or live workflow processing.
650
654
  */
@@ -685,11 +689,20 @@ export interface AutomationRunRecord extends AdditionalDataHolder, Parsable {
685
689
  * Current lifecycle status for this automation run record in the Leadping API.
686
690
  */
687
691
  status?: string | null;
692
+ /**
693
+ * Identifier of the trigger node selected when this run was queued.
694
+ */
695
+ triggerId?: string | null;
688
696
  /**
689
697
  * Automation trigger type that starts the workflow.
690
698
  */
691
699
  triggerType?: string | null;
692
700
  }
701
+ /**
702
+ * Results of condition nodes already visited by this run, preserved across waits and retries.
703
+ */
704
+ export interface AutomationRunRecord_conditionResults extends AdditionalDataHolder, Parsable {
705
+ }
693
706
  /**
694
707
  * Summarizes automation data in paginated and searchable results.
695
708
  */
@@ -747,7 +760,7 @@ export interface AutomationTableRow extends AdditionalDataHolder, Parsable {
747
760
  */
748
761
  name?: string | null;
749
762
  /**
750
- * Organization summary connected to this automation table row.
763
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
751
764
  */
752
765
  organization?: AutomationTableRow_organization | null;
753
766
  /**
@@ -771,7 +784,7 @@ export interface AutomationTableRow extends AdditionalDataHolder, Parsable {
771
784
  */
772
785
  triggerType?: string | null;
773
786
  /**
774
- * User summary connected to this automation table row.
787
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
775
788
  */
776
789
  user?: AutomationTableRow_user | null;
777
790
  /**
@@ -780,12 +793,12 @@ export interface AutomationTableRow extends AdditionalDataHolder, Parsable {
780
793
  visibility?: string | null;
781
794
  }
782
795
  /**
783
- * Organization summary connected to this automation table row.
796
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
784
797
  */
785
798
  export interface AutomationTableRow_organization extends IdNamePair, Parsable {
786
799
  }
787
800
  /**
788
- * User summary connected to this automation table row.
801
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
789
802
  */
790
803
  export interface AutomationTableRow_user extends IdNamePair, Parsable {
791
804
  }
@@ -959,7 +972,7 @@ export interface AutomationWorkflowRunResponse extends AdditionalDataHolder, Par
959
972
  */
960
973
  actions?: AutomationWorkflowActionResponse[] | null;
961
974
  /**
962
- * Identifier and display name of the related automation.
975
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
963
976
  */
964
977
  automation?: AutomationWorkflowRunResponse_automation | null;
965
978
  /**
@@ -971,7 +984,7 @@ export interface AutomationWorkflowRunResponse extends AdditionalDataHolder, Par
971
984
  */
972
985
  completedAt?: Date | null;
973
986
  /**
974
- * Identifier and display name of the workflow step currently awaiting or performing work.
987
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
975
988
  */
976
989
  currentStep?: AutomationWorkflowRunResponse_currentStep | null;
977
990
  /**
@@ -1064,12 +1077,12 @@ export interface AutomationWorkflowRunResponse extends AdditionalDataHolder, Par
1064
1077
  updatedAt?: Date | null;
1065
1078
  }
1066
1079
  /**
1067
- * Identifier and display name of the related automation.
1080
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
1068
1081
  */
1069
1082
  export interface AutomationWorkflowRunResponse_automation extends IdNamePair, Parsable {
1070
1083
  }
1071
1084
  /**
1072
- * Identifier and display name of the workflow step currently awaiting or performing work.
1085
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
1073
1086
  */
1074
1087
  export interface AutomationWorkflowRunResponse_currentStep extends IdNamePair, Parsable {
1075
1088
  }
@@ -1093,55 +1106,79 @@ export type BillingPlan = (typeof BillingPlanObject)[keyof typeof BillingPlanObj
1093
1106
  */
1094
1107
  export interface BlogArticleResponse extends AdditionalDataHolder, Parsable {
1095
1108
  /**
1096
- * Gets or sets the author name.
1109
+ * The authorName property
1097
1110
  */
1098
1111
  authorName?: string | null;
1099
1112
  /**
1100
- * Gets or sets the category.
1113
+ * The category property
1101
1114
  */
1102
1115
  category?: string | null;
1103
1116
  /**
1104
- * Gets or sets the content.
1117
+ * The content property
1105
1118
  */
1106
1119
  content?: string | null;
1107
1120
  /**
1108
- * Gets or sets the cover image URL.
1121
+ * The contentUpdatedAt property
1122
+ */
1123
+ contentUpdatedAt?: Date | null;
1124
+ /**
1125
+ * The coverImageAlt property
1126
+ */
1127
+ coverImageAlt?: string | null;
1128
+ /**
1129
+ * The coverImageUrl property
1109
1130
  */
1110
1131
  coverImageUrl?: string | null;
1111
1132
  /**
1112
- * Gets or sets the created at.
1133
+ * The createdAt property
1113
1134
  */
1114
1135
  createdAt?: Date | null;
1115
1136
  /**
1116
- * Gets or sets the excerpt.
1137
+ * The excerpt property
1117
1138
  */
1118
1139
  excerpt?: string | null;
1119
1140
  /**
1120
- * Gets or sets the ID.
1141
+ * The id property
1121
1142
  */
1122
1143
  id?: string | null;
1123
1144
  /**
1124
- * Gets or sets the is featured.
1145
+ * The latest background image processing failure, when present.
1146
+ */
1147
+ imageProcessingError?: string | null;
1148
+ /**
1149
+ * Whether saved image references are awaiting Engine processing.
1150
+ */
1151
+ imagesProcessing?: boolean | null;
1152
+ /**
1153
+ * The isFeatured property
1125
1154
  */
1126
1155
  isFeatured?: boolean | null;
1127
1156
  /**
1128
- * Gets or sets the is published.
1157
+ * The isPublished property
1129
1158
  */
1130
1159
  isPublished?: boolean | null;
1131
1160
  /**
1132
- * Gets or sets the modified at.
1161
+ * The metaDescription property
1162
+ */
1163
+ metaDescription?: string | null;
1164
+ /**
1165
+ * The modifiedAt property
1133
1166
  */
1134
1167
  modifiedAt?: Date | null;
1135
1168
  /**
1136
- * Gets or sets the published at.
1169
+ * The publishedAt property
1137
1170
  */
1138
1171
  publishedAt?: Date | null;
1139
1172
  /**
1140
- * Gets or sets the slug.
1173
+ * The seoTitle property
1174
+ */
1175
+ seoTitle?: string | null;
1176
+ /**
1177
+ * The slug property
1141
1178
  */
1142
1179
  slug?: string | null;
1143
1180
  /**
1144
- * Gets or sets the title.
1181
+ * The title property
1145
1182
  */
1146
1183
  title?: string | null;
1147
1184
  }
@@ -1264,7 +1301,7 @@ export type CallEventTableRow_status = (typeof CallEventTableRow_statusObject)[k
1264
1301
  */
1265
1302
  export interface ChangeBillingPlanRequest extends AdditionalDataHolder, Parsable {
1266
1303
  /**
1267
- * Billing plan for this billing plan.
1304
+ * Identifies the Leadping subscription plan that determines organization features, allowances, and billing behavior.
1268
1305
  */
1269
1306
  billingPlan?: BillingPlan | null;
1270
1307
  }
@@ -1298,7 +1335,7 @@ export interface CommunicationConsoleEntry extends AdditionalDataHolder, Parsabl
1298
1335
  */
1299
1336
  export interface ComplianceUpdateRequest extends AdditionalDataHolder, Parsable {
1300
1337
  /**
1301
- * Compliance for this compliance update.
1338
+ * Describes user compliance data used in Leadping API requests and responses.
1302
1339
  */
1303
1340
  compliance?: ComplianceUpdateRequest_compliance | null;
1304
1341
  /**
@@ -1307,7 +1344,7 @@ export interface ComplianceUpdateRequest extends AdditionalDataHolder, Parsable
1307
1344
  source?: string | null;
1308
1345
  }
1309
1346
  /**
1310
- * Compliance for this compliance update.
1347
+ * Describes user compliance data used in Leadping API requests and responses.
1311
1348
  */
1312
1349
  export interface ComplianceUpdateRequest_compliance extends Parsable, UserCompliance {
1313
1350
  }
@@ -1332,7 +1369,7 @@ export interface ConversationResponse extends AdditionalDataHolder, Parsable {
1332
1369
  */
1333
1370
  avatarUrl?: string | null;
1334
1371
  /**
1335
- * Current lead status change summary that describes the lead outcome.
1372
+ * Summary schema for Leadping API current lead status change summary data used in dashboards and reports.
1336
1373
  */
1337
1374
  currentLeadStatus?: ConversationResponse_currentLeadStatus | null;
1338
1375
  /**
@@ -1388,7 +1425,7 @@ export interface ConversationResponse extends AdditionalDataHolder, Parsable {
1388
1425
  */
1389
1426
  outboundPhoneNumberOverrideId?: string | null;
1390
1427
  /**
1391
- * Phone number used by this conversation response for calls, SMS, lookup, or routing.
1428
+ * Extends an identifier-and-name resource reference with an optional string value used for display or selection metadata.
1392
1429
  */
1393
1430
  phoneNumber?: ConversationResponse_phoneNumber | null;
1394
1431
  /**
@@ -1401,12 +1438,12 @@ export interface ConversationResponse extends AdditionalDataHolder, Parsable {
1401
1438
  statusReason?: string | null;
1402
1439
  }
1403
1440
  /**
1404
- * Current lead status change summary that describes the lead outcome.
1441
+ * Summary schema for Leadping API current lead status change summary data used in dashboards and reports.
1405
1442
  */
1406
1443
  export interface ConversationResponse_currentLeadStatus extends CurrentLeadStatusSummary, Parsable {
1407
1444
  }
1408
1445
  /**
1409
- * Phone number used by this conversation response for calls, SMS, lookup, or routing.
1446
+ * Extends an identifier-and-name resource reference with an optional string value used for display or selection metadata.
1410
1447
  */
1411
1448
  export interface ConversationResponse_phoneNumber extends IdNameValue, Parsable {
1412
1449
  }
@@ -1574,6 +1611,12 @@ export declare function createAutomationResponse_userFromDiscriminatorValue(pars
1574
1611
  * @returns {AutomationResponse}
1575
1612
  */
1576
1613
  export declare function createAutomationResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
1614
+ /**
1615
+ * Creates a new instance of the appropriate class based on discriminator value
1616
+ * @param parseNode The parse node to use to read the discriminator value and create the object
1617
+ * @returns {AutomationRunRecord_conditionResults}
1618
+ */
1619
+ export declare function createAutomationRunRecord_conditionResultsFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
1577
1620
  /**
1578
1621
  * Creates a new instance of the appropriate class based on discriminator value
1579
1622
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -3118,15 +3161,15 @@ export type CustomerActivationStatus = (typeof CustomerActivationStatusObject)[k
3118
3161
  */
3119
3162
  export interface CustomerAnalyticsResponse extends AdditionalDataHolder, Parsable {
3120
3163
  /**
3121
- * Activation health associated with this Leadping customer analytics.
3164
+ * Summarizes an organization's progress and blockers across onboarding, billing, telephony, compliance, and launch readiness.
3122
3165
  */
3123
3166
  activationHealth?: CustomerActivationHealth | null;
3124
3167
  /**
3125
- * Automation health associated with this Leadping customer analytics.
3168
+ * Summarizes automation coverage, execution success, failures, and workflows requiring organization attention.
3126
3169
  */
3127
3170
  automationHealth?: CustomerAutomationHealth | null;
3128
3171
  /**
3129
- * Communication usage associated with this Leadping customer analytics.
3172
+ * Aggregates an organization's SMS, MMS, and calling activity, delivery outcomes, and billable usage over time.
3130
3173
  */
3131
3174
  communicationUsage?: CustomerCommunicationUsage | null;
3132
3175
  /**
@@ -3138,7 +3181,7 @@ export interface CustomerAnalyticsResponse extends AdditionalDataHolder, Parsabl
3138
3181
  */
3139
3182
  leadSources?: CustomerLeadSourceBreakdown[] | null;
3140
3183
  /**
3141
- * Lead trend associated with this Leadping customer analytics.
3184
+ * Measures lead creation, qualification, and conversion activity within one reporting time bucket.
3142
3185
  */
3143
3186
  leadTrend?: CustomerLeadTrend | null;
3144
3187
  /**
@@ -3146,15 +3189,15 @@ export interface CustomerAnalyticsResponse extends AdditionalDataHolder, Parsabl
3146
3189
  */
3147
3190
  needsAttention?: CustomerNeedsAttentionItem[] | null;
3148
3191
  /**
3149
- * Range associated with this Leadping customer analytics.
3192
+ * Defines the inclusive reporting window and comparison window used to calculate Leadping analytics.
3150
3193
  */
3151
3194
  range?: AnalyticsDateRange | null;
3152
3195
  /**
3153
- * Response metrics associated with this Leadping customer analytics.
3196
+ * Measures how quickly and consistently an organization responds to leads across supported communication channels.
3154
3197
  */
3155
3198
  responseMetrics?: CustomerResponseMetrics | null;
3156
3199
  /**
3157
- * Human-readable summary for this Leadping customer analytics.
3200
+ * Summarizes an organization's primary lead, response, communication, and conversion KPIs for the selected period.
3158
3201
  */
3159
3202
  summary?: CustomerAnalyticsSummary | null;
3160
3203
  }
@@ -3187,7 +3230,7 @@ export interface CustomerAnalyticsSummary extends AdditionalDataHolder, Parsable
3187
3230
  */
3188
3231
  leads?: number | null;
3189
3232
  /**
3190
- * Date and time when this Leadping customer analytics summary was leads comparison.
3233
+ * Compares a metric with the preceding period and reports its absolute and percentage change.
3191
3234
  */
3192
3235
  leadsComparison?: AnalyticsComparison | null;
3193
3236
  /**
@@ -3256,7 +3299,7 @@ export interface CustomerAutomationHealth extends AdditionalDataHolder, Parsable
3256
3299
  */
3257
3300
  failureCount?: number | null;
3258
3301
  /**
3259
- * Last failure associated with this Leadping customer automation health.
3302
+ * Identifies an automation with recent execution failures and summarizes its affected leads and failure context.
3260
3303
  */
3261
3304
  lastFailure?: CustomerAutomationHealth_lastFailure | null;
3262
3305
  /**
@@ -3269,7 +3312,7 @@ export interface CustomerAutomationHealth extends AdditionalDataHolder, Parsable
3269
3312
  trend?: CustomerAutomationHealthPoint[] | null;
3270
3313
  }
3271
3314
  /**
3272
- * Last failure associated with this Leadping customer automation health.
3315
+ * Identifies an automation with recent execution failures and summarizes its affected leads and failure context.
3273
3316
  */
3274
3317
  export interface CustomerAutomationHealth_lastFailure extends CustomerFailingAutomation, Parsable {
3275
3318
  }
@@ -3278,27 +3321,27 @@ export interface CustomerAutomationHealth_lastFailure extends CustomerFailingAut
3278
3321
  */
3279
3322
  export interface CustomerAutomationHealthPoint extends AdditionalDataHolder, Parsable {
3280
3323
  /**
3281
- * Gets or sets the end at.
3324
+ * The endAt property
3282
3325
  */
3283
3326
  endAt?: Date | null;
3284
3327
  /**
3285
- * Gets or sets the executions.
3328
+ * The executions property
3286
3329
  */
3287
3330
  executions?: number | null;
3288
3331
  /**
3289
- * Gets or sets the failure count.
3332
+ * The failureCount property
3290
3333
  */
3291
3334
  failureCount?: number | null;
3292
3335
  /**
3293
- * Gets or sets the label.
3336
+ * The label property
3294
3337
  */
3295
3338
  label?: string | null;
3296
3339
  /**
3297
- * Gets or sets the start at.
3340
+ * The startAt property
3298
3341
  */
3299
3342
  startAt?: Date | null;
3300
3343
  /**
3301
- * Gets or sets the success count.
3344
+ * The successCount property
3302
3345
  */
3303
3346
  successCount?: number | null;
3304
3347
  }
@@ -3447,7 +3490,7 @@ export interface CustomerLeadSourceBreakdown extends AdditionalDataHolder, Parsa
3447
3490
  */
3448
3491
  export interface CustomerLeadTrend extends AdditionalDataHolder, Parsable {
3449
3492
  /**
3450
- * Date and time when this Leadping customer lead trend was comparison.
3493
+ * Compares a metric with the preceding period and reports its absolute and percentage change.
3451
3494
  */
3452
3495
  comparison?: AnalyticsComparison | null;
3453
3496
  /**
@@ -3685,6 +3728,12 @@ export declare function deserializeIntoAutomationResponse_user(automationRespons
3685
3728
  * @returns {Record<string, (node: ParseNode) => void>}
3686
3729
  */
3687
3730
  export declare function deserializeIntoAutomationRunRecord(automationRunRecord?: Partial<AutomationRunRecord> | undefined): Record<string, (node: ParseNode) => void>;
3731
+ /**
3732
+ * The deserialization information for the current model
3733
+ * @param AutomationRunRecord_conditionResults The instance to deserialize into.
3734
+ * @returns {Record<string, (node: ParseNode) => void>}
3735
+ */
3736
+ export declare function deserializeIntoAutomationRunRecord_conditionResults(automationRunRecord_conditionResults?: Partial<AutomationRunRecord_conditionResults> | undefined): Record<string, (node: ParseNode) => void>;
3688
3737
  /**
3689
3738
  * The deserialization information for the current model
3690
3739
  * @param AutomationTableRow The instance to deserialize into.
@@ -5180,7 +5229,7 @@ export interface EligibleOutgoingNumberResponse extends AdditionalDataHolder, Pa
5180
5229
  */
5181
5230
  reasonLabel?: string | null;
5182
5231
  /**
5183
- * Reason Leadping selected this outbound sender number.
5232
+ * Explains why Leadping selected, rejected, or substituted an outgoing caller or messaging number.
5184
5233
  */
5185
5234
  selectionReason?: OutgoingNumberSelectionReason | null;
5186
5235
  /**
@@ -5314,7 +5363,7 @@ export interface EventDetailResponse extends AdditionalDataHolder, Parsable {
5314
5363
  */
5315
5364
  undeliverableAt?: Date | null;
5316
5365
  /**
5317
- * User summary connected to this event detail response.
5366
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
5318
5367
  */
5319
5368
  user?: EventDetailResponse_user | null;
5320
5369
  /**
@@ -5329,7 +5378,7 @@ export interface EventDetailResponse extends AdditionalDataHolder, Parsable {
5329
5378
  export type EventDetailResponse_status = (typeof EventDetailResponse_statusObject)[keyof typeof EventDetailResponse_statusObject];
5330
5379
  export type EventDetailResponse_timelineType = (typeof EventDetailResponse_timelineTypeObject)[keyof typeof EventDetailResponse_timelineTypeObject];
5331
5380
  /**
5332
- * User summary connected to this event detail response.
5381
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
5333
5382
  */
5334
5383
  export interface EventDetailResponse_user extends IdNamePair, Parsable {
5335
5384
  }
@@ -5506,7 +5555,7 @@ export interface EventTableRow extends AdditionalDataHolder, Parsable {
5506
5555
  */
5507
5556
  timelineCategory?: string | null;
5508
5557
  /**
5509
- * Timeline type used to render this event in Leadping activity feeds.
5558
+ * Classifies the kind of activity displayed in a lead or conversation event timeline.
5510
5559
  */
5511
5560
  timelineType?: EventTimelineType | null;
5512
5561
  /**
@@ -5610,11 +5659,11 @@ export interface FeedbackResponse extends AdditionalDataHolder, Parsable {
5610
5659
  */
5611
5660
  route?: string | null;
5612
5661
  /**
5613
- * Current lifecycle status for this feedback item response in the Leadping API.
5662
+ * Defines admin triage statuses for durable product feedback.
5614
5663
  */
5615
5664
  status?: FeedbackStatus | null;
5616
5665
  /**
5617
- * Type classification used to route and interpret this feedback item response in the Leadping API.
5666
+ * Defines the type of product feedback submitted from inside Leadping.
5618
5667
  */
5619
5668
  type?: FeedbackType | null;
5620
5669
  /**
@@ -5709,7 +5758,7 @@ export interface LeadArchiveRequest extends AdditionalDataHolder, Parsable {
5709
5758
  */
5710
5759
  note?: string | null;
5711
5760
  /**
5712
- * Human-readable reason supplied for this request or result.
5761
+ * Defines why a lead was removed from the active working pipeline.
5713
5762
  */
5714
5763
  reason?: number | null;
5715
5764
  }
@@ -5718,7 +5767,7 @@ export interface LeadArchiveRequest extends AdditionalDataHolder, Parsable {
5718
5767
  */
5719
5768
  export interface LeadAssignmentRequest extends AdditionalDataHolder, Parsable {
5720
5769
  /**
5721
- * Gets or sets the assigned to user ID.
5770
+ * The assignedToUserId property
5722
5771
  */
5723
5772
  assignedToUserId?: string | null;
5724
5773
  }
@@ -5747,11 +5796,11 @@ export interface LeadContact extends AdditionalDataHolder, Parsable {
5747
5796
  */
5748
5797
  lastName?: string | null;
5749
5798
  /**
5750
- * Phone details for the lead, user, or organization represented by this lead contact profile.
5799
+ * Public Leadping API schema for lead phone number data.
5751
5800
  */
5752
5801
  phone?: LeadContact_phone | null;
5753
5802
  /**
5754
- * Postal street address for the lead contact profile.
5803
+ * Describes a physical or mailing address using international locality, administrative-area, postal-code, and country fields.
5755
5804
  */
5756
5805
  streetAddress?: LeadContact_streetAddress | null;
5757
5806
  /**
@@ -5765,12 +5814,12 @@ export interface LeadContact extends AdditionalDataHolder, Parsable {
5765
5814
  export interface LeadContact_coordinate extends Coordinate, Parsable {
5766
5815
  }
5767
5816
  /**
5768
- * Phone details for the lead, user, or organization represented by this lead contact profile.
5817
+ * Public Leadping API schema for lead phone number data.
5769
5818
  */
5770
5819
  export interface LeadContact_phone extends Parsable, Phone {
5771
5820
  }
5772
5821
  /**
5773
- * Postal street address for the lead contact profile.
5822
+ * Describes a physical or mailing address using international locality, administrative-area, postal-code, and country fields.
5774
5823
  */
5775
5824
  export interface LeadContact_streetAddress extends Parsable, StreetAddress {
5776
5825
  }
@@ -6131,11 +6180,11 @@ export type LeadProfile_maritalStatus = (typeof LeadProfile_maritalStatusObject)
6131
6180
  */
6132
6181
  export interface LeadRequest extends AdditionalDataHolder, Parsable {
6133
6182
  /**
6134
- * Contact details for the lead or customer represented by this lead request.
6183
+ * Public Leadping API schema for lead contact profile data.
6135
6184
  */
6136
6185
  contact?: LeadContact | null;
6137
6186
  /**
6138
- * Demographic profile details for the lead represented by this lead request.
6187
+ * Public Leadping API schema for lead demographic profile data.
6139
6188
  */
6140
6189
  customer?: LeadProfile | null;
6141
6190
  /**
@@ -6147,7 +6196,7 @@ export interface LeadRequest extends AdditionalDataHolder, Parsable {
6147
6196
  */
6148
6197
  id?: string | null;
6149
6198
  /**
6150
- * Structured metadata used for attribution, integrations, and reporting on this lead request.
6199
+ * Public Leadping API schema for lead attribution metadata data.
6151
6200
  */
6152
6201
  metadata?: LeadMetadata | null;
6153
6202
  /**
@@ -6180,7 +6229,7 @@ export interface LeadResponse extends AdditionalDataHolder, Parsable {
6180
6229
  */
6181
6230
  archiveReason?: number | null;
6182
6231
  /**
6183
- * Identifier and display name of the active organization member assigned to this lead.
6232
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
6184
6233
  */
6185
6234
  assignedTo?: LeadResponse_assignedTo | null;
6186
6235
  /**
@@ -6188,7 +6237,7 @@ export interface LeadResponse extends AdditionalDataHolder, Parsable {
6188
6237
  */
6189
6238
  assignedToUserId?: string | null;
6190
6239
  /**
6191
- * Contact details for the lead or customer represented by this lead response.
6240
+ * Public Leadping API schema for lead contact profile data.
6192
6241
  */
6193
6242
  contact?: LeadContact | null;
6194
6243
  /**
@@ -6196,11 +6245,11 @@ export interface LeadResponse extends AdditionalDataHolder, Parsable {
6196
6245
  */
6197
6246
  createdAt?: Date | null;
6198
6247
  /**
6199
- * Current lead status change summary that describes the lead outcome.
6248
+ * Summary schema for Leadping API current lead status change summary data used in dashboards and reports.
6200
6249
  */
6201
6250
  currentLeadStatus?: LeadResponse_currentLeadStatus | null;
6202
6251
  /**
6203
- * Demographic profile details for the lead represented by this lead response.
6252
+ * Public Leadping API schema for lead demographic profile data.
6204
6253
  */
6205
6254
  customer?: LeadProfile | null;
6206
6255
  /**
@@ -6224,7 +6273,7 @@ export interface LeadResponse extends AdditionalDataHolder, Parsable {
6224
6273
  */
6225
6274
  isArchived?: boolean | null;
6226
6275
  /**
6227
- * Structured metadata used for attribution, integrations, and reporting on this lead response.
6276
+ * Public Leadping API schema for lead attribution metadata data.
6228
6277
  */
6229
6278
  metadata?: LeadMetadata | null;
6230
6279
  /**
@@ -6232,7 +6281,7 @@ export interface LeadResponse extends AdditionalDataHolder, Parsable {
6232
6281
  */
6233
6282
  modifiedAt?: Date | null;
6234
6283
  /**
6235
- * Canonical phone identity and provider lookup details for this lead.
6284
+ * Describes Leadping's canonical identity for a phone number, including normalization, carrier, line type, reputation, and lookup history.
6236
6285
  */
6237
6286
  phoneIdentity?: LeadResponse_phoneIdentity | null;
6238
6287
  /**
@@ -6253,17 +6302,17 @@ export interface LeadResponse extends AdditionalDataHolder, Parsable {
6253
6302
  tags?: TagSummary[] | null;
6254
6303
  }
6255
6304
  /**
6256
- * Identifier and display name of the active organization member assigned to this lead.
6305
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
6257
6306
  */
6258
6307
  export interface LeadResponse_assignedTo extends IdNamePair, Parsable {
6259
6308
  }
6260
6309
  /**
6261
- * Current lead status change summary that describes the lead outcome.
6310
+ * Summary schema for Leadping API current lead status change summary data used in dashboards and reports.
6262
6311
  */
6263
6312
  export interface LeadResponse_currentLeadStatus extends CurrentLeadStatusSummary, Parsable {
6264
6313
  }
6265
6314
  /**
6266
- * Canonical phone identity and provider lookup details for this lead.
6315
+ * Describes Leadping's canonical identity for a phone number, including normalization, carrier, line type, reputation, and lookup history.
6267
6316
  */
6268
6317
  export interface LeadResponse_phoneIdentity extends Parsable, PhoneIdentityResponse {
6269
6318
  }
@@ -6511,6 +6560,14 @@ export interface LeadStatusChangeResponse extends AdditionalDataHolder, Parsable
6511
6560
  * Whether this lead status change is missed call follow up.
6512
6561
  */
6513
6562
  isMissedCallFollowUp?: boolean | null;
6563
+ /**
6564
+ * The lead's profile image URL, when available.
6565
+ */
6566
+ leadAvatarUrl?: string | null;
6567
+ /**
6568
+ * The lead's email address, used for Gravatar fallback.
6569
+ */
6570
+ leadEmail?: string | null;
6514
6571
  /**
6515
6572
  * The lead ID associated with this lead status change.
6516
6573
  */
@@ -6601,7 +6658,7 @@ export type LeadStatusRequest_category = (typeof LeadStatusRequest_categoryObjec
6601
6658
  */
6602
6659
  export interface LeadStatusResponse extends AdditionalDataHolder, Parsable {
6603
6660
  /**
6604
- * LeadStatusChange category represented by the lead status.
6661
+ * Controlled lead status change categories used for reporting, automation, and analytics.
6605
6662
  */
6606
6663
  category?: LeadStatusCategory | null;
6607
6664
  /**
@@ -6650,7 +6707,7 @@ export interface LeadTableRow extends AdditionalDataHolder, Parsable {
6650
6707
  */
6651
6708
  archiveReason?: number | null;
6652
6709
  /**
6653
- * Identifier and display name of the assigned organization member.
6710
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
6654
6711
  */
6655
6712
  assignedTo?: LeadTableRow_assignedTo | null;
6656
6713
  /**
@@ -6666,7 +6723,7 @@ export interface LeadTableRow extends AdditionalDataHolder, Parsable {
6666
6723
  */
6667
6724
  createdAt?: Date | null;
6668
6725
  /**
6669
- * Current lead status change summary that describes the lead outcome.
6726
+ * Summary schema for Leadping API current lead status change summary data used in dashboards and reports.
6670
6727
  */
6671
6728
  currentLeadStatus?: LeadTableRow_currentLeadStatus | null;
6672
6729
  /**
@@ -6694,7 +6751,7 @@ export interface LeadTableRow extends AdditionalDataHolder, Parsable {
6694
6751
  */
6695
6752
  lastName?: string | null;
6696
6753
  /**
6697
- * Identifier and display name of the related organization.
6754
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
6698
6755
  */
6699
6756
  organization?: LeadTableRow_organization | null;
6700
6757
  /**
@@ -6722,7 +6779,7 @@ export interface LeadTableRow extends AdditionalDataHolder, Parsable {
6722
6779
  */
6723
6780
  processingStatusReason?: string | null;
6724
6781
  /**
6725
- * Identifier and display name of the related source.
6782
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
6726
6783
  */
6727
6784
  source?: LeadTableRow_source | null;
6728
6785
  /**
@@ -6743,23 +6800,23 @@ export interface LeadTableRow extends AdditionalDataHolder, Parsable {
6743
6800
  updatedAt?: Date | null;
6744
6801
  }
6745
6802
  /**
6746
- * Identifier and display name of the assigned organization member.
6803
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
6747
6804
  */
6748
6805
  export interface LeadTableRow_assignedTo extends IdNamePair, Parsable {
6749
6806
  }
6750
6807
  /**
6751
- * Current lead status change summary that describes the lead outcome.
6808
+ * Summary schema for Leadping API current lead status change summary data used in dashboards and reports.
6752
6809
  */
6753
6810
  export interface LeadTableRow_currentLeadStatus extends CurrentLeadStatusSummary, Parsable {
6754
6811
  }
6755
6812
  /**
6756
- * Identifier and display name of the related organization.
6813
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
6757
6814
  */
6758
6815
  export interface LeadTableRow_organization extends IdNamePair, Parsable {
6759
6816
  }
6760
6817
  export type LeadTableRow_processingStatus = (typeof LeadTableRow_processingStatusObject)[keyof typeof LeadTableRow_processingStatusObject];
6761
6818
  /**
6762
- * Identifier and display name of the related source.
6819
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
6763
6820
  */
6764
6821
  export interface LeadTableRow_source extends IdNamePair, Parsable {
6765
6822
  }
@@ -6792,6 +6849,10 @@ export interface MessageMediaAttachment extends AdditionalDataHolder, Parsable {
6792
6849
  * Original file name of the media attachment, when available.
6793
6850
  */
6794
6851
  fileName?: string | null;
6852
+ /**
6853
+ * The durable Media record containing this attachment's scanned bytes.
6854
+ */
6855
+ mediaId?: string | null;
6795
6856
  /**
6796
6857
  * SHA-256 digest of the media content, when available.
6797
6858
  */
@@ -6810,7 +6871,7 @@ export interface MessageMediaAttachment extends AdditionalDataHolder, Parsable {
6810
6871
  */
6811
6872
  export interface MobileDevicePreferences extends AdditionalDataHolder, Parsable {
6812
6873
  /**
6813
- * Identifier and display name of the related device.
6874
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
6814
6875
  */
6815
6876
  device?: IdNamePair | null;
6816
6877
  /**
@@ -6864,7 +6925,7 @@ export interface NotificationResponse extends AdditionalDataHolder, Parsable {
6864
6925
  */
6865
6926
  name?: string | null;
6866
6927
  /**
6867
- * Priority for this notification.
6928
+ * Ranks the urgency and presentation importance of a Leadping user notification.
6868
6929
  */
6869
6930
  priority?: NotificationPriority | null;
6870
6931
  /**
@@ -6884,7 +6945,7 @@ export interface NotificationResponse extends AdditionalDataHolder, Parsable {
6884
6945
  */
6885
6946
  relatedEntityType?: string | null;
6886
6947
  /**
6887
- * The type classification for this notification.
6948
+ * Identifies the Leadping workflow or account event communicated by a user notification.
6888
6949
  */
6889
6950
  type?: NotificationType | null;
6890
6951
  /**
@@ -6933,7 +6994,7 @@ export interface NotificationTableRow extends AdditionalDataHolder, Parsable {
6933
6994
  */
6934
6995
  name?: string | null;
6935
6996
  /**
6936
- * Priority for this notification.
6997
+ * Ranks the urgency and presentation importance of a Leadping user notification.
6937
6998
  */
6938
6999
  priority?: NotificationPriority | null;
6939
7000
  /**
@@ -6949,7 +7010,7 @@ export interface NotificationTableRow extends AdditionalDataHolder, Parsable {
6949
7010
  */
6950
7011
  relatedEntityType?: string | null;
6951
7012
  /**
6952
- * The type classification for this notification.
7013
+ * Identifies the Leadping workflow or account event communicated by a user notification.
6953
7014
  */
6954
7015
  type?: NotificationType | null;
6955
7016
  }
@@ -6981,7 +7042,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
6981
7042
  */
6982
7043
  availableDomainCount?: number | null;
6983
7044
  /**
6984
- * The current billing subscription status for this organization activation state.
7045
+ * Describes whether an organization's subscription is ready, blocked, or still incomplete during activation.
6985
7046
  */
6986
7047
  billingSubscriptionStatus?: ActivationSubscriptionStatus | null;
6987
7048
  /**
@@ -7049,7 +7110,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
7049
7110
  */
7050
7111
  launchReviewRequestedAt?: Date | null;
7051
7112
  /**
7052
- * The current launch review status for this organization activation state.
7113
+ * Describes the administrative review decision that determines whether an organization can launch Leadping workflows.
7053
7114
  */
7054
7115
  launchReviewStatus?: ActivationLaunchReviewStatus | null;
7055
7116
  /**
@@ -7057,7 +7118,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
7057
7118
  */
7058
7119
  offer?: string | null;
7059
7120
  /**
7060
- * The current onboarding status for this organization activation state.
7121
+ * Describes completion and blocking state for an organization's core Leadping onboarding requirements.
7061
7122
  */
7062
7123
  onboardingStatus?: ActivationOnboardingStatus | null;
7063
7124
  /**
@@ -7069,7 +7130,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
7069
7130
  */
7070
7131
  paymentMethodConfirmedAt?: Date | null;
7071
7132
  /**
7072
- * The current payment status for this organization activation state.
7133
+ * Describes whether valid funding and payment prerequisites are satisfied during organization activation.
7073
7134
  */
7074
7135
  paymentStatus?: ActivationPaymentStatus | null;
7075
7136
  /**
@@ -7081,7 +7142,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
7081
7142
  */
7082
7143
  serviceArea?: string | null;
7083
7144
  /**
7084
- * The current status for this organization activation state.
7145
+ * Summarizes an organization's overall progress from initial Leadping onboarding through launch readiness.
7085
7146
  */
7086
7147
  status?: CustomerActivationStatus | null;
7087
7148
  /**
@@ -7109,7 +7170,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
7109
7170
  */
7110
7171
  telephonyReadyAt?: Date | null;
7111
7172
  /**
7112
- * The current telephony status for this organization activation state.
7173
+ * Describes whether phone numbers, calling, messaging, and provider resources are ready for organization launch.
7113
7174
  */
7114
7175
  telephonyStatus?: ActivationTelephonyStatus | null;
7115
7176
  /**
@@ -7117,11 +7178,11 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
7117
7178
  */
7118
7179
  tenDlcApplicationId?: string | null;
7119
7180
  /**
7120
- * 10DLC draft for this organization activation state.
7181
+ * Describes 10DLC application draft data used in Leadping API requests and responses.
7121
7182
  */
7122
7183
  tenDlcDraft?: OrganizationActivationState_tenDlcDraft | null;
7123
7184
  /**
7124
- * The current 10DLC status for this organization activation state.
7185
+ * Describes an organization's overall 10DLC registration lifecycle across brand and messaging campaign submission.
7125
7186
  */
7126
7187
  tenDlcStatus?: TenDlcApplicationStatus | null;
7127
7188
  /**
@@ -7137,7 +7198,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
7137
7198
  */
7138
7199
  websiteNeeds?: string | null;
7139
7200
  /**
7140
- * The current website status for this organization activation state.
7201
+ * Describes an organization website's lifecycle from discovery and verification through activation, suspension, or removal.
7141
7202
  */
7142
7203
  websiteStatus?: WebsiteLifecycleStatus | null;
7143
7204
  /**
@@ -7147,7 +7208,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
7147
7208
  }
7148
7209
  export type OrganizationActivationState_domainSearchStage = (typeof OrganizationActivationState_domainSearchStageObject)[keyof typeof OrganizationActivationState_domainSearchStageObject];
7149
7210
  /**
7150
- * 10DLC draft for this organization activation state.
7211
+ * Describes 10DLC application draft data used in Leadping API requests and responses.
7151
7212
  */
7152
7213
  export interface OrganizationActivationState_tenDlcDraft extends Parsable, TenDlcApplicationDraft {
7153
7214
  }
@@ -7156,7 +7217,7 @@ export interface OrganizationActivationState_tenDlcDraft extends Parsable, TenDl
7156
7217
  */
7157
7218
  export interface OrganizationApiKeyIssueResponse extends AdditionalDataHolder, Parsable {
7158
7219
  /**
7159
- * API key associated with this Leadping organization API key issue.
7220
+ * Safe identifying and usage metadata for an organization API key. This model never contains the secret credential.
7160
7221
  */
7161
7222
  apiKey?: OrganizationApiKeyPreviewResponse | null;
7162
7223
  /**
@@ -7230,7 +7291,7 @@ export interface OrganizationApiKeyPreviewResponse extends AdditionalDataHolder,
7230
7291
  */
7231
7292
  name?: string | null;
7232
7293
  /**
7233
- * Organization that owns the API key.
7294
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
7234
7295
  */
7235
7296
  organization?: IdNamePair | null;
7236
7297
  /**
@@ -7289,7 +7350,7 @@ export interface OrganizationBillingState extends AdditionalDataHolder, Parsable
7289
7350
  */
7290
7351
  cancelAt?: Date | null;
7291
7352
  /**
7292
- * Customer-safe payment recovery state for the organization.
7353
+ * Dunning state recorded after a failed recurring payment.
7293
7354
  */
7294
7355
  dunning?: OrganizationBillingState_dunning | null;
7295
7356
  /**
@@ -7334,7 +7395,7 @@ export interface OrganizationBillingState extends AdditionalDataHolder, Parsable
7334
7395
  planRenewalAt?: Date | null;
7335
7396
  }
7336
7397
  /**
7337
- * Customer-safe payment recovery state for the organization.
7398
+ * Dunning state recorded after a failed recurring payment.
7338
7399
  */
7339
7400
  export interface OrganizationBillingState_dunning extends OrganizationDunningInfo, Parsable {
7340
7401
  }
@@ -7430,7 +7491,7 @@ export interface OrganizationInvitationRequest extends AdditionalDataHolder, Par
7430
7491
  */
7431
7492
  email?: string | null;
7432
7493
  /**
7433
- * Role for this organization invitation.
7494
+ * Identifies an organization member's access level and permission scope within Leadping.
7434
7495
  */
7435
7496
  role?: OrganizationMemberRole | null;
7436
7497
  }
@@ -7479,7 +7540,7 @@ export interface OrganizationInvitationResponse extends AdditionalDataHolder, Pa
7479
7540
  */
7480
7541
  licenseRenewalDate?: Date | null;
7481
7542
  /**
7482
- * Identifier and display name of the related organization.
7543
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
7483
7544
  */
7484
7545
  organization?: IdNamePair | null;
7485
7546
  /**
@@ -7491,7 +7552,7 @@ export interface OrganizationInvitationResponse extends AdditionalDataHolder, Pa
7491
7552
  */
7492
7553
  revokedAt?: Date | null;
7493
7554
  /**
7494
- * Role for this organization invitation.
7555
+ * Identifies an organization member's access level and permission scope within Leadping.
7495
7556
  */
7496
7557
  role?: OrganizationMemberRole | null;
7497
7558
  /**
@@ -7507,7 +7568,7 @@ export interface OrganizationInvitationResponse extends AdditionalDataHolder, Pa
7507
7568
  */
7508
7569
  sentAt?: Date | null;
7509
7570
  /**
7510
- * The current status for this organization invitation.
7571
+ * Describes the lifecycle of an organization membership invitation from issuance through acceptance, expiration, or revocation.
7511
7572
  */
7512
7573
  status?: OrganizationInvitationStatus | null;
7513
7574
  }
@@ -7557,7 +7618,7 @@ export interface OrganizationInvitationTableRow extends AdditionalDataHolder, Pa
7557
7618
  */
7558
7619
  licenseRenewalDate?: Date | null;
7559
7620
  /**
7560
- * Identifier and display name of the related organization.
7621
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
7561
7622
  */
7562
7623
  organization?: IdNamePair | null;
7563
7624
  /**
@@ -7569,7 +7630,7 @@ export interface OrganizationInvitationTableRow extends AdditionalDataHolder, Pa
7569
7630
  */
7570
7631
  revokedAt?: Date | null;
7571
7632
  /**
7572
- * Role for this organization invitation.
7633
+ * Identifies an organization member's access level and permission scope within Leadping.
7573
7634
  */
7574
7635
  role?: OrganizationMemberRole | null;
7575
7636
  /**
@@ -7581,7 +7642,7 @@ export interface OrganizationInvitationTableRow extends AdditionalDataHolder, Pa
7581
7642
  */
7582
7643
  sentAt?: Date | null;
7583
7644
  /**
7584
- * The current status for this organization invitation.
7645
+ * Describes the lifecycle of an organization membership invitation from issuance through acceptance, expiration, or revocation.
7585
7646
  */
7586
7647
  status?: OrganizationInvitationStatus | null;
7587
7648
  }
@@ -7594,7 +7655,7 @@ export interface OrganizationMemberRequest extends AdditionalDataHolder, Parsabl
7594
7655
  */
7595
7656
  email?: string | null;
7596
7657
  /**
7597
- * Organization role assigned to the user.
7658
+ * Identifies an organization member's access level and permission scope within Leadping.
7598
7659
  */
7599
7660
  role?: OrganizationMemberRole | null;
7600
7661
  /**
@@ -7643,7 +7704,7 @@ export interface OrganizationMemberResponse extends AdditionalDataHolder, Parsab
7643
7704
  */
7644
7705
  name?: string | null;
7645
7706
  /**
7646
- * Organization for this organization user.
7707
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
7647
7708
  */
7648
7709
  organization?: IdNamePair | null;
7649
7710
  /**
@@ -7655,11 +7716,11 @@ export interface OrganizationMemberResponse extends AdditionalDataHolder, Parsab
7655
7716
  */
7656
7717
  removedByUserId?: string | null;
7657
7718
  /**
7658
- * Role for this organization user.
7719
+ * Identifies an organization member's access level and permission scope within Leadping.
7659
7720
  */
7660
7721
  role?: OrganizationMemberRole | null;
7661
7722
  /**
7662
- * User for this organization user.
7723
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
7663
7724
  */
7664
7725
  user?: IdNamePair | null;
7665
7726
  /**
@@ -7689,11 +7750,11 @@ export interface OrganizationMemberTableRow extends AdditionalDataHolder, Parsab
7689
7750
  */
7690
7751
  licenseRenewalDate?: Date | null;
7691
7752
  /**
7692
- * Role for this organization user.
7753
+ * Identifies an organization member's access level and permission scope within Leadping.
7693
7754
  */
7694
7755
  role?: OrganizationMemberRole | null;
7695
7756
  /**
7696
- * Identifier and display name of the related user.
7757
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
7697
7758
  */
7698
7759
  user?: IdNamePair | null;
7699
7760
  /**
@@ -7706,7 +7767,7 @@ export interface OrganizationMemberTableRow extends AdditionalDataHolder, Parsab
7706
7767
  */
7707
7768
  export interface OrganizationRequest extends AdditionalDataHolder, Parsable {
7708
7769
  /**
7709
- * Postal address for the organization, lead, or contact represented by this organization profile request.
7770
+ * Describes a physical or mailing address using international locality, administrative-area, postal-code, and country fields.
7710
7771
  */
7711
7772
  address?: OrganizationRequest_address | null;
7712
7773
  /**
@@ -7743,7 +7804,7 @@ export interface OrganizationRequest extends AdditionalDataHolder, Parsable {
7743
7804
  website?: string | null;
7744
7805
  }
7745
7806
  /**
7746
- * Postal address for the organization, lead, or contact represented by this organization profile request.
7807
+ * Describes a physical or mailing address using international locality, administrative-area, postal-code, and country fields.
7747
7808
  */
7748
7809
  export interface OrganizationRequest_address extends Parsable, StreetAddress {
7749
7810
  }
@@ -7756,11 +7817,11 @@ export interface OrganizationResponse extends AdditionalDataHolder, Parsable {
7756
7817
  */
7757
7818
  accountBalance?: number | null;
7758
7819
  /**
7759
- * Organization activation state covering site, billing, compliance, and telephony readiness.
7820
+ * Describes organization activation state data used in Leadping API requests and responses.
7760
7821
  */
7761
7822
  activation?: OrganizationResponse_activation | null;
7762
7823
  /**
7763
- * Postal address for the organization, lead, or contact represented by this organization profile response.
7824
+ * Describes a physical or mailing address using international locality, administrative-area, postal-code, and country fields.
7764
7825
  */
7765
7826
  address?: OrganizationResponse_address | null;
7766
7827
  /**
@@ -7776,7 +7837,7 @@ export interface OrganizationResponse extends AdditionalDataHolder, Parsable {
7776
7837
  */
7777
7838
  autoRefillTrigger?: number | null;
7778
7839
  /**
7779
- * Postal address used for invoices, receipts, and payment processor billing records.
7840
+ * Describes a physical or mailing address using international locality, administrative-area, postal-code, and country fields.
7780
7841
  */
7781
7842
  billingAddress?: OrganizationResponse_billingAddress | null;
7782
7843
  /**
@@ -7788,7 +7849,7 @@ export interface OrganizationResponse extends AdditionalDataHolder, Parsable {
7788
7849
  */
7789
7850
  billingPlan?: OrganizationResponse_billingPlan | null;
7790
7851
  /**
7791
- * Customer-safe billing state for this organization.
7852
+ * Customer-safe billing state for a Leadping organization.
7792
7853
  */
7793
7854
  billingState?: OrganizationResponse_billingState | null;
7794
7855
  /**
@@ -7796,7 +7857,7 @@ export interface OrganizationResponse extends AdditionalDataHolder, Parsable {
7796
7857
  */
7797
7858
  billingTaxId?: string | null;
7798
7859
  /**
7799
- * Compliance policy configuration for the organization.
7860
+ * Describes organization compliance policy data used in Leadping API requests and responses.
7800
7861
  */
7801
7862
  compliancePolicy?: OrganizationResponse_compliancePolicy | null;
7802
7863
  /**
@@ -7816,7 +7877,7 @@ export interface OrganizationResponse extends AdditionalDataHolder, Parsable {
7816
7877
  */
7817
7878
  ein?: string | null;
7818
7879
  /**
7819
- * Uploaded EIN document reference used for organization verification.
7880
+ * Extends an identifier-and-name resource reference with an optional string value used for display or selection metadata.
7820
7881
  */
7821
7882
  einDocument?: OrganizationResponse_einDocument | null;
7822
7883
  /**
@@ -7856,7 +7917,7 @@ export interface OrganizationResponse extends AdditionalDataHolder, Parsable {
7856
7917
  */
7857
7918
  setupStep?: OrganizationResponse_setupStep | null;
7858
7919
  /**
7859
- * Leadping website record connected to this organization.
7920
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
7860
7921
  */
7861
7922
  site?: OrganizationResponse_site | null;
7862
7923
  /**
@@ -7868,7 +7929,7 @@ export interface OrganizationResponse extends AdditionalDataHolder, Parsable {
7868
7929
  */
7869
7930
  subscriptionStatus?: OrganizationResponse_subscriptionStatus | null;
7870
7931
  /**
7871
- * User summary connected to this organization profile response.
7932
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
7872
7933
  */
7873
7934
  user?: OrganizationResponse_user | null;
7874
7935
  /**
@@ -7881,47 +7942,47 @@ export interface OrganizationResponse extends AdditionalDataHolder, Parsable {
7881
7942
  website?: string | null;
7882
7943
  }
7883
7944
  /**
7884
- * Organization activation state covering site, billing, compliance, and telephony readiness.
7945
+ * Describes organization activation state data used in Leadping API requests and responses.
7885
7946
  */
7886
7947
  export interface OrganizationResponse_activation extends OrganizationActivationState, Parsable {
7887
7948
  }
7888
7949
  /**
7889
- * Postal address for the organization, lead, or contact represented by this organization profile response.
7950
+ * Describes a physical or mailing address using international locality, administrative-area, postal-code, and country fields.
7890
7951
  */
7891
7952
  export interface OrganizationResponse_address extends Parsable, StreetAddress {
7892
7953
  }
7893
7954
  /**
7894
- * Postal address used for invoices, receipts, and payment processor billing records.
7955
+ * Describes a physical or mailing address using international locality, administrative-area, postal-code, and country fields.
7895
7956
  */
7896
7957
  export interface OrganizationResponse_billingAddress extends Parsable, StreetAddress {
7897
7958
  }
7898
7959
  export type OrganizationResponse_billingPlan = (typeof OrganizationResponse_billingPlanObject)[keyof typeof OrganizationResponse_billingPlanObject];
7899
7960
  /**
7900
- * Customer-safe billing state for this organization.
7961
+ * Customer-safe billing state for a Leadping organization.
7901
7962
  */
7902
7963
  export interface OrganizationResponse_billingState extends OrganizationBillingState, Parsable {
7903
7964
  }
7904
7965
  /**
7905
- * Compliance policy configuration for the organization.
7966
+ * Describes organization compliance policy data used in Leadping API requests and responses.
7906
7967
  */
7907
7968
  export interface OrganizationResponse_compliancePolicy extends OrganizationCompliancePolicy, Parsable {
7908
7969
  }
7909
7970
  /**
7910
- * Uploaded EIN document reference used for organization verification.
7971
+ * Extends an identifier-and-name resource reference with an optional string value used for display or selection metadata.
7911
7972
  */
7912
7973
  export interface OrganizationResponse_einDocument extends IdNameValue, Parsable {
7913
7974
  }
7914
7975
  export type OrganizationResponse_setupStatus = (typeof OrganizationResponse_setupStatusObject)[keyof typeof OrganizationResponse_setupStatusObject];
7915
7976
  export type OrganizationResponse_setupStep = (typeof OrganizationResponse_setupStepObject)[keyof typeof OrganizationResponse_setupStepObject];
7916
7977
  /**
7917
- * Leadping website record connected to this organization.
7978
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
7918
7979
  */
7919
7980
  export interface OrganizationResponse_site extends IdNamePair, Parsable {
7920
7981
  }
7921
7982
  export type OrganizationResponse_status = (typeof OrganizationResponse_statusObject)[keyof typeof OrganizationResponse_statusObject];
7922
7983
  export type OrganizationResponse_subscriptionStatus = (typeof OrganizationResponse_subscriptionStatusObject)[keyof typeof OrganizationResponse_subscriptionStatusObject];
7923
7984
  /**
7924
- * User summary connected to this organization profile response.
7985
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
7925
7986
  */
7926
7987
  export interface OrganizationResponse_user extends IdNamePair, Parsable {
7927
7988
  }
@@ -7970,7 +8031,7 @@ export interface OrganizationSwitchOption extends AdditionalDataHolder, Parsable
7970
8031
  */
7971
8032
  readyForCustomerTraffic?: boolean | null;
7972
8033
  /**
7973
- * Role for this organization switch option.
8034
+ * Identifies an organization member's access level and permission scope within Leadping.
7974
8035
  */
7975
8036
  role?: OrganizationMemberRole | null;
7976
8037
  /**
@@ -8051,7 +8112,7 @@ export interface OutboundPhoneNumberCapacity extends AdditionalDataHolder, Parsa
8051
8112
  */
8052
8113
  healthReason?: string | null;
8053
8114
  /**
8054
- * Current health status for this Leadping outbound phone number capacity.
8115
+ * Defines phone-number outbound health states used by pacing.
8055
8116
  */
8056
8117
  healthStatus?: PhoneNumberOutboundHealthStatus | null;
8057
8118
  /**
@@ -8176,7 +8237,7 @@ export interface OutboundPhoneNumberCapacity extends AdditionalDataHolder, Parsa
8176
8237
  */
8177
8238
  export interface OutboundQueueItem extends AdditionalDataHolder, Parsable {
8178
8239
  /**
8179
- * Channel classification for this Leadping outbound queue item.
8240
+ * Defines outbound delivery channels protected by delivery control.
8180
8241
  */
8181
8242
  channel?: OutboundDeliveryChannel | null;
8182
8243
  /**
@@ -8200,11 +8261,11 @@ export interface OutboundQueueItem extends AdditionalDataHolder, Parsable {
8200
8261
  */
8201
8262
  scheduledSendAt?: Date | null;
8202
8263
  /**
8203
- * Source classification for this Leadping outbound queue item.
8264
+ * Defines the source that requested outbound delivery.
8204
8265
  */
8205
8266
  source?: OutboundDeliverySource | null;
8206
8267
  /**
8207
- * Current status for this Leadping outbound queue item.
8268
+ * Defines durable outbound delivery request statuses.
8208
8269
  */
8209
8270
  status?: OutboundDeliveryStatus | null;
8210
8271
  }
@@ -8218,7 +8279,7 @@ export interface OutgoingNumberManualOverrideRequest extends AdditionalDataHolde
8218
8279
  */
8219
8280
  fromPhoneNumberId?: string | null;
8220
8281
  /**
8221
- * Selected outgoing number and selection rationale returned by Leadping.
8282
+ * Defines the fields clients can send when working with outgoing number selection.
8222
8283
  */
8223
8284
  selection?: OutgoingNumberSelectionRequest | null;
8224
8285
  }
@@ -8699,7 +8760,7 @@ export interface PhoneCallResponse extends AdditionalDataHolder, Parsable {
8699
8760
  */
8700
8761
  sourceId?: string | null;
8701
8762
  /**
8702
- * Current lifecycle status for this phone call in the Leadping API.
8763
+ * Describes the durable business outcome of a Leadping phone call after provider status normalization.
8703
8764
  */
8704
8765
  status?: PhoneCallStatus | null;
8705
8766
  /**
@@ -8746,11 +8807,11 @@ export interface PhoneIdentityLookupAction extends AdditionalDataHolder, Parsabl
8746
8807
  */
8747
8808
  providerPricingVersion?: string | null;
8748
8809
  /**
8749
- * The processing outcome reported for the phone identity lookup.
8810
+ * Identifies the outcome of a phone identity lookup action.
8750
8811
  */
8751
8812
  status?: PhoneIdentityLookupActionStatus | null;
8752
8813
  /**
8753
- * The category of enrichment, validation, or reputation lookup that was performed.
8814
+ * Identifies the kind of lookup action performed for a phone identity.
8754
8815
  */
8755
8816
  type?: PhoneIdentityLookupActionType | null;
8756
8817
  }
@@ -8773,7 +8834,7 @@ export interface PhoneIdentityResponse extends AdditionalDataHolder, Parsable {
8773
8834
  */
8774
8835
  lastEnrichedAt?: Date | null;
8775
8836
  /**
8776
- * Provider lookup and enrichment data for the number.
8837
+ * Public Leadping API schema for phone lookup result data.
8777
8838
  */
8778
8839
  lookup?: PhoneIdentityResponse_lookup | null;
8779
8840
  /**
@@ -8793,17 +8854,17 @@ export interface PhoneIdentityResponse extends AdditionalDataHolder, Parsable {
8793
8854
  */
8794
8855
  number?: string | null;
8795
8856
  /**
8796
- * Lossless provider response retained for administrative diagnostics.
8857
+ * Lossless provider snapshot retained with a phone identity for replay, audits, and fields added by providers later.
8797
8858
  */
8798
8859
  providerEnrichment?: PhoneIdentityResponse_providerEnrichment | null;
8799
8860
  }
8800
8861
  /**
8801
- * Provider lookup and enrichment data for the number.
8862
+ * Public Leadping API schema for phone lookup result data.
8802
8863
  */
8803
8864
  export interface PhoneIdentityResponse_lookup extends Parsable, PhoneLookup {
8804
8865
  }
8805
8866
  /**
8806
- * Lossless provider response retained for administrative diagnostics.
8867
+ * Lossless provider snapshot retained with a phone identity for replay, audits, and fields added by providers later.
8807
8868
  */
8808
8869
  export interface PhoneIdentityResponse_providerEnrichment extends Parsable, PhoneLookupProviderSnapshot {
8809
8870
  }
@@ -8825,11 +8886,11 @@ export interface PhoneLocationSource extends AdditionalDataHolder, Parsable {
8825
8886
  */
8826
8887
  export interface PhoneLookup extends AdditionalDataHolder, Parsable {
8827
8888
  /**
8828
- * Caller-name data returned by the provider.
8889
+ * Caller-name data returned by the phone lookup provider.
8829
8890
  */
8830
8891
  callerName?: PhoneLookup_callerName | null;
8831
8892
  /**
8832
- * Complete carrier metadata reported for this phone number.
8893
+ * Complete carrier metadata returned by a phone number lookup provider.
8833
8894
  */
8834
8895
  carrier?: PhoneLookup_carrier | null;
8835
8896
  /**
@@ -8853,7 +8914,7 @@ export interface PhoneLookup extends AdditionalDataHolder, Parsable {
8853
8914
  */
8854
8915
  lineType?: PhoneLookup_lineType | null;
8855
8916
  /**
8856
- * Geographic location metadata for the phone number, lead, or lookup result.
8917
+ * Public Leadping API schema for phone number location data.
8857
8918
  */
8858
8919
  location?: PhoneLookup_location | null;
8859
8920
  /**
@@ -8869,7 +8930,7 @@ export interface PhoneLookup extends AdditionalDataHolder, Parsable {
8869
8930
  */
8870
8931
  number?: string | null;
8871
8932
  /**
8872
- * Complete portability data returned by Telnyx.
8933
+ * Number-portability and routing data returned by Telnyx.
8873
8934
  */
8874
8935
  portability?: PhoneLookup_portability | null;
8875
8936
  /**
@@ -8878,23 +8939,23 @@ export interface PhoneLookup extends AdditionalDataHolder, Parsable {
8878
8939
  recordType?: string | null;
8879
8940
  }
8880
8941
  /**
8881
- * Caller-name data returned by the provider.
8942
+ * Caller-name data returned by the phone lookup provider.
8882
8943
  */
8883
8944
  export interface PhoneLookup_callerName extends Parsable, PhoneLookupCallerName {
8884
8945
  }
8885
8946
  /**
8886
- * Complete carrier metadata reported for this phone number.
8947
+ * Complete carrier metadata returned by a phone number lookup provider.
8887
8948
  */
8888
8949
  export interface PhoneLookup_carrier extends Parsable, PhoneLookupCarrier {
8889
8950
  }
8890
8951
  export type PhoneLookup_lineType = (typeof PhoneLookup_lineTypeObject)[keyof typeof PhoneLookup_lineTypeObject];
8891
8952
  /**
8892
- * Geographic location metadata for the phone number, lead, or lookup result.
8953
+ * Public Leadping API schema for phone number location data.
8893
8954
  */
8894
8955
  export interface PhoneLookup_location extends Parsable, PhoneNumberLocation {
8895
8956
  }
8896
8957
  /**
8897
- * Complete portability data returned by Telnyx.
8958
+ * Number-portability and routing data returned by Telnyx.
8898
8959
  */
8899
8960
  export interface PhoneLookup_portability extends Parsable, PhoneLookupPortability {
8900
8961
  }
@@ -9045,7 +9106,7 @@ export interface PhoneNumberAvailabilityResponse extends AdditionalDataHolder, P
9045
9106
  */
9046
9107
  isAvailable?: boolean | null;
9047
9108
  /**
9048
- * Geographic location metadata for the phone number, lead, or lookup result.
9109
+ * Public Leadping API schema for phone number location data.
9049
9110
  */
9050
9111
  location?: PhoneNumberAvailabilityResponse_location | null;
9051
9112
  /**
@@ -9058,7 +9119,7 @@ export interface PhoneNumberAvailabilityResponse extends AdditionalDataHolder, P
9058
9119
  price?: number | null;
9059
9120
  }
9060
9121
  /**
9061
- * Geographic location metadata for the phone number, lead, or lookup result.
9122
+ * Public Leadping API schema for phone number location data.
9062
9123
  */
9063
9124
  export interface PhoneNumberAvailabilityResponse_location extends Parsable, PhoneNumberLocation {
9064
9125
  }
@@ -9075,11 +9136,11 @@ export interface PhoneNumberLocation extends AdditionalDataHolder, Parsable {
9075
9136
  */
9076
9137
  canonicalState?: string | null;
9077
9138
  /**
9078
- * Latitude and longitude coordinate for this phone number location.
9139
+ * Latitude and longitude coordinate for this lead contact profile.
9079
9140
  */
9080
9141
  coordinate?: PhoneNumberLocation_coordinate | null;
9081
9142
  /**
9082
- * Describes how the coordinate was resolved.
9143
+ * Describes how a phone location value was resolved.
9083
9144
  */
9084
9145
  coordinateSource?: PhoneNumberLocation_coordinateSource | null;
9085
9146
  /**
@@ -9099,22 +9160,22 @@ export interface PhoneNumberLocation extends AdditionalDataHolder, Parsable {
9099
9160
  */
9100
9161
  timeZoneId?: string | null;
9101
9162
  /**
9102
- * Describes how the time zone was resolved.
9163
+ * Describes how a phone location value was resolved.
9103
9164
  */
9104
9165
  timeZoneSource?: PhoneNumberLocation_timeZoneSource | null;
9105
9166
  }
9106
9167
  /**
9107
- * Latitude and longitude coordinate for this phone number location.
9168
+ * Latitude and longitude coordinate for this lead contact profile.
9108
9169
  */
9109
9170
  export interface PhoneNumberLocation_coordinate extends Coordinate, Parsable {
9110
9171
  }
9111
9172
  /**
9112
- * Describes how the coordinate was resolved.
9173
+ * Describes how a phone location value was resolved.
9113
9174
  */
9114
9175
  export interface PhoneNumberLocation_coordinateSource extends Parsable, PhoneLocationSource {
9115
9176
  }
9116
9177
  /**
9117
- * Describes how the time zone was resolved.
9178
+ * Describes how a phone location value was resolved.
9118
9179
  */
9119
9180
  export interface PhoneNumberLocation_timeZoneSource extends Parsable, PhoneLocationSource {
9120
9181
  }
@@ -9229,6 +9290,10 @@ export interface PhoneNumberRequest extends AdditionalDataHolder, Parsable {
9229
9290
  * E.164 phone number exposed by this phone number update request.
9230
9291
  */
9231
9292
  number?: string | null;
9293
+ /**
9294
+ * Opts this number into the optional $2 monthly number health add-on. Defaults to on on creation; omitted updates preserve the current selection.
9295
+ */
9296
+ numberHealthEnabled?: boolean | null;
9232
9297
  }
9233
9298
  /**
9234
9299
  * Describes a Leadping-managed phone number, including capabilities, messaging registration, health, and assignment details.
@@ -9263,7 +9328,11 @@ export interface PhoneNumberResponse extends AdditionalDataHolder, Parsable {
9263
9328
  */
9264
9329
  number?: string | null;
9265
9330
  /**
9266
- * Organization summary connected to this phone number.
9331
+ * Opts this number into the optional $2 monthly number health add-on. Defaults to on; customers can opt out.
9332
+ */
9333
+ numberHealthEnabled?: boolean | null;
9334
+ /**
9335
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
9267
9336
  */
9268
9337
  organization?: PhoneNumberResponse_organization | null;
9269
9338
  /**
@@ -9271,16 +9340,16 @@ export interface PhoneNumberResponse extends AdditionalDataHolder, Parsable {
9271
9340
  */
9272
9341
  phoneIdentityId?: string | null;
9273
9342
  /**
9274
- * Routing metadata that connects this phone number to teams, campaigns, and sources.
9343
+ * Public Leadping API schema for phone number routing metadata data.
9275
9344
  */
9276
9345
  routing?: PhoneNumberRoutingMetadata | null;
9277
9346
  /**
9278
- * SMS and call warmup for this phone number.
9347
+ * Messaging and calling warmup for a Leadping phone number.
9279
9348
  */
9280
9349
  warmup?: PhoneNumberReadiness | null;
9281
9350
  }
9282
9351
  /**
9283
- * Organization summary connected to this phone number.
9352
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
9284
9353
  */
9285
9354
  export interface PhoneNumberResponse_organization extends IdNamePair, Parsable {
9286
9355
  }
@@ -9318,7 +9387,7 @@ export interface PhoneNumberRoutingMetadata extends AdditionalDataHolder, Parsab
9318
9387
  */
9319
9388
  export interface PhoneNumberSearchRequest extends AdditionalDataHolder, Parsable {
9320
9389
  /**
9321
- * Geographic location metadata for the phone number, lead, or lookup result.
9390
+ * Public Leadping API schema for phone number location data.
9322
9391
  */
9323
9392
  location?: PhoneNumberSearchRequest_location | null;
9324
9393
  /**
@@ -9327,7 +9396,7 @@ export interface PhoneNumberSearchRequest extends AdditionalDataHolder, Parsable
9327
9396
  phoneNumber?: string | null;
9328
9397
  }
9329
9398
  /**
9330
- * Geographic location metadata for the phone number, lead, or lookup result.
9399
+ * Public Leadping API schema for phone number location data.
9331
9400
  */
9332
9401
  export interface PhoneNumberSearchRequest_location extends Parsable, PhoneNumberLocation {
9333
9402
  }
@@ -9345,7 +9414,7 @@ export interface PhoneNumberSearchResponse extends AdditionalDataHolder, Parsabl
9345
9414
  */
9346
9415
  export interface PhoneNumberSearchResult extends AdditionalDataHolder, Parsable {
9347
9416
  /**
9348
- * Geographic location metadata for the phone number, lead, or lookup result.
9417
+ * Public Leadping API schema for phone number location data.
9349
9418
  */
9350
9419
  location?: PhoneNumberSearchResult_location | null;
9351
9420
  /**
@@ -9354,7 +9423,7 @@ export interface PhoneNumberSearchResult extends AdditionalDataHolder, Parsable
9354
9423
  number?: string | null;
9355
9424
  }
9356
9425
  /**
9357
- * Geographic location metadata for the phone number, lead, or lookup result.
9426
+ * Public Leadping API schema for phone number location data.
9358
9427
  */
9359
9428
  export interface PhoneNumberSearchResult_location extends Parsable, PhoneNumberLocation {
9360
9429
  }
@@ -9375,11 +9444,11 @@ export interface PhoneNumberStatusResponse extends AdditionalDataHolder, Parsabl
9375
9444
  */
9376
9445
  number?: string | null;
9377
9446
  /**
9378
- * Recent SMS opt-out metrics used to evaluate sender health and compliance risk.
9447
+ * Describes phone number opt-out metrics data returned by Leadping.
9379
9448
  */
9380
9449
  optOutMetrics?: PhoneNumberOptOutMetricsResponse | null;
9381
9450
  /**
9382
- * Current outbound SMS and voice capacity for this phone number.
9451
+ * Reports the sending capacity, current load, and availability of a phone number considered for outbound delivery.
9383
9452
  */
9384
9453
  outboundCapacity?: PhoneNumberStatusResponse_outboundCapacity | null;
9385
9454
  /**
@@ -9387,21 +9456,21 @@ export interface PhoneNumberStatusResponse extends AdditionalDataHolder, Parsabl
9387
9456
  */
9388
9457
  recentEvents?: PhoneNumberMessagingEventResponse[] | null;
9389
9458
  /**
9390
- * SMS warmup status for this phone number.
9459
+ * Describes SMS warmup status data returned by Leadping.
9391
9460
  */
9392
9461
  smsWarmup?: PhoneNumberStatusResponse_smsWarmup | null;
9393
9462
  /**
9394
- * Phone number traffic metrics for recent SMS and call activity.
9463
+ * Describes phone number traffic metrics data returned by Leadping.
9395
9464
  */
9396
9465
  trafficMetrics?: PhoneNumberTrafficMetricsResponse | null;
9397
9466
  }
9398
9467
  /**
9399
- * Current outbound SMS and voice capacity for this phone number.
9468
+ * Reports the sending capacity, current load, and availability of a phone number considered for outbound delivery.
9400
9469
  */
9401
9470
  export interface PhoneNumberStatusResponse_outboundCapacity extends OutboundPhoneNumberCapacity, Parsable {
9402
9471
  }
9403
9472
  /**
9404
- * SMS warmup status for this phone number.
9473
+ * Describes SMS warmup status data returned by Leadping.
9405
9474
  */
9406
9475
  export interface PhoneNumberStatusResponse_smsWarmup extends Parsable, SmsReadinessStatusResponse {
9407
9476
  }
@@ -9458,7 +9527,7 @@ export interface PhoneNumberTableRow extends AdditionalDataHolder, Parsable {
9458
9527
  */
9459
9528
  voiceReady?: boolean | null;
9460
9529
  /**
9461
- * Warmup state for this phone number.
9530
+ * Messaging and calling warmup for a Leadping phone number.
9462
9531
  */
9463
9532
  warmup?: PhoneNumberReadiness | null;
9464
9533
  }
@@ -9937,6 +10006,13 @@ export declare function serializeAutomationResponse_user(writer: SerializationWr
9937
10006
  * @param writer Serialization writer to use to serialize this model
9938
10007
  */
9939
10008
  export declare function serializeAutomationRunRecord(writer: SerializationWriter, automationRunRecord?: Partial<AutomationRunRecord> | undefined | null, isSerializingDerivedType?: boolean): void;
10009
+ /**
10010
+ * Serializes information the current object
10011
+ * @param AutomationRunRecord_conditionResults The instance to serialize from.
10012
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
10013
+ * @param writer Serialization writer to use to serialize this model
10014
+ */
10015
+ export declare function serializeAutomationRunRecord_conditionResults(writer: SerializationWriter, automationRunRecord_conditionResults?: Partial<AutomationRunRecord_conditionResults> | undefined | null, isSerializingDerivedType?: boolean): void;
9940
10016
  /**
9941
10017
  * Serializes information the current object
9942
10018
  * @param AutomationTableRow The instance to serialize from.
@@ -11709,7 +11785,7 @@ export interface SmsEventTableRow extends AdditionalDataHolder, Parsable {
11709
11785
  */
11710
11786
  isAutomated?: boolean | null;
11711
11787
  /**
11712
- * Identifier and display name of the related lead.
11788
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
11713
11789
  */
11714
11790
  lead?: IdNamePair | null;
11715
11791
  /**
@@ -11807,7 +11883,7 @@ export interface SmsReadinessStatusResponse extends AdditionalDataHolder, Parsab
11807
11883
  */
11808
11884
  healthScore?: number | null;
11809
11885
  /**
11810
- * The current delivery-health assessment for this SMS warmup status.
11886
+ * Summarizes the severity of conditions affecting an organization's ability to send compliant SMS or MMS traffic.
11811
11887
  */
11812
11888
  healthStatus?: SmsReadinessHealthStatus | null;
11813
11889
  /**
@@ -11823,11 +11899,11 @@ export interface SmsReadinessStatusResponse extends AdditionalDataHolder, Parsab
11823
11899
  */
11824
11900
  progressPercent?: number | null;
11825
11901
  /**
11826
- * The current state for this SMS warmup status.
11902
+ * Describes whether an organization is configured and permitted to send SMS or MMS traffic through Leadping.
11827
11903
  */
11828
11904
  status?: SmsReadinessState | null;
11829
11905
  /**
11830
- * The current UI state for this SMS warmup status.
11906
+ * Describes SMS readiness UI state data used in Leadping API requests and responses.
11831
11907
  */
11832
11908
  uiState?: SmsReadinessUiState | null;
11833
11909
  /**
@@ -11844,7 +11920,7 @@ export interface SmsReadinessUiState extends AdditionalDataHolder, Parsable {
11844
11920
  */
11845
11921
  description?: string | null;
11846
11922
  /**
11847
- * The human-readable label shown for this SMS readiness UI state.
11923
+ * Describes whether an organization is configured and permitted to send SMS or MMS traffic through Leadping.
11848
11924
  */
11849
11925
  label?: SmsReadinessState | null;
11850
11926
  /**
@@ -12017,7 +12093,7 @@ export interface SourceCredentialIssueResponse extends AdditionalDataHolder, Par
12017
12093
  */
12018
12094
  secret?: string | null;
12019
12095
  /**
12020
- * Source metadata safe for later retrieval.
12096
+ * Describes lead source data returned by Leadping.
12021
12097
  */
12022
12098
  source?: SourceResponse | null;
12023
12099
  }
@@ -12038,7 +12114,7 @@ export interface SourceMetricsResponse extends AdditionalDataHolder, Parsable {
12038
12114
  */
12039
12115
  points?: AnalyticsTrendPointOfint[] | null;
12040
12116
  /**
12041
- * Range associated with this Leadping source metrics.
12117
+ * Defines the inclusive reporting window and comparison window used to calculate Leadping analytics.
12042
12118
  */
12043
12119
  range?: AnalyticsDateRange | null;
12044
12120
  /**
@@ -12116,7 +12192,7 @@ export interface SourceResponse extends AdditionalDataHolder, Parsable {
12116
12192
  */
12117
12193
  createdAt?: Date | null;
12118
12194
  /**
12119
- * User summary for the person who created this lead source response.
12195
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12120
12196
  */
12121
12197
  createdByUser?: SourceResponse_createdByUser | null;
12122
12198
  /**
@@ -12156,7 +12232,7 @@ export interface SourceResponse extends AdditionalDataHolder, Parsable {
12156
12232
  */
12157
12233
  modifiedAt?: Date | null;
12158
12234
  /**
12159
- * User summary for the person who last modified this lead source response.
12235
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12160
12236
  */
12161
12237
  modifiedByUser?: SourceResponse_modifiedByUser | null;
12162
12238
  /**
@@ -12164,7 +12240,7 @@ export interface SourceResponse extends AdditionalDataHolder, Parsable {
12164
12240
  */
12165
12241
  name?: string | null;
12166
12242
  /**
12167
- * Organization summary connected to this lead source response.
12243
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12168
12244
  */
12169
12245
  organization?: SourceResponse_organization | null;
12170
12246
  /**
@@ -12172,27 +12248,27 @@ export interface SourceResponse extends AdditionalDataHolder, Parsable {
12172
12248
  */
12173
12249
  requiresTrustedForm?: boolean | null;
12174
12250
  /**
12175
- * User summary connected to this lead source response.
12251
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12176
12252
  */
12177
12253
  user?: SourceResponse_user | null;
12178
12254
  }
12179
12255
  /**
12180
- * User summary for the person who created this lead source response.
12256
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12181
12257
  */
12182
12258
  export interface SourceResponse_createdByUser extends IdNamePair, Parsable {
12183
12259
  }
12184
12260
  /**
12185
- * User summary for the person who last modified this lead source response.
12261
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12186
12262
  */
12187
12263
  export interface SourceResponse_modifiedByUser extends IdNamePair, Parsable {
12188
12264
  }
12189
12265
  /**
12190
- * Organization summary connected to this lead source response.
12266
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12191
12267
  */
12192
12268
  export interface SourceResponse_organization extends IdNamePair, Parsable {
12193
12269
  }
12194
12270
  /**
12195
- * User summary connected to this lead source response.
12271
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12196
12272
  */
12197
12273
  export interface SourceResponse_user extends IdNamePair, Parsable {
12198
12274
  }
@@ -12237,7 +12313,7 @@ export interface SourceTableRow extends AdditionalDataHolder, Parsable {
12237
12313
  */
12238
12314
  createdAt?: Date | null;
12239
12315
  /**
12240
- * User summary for the person who created this lead source table row.
12316
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12241
12317
  */
12242
12318
  createdByUser?: SourceTableRow_createdByUser | null;
12243
12319
  /**
@@ -12273,7 +12349,7 @@ export interface SourceTableRow extends AdditionalDataHolder, Parsable {
12273
12349
  */
12274
12350
  modifiedAt?: Date | null;
12275
12351
  /**
12276
- * User summary for the person who last modified this lead source table row.
12352
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12277
12353
  */
12278
12354
  modifiedByUser?: SourceTableRow_modifiedByUser | null;
12279
12355
  /**
@@ -12281,7 +12357,7 @@ export interface SourceTableRow extends AdditionalDataHolder, Parsable {
12281
12357
  */
12282
12358
  name?: string | null;
12283
12359
  /**
12284
- * Organization summary connected to this lead source table row.
12360
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12285
12361
  */
12286
12362
  organization?: SourceTableRow_organization | null;
12287
12363
  /**
@@ -12293,27 +12369,27 @@ export interface SourceTableRow extends AdditionalDataHolder, Parsable {
12293
12369
  */
12294
12370
  requiresTrustedForm?: boolean | null;
12295
12371
  /**
12296
- * User summary connected to this lead source table row.
12372
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12297
12373
  */
12298
12374
  user?: SourceTableRow_user | null;
12299
12375
  }
12300
12376
  /**
12301
- * User summary for the person who created this lead source table row.
12377
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12302
12378
  */
12303
12379
  export interface SourceTableRow_createdByUser extends IdNamePair, Parsable {
12304
12380
  }
12305
12381
  /**
12306
- * User summary for the person who last modified this lead source table row.
12382
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12307
12383
  */
12308
12384
  export interface SourceTableRow_modifiedByUser extends IdNamePair, Parsable {
12309
12385
  }
12310
12386
  /**
12311
- * Organization summary connected to this lead source table row.
12387
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12312
12388
  */
12313
12389
  export interface SourceTableRow_organization extends IdNamePair, Parsable {
12314
12390
  }
12315
12391
  /**
12316
- * User summary connected to this lead source table row.
12392
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12317
12393
  */
12318
12394
  export interface SourceTableRow_user extends IdNamePair, Parsable {
12319
12395
  }
@@ -12677,12 +12753,12 @@ export interface TagSummary extends AdditionalDataHolder, Parsable {
12677
12753
  */
12678
12754
  export interface TelephonyLoginRequest extends AdditionalDataHolder, Parsable {
12679
12755
  /**
12680
- * Identifier and display name of the related device.
12756
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12681
12757
  */
12682
12758
  device?: TelephonyLoginRequest_device | null;
12683
12759
  }
12684
12760
  /**
12685
- * Identifier and display name of the related device.
12761
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12686
12762
  */
12687
12763
  export interface TelephonyLoginRequest_device extends IdNamePair, Parsable {
12688
12764
  }
@@ -12712,11 +12788,11 @@ export interface TelephonyLoginResponse extends AdditionalDataHolder, Parsable {
12712
12788
  */
12713
12789
  export interface TenDlcApplicationDraft extends AdditionalDataHolder, Parsable {
12714
12790
  /**
12715
- * The current provider review status for the submitted brand.
12791
+ * Defines the provider lifecycle for an individual 10DLC brand or campaign.
12716
12792
  */
12717
12793
  brandStatus?: TenDlcRegistrationStatus | null;
12718
12794
  /**
12719
- * The current provider review status for the submitted campaign.
12795
+ * Defines the provider lifecycle for an individual 10DLC brand or campaign.
12720
12796
  */
12721
12797
  campaignStatus?: TenDlcRegistrationStatus | null;
12722
12798
  /**
@@ -12856,7 +12932,7 @@ export interface TransactionResponse extends AdditionalDataHolder, Parsable {
12856
12932
  */
12857
12933
  id?: string | null;
12858
12934
  /**
12859
- * Identifier and display name of the related lead.
12935
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12860
12936
  */
12861
12937
  lead?: TransactionResponse_lead | null;
12862
12938
  /**
@@ -12872,7 +12948,7 @@ export interface TransactionResponse extends AdditionalDataHolder, Parsable {
12872
12948
  */
12873
12949
  notes?: string | null;
12874
12950
  /**
12875
- * Identifier and display name of the related organization.
12951
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12876
12952
  */
12877
12953
  organization?: TransactionResponse_organization | null;
12878
12954
  /**
@@ -12884,23 +12960,23 @@ export interface TransactionResponse extends AdditionalDataHolder, Parsable {
12884
12960
  */
12885
12961
  platformFeeAmount?: number | null;
12886
12962
  /**
12887
- * Processing status for this wallet transaction.
12963
+ * Describes the processing and settlement lifecycle of a Leadping wallet or billing transaction.
12888
12964
  */
12889
12965
  transactionStatus?: TransactionStatus | null;
12890
12966
  /**
12891
- * Debit or credit classification for this wallet transaction.
12967
+ * Classifies a wallet transaction as a debit, credit, refund, adjustment, deposit, or other balance movement.
12892
12968
  */
12893
12969
  transactionType?: TransactionType | null;
12894
12970
  }
12895
12971
  export type TransactionResponse_billableUnit = (typeof TransactionResponse_billableUnitObject)[keyof typeof TransactionResponse_billableUnitObject];
12896
12972
  export type TransactionResponse_billingChannel = (typeof TransactionResponse_billingChannelObject)[keyof typeof TransactionResponse_billingChannelObject];
12897
12973
  /**
12898
- * Identifier and display name of the related lead.
12974
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12899
12975
  */
12900
12976
  export interface TransactionResponse_lead extends IdNamePair, Parsable {
12901
12977
  }
12902
12978
  /**
12903
- * Identifier and display name of the related organization.
12979
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12904
12980
  */
12905
12981
  export interface TransactionResponse_organization extends IdNamePair, Parsable {
12906
12982
  }
@@ -12938,7 +13014,7 @@ export interface TransactionTableRow extends AdditionalDataHolder, Parsable {
12938
13014
  */
12939
13015
  id?: string | null;
12940
13016
  /**
12941
- * Identifier and display name of the related lead.
13017
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12942
13018
  */
12943
13019
  lead?: TransactionTableRow_lead | null;
12944
13020
  /**
@@ -12946,7 +13022,7 @@ export interface TransactionTableRow extends AdditionalDataHolder, Parsable {
12946
13022
  */
12947
13023
  netAmount?: number | null;
12948
13024
  /**
12949
- * Identifier and display name of the related organization.
13025
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12950
13026
  */
12951
13027
  organization?: TransactionTableRow_organization | null;
12952
13028
  /**
@@ -12970,11 +13046,11 @@ export interface TransactionTableRow extends AdditionalDataHolder, Parsable {
12970
13046
  */
12971
13047
  sourceEventType?: string | null;
12972
13048
  /**
12973
- * Processing status for this wallet transaction.
13049
+ * Describes the processing and settlement lifecycle of a Leadping wallet or billing transaction.
12974
13050
  */
12975
13051
  transactionStatus?: TransactionStatus | null;
12976
13052
  /**
12977
- * Debit or credit classification for this wallet transaction.
13053
+ * Classifies a wallet transaction as a debit, credit, refund, adjustment, deposit, or other balance movement.
12978
13054
  */
12979
13055
  transactionType?: TransactionType | null;
12980
13056
  /**
@@ -12985,12 +13061,12 @@ export interface TransactionTableRow extends AdditionalDataHolder, Parsable {
12985
13061
  export type TransactionTableRow_billableUnit = (typeof TransactionTableRow_billableUnitObject)[keyof typeof TransactionTableRow_billableUnitObject];
12986
13062
  export type TransactionTableRow_billingChannel = (typeof TransactionTableRow_billingChannelObject)[keyof typeof TransactionTableRow_billingChannelObject];
12987
13063
  /**
12988
- * Identifier and display name of the related lead.
13064
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12989
13065
  */
12990
13066
  export interface TransactionTableRow_lead extends IdNamePair, Parsable {
12991
13067
  }
12992
13068
  /**
12993
- * Identifier and display name of the related organization.
13069
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12994
13070
  */
12995
13071
  export interface TransactionTableRow_organization extends IdNamePair, Parsable {
12996
13072
  }
@@ -13051,11 +13127,11 @@ export interface UsageLedgerTableRow extends AdditionalDataHolder, Parsable {
13051
13127
  */
13052
13128
  billableSeconds?: number | null;
13053
13129
  /**
13054
- * Billable unit for this usage ledger.
13130
+ * Identifies the metered unit used to price Leadping usage, such as a message, call minute, lookup, or phone number.
13055
13131
  */
13056
13132
  billableUnit?: BillableUnit | null;
13057
13133
  /**
13058
- * Channel for this usage ledger.
13134
+ * Identifies the messaging, calling, phone-number, lookup, or platform channel that generated billable usage.
13059
13135
  */
13060
13136
  channel?: UsageChannel | null;
13061
13137
  /**
@@ -13083,11 +13159,11 @@ export interface UsageLedgerTableRow extends AdditionalDataHolder, Parsable {
13083
13159
  */
13084
13160
  isBillable?: boolean | null;
13085
13161
  /**
13086
- * Identifier and display name of the related lead.
13162
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
13087
13163
  */
13088
13164
  lead?: UsageLedgerTableRow_lead | null;
13089
13165
  /**
13090
- * Identifier and display name of the related organization.
13166
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
13091
13167
  */
13092
13168
  organization?: UsageLedgerTableRow_organization | null;
13093
13169
  /**
@@ -13107,7 +13183,7 @@ export interface UsageLedgerTableRow extends AdditionalDataHolder, Parsable {
13107
13183
  */
13108
13184
  smsSegments?: number | null;
13109
13185
  /**
13110
- * The current status for this usage ledger.
13186
+ * Describes whether a metered usage record is pending, rated, billed, reconciled, excluded, or failed.
13111
13187
  */
13112
13188
  status?: UsageStatus | null;
13113
13189
  /**
@@ -13115,22 +13191,22 @@ export interface UsageLedgerTableRow extends AdditionalDataHolder, Parsable {
13115
13191
  */
13116
13192
  unitPrice?: number | null;
13117
13193
  /**
13118
- * Identifier and display name of the related user.
13194
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
13119
13195
  */
13120
13196
  user?: UsageLedgerTableRow_user | null;
13121
13197
  }
13122
13198
  /**
13123
- * Identifier and display name of the related lead.
13199
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
13124
13200
  */
13125
13201
  export interface UsageLedgerTableRow_lead extends IdNamePair, Parsable {
13126
13202
  }
13127
13203
  /**
13128
- * Identifier and display name of the related organization.
13204
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
13129
13205
  */
13130
13206
  export interface UsageLedgerTableRow_organization extends IdNamePair, Parsable {
13131
13207
  }
13132
13208
  /**
13133
- * Identifier and display name of the related user.
13209
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
13134
13210
  */
13135
13211
  export interface UsageLedgerTableRow_user extends IdNamePair, Parsable {
13136
13212
  }
@@ -13140,11 +13216,11 @@ export type UsageStatus = (typeof UsageStatusObject)[keyof typeof UsageStatusObj
13140
13216
  */
13141
13217
  export interface UsageSummaryLine extends AdditionalDataHolder, Parsable {
13142
13218
  /**
13143
- * Billable unit for this usage summary line.
13219
+ * Identifies the metered unit used to price Leadping usage, such as a message, call minute, lookup, or phone number.
13144
13220
  */
13145
13221
  billableUnit?: BillableUnit | null;
13146
13222
  /**
13147
- * Channel for this usage summary line.
13223
+ * Identifies the messaging, calling, phone-number, lookup, or platform channel that generated billable usage.
13148
13224
  */
13149
13225
  channel?: UsageChannel | null;
13150
13226
  /**
@@ -13160,7 +13236,7 @@ export interface UsageSummaryLine extends AdditionalDataHolder, Parsable {
13160
13236
  */
13161
13237
  recordCount?: number | null;
13162
13238
  /**
13163
- * The current status for this usage summary line.
13239
+ * Describes whether a metered usage record is pending, rated, billed, reconciled, excluded, or failed.
13164
13240
  */
13165
13241
  status?: UsageStatus | null;
13166
13242
  }
@@ -13325,7 +13401,7 @@ export interface UserDataExportResponse extends AdditionalDataHolder, Parsable {
13325
13401
  */
13326
13402
  startedAt?: Date | null;
13327
13403
  /**
13328
- * Current status for this Leadping user data export.
13404
+ * Identifies the preparation, availability, failure, expiration, or deletion stage of a Leadping user-data export.
13329
13405
  */
13330
13406
  status?: UserDataExportStatuses | null;
13331
13407
  }
@@ -13420,7 +13496,7 @@ export interface UserNotificationPreferences extends AdditionalDataHolder, Parsa
13420
13496
  */
13421
13497
  smsConsentOptedIn?: boolean | null;
13422
13498
  /**
13423
- * The TrustedForm certificate captured for the user's most recent SMS opt-in.
13499
+ * Describes trusted form certificate data used in Leadping API requests and responses.
13424
13500
  */
13425
13501
  smsConsentTrustedFormCertificate?: UserNotificationPreferences_smsConsentTrustedFormCertificate | null;
13426
13502
  /**
@@ -13461,7 +13537,7 @@ export interface UserNotificationPreferences extends AdditionalDataHolder, Parsa
13461
13537
  usageLimitHitEnabled?: boolean | null;
13462
13538
  }
13463
13539
  /**
13464
- * The TrustedForm certificate captured for the user's most recent SMS opt-in.
13540
+ * Describes trusted form certificate data used in Leadping API requests and responses.
13465
13541
  */
13466
13542
  export interface UserNotificationPreferences_smsConsentTrustedFormCertificate extends Parsable, TrustedFormCertificate {
13467
13543
  }
@@ -13482,7 +13558,7 @@ export interface UserRequest extends AdditionalDataHolder, Parsable {
13482
13558
  */
13483
13559
  name?: string | null;
13484
13560
  /**
13485
- * Notification preferences configured for the user.
13561
+ * Describes user notification preferences data used in Leadping API requests and responses.
13486
13562
  */
13487
13563
  notificationPreferences?: UserRequest_notificationPreferences | null;
13488
13564
  /**
@@ -13495,7 +13571,7 @@ export interface UserRequest extends AdditionalDataHolder, Parsable {
13495
13571
  timeZoneId?: string | null;
13496
13572
  }
13497
13573
  /**
13498
- * Notification preferences configured for the user.
13574
+ * Describes user notification preferences data used in Leadping API requests and responses.
13499
13575
  */
13500
13576
  export interface UserRequest_notificationPreferences extends Parsable, UserNotificationPreferences {
13501
13577
  }
@@ -13508,11 +13584,11 @@ export interface UserResponse extends AdditionalDataHolder, Parsable {
13508
13584
  */
13509
13585
  billingPlan?: UserResponse_billingPlan | null;
13510
13586
  /**
13511
- * Customer-safe billing state for the user's currently selected organization.
13587
+ * Customer-safe billing state for a Leadping organization.
13512
13588
  */
13513
13589
  billingState?: UserResponse_billingState | null;
13514
13590
  /**
13515
- * Compliance for this user.
13591
+ * Describes user compliance data used in Leadping API requests and responses.
13516
13592
  */
13517
13593
  compliance?: UserResponse_compliance | null;
13518
13594
  /**
@@ -13520,7 +13596,7 @@ export interface UserResponse extends AdditionalDataHolder, Parsable {
13520
13596
  */
13521
13597
  createdAt?: Date | null;
13522
13598
  /**
13523
- * Current organization for this user.
13599
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
13524
13600
  */
13525
13601
  currentOrganization?: UserResponse_currentOrganization | null;
13526
13602
  /**
@@ -13560,7 +13636,7 @@ export interface UserResponse extends AdditionalDataHolder, Parsable {
13560
13636
  */
13561
13637
  name?: string | null;
13562
13638
  /**
13563
- * Notification preferences for this user.
13639
+ * Describes user notification preferences data used in Leadping API requests and responses.
13564
13640
  */
13565
13641
  notificationPreferences?: UserResponse_notificationPreferences | null;
13566
13642
  /**
@@ -13598,22 +13674,22 @@ export interface UserResponse extends AdditionalDataHolder, Parsable {
13598
13674
  }
13599
13675
  export type UserResponse_billingPlan = (typeof UserResponse_billingPlanObject)[keyof typeof UserResponse_billingPlanObject];
13600
13676
  /**
13601
- * Customer-safe billing state for the user's currently selected organization.
13677
+ * Customer-safe billing state for a Leadping organization.
13602
13678
  */
13603
13679
  export interface UserResponse_billingState extends OrganizationBillingState, Parsable {
13604
13680
  }
13605
13681
  /**
13606
- * Compliance for this user.
13682
+ * Describes user compliance data used in Leadping API requests and responses.
13607
13683
  */
13608
13684
  export interface UserResponse_compliance extends Parsable, UserCompliance {
13609
13685
  }
13610
13686
  /**
13611
- * Current organization for this user.
13687
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
13612
13688
  */
13613
13689
  export interface UserResponse_currentOrganization extends IdNamePair, Parsable {
13614
13690
  }
13615
13691
  /**
13616
- * Notification preferences for this user.
13692
+ * Describes user notification preferences data used in Leadping API requests and responses.
13617
13693
  */
13618
13694
  export interface UserResponse_notificationPreferences extends Parsable, UserNotificationPreferences {
13619
13695
  }