@leadping/sdk 1.0.53 → 1.0.55

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
  }
@@ -747,7 +747,7 @@ export interface AutomationTableRow extends AdditionalDataHolder, Parsable {
747
747
  */
748
748
  name?: string | null;
749
749
  /**
750
- * Organization summary connected to this automation table row.
750
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
751
751
  */
752
752
  organization?: AutomationTableRow_organization | null;
753
753
  /**
@@ -771,7 +771,7 @@ export interface AutomationTableRow extends AdditionalDataHolder, Parsable {
771
771
  */
772
772
  triggerType?: string | null;
773
773
  /**
774
- * User summary connected to this automation table row.
774
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
775
775
  */
776
776
  user?: AutomationTableRow_user | null;
777
777
  /**
@@ -780,12 +780,12 @@ export interface AutomationTableRow extends AdditionalDataHolder, Parsable {
780
780
  visibility?: string | null;
781
781
  }
782
782
  /**
783
- * Organization summary connected to this automation table row.
783
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
784
784
  */
785
785
  export interface AutomationTableRow_organization extends IdNamePair, Parsable {
786
786
  }
787
787
  /**
788
- * User summary connected to this automation table row.
788
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
789
789
  */
790
790
  export interface AutomationTableRow_user extends IdNamePair, Parsable {
791
791
  }
@@ -959,7 +959,7 @@ export interface AutomationWorkflowRunResponse extends AdditionalDataHolder, Par
959
959
  */
960
960
  actions?: AutomationWorkflowActionResponse[] | null;
961
961
  /**
962
- * Identifier and display name of the related automation.
962
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
963
963
  */
964
964
  automation?: AutomationWorkflowRunResponse_automation | null;
965
965
  /**
@@ -971,7 +971,7 @@ export interface AutomationWorkflowRunResponse extends AdditionalDataHolder, Par
971
971
  */
972
972
  completedAt?: Date | null;
973
973
  /**
974
- * Identifier and display name of the workflow step currently awaiting or performing work.
974
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
975
975
  */
976
976
  currentStep?: AutomationWorkflowRunResponse_currentStep | null;
977
977
  /**
@@ -1064,12 +1064,12 @@ export interface AutomationWorkflowRunResponse extends AdditionalDataHolder, Par
1064
1064
  updatedAt?: Date | null;
1065
1065
  }
1066
1066
  /**
1067
- * Identifier and display name of the related automation.
1067
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
1068
1068
  */
1069
1069
  export interface AutomationWorkflowRunResponse_automation extends IdNamePair, Parsable {
1070
1070
  }
1071
1071
  /**
1072
- * Identifier and display name of the workflow step currently awaiting or performing work.
1072
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
1073
1073
  */
1074
1074
  export interface AutomationWorkflowRunResponse_currentStep extends IdNamePair, Parsable {
1075
1075
  }
@@ -1093,55 +1093,79 @@ export type BillingPlan = (typeof BillingPlanObject)[keyof typeof BillingPlanObj
1093
1093
  */
1094
1094
  export interface BlogArticleResponse extends AdditionalDataHolder, Parsable {
1095
1095
  /**
1096
- * Gets or sets the author name.
1096
+ * The authorName property
1097
1097
  */
1098
1098
  authorName?: string | null;
1099
1099
  /**
1100
- * Gets or sets the category.
1100
+ * The category property
1101
1101
  */
1102
1102
  category?: string | null;
1103
1103
  /**
1104
- * Gets or sets the content.
1104
+ * The content property
1105
1105
  */
1106
1106
  content?: string | null;
1107
1107
  /**
1108
- * Gets or sets the cover image URL.
1108
+ * The contentUpdatedAt property
1109
+ */
1110
+ contentUpdatedAt?: Date | null;
1111
+ /**
1112
+ * The coverImageAlt property
1113
+ */
1114
+ coverImageAlt?: string | null;
1115
+ /**
1116
+ * The coverImageUrl property
1109
1117
  */
1110
1118
  coverImageUrl?: string | null;
1111
1119
  /**
1112
- * Gets or sets the created at.
1120
+ * The createdAt property
1113
1121
  */
1114
1122
  createdAt?: Date | null;
1115
1123
  /**
1116
- * Gets or sets the excerpt.
1124
+ * The excerpt property
1117
1125
  */
1118
1126
  excerpt?: string | null;
1119
1127
  /**
1120
- * Gets or sets the ID.
1128
+ * The id property
1121
1129
  */
1122
1130
  id?: string | null;
1123
1131
  /**
1124
- * Gets or sets the is featured.
1132
+ * The latest background image processing failure, when present.
1133
+ */
1134
+ imageProcessingError?: string | null;
1135
+ /**
1136
+ * Whether saved image references are awaiting Engine processing.
1137
+ */
1138
+ imagesProcessing?: boolean | null;
1139
+ /**
1140
+ * The isFeatured property
1125
1141
  */
1126
1142
  isFeatured?: boolean | null;
1127
1143
  /**
1128
- * Gets or sets the is published.
1144
+ * The isPublished property
1129
1145
  */
1130
1146
  isPublished?: boolean | null;
1131
1147
  /**
1132
- * Gets or sets the modified at.
1148
+ * The metaDescription property
1149
+ */
1150
+ metaDescription?: string | null;
1151
+ /**
1152
+ * The modifiedAt property
1133
1153
  */
1134
1154
  modifiedAt?: Date | null;
1135
1155
  /**
1136
- * Gets or sets the published at.
1156
+ * The publishedAt property
1137
1157
  */
1138
1158
  publishedAt?: Date | null;
1139
1159
  /**
1140
- * Gets or sets the slug.
1160
+ * The seoTitle property
1161
+ */
1162
+ seoTitle?: string | null;
1163
+ /**
1164
+ * The slug property
1141
1165
  */
1142
1166
  slug?: string | null;
1143
1167
  /**
1144
- * Gets or sets the title.
1168
+ * The title property
1145
1169
  */
1146
1170
  title?: string | null;
1147
1171
  }
@@ -1225,10 +1249,6 @@ export interface CallEventTableRow extends AdditionalDataHolder, Parsable {
1225
1249
  * Display name for the organization associated with this call event.
1226
1250
  */
1227
1251
  organizationName?: string | null;
1228
- /**
1229
- * URL for the call recording, when the provider makes one available.
1230
- */
1231
- recordingUrl?: string | null;
1232
1252
  /**
1233
1253
  * Describes the durable business outcome of a Leadping phone call after provider status normalization.
1234
1254
  */
@@ -1257,6 +1277,10 @@ export interface CallEventTableRow extends AdditionalDataHolder, Parsable {
1257
1277
  * Display name for the person or agent who initiated this call event.
1258
1278
  */
1259
1279
  userName?: string | null;
1280
+ /**
1281
+ * URL for voicemail audio, when the call resulted in a voicemail.
1282
+ */
1283
+ voicemailUrl?: string | null;
1260
1284
  }
1261
1285
  export type CallEventTableRow_status = (typeof CallEventTableRow_statusObject)[keyof typeof CallEventTableRow_statusObject];
1262
1286
  /**
@@ -1264,7 +1288,7 @@ export type CallEventTableRow_status = (typeof CallEventTableRow_statusObject)[k
1264
1288
  */
1265
1289
  export interface ChangeBillingPlanRequest extends AdditionalDataHolder, Parsable {
1266
1290
  /**
1267
- * Billing plan for this billing plan.
1291
+ * Identifies the Leadping subscription plan that determines organization features, allowances, and billing behavior.
1268
1292
  */
1269
1293
  billingPlan?: BillingPlan | null;
1270
1294
  }
@@ -1298,7 +1322,7 @@ export interface CommunicationConsoleEntry extends AdditionalDataHolder, Parsabl
1298
1322
  */
1299
1323
  export interface ComplianceUpdateRequest extends AdditionalDataHolder, Parsable {
1300
1324
  /**
1301
- * Compliance for this compliance update.
1325
+ * Describes user compliance data used in Leadping API requests and responses.
1302
1326
  */
1303
1327
  compliance?: ComplianceUpdateRequest_compliance | null;
1304
1328
  /**
@@ -1307,7 +1331,7 @@ export interface ComplianceUpdateRequest extends AdditionalDataHolder, Parsable
1307
1331
  source?: string | null;
1308
1332
  }
1309
1333
  /**
1310
- * Compliance for this compliance update.
1334
+ * Describes user compliance data used in Leadping API requests and responses.
1311
1335
  */
1312
1336
  export interface ComplianceUpdateRequest_compliance extends Parsable, UserCompliance {
1313
1337
  }
@@ -1332,7 +1356,7 @@ export interface ConversationResponse extends AdditionalDataHolder, Parsable {
1332
1356
  */
1333
1357
  avatarUrl?: string | null;
1334
1358
  /**
1335
- * Current lead status change summary that describes the lead outcome.
1359
+ * Summary schema for Leadping API current lead status change summary data used in dashboards and reports.
1336
1360
  */
1337
1361
  currentLeadStatus?: ConversationResponse_currentLeadStatus | null;
1338
1362
  /**
@@ -1388,7 +1412,7 @@ export interface ConversationResponse extends AdditionalDataHolder, Parsable {
1388
1412
  */
1389
1413
  outboundPhoneNumberOverrideId?: string | null;
1390
1414
  /**
1391
- * Phone number used by this conversation response for calls, SMS, lookup, or routing.
1415
+ * Extends an identifier-and-name resource reference with an optional string value used for display or selection metadata.
1392
1416
  */
1393
1417
  phoneNumber?: ConversationResponse_phoneNumber | null;
1394
1418
  /**
@@ -1401,12 +1425,12 @@ export interface ConversationResponse extends AdditionalDataHolder, Parsable {
1401
1425
  statusReason?: string | null;
1402
1426
  }
1403
1427
  /**
1404
- * Current lead status change summary that describes the lead outcome.
1428
+ * Summary schema for Leadping API current lead status change summary data used in dashboards and reports.
1405
1429
  */
1406
1430
  export interface ConversationResponse_currentLeadStatus extends CurrentLeadStatusSummary, Parsable {
1407
1431
  }
1408
1432
  /**
1409
- * Phone number used by this conversation response for calls, SMS, lookup, or routing.
1433
+ * Extends an identifier-and-name resource reference with an optional string value used for display or selection metadata.
1410
1434
  */
1411
1435
  export interface ConversationResponse_phoneNumber extends IdNameValue, Parsable {
1412
1436
  }
@@ -3118,15 +3142,15 @@ export type CustomerActivationStatus = (typeof CustomerActivationStatusObject)[k
3118
3142
  */
3119
3143
  export interface CustomerAnalyticsResponse extends AdditionalDataHolder, Parsable {
3120
3144
  /**
3121
- * Activation health associated with this Leadping customer analytics.
3145
+ * Summarizes an organization's progress and blockers across onboarding, billing, telephony, compliance, and launch readiness.
3122
3146
  */
3123
3147
  activationHealth?: CustomerActivationHealth | null;
3124
3148
  /**
3125
- * Automation health associated with this Leadping customer analytics.
3149
+ * Summarizes automation coverage, execution success, failures, and workflows requiring organization attention.
3126
3150
  */
3127
3151
  automationHealth?: CustomerAutomationHealth | null;
3128
3152
  /**
3129
- * Communication usage associated with this Leadping customer analytics.
3153
+ * Aggregates an organization's SMS, MMS, and calling activity, delivery outcomes, and billable usage over time.
3130
3154
  */
3131
3155
  communicationUsage?: CustomerCommunicationUsage | null;
3132
3156
  /**
@@ -3138,7 +3162,7 @@ export interface CustomerAnalyticsResponse extends AdditionalDataHolder, Parsabl
3138
3162
  */
3139
3163
  leadSources?: CustomerLeadSourceBreakdown[] | null;
3140
3164
  /**
3141
- * Lead trend associated with this Leadping customer analytics.
3165
+ * Measures lead creation, qualification, and conversion activity within one reporting time bucket.
3142
3166
  */
3143
3167
  leadTrend?: CustomerLeadTrend | null;
3144
3168
  /**
@@ -3146,15 +3170,15 @@ export interface CustomerAnalyticsResponse extends AdditionalDataHolder, Parsabl
3146
3170
  */
3147
3171
  needsAttention?: CustomerNeedsAttentionItem[] | null;
3148
3172
  /**
3149
- * Range associated with this Leadping customer analytics.
3173
+ * Defines the inclusive reporting window and comparison window used to calculate Leadping analytics.
3150
3174
  */
3151
3175
  range?: AnalyticsDateRange | null;
3152
3176
  /**
3153
- * Response metrics associated with this Leadping customer analytics.
3177
+ * Measures how quickly and consistently an organization responds to leads across supported communication channels.
3154
3178
  */
3155
3179
  responseMetrics?: CustomerResponseMetrics | null;
3156
3180
  /**
3157
- * Human-readable summary for this Leadping customer analytics.
3181
+ * Summarizes an organization's primary lead, response, communication, and conversion KPIs for the selected period.
3158
3182
  */
3159
3183
  summary?: CustomerAnalyticsSummary | null;
3160
3184
  }
@@ -3187,7 +3211,7 @@ export interface CustomerAnalyticsSummary extends AdditionalDataHolder, Parsable
3187
3211
  */
3188
3212
  leads?: number | null;
3189
3213
  /**
3190
- * Date and time when this Leadping customer analytics summary was leads comparison.
3214
+ * Compares a metric with the preceding period and reports its absolute and percentage change.
3191
3215
  */
3192
3216
  leadsComparison?: AnalyticsComparison | null;
3193
3217
  /**
@@ -3256,7 +3280,7 @@ export interface CustomerAutomationHealth extends AdditionalDataHolder, Parsable
3256
3280
  */
3257
3281
  failureCount?: number | null;
3258
3282
  /**
3259
- * Last failure associated with this Leadping customer automation health.
3283
+ * Identifies an automation with recent execution failures and summarizes its affected leads and failure context.
3260
3284
  */
3261
3285
  lastFailure?: CustomerAutomationHealth_lastFailure | null;
3262
3286
  /**
@@ -3269,7 +3293,7 @@ export interface CustomerAutomationHealth extends AdditionalDataHolder, Parsable
3269
3293
  trend?: CustomerAutomationHealthPoint[] | null;
3270
3294
  }
3271
3295
  /**
3272
- * Last failure associated with this Leadping customer automation health.
3296
+ * Identifies an automation with recent execution failures and summarizes its affected leads and failure context.
3273
3297
  */
3274
3298
  export interface CustomerAutomationHealth_lastFailure extends CustomerFailingAutomation, Parsable {
3275
3299
  }
@@ -3278,27 +3302,27 @@ export interface CustomerAutomationHealth_lastFailure extends CustomerFailingAut
3278
3302
  */
3279
3303
  export interface CustomerAutomationHealthPoint extends AdditionalDataHolder, Parsable {
3280
3304
  /**
3281
- * Gets or sets the end at.
3305
+ * The endAt property
3282
3306
  */
3283
3307
  endAt?: Date | null;
3284
3308
  /**
3285
- * Gets or sets the executions.
3309
+ * The executions property
3286
3310
  */
3287
3311
  executions?: number | null;
3288
3312
  /**
3289
- * Gets or sets the failure count.
3313
+ * The failureCount property
3290
3314
  */
3291
3315
  failureCount?: number | null;
3292
3316
  /**
3293
- * Gets or sets the label.
3317
+ * The label property
3294
3318
  */
3295
3319
  label?: string | null;
3296
3320
  /**
3297
- * Gets or sets the start at.
3321
+ * The startAt property
3298
3322
  */
3299
3323
  startAt?: Date | null;
3300
3324
  /**
3301
- * Gets or sets the success count.
3325
+ * The successCount property
3302
3326
  */
3303
3327
  successCount?: number | null;
3304
3328
  }
@@ -3447,7 +3471,7 @@ export interface CustomerLeadSourceBreakdown extends AdditionalDataHolder, Parsa
3447
3471
  */
3448
3472
  export interface CustomerLeadTrend extends AdditionalDataHolder, Parsable {
3449
3473
  /**
3450
- * Date and time when this Leadping customer lead trend was comparison.
3474
+ * Compares a metric with the preceding period and reports its absolute and percentage change.
3451
3475
  */
3452
3476
  comparison?: AnalyticsComparison | null;
3453
3477
  /**
@@ -5180,7 +5204,7 @@ export interface EligibleOutgoingNumberResponse extends AdditionalDataHolder, Pa
5180
5204
  */
5181
5205
  reasonLabel?: string | null;
5182
5206
  /**
5183
- * Reason Leadping selected this outbound sender number.
5207
+ * Explains why Leadping selected, rejected, or substituted an outgoing caller or messaging number.
5184
5208
  */
5185
5209
  selectionReason?: OutgoingNumberSelectionReason | null;
5186
5210
  /**
@@ -5314,7 +5338,7 @@ export interface EventDetailResponse extends AdditionalDataHolder, Parsable {
5314
5338
  */
5315
5339
  undeliverableAt?: Date | null;
5316
5340
  /**
5317
- * User summary connected to this event detail response.
5341
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
5318
5342
  */
5319
5343
  user?: EventDetailResponse_user | null;
5320
5344
  /**
@@ -5329,7 +5353,7 @@ export interface EventDetailResponse extends AdditionalDataHolder, Parsable {
5329
5353
  export type EventDetailResponse_status = (typeof EventDetailResponse_statusObject)[keyof typeof EventDetailResponse_statusObject];
5330
5354
  export type EventDetailResponse_timelineType = (typeof EventDetailResponse_timelineTypeObject)[keyof typeof EventDetailResponse_timelineTypeObject];
5331
5355
  /**
5332
- * User summary connected to this event detail response.
5356
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
5333
5357
  */
5334
5358
  export interface EventDetailResponse_user extends IdNamePair, Parsable {
5335
5359
  }
@@ -5506,7 +5530,7 @@ export interface EventTableRow extends AdditionalDataHolder, Parsable {
5506
5530
  */
5507
5531
  timelineCategory?: string | null;
5508
5532
  /**
5509
- * Timeline type used to render this event in Leadping activity feeds.
5533
+ * Classifies the kind of activity displayed in a lead or conversation event timeline.
5510
5534
  */
5511
5535
  timelineType?: EventTimelineType | null;
5512
5536
  /**
@@ -5610,11 +5634,11 @@ export interface FeedbackResponse extends AdditionalDataHolder, Parsable {
5610
5634
  */
5611
5635
  route?: string | null;
5612
5636
  /**
5613
- * Current lifecycle status for this feedback item response in the Leadping API.
5637
+ * Defines admin triage statuses for durable product feedback.
5614
5638
  */
5615
5639
  status?: FeedbackStatus | null;
5616
5640
  /**
5617
- * Type classification used to route and interpret this feedback item response in the Leadping API.
5641
+ * Defines the type of product feedback submitted from inside Leadping.
5618
5642
  */
5619
5643
  type?: FeedbackType | null;
5620
5644
  /**
@@ -5709,7 +5733,7 @@ export interface LeadArchiveRequest extends AdditionalDataHolder, Parsable {
5709
5733
  */
5710
5734
  note?: string | null;
5711
5735
  /**
5712
- * Human-readable reason supplied for this request or result.
5736
+ * Defines why a lead was removed from the active working pipeline.
5713
5737
  */
5714
5738
  reason?: number | null;
5715
5739
  }
@@ -5718,7 +5742,7 @@ export interface LeadArchiveRequest extends AdditionalDataHolder, Parsable {
5718
5742
  */
5719
5743
  export interface LeadAssignmentRequest extends AdditionalDataHolder, Parsable {
5720
5744
  /**
5721
- * Gets or sets the assigned to user ID.
5745
+ * The assignedToUserId property
5722
5746
  */
5723
5747
  assignedToUserId?: string | null;
5724
5748
  }
@@ -5747,11 +5771,11 @@ export interface LeadContact extends AdditionalDataHolder, Parsable {
5747
5771
  */
5748
5772
  lastName?: string | null;
5749
5773
  /**
5750
- * Phone details for the lead, user, or organization represented by this lead contact profile.
5774
+ * Public Leadping API schema for lead phone number data.
5751
5775
  */
5752
5776
  phone?: LeadContact_phone | null;
5753
5777
  /**
5754
- * Postal street address for the lead contact profile.
5778
+ * Describes a physical or mailing address using international locality, administrative-area, postal-code, and country fields.
5755
5779
  */
5756
5780
  streetAddress?: LeadContact_streetAddress | null;
5757
5781
  /**
@@ -5765,12 +5789,12 @@ export interface LeadContact extends AdditionalDataHolder, Parsable {
5765
5789
  export interface LeadContact_coordinate extends Coordinate, Parsable {
5766
5790
  }
5767
5791
  /**
5768
- * Phone details for the lead, user, or organization represented by this lead contact profile.
5792
+ * Public Leadping API schema for lead phone number data.
5769
5793
  */
5770
5794
  export interface LeadContact_phone extends Parsable, Phone {
5771
5795
  }
5772
5796
  /**
5773
- * Postal street address for the lead contact profile.
5797
+ * Describes a physical or mailing address using international locality, administrative-area, postal-code, and country fields.
5774
5798
  */
5775
5799
  export interface LeadContact_streetAddress extends Parsable, StreetAddress {
5776
5800
  }
@@ -6131,11 +6155,11 @@ export type LeadProfile_maritalStatus = (typeof LeadProfile_maritalStatusObject)
6131
6155
  */
6132
6156
  export interface LeadRequest extends AdditionalDataHolder, Parsable {
6133
6157
  /**
6134
- * Contact details for the lead or customer represented by this lead request.
6158
+ * Public Leadping API schema for lead contact profile data.
6135
6159
  */
6136
6160
  contact?: LeadContact | null;
6137
6161
  /**
6138
- * Demographic profile details for the lead represented by this lead request.
6162
+ * Public Leadping API schema for lead demographic profile data.
6139
6163
  */
6140
6164
  customer?: LeadProfile | null;
6141
6165
  /**
@@ -6147,7 +6171,7 @@ export interface LeadRequest extends AdditionalDataHolder, Parsable {
6147
6171
  */
6148
6172
  id?: string | null;
6149
6173
  /**
6150
- * Structured metadata used for attribution, integrations, and reporting on this lead request.
6174
+ * Public Leadping API schema for lead attribution metadata data.
6151
6175
  */
6152
6176
  metadata?: LeadMetadata | null;
6153
6177
  /**
@@ -6180,7 +6204,7 @@ export interface LeadResponse extends AdditionalDataHolder, Parsable {
6180
6204
  */
6181
6205
  archiveReason?: number | null;
6182
6206
  /**
6183
- * Identifier and display name of the active organization member assigned to this lead.
6207
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
6184
6208
  */
6185
6209
  assignedTo?: LeadResponse_assignedTo | null;
6186
6210
  /**
@@ -6188,7 +6212,7 @@ export interface LeadResponse extends AdditionalDataHolder, Parsable {
6188
6212
  */
6189
6213
  assignedToUserId?: string | null;
6190
6214
  /**
6191
- * Contact details for the lead or customer represented by this lead response.
6215
+ * Public Leadping API schema for lead contact profile data.
6192
6216
  */
6193
6217
  contact?: LeadContact | null;
6194
6218
  /**
@@ -6196,11 +6220,11 @@ export interface LeadResponse extends AdditionalDataHolder, Parsable {
6196
6220
  */
6197
6221
  createdAt?: Date | null;
6198
6222
  /**
6199
- * Current lead status change summary that describes the lead outcome.
6223
+ * Summary schema for Leadping API current lead status change summary data used in dashboards and reports.
6200
6224
  */
6201
6225
  currentLeadStatus?: LeadResponse_currentLeadStatus | null;
6202
6226
  /**
6203
- * Demographic profile details for the lead represented by this lead response.
6227
+ * Public Leadping API schema for lead demographic profile data.
6204
6228
  */
6205
6229
  customer?: LeadProfile | null;
6206
6230
  /**
@@ -6224,7 +6248,7 @@ export interface LeadResponse extends AdditionalDataHolder, Parsable {
6224
6248
  */
6225
6249
  isArchived?: boolean | null;
6226
6250
  /**
6227
- * Structured metadata used for attribution, integrations, and reporting on this lead response.
6251
+ * Public Leadping API schema for lead attribution metadata data.
6228
6252
  */
6229
6253
  metadata?: LeadMetadata | null;
6230
6254
  /**
@@ -6232,7 +6256,7 @@ export interface LeadResponse extends AdditionalDataHolder, Parsable {
6232
6256
  */
6233
6257
  modifiedAt?: Date | null;
6234
6258
  /**
6235
- * Canonical phone identity and provider lookup details for this lead.
6259
+ * Describes Leadping's canonical identity for a phone number, including normalization, carrier, line type, reputation, and lookup history.
6236
6260
  */
6237
6261
  phoneIdentity?: LeadResponse_phoneIdentity | null;
6238
6262
  /**
@@ -6253,17 +6277,17 @@ export interface LeadResponse extends AdditionalDataHolder, Parsable {
6253
6277
  tags?: TagSummary[] | null;
6254
6278
  }
6255
6279
  /**
6256
- * Identifier and display name of the active organization member assigned to this lead.
6280
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
6257
6281
  */
6258
6282
  export interface LeadResponse_assignedTo extends IdNamePair, Parsable {
6259
6283
  }
6260
6284
  /**
6261
- * Current lead status change summary that describes the lead outcome.
6285
+ * Summary schema for Leadping API current lead status change summary data used in dashboards and reports.
6262
6286
  */
6263
6287
  export interface LeadResponse_currentLeadStatus extends CurrentLeadStatusSummary, Parsable {
6264
6288
  }
6265
6289
  /**
6266
- * Canonical phone identity and provider lookup details for this lead.
6290
+ * Describes Leadping's canonical identity for a phone number, including normalization, carrier, line type, reputation, and lookup history.
6267
6291
  */
6268
6292
  export interface LeadResponse_phoneIdentity extends Parsable, PhoneIdentityResponse {
6269
6293
  }
@@ -6511,6 +6535,14 @@ export interface LeadStatusChangeResponse extends AdditionalDataHolder, Parsable
6511
6535
  * Whether this lead status change is missed call follow up.
6512
6536
  */
6513
6537
  isMissedCallFollowUp?: boolean | null;
6538
+ /**
6539
+ * The lead's profile image URL, when available.
6540
+ */
6541
+ leadAvatarUrl?: string | null;
6542
+ /**
6543
+ * The lead's email address, used for Gravatar fallback.
6544
+ */
6545
+ leadEmail?: string | null;
6514
6546
  /**
6515
6547
  * The lead ID associated with this lead status change.
6516
6548
  */
@@ -6601,7 +6633,7 @@ export type LeadStatusRequest_category = (typeof LeadStatusRequest_categoryObjec
6601
6633
  */
6602
6634
  export interface LeadStatusResponse extends AdditionalDataHolder, Parsable {
6603
6635
  /**
6604
- * LeadStatusChange category represented by the lead status.
6636
+ * Controlled lead status change categories used for reporting, automation, and analytics.
6605
6637
  */
6606
6638
  category?: LeadStatusCategory | null;
6607
6639
  /**
@@ -6650,7 +6682,7 @@ export interface LeadTableRow extends AdditionalDataHolder, Parsable {
6650
6682
  */
6651
6683
  archiveReason?: number | null;
6652
6684
  /**
6653
- * Identifier and display name of the assigned organization member.
6685
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
6654
6686
  */
6655
6687
  assignedTo?: LeadTableRow_assignedTo | null;
6656
6688
  /**
@@ -6666,7 +6698,7 @@ export interface LeadTableRow extends AdditionalDataHolder, Parsable {
6666
6698
  */
6667
6699
  createdAt?: Date | null;
6668
6700
  /**
6669
- * Current lead status change summary that describes the lead outcome.
6701
+ * Summary schema for Leadping API current lead status change summary data used in dashboards and reports.
6670
6702
  */
6671
6703
  currentLeadStatus?: LeadTableRow_currentLeadStatus | null;
6672
6704
  /**
@@ -6694,7 +6726,7 @@ export interface LeadTableRow extends AdditionalDataHolder, Parsable {
6694
6726
  */
6695
6727
  lastName?: string | null;
6696
6728
  /**
6697
- * Identifier and display name of the related organization.
6729
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
6698
6730
  */
6699
6731
  organization?: LeadTableRow_organization | null;
6700
6732
  /**
@@ -6722,7 +6754,7 @@ export interface LeadTableRow extends AdditionalDataHolder, Parsable {
6722
6754
  */
6723
6755
  processingStatusReason?: string | null;
6724
6756
  /**
6725
- * Identifier and display name of the related source.
6757
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
6726
6758
  */
6727
6759
  source?: LeadTableRow_source | null;
6728
6760
  /**
@@ -6743,23 +6775,23 @@ export interface LeadTableRow extends AdditionalDataHolder, Parsable {
6743
6775
  updatedAt?: Date | null;
6744
6776
  }
6745
6777
  /**
6746
- * Identifier and display name of the assigned organization member.
6778
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
6747
6779
  */
6748
6780
  export interface LeadTableRow_assignedTo extends IdNamePair, Parsable {
6749
6781
  }
6750
6782
  /**
6751
- * Current lead status change summary that describes the lead outcome.
6783
+ * Summary schema for Leadping API current lead status change summary data used in dashboards and reports.
6752
6784
  */
6753
6785
  export interface LeadTableRow_currentLeadStatus extends CurrentLeadStatusSummary, Parsable {
6754
6786
  }
6755
6787
  /**
6756
- * Identifier and display name of the related organization.
6788
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
6757
6789
  */
6758
6790
  export interface LeadTableRow_organization extends IdNamePair, Parsable {
6759
6791
  }
6760
6792
  export type LeadTableRow_processingStatus = (typeof LeadTableRow_processingStatusObject)[keyof typeof LeadTableRow_processingStatusObject];
6761
6793
  /**
6762
- * Identifier and display name of the related source.
6794
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
6763
6795
  */
6764
6796
  export interface LeadTableRow_source extends IdNamePair, Parsable {
6765
6797
  }
@@ -6792,6 +6824,10 @@ export interface MessageMediaAttachment extends AdditionalDataHolder, Parsable {
6792
6824
  * Original file name of the media attachment, when available.
6793
6825
  */
6794
6826
  fileName?: string | null;
6827
+ /**
6828
+ * The durable Media record containing this attachment's scanned bytes.
6829
+ */
6830
+ mediaId?: string | null;
6795
6831
  /**
6796
6832
  * SHA-256 digest of the media content, when available.
6797
6833
  */
@@ -6810,7 +6846,7 @@ export interface MessageMediaAttachment extends AdditionalDataHolder, Parsable {
6810
6846
  */
6811
6847
  export interface MobileDevicePreferences extends AdditionalDataHolder, Parsable {
6812
6848
  /**
6813
- * Identifier and display name of the related device.
6849
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
6814
6850
  */
6815
6851
  device?: IdNamePair | null;
6816
6852
  /**
@@ -6864,7 +6900,7 @@ export interface NotificationResponse extends AdditionalDataHolder, Parsable {
6864
6900
  */
6865
6901
  name?: string | null;
6866
6902
  /**
6867
- * Priority for this notification.
6903
+ * Ranks the urgency and presentation importance of a Leadping user notification.
6868
6904
  */
6869
6905
  priority?: NotificationPriority | null;
6870
6906
  /**
@@ -6884,7 +6920,7 @@ export interface NotificationResponse extends AdditionalDataHolder, Parsable {
6884
6920
  */
6885
6921
  relatedEntityType?: string | null;
6886
6922
  /**
6887
- * The type classification for this notification.
6923
+ * Identifies the Leadping workflow or account event communicated by a user notification.
6888
6924
  */
6889
6925
  type?: NotificationType | null;
6890
6926
  /**
@@ -6933,7 +6969,7 @@ export interface NotificationTableRow extends AdditionalDataHolder, Parsable {
6933
6969
  */
6934
6970
  name?: string | null;
6935
6971
  /**
6936
- * Priority for this notification.
6972
+ * Ranks the urgency and presentation importance of a Leadping user notification.
6937
6973
  */
6938
6974
  priority?: NotificationPriority | null;
6939
6975
  /**
@@ -6949,7 +6985,7 @@ export interface NotificationTableRow extends AdditionalDataHolder, Parsable {
6949
6985
  */
6950
6986
  relatedEntityType?: string | null;
6951
6987
  /**
6952
- * The type classification for this notification.
6988
+ * Identifies the Leadping workflow or account event communicated by a user notification.
6953
6989
  */
6954
6990
  type?: NotificationType | null;
6955
6991
  }
@@ -6981,7 +7017,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
6981
7017
  */
6982
7018
  availableDomainCount?: number | null;
6983
7019
  /**
6984
- * The current billing subscription status for this organization activation state.
7020
+ * Describes whether an organization's subscription is ready, blocked, or still incomplete during activation.
6985
7021
  */
6986
7022
  billingSubscriptionStatus?: ActivationSubscriptionStatus | null;
6987
7023
  /**
@@ -7049,7 +7085,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
7049
7085
  */
7050
7086
  launchReviewRequestedAt?: Date | null;
7051
7087
  /**
7052
- * The current launch review status for this organization activation state.
7088
+ * Describes the administrative review decision that determines whether an organization can launch Leadping workflows.
7053
7089
  */
7054
7090
  launchReviewStatus?: ActivationLaunchReviewStatus | null;
7055
7091
  /**
@@ -7057,7 +7093,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
7057
7093
  */
7058
7094
  offer?: string | null;
7059
7095
  /**
7060
- * The current onboarding status for this organization activation state.
7096
+ * Describes completion and blocking state for an organization's core Leadping onboarding requirements.
7061
7097
  */
7062
7098
  onboardingStatus?: ActivationOnboardingStatus | null;
7063
7099
  /**
@@ -7069,7 +7105,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
7069
7105
  */
7070
7106
  paymentMethodConfirmedAt?: Date | null;
7071
7107
  /**
7072
- * The current payment status for this organization activation state.
7108
+ * Describes whether valid funding and payment prerequisites are satisfied during organization activation.
7073
7109
  */
7074
7110
  paymentStatus?: ActivationPaymentStatus | null;
7075
7111
  /**
@@ -7081,7 +7117,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
7081
7117
  */
7082
7118
  serviceArea?: string | null;
7083
7119
  /**
7084
- * The current status for this organization activation state.
7120
+ * Summarizes an organization's overall progress from initial Leadping onboarding through launch readiness.
7085
7121
  */
7086
7122
  status?: CustomerActivationStatus | null;
7087
7123
  /**
@@ -7109,7 +7145,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
7109
7145
  */
7110
7146
  telephonyReadyAt?: Date | null;
7111
7147
  /**
7112
- * The current telephony status for this organization activation state.
7148
+ * Describes whether phone numbers, calling, messaging, and provider resources are ready for organization launch.
7113
7149
  */
7114
7150
  telephonyStatus?: ActivationTelephonyStatus | null;
7115
7151
  /**
@@ -7117,11 +7153,11 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
7117
7153
  */
7118
7154
  tenDlcApplicationId?: string | null;
7119
7155
  /**
7120
- * 10DLC draft for this organization activation state.
7156
+ * Describes 10DLC application draft data used in Leadping API requests and responses.
7121
7157
  */
7122
7158
  tenDlcDraft?: OrganizationActivationState_tenDlcDraft | null;
7123
7159
  /**
7124
- * The current 10DLC status for this organization activation state.
7160
+ * Describes an organization's overall 10DLC registration lifecycle across brand and messaging campaign submission.
7125
7161
  */
7126
7162
  tenDlcStatus?: TenDlcApplicationStatus | null;
7127
7163
  /**
@@ -7137,7 +7173,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
7137
7173
  */
7138
7174
  websiteNeeds?: string | null;
7139
7175
  /**
7140
- * The current website status for this organization activation state.
7176
+ * Describes an organization website's lifecycle from discovery and verification through activation, suspension, or removal.
7141
7177
  */
7142
7178
  websiteStatus?: WebsiteLifecycleStatus | null;
7143
7179
  /**
@@ -7147,7 +7183,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
7147
7183
  }
7148
7184
  export type OrganizationActivationState_domainSearchStage = (typeof OrganizationActivationState_domainSearchStageObject)[keyof typeof OrganizationActivationState_domainSearchStageObject];
7149
7185
  /**
7150
- * 10DLC draft for this organization activation state.
7186
+ * Describes 10DLC application draft data used in Leadping API requests and responses.
7151
7187
  */
7152
7188
  export interface OrganizationActivationState_tenDlcDraft extends Parsable, TenDlcApplicationDraft {
7153
7189
  }
@@ -7156,7 +7192,7 @@ export interface OrganizationActivationState_tenDlcDraft extends Parsable, TenDl
7156
7192
  */
7157
7193
  export interface OrganizationApiKeyIssueResponse extends AdditionalDataHolder, Parsable {
7158
7194
  /**
7159
- * API key associated with this Leadping organization API key issue.
7195
+ * Safe identifying and usage metadata for an organization API key. This model never contains the secret credential.
7160
7196
  */
7161
7197
  apiKey?: OrganizationApiKeyPreviewResponse | null;
7162
7198
  /**
@@ -7230,7 +7266,7 @@ export interface OrganizationApiKeyPreviewResponse extends AdditionalDataHolder,
7230
7266
  */
7231
7267
  name?: string | null;
7232
7268
  /**
7233
- * Organization that owns the API key.
7269
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
7234
7270
  */
7235
7271
  organization?: IdNamePair | null;
7236
7272
  /**
@@ -7289,7 +7325,7 @@ export interface OrganizationBillingState extends AdditionalDataHolder, Parsable
7289
7325
  */
7290
7326
  cancelAt?: Date | null;
7291
7327
  /**
7292
- * Customer-safe payment recovery state for the organization.
7328
+ * Dunning state recorded after a failed recurring payment.
7293
7329
  */
7294
7330
  dunning?: OrganizationBillingState_dunning | null;
7295
7331
  /**
@@ -7334,7 +7370,7 @@ export interface OrganizationBillingState extends AdditionalDataHolder, Parsable
7334
7370
  planRenewalAt?: Date | null;
7335
7371
  }
7336
7372
  /**
7337
- * Customer-safe payment recovery state for the organization.
7373
+ * Dunning state recorded after a failed recurring payment.
7338
7374
  */
7339
7375
  export interface OrganizationBillingState_dunning extends OrganizationDunningInfo, Parsable {
7340
7376
  }
@@ -7430,7 +7466,7 @@ export interface OrganizationInvitationRequest extends AdditionalDataHolder, Par
7430
7466
  */
7431
7467
  email?: string | null;
7432
7468
  /**
7433
- * Role for this organization invitation.
7469
+ * Identifies an organization member's access level and permission scope within Leadping.
7434
7470
  */
7435
7471
  role?: OrganizationMemberRole | null;
7436
7472
  }
@@ -7479,7 +7515,7 @@ export interface OrganizationInvitationResponse extends AdditionalDataHolder, Pa
7479
7515
  */
7480
7516
  licenseRenewalDate?: Date | null;
7481
7517
  /**
7482
- * Identifier and display name of the related organization.
7518
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
7483
7519
  */
7484
7520
  organization?: IdNamePair | null;
7485
7521
  /**
@@ -7491,7 +7527,7 @@ export interface OrganizationInvitationResponse extends AdditionalDataHolder, Pa
7491
7527
  */
7492
7528
  revokedAt?: Date | null;
7493
7529
  /**
7494
- * Role for this organization invitation.
7530
+ * Identifies an organization member's access level and permission scope within Leadping.
7495
7531
  */
7496
7532
  role?: OrganizationMemberRole | null;
7497
7533
  /**
@@ -7507,7 +7543,7 @@ export interface OrganizationInvitationResponse extends AdditionalDataHolder, Pa
7507
7543
  */
7508
7544
  sentAt?: Date | null;
7509
7545
  /**
7510
- * The current status for this organization invitation.
7546
+ * Describes the lifecycle of an organization membership invitation from issuance through acceptance, expiration, or revocation.
7511
7547
  */
7512
7548
  status?: OrganizationInvitationStatus | null;
7513
7549
  }
@@ -7557,7 +7593,7 @@ export interface OrganizationInvitationTableRow extends AdditionalDataHolder, Pa
7557
7593
  */
7558
7594
  licenseRenewalDate?: Date | null;
7559
7595
  /**
7560
- * Identifier and display name of the related organization.
7596
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
7561
7597
  */
7562
7598
  organization?: IdNamePair | null;
7563
7599
  /**
@@ -7569,7 +7605,7 @@ export interface OrganizationInvitationTableRow extends AdditionalDataHolder, Pa
7569
7605
  */
7570
7606
  revokedAt?: Date | null;
7571
7607
  /**
7572
- * Role for this organization invitation.
7608
+ * Identifies an organization member's access level and permission scope within Leadping.
7573
7609
  */
7574
7610
  role?: OrganizationMemberRole | null;
7575
7611
  /**
@@ -7581,7 +7617,7 @@ export interface OrganizationInvitationTableRow extends AdditionalDataHolder, Pa
7581
7617
  */
7582
7618
  sentAt?: Date | null;
7583
7619
  /**
7584
- * The current status for this organization invitation.
7620
+ * Describes the lifecycle of an organization membership invitation from issuance through acceptance, expiration, or revocation.
7585
7621
  */
7586
7622
  status?: OrganizationInvitationStatus | null;
7587
7623
  }
@@ -7594,7 +7630,7 @@ export interface OrganizationMemberRequest extends AdditionalDataHolder, Parsabl
7594
7630
  */
7595
7631
  email?: string | null;
7596
7632
  /**
7597
- * Organization role assigned to the user.
7633
+ * Identifies an organization member's access level and permission scope within Leadping.
7598
7634
  */
7599
7635
  role?: OrganizationMemberRole | null;
7600
7636
  /**
@@ -7643,7 +7679,7 @@ export interface OrganizationMemberResponse extends AdditionalDataHolder, Parsab
7643
7679
  */
7644
7680
  name?: string | null;
7645
7681
  /**
7646
- * Organization for this organization user.
7682
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
7647
7683
  */
7648
7684
  organization?: IdNamePair | null;
7649
7685
  /**
@@ -7655,11 +7691,11 @@ export interface OrganizationMemberResponse extends AdditionalDataHolder, Parsab
7655
7691
  */
7656
7692
  removedByUserId?: string | null;
7657
7693
  /**
7658
- * Role for this organization user.
7694
+ * Identifies an organization member's access level and permission scope within Leadping.
7659
7695
  */
7660
7696
  role?: OrganizationMemberRole | null;
7661
7697
  /**
7662
- * User for this organization user.
7698
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
7663
7699
  */
7664
7700
  user?: IdNamePair | null;
7665
7701
  /**
@@ -7689,11 +7725,11 @@ export interface OrganizationMemberTableRow extends AdditionalDataHolder, Parsab
7689
7725
  */
7690
7726
  licenseRenewalDate?: Date | null;
7691
7727
  /**
7692
- * Role for this organization user.
7728
+ * Identifies an organization member's access level and permission scope within Leadping.
7693
7729
  */
7694
7730
  role?: OrganizationMemberRole | null;
7695
7731
  /**
7696
- * Identifier and display name of the related user.
7732
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
7697
7733
  */
7698
7734
  user?: IdNamePair | null;
7699
7735
  /**
@@ -7706,7 +7742,7 @@ export interface OrganizationMemberTableRow extends AdditionalDataHolder, Parsab
7706
7742
  */
7707
7743
  export interface OrganizationRequest extends AdditionalDataHolder, Parsable {
7708
7744
  /**
7709
- * Postal address for the organization, lead, or contact represented by this organization profile request.
7745
+ * Describes a physical or mailing address using international locality, administrative-area, postal-code, and country fields.
7710
7746
  */
7711
7747
  address?: OrganizationRequest_address | null;
7712
7748
  /**
@@ -7743,7 +7779,7 @@ export interface OrganizationRequest extends AdditionalDataHolder, Parsable {
7743
7779
  website?: string | null;
7744
7780
  }
7745
7781
  /**
7746
- * Postal address for the organization, lead, or contact represented by this organization profile request.
7782
+ * Describes a physical or mailing address using international locality, administrative-area, postal-code, and country fields.
7747
7783
  */
7748
7784
  export interface OrganizationRequest_address extends Parsable, StreetAddress {
7749
7785
  }
@@ -7756,11 +7792,11 @@ export interface OrganizationResponse extends AdditionalDataHolder, Parsable {
7756
7792
  */
7757
7793
  accountBalance?: number | null;
7758
7794
  /**
7759
- * Organization activation state covering site, billing, compliance, and telephony readiness.
7795
+ * Describes organization activation state data used in Leadping API requests and responses.
7760
7796
  */
7761
7797
  activation?: OrganizationResponse_activation | null;
7762
7798
  /**
7763
- * Postal address for the organization, lead, or contact represented by this organization profile response.
7799
+ * Describes a physical or mailing address using international locality, administrative-area, postal-code, and country fields.
7764
7800
  */
7765
7801
  address?: OrganizationResponse_address | null;
7766
7802
  /**
@@ -7776,7 +7812,7 @@ export interface OrganizationResponse extends AdditionalDataHolder, Parsable {
7776
7812
  */
7777
7813
  autoRefillTrigger?: number | null;
7778
7814
  /**
7779
- * Postal address used for invoices, receipts, and payment processor billing records.
7815
+ * Describes a physical or mailing address using international locality, administrative-area, postal-code, and country fields.
7780
7816
  */
7781
7817
  billingAddress?: OrganizationResponse_billingAddress | null;
7782
7818
  /**
@@ -7788,7 +7824,7 @@ export interface OrganizationResponse extends AdditionalDataHolder, Parsable {
7788
7824
  */
7789
7825
  billingPlan?: OrganizationResponse_billingPlan | null;
7790
7826
  /**
7791
- * Customer-safe billing state for this organization.
7827
+ * Customer-safe billing state for a Leadping organization.
7792
7828
  */
7793
7829
  billingState?: OrganizationResponse_billingState | null;
7794
7830
  /**
@@ -7796,7 +7832,7 @@ export interface OrganizationResponse extends AdditionalDataHolder, Parsable {
7796
7832
  */
7797
7833
  billingTaxId?: string | null;
7798
7834
  /**
7799
- * Compliance policy configuration for the organization.
7835
+ * Describes organization compliance policy data used in Leadping API requests and responses.
7800
7836
  */
7801
7837
  compliancePolicy?: OrganizationResponse_compliancePolicy | null;
7802
7838
  /**
@@ -7816,7 +7852,7 @@ export interface OrganizationResponse extends AdditionalDataHolder, Parsable {
7816
7852
  */
7817
7853
  ein?: string | null;
7818
7854
  /**
7819
- * Uploaded EIN document reference used for organization verification.
7855
+ * Extends an identifier-and-name resource reference with an optional string value used for display or selection metadata.
7820
7856
  */
7821
7857
  einDocument?: OrganizationResponse_einDocument | null;
7822
7858
  /**
@@ -7856,7 +7892,7 @@ export interface OrganizationResponse extends AdditionalDataHolder, Parsable {
7856
7892
  */
7857
7893
  setupStep?: OrganizationResponse_setupStep | null;
7858
7894
  /**
7859
- * Leadping website record connected to this organization.
7895
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
7860
7896
  */
7861
7897
  site?: OrganizationResponse_site | null;
7862
7898
  /**
@@ -7868,7 +7904,7 @@ export interface OrganizationResponse extends AdditionalDataHolder, Parsable {
7868
7904
  */
7869
7905
  subscriptionStatus?: OrganizationResponse_subscriptionStatus | null;
7870
7906
  /**
7871
- * User summary connected to this organization profile response.
7907
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
7872
7908
  */
7873
7909
  user?: OrganizationResponse_user | null;
7874
7910
  /**
@@ -7881,47 +7917,47 @@ export interface OrganizationResponse extends AdditionalDataHolder, Parsable {
7881
7917
  website?: string | null;
7882
7918
  }
7883
7919
  /**
7884
- * Organization activation state covering site, billing, compliance, and telephony readiness.
7920
+ * Describes organization activation state data used in Leadping API requests and responses.
7885
7921
  */
7886
7922
  export interface OrganizationResponse_activation extends OrganizationActivationState, Parsable {
7887
7923
  }
7888
7924
  /**
7889
- * Postal address for the organization, lead, or contact represented by this organization profile response.
7925
+ * Describes a physical or mailing address using international locality, administrative-area, postal-code, and country fields.
7890
7926
  */
7891
7927
  export interface OrganizationResponse_address extends Parsable, StreetAddress {
7892
7928
  }
7893
7929
  /**
7894
- * Postal address used for invoices, receipts, and payment processor billing records.
7930
+ * Describes a physical or mailing address using international locality, administrative-area, postal-code, and country fields.
7895
7931
  */
7896
7932
  export interface OrganizationResponse_billingAddress extends Parsable, StreetAddress {
7897
7933
  }
7898
7934
  export type OrganizationResponse_billingPlan = (typeof OrganizationResponse_billingPlanObject)[keyof typeof OrganizationResponse_billingPlanObject];
7899
7935
  /**
7900
- * Customer-safe billing state for this organization.
7936
+ * Customer-safe billing state for a Leadping organization.
7901
7937
  */
7902
7938
  export interface OrganizationResponse_billingState extends OrganizationBillingState, Parsable {
7903
7939
  }
7904
7940
  /**
7905
- * Compliance policy configuration for the organization.
7941
+ * Describes organization compliance policy data used in Leadping API requests and responses.
7906
7942
  */
7907
7943
  export interface OrganizationResponse_compliancePolicy extends OrganizationCompliancePolicy, Parsable {
7908
7944
  }
7909
7945
  /**
7910
- * Uploaded EIN document reference used for organization verification.
7946
+ * Extends an identifier-and-name resource reference with an optional string value used for display or selection metadata.
7911
7947
  */
7912
7948
  export interface OrganizationResponse_einDocument extends IdNameValue, Parsable {
7913
7949
  }
7914
7950
  export type OrganizationResponse_setupStatus = (typeof OrganizationResponse_setupStatusObject)[keyof typeof OrganizationResponse_setupStatusObject];
7915
7951
  export type OrganizationResponse_setupStep = (typeof OrganizationResponse_setupStepObject)[keyof typeof OrganizationResponse_setupStepObject];
7916
7952
  /**
7917
- * Leadping website record connected to this organization.
7953
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
7918
7954
  */
7919
7955
  export interface OrganizationResponse_site extends IdNamePair, Parsable {
7920
7956
  }
7921
7957
  export type OrganizationResponse_status = (typeof OrganizationResponse_statusObject)[keyof typeof OrganizationResponse_statusObject];
7922
7958
  export type OrganizationResponse_subscriptionStatus = (typeof OrganizationResponse_subscriptionStatusObject)[keyof typeof OrganizationResponse_subscriptionStatusObject];
7923
7959
  /**
7924
- * User summary connected to this organization profile response.
7960
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
7925
7961
  */
7926
7962
  export interface OrganizationResponse_user extends IdNamePair, Parsable {
7927
7963
  }
@@ -7970,7 +8006,7 @@ export interface OrganizationSwitchOption extends AdditionalDataHolder, Parsable
7970
8006
  */
7971
8007
  readyForCustomerTraffic?: boolean | null;
7972
8008
  /**
7973
- * Role for this organization switch option.
8009
+ * Identifies an organization member's access level and permission scope within Leadping.
7974
8010
  */
7975
8011
  role?: OrganizationMemberRole | null;
7976
8012
  /**
@@ -8051,7 +8087,7 @@ export interface OutboundPhoneNumberCapacity extends AdditionalDataHolder, Parsa
8051
8087
  */
8052
8088
  healthReason?: string | null;
8053
8089
  /**
8054
- * Current health status for this Leadping outbound phone number capacity.
8090
+ * Defines phone-number outbound health states used by pacing.
8055
8091
  */
8056
8092
  healthStatus?: PhoneNumberOutboundHealthStatus | null;
8057
8093
  /**
@@ -8176,7 +8212,7 @@ export interface OutboundPhoneNumberCapacity extends AdditionalDataHolder, Parsa
8176
8212
  */
8177
8213
  export interface OutboundQueueItem extends AdditionalDataHolder, Parsable {
8178
8214
  /**
8179
- * Channel classification for this Leadping outbound queue item.
8215
+ * Defines outbound delivery channels protected by delivery control.
8180
8216
  */
8181
8217
  channel?: OutboundDeliveryChannel | null;
8182
8218
  /**
@@ -8200,11 +8236,11 @@ export interface OutboundQueueItem extends AdditionalDataHolder, Parsable {
8200
8236
  */
8201
8237
  scheduledSendAt?: Date | null;
8202
8238
  /**
8203
- * Source classification for this Leadping outbound queue item.
8239
+ * Defines the source that requested outbound delivery.
8204
8240
  */
8205
8241
  source?: OutboundDeliverySource | null;
8206
8242
  /**
8207
- * Current status for this Leadping outbound queue item.
8243
+ * Defines durable outbound delivery request statuses.
8208
8244
  */
8209
8245
  status?: OutboundDeliveryStatus | null;
8210
8246
  }
@@ -8218,7 +8254,7 @@ export interface OutgoingNumberManualOverrideRequest extends AdditionalDataHolde
8218
8254
  */
8219
8255
  fromPhoneNumberId?: string | null;
8220
8256
  /**
8221
- * Selected outgoing number and selection rationale returned by Leadping.
8257
+ * Defines the fields clients can send when working with outgoing number selection.
8222
8258
  */
8223
8259
  selection?: OutgoingNumberSelectionRequest | null;
8224
8260
  }
@@ -8611,7 +8647,7 @@ export interface Phone extends AdditionalDataHolder, Parsable {
8611
8647
  type?: string | null;
8612
8648
  }
8613
8649
  /**
8614
- * Describes a Leadping phone call, including participants, direction, provider state, timing, recording, and billing details.
8650
+ * Describes a Leadping phone call, including participants, direction, provider state, timing, voicemail, and billing details.
8615
8651
  */
8616
8652
  export interface PhoneCallResponse extends AdditionalDataHolder, Parsable {
8617
8653
  /**
@@ -8686,10 +8722,6 @@ export interface PhoneCallResponse extends AdditionalDataHolder, Parsable {
8686
8722
  * UTC timestamp when Leadping queued this phone call for processing.
8687
8723
  */
8688
8724
  queuedAt?: Date | null;
8689
- /**
8690
- * URL for the call recording, when the provider makes one available.
8691
- */
8692
- recordingUrl?: string | null;
8693
8725
  /**
8694
8726
  * UTC timestamp when the call started ringing.
8695
8727
  */
@@ -8703,7 +8735,7 @@ export interface PhoneCallResponse extends AdditionalDataHolder, Parsable {
8703
8735
  */
8704
8736
  sourceId?: string | null;
8705
8737
  /**
8706
- * Current lifecycle status for this phone call in the Leadping API.
8738
+ * Describes the durable business outcome of a Leadping phone call after provider status normalization.
8707
8739
  */
8708
8740
  status?: PhoneCallStatus | null;
8709
8741
  /**
@@ -8714,6 +8746,10 @@ export interface PhoneCallResponse extends AdditionalDataHolder, Parsable {
8714
8746
  * Recipient phone number used for this communication.
8715
8747
  */
8716
8748
  toPhoneNumber?: string | null;
8749
+ /**
8750
+ * URL for voicemail audio, when the call resulted in a voicemail.
8751
+ */
8752
+ voicemailUrl?: string | null;
8717
8753
  /**
8718
8754
  * Indicates whether a user manually overrode Leadping's automatic number selection for this phone call.
8719
8755
  */
@@ -8746,11 +8782,11 @@ export interface PhoneIdentityLookupAction extends AdditionalDataHolder, Parsabl
8746
8782
  */
8747
8783
  providerPricingVersion?: string | null;
8748
8784
  /**
8749
- * The processing outcome reported for the phone identity lookup.
8785
+ * Identifies the outcome of a phone identity lookup action.
8750
8786
  */
8751
8787
  status?: PhoneIdentityLookupActionStatus | null;
8752
8788
  /**
8753
- * The category of enrichment, validation, or reputation lookup that was performed.
8789
+ * Identifies the kind of lookup action performed for a phone identity.
8754
8790
  */
8755
8791
  type?: PhoneIdentityLookupActionType | null;
8756
8792
  }
@@ -8773,7 +8809,7 @@ export interface PhoneIdentityResponse extends AdditionalDataHolder, Parsable {
8773
8809
  */
8774
8810
  lastEnrichedAt?: Date | null;
8775
8811
  /**
8776
- * Provider lookup and enrichment data for the number.
8812
+ * Public Leadping API schema for phone lookup result data.
8777
8813
  */
8778
8814
  lookup?: PhoneIdentityResponse_lookup | null;
8779
8815
  /**
@@ -8793,17 +8829,17 @@ export interface PhoneIdentityResponse extends AdditionalDataHolder, Parsable {
8793
8829
  */
8794
8830
  number?: string | null;
8795
8831
  /**
8796
- * Lossless provider response retained for administrative diagnostics.
8832
+ * Lossless provider snapshot retained with a phone identity for replay, audits, and fields added by providers later.
8797
8833
  */
8798
8834
  providerEnrichment?: PhoneIdentityResponse_providerEnrichment | null;
8799
8835
  }
8800
8836
  /**
8801
- * Provider lookup and enrichment data for the number.
8837
+ * Public Leadping API schema for phone lookup result data.
8802
8838
  */
8803
8839
  export interface PhoneIdentityResponse_lookup extends Parsable, PhoneLookup {
8804
8840
  }
8805
8841
  /**
8806
- * Lossless provider response retained for administrative diagnostics.
8842
+ * Lossless provider snapshot retained with a phone identity for replay, audits, and fields added by providers later.
8807
8843
  */
8808
8844
  export interface PhoneIdentityResponse_providerEnrichment extends Parsable, PhoneLookupProviderSnapshot {
8809
8845
  }
@@ -8825,11 +8861,11 @@ export interface PhoneLocationSource extends AdditionalDataHolder, Parsable {
8825
8861
  */
8826
8862
  export interface PhoneLookup extends AdditionalDataHolder, Parsable {
8827
8863
  /**
8828
- * Caller-name data returned by the provider.
8864
+ * Caller-name data returned by the phone lookup provider.
8829
8865
  */
8830
8866
  callerName?: PhoneLookup_callerName | null;
8831
8867
  /**
8832
- * Complete carrier metadata reported for this phone number.
8868
+ * Complete carrier metadata returned by a phone number lookup provider.
8833
8869
  */
8834
8870
  carrier?: PhoneLookup_carrier | null;
8835
8871
  /**
@@ -8853,7 +8889,7 @@ export interface PhoneLookup extends AdditionalDataHolder, Parsable {
8853
8889
  */
8854
8890
  lineType?: PhoneLookup_lineType | null;
8855
8891
  /**
8856
- * Geographic location metadata for the phone number, lead, or lookup result.
8892
+ * Public Leadping API schema for phone number location data.
8857
8893
  */
8858
8894
  location?: PhoneLookup_location | null;
8859
8895
  /**
@@ -8869,7 +8905,7 @@ export interface PhoneLookup extends AdditionalDataHolder, Parsable {
8869
8905
  */
8870
8906
  number?: string | null;
8871
8907
  /**
8872
- * Complete portability data returned by Telnyx.
8908
+ * Number-portability and routing data returned by Telnyx.
8873
8909
  */
8874
8910
  portability?: PhoneLookup_portability | null;
8875
8911
  /**
@@ -8878,23 +8914,23 @@ export interface PhoneLookup extends AdditionalDataHolder, Parsable {
8878
8914
  recordType?: string | null;
8879
8915
  }
8880
8916
  /**
8881
- * Caller-name data returned by the provider.
8917
+ * Caller-name data returned by the phone lookup provider.
8882
8918
  */
8883
8919
  export interface PhoneLookup_callerName extends Parsable, PhoneLookupCallerName {
8884
8920
  }
8885
8921
  /**
8886
- * Complete carrier metadata reported for this phone number.
8922
+ * Complete carrier metadata returned by a phone number lookup provider.
8887
8923
  */
8888
8924
  export interface PhoneLookup_carrier extends Parsable, PhoneLookupCarrier {
8889
8925
  }
8890
8926
  export type PhoneLookup_lineType = (typeof PhoneLookup_lineTypeObject)[keyof typeof PhoneLookup_lineTypeObject];
8891
8927
  /**
8892
- * Geographic location metadata for the phone number, lead, or lookup result.
8928
+ * Public Leadping API schema for phone number location data.
8893
8929
  */
8894
8930
  export interface PhoneLookup_location extends Parsable, PhoneNumberLocation {
8895
8931
  }
8896
8932
  /**
8897
- * Complete portability data returned by Telnyx.
8933
+ * Number-portability and routing data returned by Telnyx.
8898
8934
  */
8899
8935
  export interface PhoneLookup_portability extends Parsable, PhoneLookupPortability {
8900
8936
  }
@@ -9045,7 +9081,7 @@ export interface PhoneNumberAvailabilityResponse extends AdditionalDataHolder, P
9045
9081
  */
9046
9082
  isAvailable?: boolean | null;
9047
9083
  /**
9048
- * Geographic location metadata for the phone number, lead, or lookup result.
9084
+ * Public Leadping API schema for phone number location data.
9049
9085
  */
9050
9086
  location?: PhoneNumberAvailabilityResponse_location | null;
9051
9087
  /**
@@ -9058,7 +9094,7 @@ export interface PhoneNumberAvailabilityResponse extends AdditionalDataHolder, P
9058
9094
  price?: number | null;
9059
9095
  }
9060
9096
  /**
9061
- * Geographic location metadata for the phone number, lead, or lookup result.
9097
+ * Public Leadping API schema for phone number location data.
9062
9098
  */
9063
9099
  export interface PhoneNumberAvailabilityResponse_location extends Parsable, PhoneNumberLocation {
9064
9100
  }
@@ -9075,11 +9111,11 @@ export interface PhoneNumberLocation extends AdditionalDataHolder, Parsable {
9075
9111
  */
9076
9112
  canonicalState?: string | null;
9077
9113
  /**
9078
- * Latitude and longitude coordinate for this phone number location.
9114
+ * Latitude and longitude coordinate for this lead contact profile.
9079
9115
  */
9080
9116
  coordinate?: PhoneNumberLocation_coordinate | null;
9081
9117
  /**
9082
- * Describes how the coordinate was resolved.
9118
+ * Describes how a phone location value was resolved.
9083
9119
  */
9084
9120
  coordinateSource?: PhoneNumberLocation_coordinateSource | null;
9085
9121
  /**
@@ -9099,22 +9135,22 @@ export interface PhoneNumberLocation extends AdditionalDataHolder, Parsable {
9099
9135
  */
9100
9136
  timeZoneId?: string | null;
9101
9137
  /**
9102
- * Describes how the time zone was resolved.
9138
+ * Describes how a phone location value was resolved.
9103
9139
  */
9104
9140
  timeZoneSource?: PhoneNumberLocation_timeZoneSource | null;
9105
9141
  }
9106
9142
  /**
9107
- * Latitude and longitude coordinate for this phone number location.
9143
+ * Latitude and longitude coordinate for this lead contact profile.
9108
9144
  */
9109
9145
  export interface PhoneNumberLocation_coordinate extends Coordinate, Parsable {
9110
9146
  }
9111
9147
  /**
9112
- * Describes how the coordinate was resolved.
9148
+ * Describes how a phone location value was resolved.
9113
9149
  */
9114
9150
  export interface PhoneNumberLocation_coordinateSource extends Parsable, PhoneLocationSource {
9115
9151
  }
9116
9152
  /**
9117
- * Describes how the time zone was resolved.
9153
+ * Describes how a phone location value was resolved.
9118
9154
  */
9119
9155
  export interface PhoneNumberLocation_timeZoneSource extends Parsable, PhoneLocationSource {
9120
9156
  }
@@ -9229,6 +9265,10 @@ export interface PhoneNumberRequest extends AdditionalDataHolder, Parsable {
9229
9265
  * E.164 phone number exposed by this phone number update request.
9230
9266
  */
9231
9267
  number?: string | null;
9268
+ /**
9269
+ * Opts this number into the optional $2 monthly number health add-on. Defaults to on on creation; omitted updates preserve the current selection.
9270
+ */
9271
+ numberHealthEnabled?: boolean | null;
9232
9272
  }
9233
9273
  /**
9234
9274
  * Describes a Leadping-managed phone number, including capabilities, messaging registration, health, and assignment details.
@@ -9263,7 +9303,11 @@ export interface PhoneNumberResponse extends AdditionalDataHolder, Parsable {
9263
9303
  */
9264
9304
  number?: string | null;
9265
9305
  /**
9266
- * Organization summary connected to this phone number.
9306
+ * Opts this number into the optional $2 monthly number health add-on. Defaults to on; customers can opt out.
9307
+ */
9308
+ numberHealthEnabled?: boolean | null;
9309
+ /**
9310
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
9267
9311
  */
9268
9312
  organization?: PhoneNumberResponse_organization | null;
9269
9313
  /**
@@ -9271,16 +9315,16 @@ export interface PhoneNumberResponse extends AdditionalDataHolder, Parsable {
9271
9315
  */
9272
9316
  phoneIdentityId?: string | null;
9273
9317
  /**
9274
- * Routing metadata that connects this phone number to teams, campaigns, and sources.
9318
+ * Public Leadping API schema for phone number routing metadata data.
9275
9319
  */
9276
9320
  routing?: PhoneNumberRoutingMetadata | null;
9277
9321
  /**
9278
- * SMS and call warmup for this phone number.
9322
+ * Messaging and calling warmup for a Leadping phone number.
9279
9323
  */
9280
9324
  warmup?: PhoneNumberReadiness | null;
9281
9325
  }
9282
9326
  /**
9283
- * Organization summary connected to this phone number.
9327
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
9284
9328
  */
9285
9329
  export interface PhoneNumberResponse_organization extends IdNamePair, Parsable {
9286
9330
  }
@@ -9318,7 +9362,7 @@ export interface PhoneNumberRoutingMetadata extends AdditionalDataHolder, Parsab
9318
9362
  */
9319
9363
  export interface PhoneNumberSearchRequest extends AdditionalDataHolder, Parsable {
9320
9364
  /**
9321
- * Geographic location metadata for the phone number, lead, or lookup result.
9365
+ * Public Leadping API schema for phone number location data.
9322
9366
  */
9323
9367
  location?: PhoneNumberSearchRequest_location | null;
9324
9368
  /**
@@ -9327,7 +9371,7 @@ export interface PhoneNumberSearchRequest extends AdditionalDataHolder, Parsable
9327
9371
  phoneNumber?: string | null;
9328
9372
  }
9329
9373
  /**
9330
- * Geographic location metadata for the phone number, lead, or lookup result.
9374
+ * Public Leadping API schema for phone number location data.
9331
9375
  */
9332
9376
  export interface PhoneNumberSearchRequest_location extends Parsable, PhoneNumberLocation {
9333
9377
  }
@@ -9345,7 +9389,7 @@ export interface PhoneNumberSearchResponse extends AdditionalDataHolder, Parsabl
9345
9389
  */
9346
9390
  export interface PhoneNumberSearchResult extends AdditionalDataHolder, Parsable {
9347
9391
  /**
9348
- * Geographic location metadata for the phone number, lead, or lookup result.
9392
+ * Public Leadping API schema for phone number location data.
9349
9393
  */
9350
9394
  location?: PhoneNumberSearchResult_location | null;
9351
9395
  /**
@@ -9354,7 +9398,7 @@ export interface PhoneNumberSearchResult extends AdditionalDataHolder, Parsable
9354
9398
  number?: string | null;
9355
9399
  }
9356
9400
  /**
9357
- * Geographic location metadata for the phone number, lead, or lookup result.
9401
+ * Public Leadping API schema for phone number location data.
9358
9402
  */
9359
9403
  export interface PhoneNumberSearchResult_location extends Parsable, PhoneNumberLocation {
9360
9404
  }
@@ -9375,11 +9419,11 @@ export interface PhoneNumberStatusResponse extends AdditionalDataHolder, Parsabl
9375
9419
  */
9376
9420
  number?: string | null;
9377
9421
  /**
9378
- * Recent SMS opt-out metrics used to evaluate sender health and compliance risk.
9422
+ * Describes phone number opt-out metrics data returned by Leadping.
9379
9423
  */
9380
9424
  optOutMetrics?: PhoneNumberOptOutMetricsResponse | null;
9381
9425
  /**
9382
- * Current outbound SMS and voice capacity for this phone number.
9426
+ * Reports the sending capacity, current load, and availability of a phone number considered for outbound delivery.
9383
9427
  */
9384
9428
  outboundCapacity?: PhoneNumberStatusResponse_outboundCapacity | null;
9385
9429
  /**
@@ -9387,21 +9431,21 @@ export interface PhoneNumberStatusResponse extends AdditionalDataHolder, Parsabl
9387
9431
  */
9388
9432
  recentEvents?: PhoneNumberMessagingEventResponse[] | null;
9389
9433
  /**
9390
- * SMS warmup status for this phone number.
9434
+ * Describes SMS warmup status data returned by Leadping.
9391
9435
  */
9392
9436
  smsWarmup?: PhoneNumberStatusResponse_smsWarmup | null;
9393
9437
  /**
9394
- * Phone number traffic metrics for recent SMS and call activity.
9438
+ * Describes phone number traffic metrics data returned by Leadping.
9395
9439
  */
9396
9440
  trafficMetrics?: PhoneNumberTrafficMetricsResponse | null;
9397
9441
  }
9398
9442
  /**
9399
- * Current outbound SMS and voice capacity for this phone number.
9443
+ * Reports the sending capacity, current load, and availability of a phone number considered for outbound delivery.
9400
9444
  */
9401
9445
  export interface PhoneNumberStatusResponse_outboundCapacity extends OutboundPhoneNumberCapacity, Parsable {
9402
9446
  }
9403
9447
  /**
9404
- * SMS warmup status for this phone number.
9448
+ * Describes SMS warmup status data returned by Leadping.
9405
9449
  */
9406
9450
  export interface PhoneNumberStatusResponse_smsWarmup extends Parsable, SmsReadinessStatusResponse {
9407
9451
  }
@@ -9458,7 +9502,7 @@ export interface PhoneNumberTableRow extends AdditionalDataHolder, Parsable {
9458
9502
  */
9459
9503
  voiceReady?: boolean | null;
9460
9504
  /**
9461
- * Warmup state for this phone number.
9505
+ * Messaging and calling warmup for a Leadping phone number.
9462
9506
  */
9463
9507
  warmup?: PhoneNumberReadiness | null;
9464
9508
  }
@@ -11709,7 +11753,7 @@ export interface SmsEventTableRow extends AdditionalDataHolder, Parsable {
11709
11753
  */
11710
11754
  isAutomated?: boolean | null;
11711
11755
  /**
11712
- * Identifier and display name of the related lead.
11756
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
11713
11757
  */
11714
11758
  lead?: IdNamePair | null;
11715
11759
  /**
@@ -11807,7 +11851,7 @@ export interface SmsReadinessStatusResponse extends AdditionalDataHolder, Parsab
11807
11851
  */
11808
11852
  healthScore?: number | null;
11809
11853
  /**
11810
- * The current delivery-health assessment for this SMS warmup status.
11854
+ * Summarizes the severity of conditions affecting an organization's ability to send compliant SMS or MMS traffic.
11811
11855
  */
11812
11856
  healthStatus?: SmsReadinessHealthStatus | null;
11813
11857
  /**
@@ -11823,11 +11867,11 @@ export interface SmsReadinessStatusResponse extends AdditionalDataHolder, Parsab
11823
11867
  */
11824
11868
  progressPercent?: number | null;
11825
11869
  /**
11826
- * The current state for this SMS warmup status.
11870
+ * Describes whether an organization is configured and permitted to send SMS or MMS traffic through Leadping.
11827
11871
  */
11828
11872
  status?: SmsReadinessState | null;
11829
11873
  /**
11830
- * The current UI state for this SMS warmup status.
11874
+ * Describes SMS readiness UI state data used in Leadping API requests and responses.
11831
11875
  */
11832
11876
  uiState?: SmsReadinessUiState | null;
11833
11877
  /**
@@ -11844,7 +11888,7 @@ export interface SmsReadinessUiState extends AdditionalDataHolder, Parsable {
11844
11888
  */
11845
11889
  description?: string | null;
11846
11890
  /**
11847
- * The human-readable label shown for this SMS readiness UI state.
11891
+ * Describes whether an organization is configured and permitted to send SMS or MMS traffic through Leadping.
11848
11892
  */
11849
11893
  label?: SmsReadinessState | null;
11850
11894
  /**
@@ -12017,7 +12061,7 @@ export interface SourceCredentialIssueResponse extends AdditionalDataHolder, Par
12017
12061
  */
12018
12062
  secret?: string | null;
12019
12063
  /**
12020
- * Source metadata safe for later retrieval.
12064
+ * Describes lead source data returned by Leadping.
12021
12065
  */
12022
12066
  source?: SourceResponse | null;
12023
12067
  }
@@ -12038,7 +12082,7 @@ export interface SourceMetricsResponse extends AdditionalDataHolder, Parsable {
12038
12082
  */
12039
12083
  points?: AnalyticsTrendPointOfint[] | null;
12040
12084
  /**
12041
- * Range associated with this Leadping source metrics.
12085
+ * Defines the inclusive reporting window and comparison window used to calculate Leadping analytics.
12042
12086
  */
12043
12087
  range?: AnalyticsDateRange | null;
12044
12088
  /**
@@ -12116,7 +12160,7 @@ export interface SourceResponse extends AdditionalDataHolder, Parsable {
12116
12160
  */
12117
12161
  createdAt?: Date | null;
12118
12162
  /**
12119
- * User summary for the person who created this lead source response.
12163
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12120
12164
  */
12121
12165
  createdByUser?: SourceResponse_createdByUser | null;
12122
12166
  /**
@@ -12156,7 +12200,7 @@ export interface SourceResponse extends AdditionalDataHolder, Parsable {
12156
12200
  */
12157
12201
  modifiedAt?: Date | null;
12158
12202
  /**
12159
- * User summary for the person who last modified this lead source response.
12203
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12160
12204
  */
12161
12205
  modifiedByUser?: SourceResponse_modifiedByUser | null;
12162
12206
  /**
@@ -12164,7 +12208,7 @@ export interface SourceResponse extends AdditionalDataHolder, Parsable {
12164
12208
  */
12165
12209
  name?: string | null;
12166
12210
  /**
12167
- * Organization summary connected to this lead source response.
12211
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12168
12212
  */
12169
12213
  organization?: SourceResponse_organization | null;
12170
12214
  /**
@@ -12172,27 +12216,27 @@ export interface SourceResponse extends AdditionalDataHolder, Parsable {
12172
12216
  */
12173
12217
  requiresTrustedForm?: boolean | null;
12174
12218
  /**
12175
- * User summary connected to this lead source response.
12219
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12176
12220
  */
12177
12221
  user?: SourceResponse_user | null;
12178
12222
  }
12179
12223
  /**
12180
- * User summary for the person who created this lead source response.
12224
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12181
12225
  */
12182
12226
  export interface SourceResponse_createdByUser extends IdNamePair, Parsable {
12183
12227
  }
12184
12228
  /**
12185
- * User summary for the person who last modified this lead source response.
12229
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12186
12230
  */
12187
12231
  export interface SourceResponse_modifiedByUser extends IdNamePair, Parsable {
12188
12232
  }
12189
12233
  /**
12190
- * Organization summary connected to this lead source response.
12234
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12191
12235
  */
12192
12236
  export interface SourceResponse_organization extends IdNamePair, Parsable {
12193
12237
  }
12194
12238
  /**
12195
- * User summary connected to this lead source response.
12239
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12196
12240
  */
12197
12241
  export interface SourceResponse_user extends IdNamePair, Parsable {
12198
12242
  }
@@ -12237,7 +12281,7 @@ export interface SourceTableRow extends AdditionalDataHolder, Parsable {
12237
12281
  */
12238
12282
  createdAt?: Date | null;
12239
12283
  /**
12240
- * User summary for the person who created this lead source table row.
12284
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12241
12285
  */
12242
12286
  createdByUser?: SourceTableRow_createdByUser | null;
12243
12287
  /**
@@ -12273,7 +12317,7 @@ export interface SourceTableRow extends AdditionalDataHolder, Parsable {
12273
12317
  */
12274
12318
  modifiedAt?: Date | null;
12275
12319
  /**
12276
- * User summary for the person who last modified this lead source table row.
12320
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12277
12321
  */
12278
12322
  modifiedByUser?: SourceTableRow_modifiedByUser | null;
12279
12323
  /**
@@ -12281,7 +12325,7 @@ export interface SourceTableRow extends AdditionalDataHolder, Parsable {
12281
12325
  */
12282
12326
  name?: string | null;
12283
12327
  /**
12284
- * Organization summary connected to this lead source table row.
12328
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12285
12329
  */
12286
12330
  organization?: SourceTableRow_organization | null;
12287
12331
  /**
@@ -12293,27 +12337,27 @@ export interface SourceTableRow extends AdditionalDataHolder, Parsable {
12293
12337
  */
12294
12338
  requiresTrustedForm?: boolean | null;
12295
12339
  /**
12296
- * User summary connected to this lead source table row.
12340
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12297
12341
  */
12298
12342
  user?: SourceTableRow_user | null;
12299
12343
  }
12300
12344
  /**
12301
- * User summary for the person who created this lead source table row.
12345
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12302
12346
  */
12303
12347
  export interface SourceTableRow_createdByUser extends IdNamePair, Parsable {
12304
12348
  }
12305
12349
  /**
12306
- * User summary for the person who last modified this lead source table row.
12350
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12307
12351
  */
12308
12352
  export interface SourceTableRow_modifiedByUser extends IdNamePair, Parsable {
12309
12353
  }
12310
12354
  /**
12311
- * Organization summary connected to this lead source table row.
12355
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12312
12356
  */
12313
12357
  export interface SourceTableRow_organization extends IdNamePair, Parsable {
12314
12358
  }
12315
12359
  /**
12316
- * User 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.
12317
12361
  */
12318
12362
  export interface SourceTableRow_user extends IdNamePair, Parsable {
12319
12363
  }
@@ -12677,12 +12721,12 @@ export interface TagSummary extends AdditionalDataHolder, Parsable {
12677
12721
  */
12678
12722
  export interface TelephonyLoginRequest extends AdditionalDataHolder, Parsable {
12679
12723
  /**
12680
- * Identifier and display name of the related device.
12724
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12681
12725
  */
12682
12726
  device?: TelephonyLoginRequest_device | null;
12683
12727
  }
12684
12728
  /**
12685
- * Identifier and display name of the related device.
12729
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12686
12730
  */
12687
12731
  export interface TelephonyLoginRequest_device extends IdNamePair, Parsable {
12688
12732
  }
@@ -12712,11 +12756,11 @@ export interface TelephonyLoginResponse extends AdditionalDataHolder, Parsable {
12712
12756
  */
12713
12757
  export interface TenDlcApplicationDraft extends AdditionalDataHolder, Parsable {
12714
12758
  /**
12715
- * The current provider review status for the submitted brand.
12759
+ * Defines the provider lifecycle for an individual 10DLC brand or campaign.
12716
12760
  */
12717
12761
  brandStatus?: TenDlcRegistrationStatus | null;
12718
12762
  /**
12719
- * The current provider review status for the submitted campaign.
12763
+ * Defines the provider lifecycle for an individual 10DLC brand or campaign.
12720
12764
  */
12721
12765
  campaignStatus?: TenDlcRegistrationStatus | null;
12722
12766
  /**
@@ -12856,7 +12900,7 @@ export interface TransactionResponse extends AdditionalDataHolder, Parsable {
12856
12900
  */
12857
12901
  id?: string | null;
12858
12902
  /**
12859
- * Identifier and display name of the related lead.
12903
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12860
12904
  */
12861
12905
  lead?: TransactionResponse_lead | null;
12862
12906
  /**
@@ -12872,7 +12916,7 @@ export interface TransactionResponse extends AdditionalDataHolder, Parsable {
12872
12916
  */
12873
12917
  notes?: string | null;
12874
12918
  /**
12875
- * Identifier and display name of the related organization.
12919
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12876
12920
  */
12877
12921
  organization?: TransactionResponse_organization | null;
12878
12922
  /**
@@ -12884,23 +12928,23 @@ export interface TransactionResponse extends AdditionalDataHolder, Parsable {
12884
12928
  */
12885
12929
  platformFeeAmount?: number | null;
12886
12930
  /**
12887
- * Processing status for this wallet transaction.
12931
+ * Describes the processing and settlement lifecycle of a Leadping wallet or billing transaction.
12888
12932
  */
12889
12933
  transactionStatus?: TransactionStatus | null;
12890
12934
  /**
12891
- * Debit or credit classification for this wallet transaction.
12935
+ * Classifies a wallet transaction as a debit, credit, refund, adjustment, deposit, or other balance movement.
12892
12936
  */
12893
12937
  transactionType?: TransactionType | null;
12894
12938
  }
12895
12939
  export type TransactionResponse_billableUnit = (typeof TransactionResponse_billableUnitObject)[keyof typeof TransactionResponse_billableUnitObject];
12896
12940
  export type TransactionResponse_billingChannel = (typeof TransactionResponse_billingChannelObject)[keyof typeof TransactionResponse_billingChannelObject];
12897
12941
  /**
12898
- * Identifier and display name of the related lead.
12942
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12899
12943
  */
12900
12944
  export interface TransactionResponse_lead extends IdNamePair, Parsable {
12901
12945
  }
12902
12946
  /**
12903
- * Identifier and display name of the related organization.
12947
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12904
12948
  */
12905
12949
  export interface TransactionResponse_organization extends IdNamePair, Parsable {
12906
12950
  }
@@ -12938,7 +12982,7 @@ export interface TransactionTableRow extends AdditionalDataHolder, Parsable {
12938
12982
  */
12939
12983
  id?: string | null;
12940
12984
  /**
12941
- * Identifier and display name of the related lead.
12985
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12942
12986
  */
12943
12987
  lead?: TransactionTableRow_lead | null;
12944
12988
  /**
@@ -12946,7 +12990,7 @@ export interface TransactionTableRow extends AdditionalDataHolder, Parsable {
12946
12990
  */
12947
12991
  netAmount?: number | null;
12948
12992
  /**
12949
- * Identifier and display name of the related organization.
12993
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12950
12994
  */
12951
12995
  organization?: TransactionTableRow_organization | null;
12952
12996
  /**
@@ -12970,11 +13014,11 @@ export interface TransactionTableRow extends AdditionalDataHolder, Parsable {
12970
13014
  */
12971
13015
  sourceEventType?: string | null;
12972
13016
  /**
12973
- * Processing status for this wallet transaction.
13017
+ * Describes the processing and settlement lifecycle of a Leadping wallet or billing transaction.
12974
13018
  */
12975
13019
  transactionStatus?: TransactionStatus | null;
12976
13020
  /**
12977
- * Debit or credit classification for this wallet transaction.
13021
+ * Classifies a wallet transaction as a debit, credit, refund, adjustment, deposit, or other balance movement.
12978
13022
  */
12979
13023
  transactionType?: TransactionType | null;
12980
13024
  /**
@@ -12985,12 +13029,12 @@ export interface TransactionTableRow extends AdditionalDataHolder, Parsable {
12985
13029
  export type TransactionTableRow_billableUnit = (typeof TransactionTableRow_billableUnitObject)[keyof typeof TransactionTableRow_billableUnitObject];
12986
13030
  export type TransactionTableRow_billingChannel = (typeof TransactionTableRow_billingChannelObject)[keyof typeof TransactionTableRow_billingChannelObject];
12987
13031
  /**
12988
- * Identifier and display name of the related lead.
13032
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12989
13033
  */
12990
13034
  export interface TransactionTableRow_lead extends IdNamePair, Parsable {
12991
13035
  }
12992
13036
  /**
12993
- * Identifier and display name of the related organization.
13037
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
12994
13038
  */
12995
13039
  export interface TransactionTableRow_organization extends IdNamePair, Parsable {
12996
13040
  }
@@ -13051,11 +13095,11 @@ export interface UsageLedgerTableRow extends AdditionalDataHolder, Parsable {
13051
13095
  */
13052
13096
  billableSeconds?: number | null;
13053
13097
  /**
13054
- * Billable unit for this usage ledger.
13098
+ * Identifies the metered unit used to price Leadping usage, such as a message, call minute, lookup, or phone number.
13055
13099
  */
13056
13100
  billableUnit?: BillableUnit | null;
13057
13101
  /**
13058
- * Channel for this usage ledger.
13102
+ * Identifies the messaging, calling, phone-number, lookup, or platform channel that generated billable usage.
13059
13103
  */
13060
13104
  channel?: UsageChannel | null;
13061
13105
  /**
@@ -13083,11 +13127,11 @@ export interface UsageLedgerTableRow extends AdditionalDataHolder, Parsable {
13083
13127
  */
13084
13128
  isBillable?: boolean | null;
13085
13129
  /**
13086
- * Identifier and display name of the related lead.
13130
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
13087
13131
  */
13088
13132
  lead?: UsageLedgerTableRow_lead | null;
13089
13133
  /**
13090
- * Identifier and display name of the related organization.
13134
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
13091
13135
  */
13092
13136
  organization?: UsageLedgerTableRow_organization | null;
13093
13137
  /**
@@ -13107,7 +13151,7 @@ export interface UsageLedgerTableRow extends AdditionalDataHolder, Parsable {
13107
13151
  */
13108
13152
  smsSegments?: number | null;
13109
13153
  /**
13110
- * The current status for this usage ledger.
13154
+ * Describes whether a metered usage record is pending, rated, billed, reconciled, excluded, or failed.
13111
13155
  */
13112
13156
  status?: UsageStatus | null;
13113
13157
  /**
@@ -13115,22 +13159,22 @@ export interface UsageLedgerTableRow extends AdditionalDataHolder, Parsable {
13115
13159
  */
13116
13160
  unitPrice?: number | null;
13117
13161
  /**
13118
- * Identifier and display name of the related user.
13162
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
13119
13163
  */
13120
13164
  user?: UsageLedgerTableRow_user | null;
13121
13165
  }
13122
13166
  /**
13123
- * Identifier and display name of the related lead.
13167
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
13124
13168
  */
13125
13169
  export interface UsageLedgerTableRow_lead extends IdNamePair, Parsable {
13126
13170
  }
13127
13171
  /**
13128
- * Identifier and display name of the related organization.
13172
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
13129
13173
  */
13130
13174
  export interface UsageLedgerTableRow_organization extends IdNamePair, Parsable {
13131
13175
  }
13132
13176
  /**
13133
- * Identifier and display name of the related user.
13177
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
13134
13178
  */
13135
13179
  export interface UsageLedgerTableRow_user extends IdNamePair, Parsable {
13136
13180
  }
@@ -13140,11 +13184,11 @@ export type UsageStatus = (typeof UsageStatusObject)[keyof typeof UsageStatusObj
13140
13184
  */
13141
13185
  export interface UsageSummaryLine extends AdditionalDataHolder, Parsable {
13142
13186
  /**
13143
- * Billable unit for this usage summary line.
13187
+ * Identifies the metered unit used to price Leadping usage, such as a message, call minute, lookup, or phone number.
13144
13188
  */
13145
13189
  billableUnit?: BillableUnit | null;
13146
13190
  /**
13147
- * Channel for this usage summary line.
13191
+ * Identifies the messaging, calling, phone-number, lookup, or platform channel that generated billable usage.
13148
13192
  */
13149
13193
  channel?: UsageChannel | null;
13150
13194
  /**
@@ -13160,7 +13204,7 @@ export interface UsageSummaryLine extends AdditionalDataHolder, Parsable {
13160
13204
  */
13161
13205
  recordCount?: number | null;
13162
13206
  /**
13163
- * The current status for this usage summary line.
13207
+ * Describes whether a metered usage record is pending, rated, billed, reconciled, excluded, or failed.
13164
13208
  */
13165
13209
  status?: UsageStatus | null;
13166
13210
  }
@@ -13325,7 +13369,7 @@ export interface UserDataExportResponse extends AdditionalDataHolder, Parsable {
13325
13369
  */
13326
13370
  startedAt?: Date | null;
13327
13371
  /**
13328
- * Current status for this Leadping user data export.
13372
+ * Identifies the preparation, availability, failure, expiration, or deletion stage of a Leadping user-data export.
13329
13373
  */
13330
13374
  status?: UserDataExportStatuses | null;
13331
13375
  }
@@ -13420,7 +13464,7 @@ export interface UserNotificationPreferences extends AdditionalDataHolder, Parsa
13420
13464
  */
13421
13465
  smsConsentOptedIn?: boolean | null;
13422
13466
  /**
13423
- * The TrustedForm certificate captured for the user's most recent SMS opt-in.
13467
+ * Describes trusted form certificate data used in Leadping API requests and responses.
13424
13468
  */
13425
13469
  smsConsentTrustedFormCertificate?: UserNotificationPreferences_smsConsentTrustedFormCertificate | null;
13426
13470
  /**
@@ -13461,7 +13505,7 @@ export interface UserNotificationPreferences extends AdditionalDataHolder, Parsa
13461
13505
  usageLimitHitEnabled?: boolean | null;
13462
13506
  }
13463
13507
  /**
13464
- * The TrustedForm certificate captured for the user's most recent SMS opt-in.
13508
+ * Describes trusted form certificate data used in Leadping API requests and responses.
13465
13509
  */
13466
13510
  export interface UserNotificationPreferences_smsConsentTrustedFormCertificate extends Parsable, TrustedFormCertificate {
13467
13511
  }
@@ -13482,7 +13526,7 @@ export interface UserRequest extends AdditionalDataHolder, Parsable {
13482
13526
  */
13483
13527
  name?: string | null;
13484
13528
  /**
13485
- * Notification preferences configured for the user.
13529
+ * Describes user notification preferences data used in Leadping API requests and responses.
13486
13530
  */
13487
13531
  notificationPreferences?: UserRequest_notificationPreferences | null;
13488
13532
  /**
@@ -13495,7 +13539,7 @@ export interface UserRequest extends AdditionalDataHolder, Parsable {
13495
13539
  timeZoneId?: string | null;
13496
13540
  }
13497
13541
  /**
13498
- * Notification preferences configured for the user.
13542
+ * Describes user notification preferences data used in Leadping API requests and responses.
13499
13543
  */
13500
13544
  export interface UserRequest_notificationPreferences extends Parsable, UserNotificationPreferences {
13501
13545
  }
@@ -13508,11 +13552,11 @@ export interface UserResponse extends AdditionalDataHolder, Parsable {
13508
13552
  */
13509
13553
  billingPlan?: UserResponse_billingPlan | null;
13510
13554
  /**
13511
- * Customer-safe billing state for the user's currently selected organization.
13555
+ * Customer-safe billing state for a Leadping organization.
13512
13556
  */
13513
13557
  billingState?: UserResponse_billingState | null;
13514
13558
  /**
13515
- * Compliance for this user.
13559
+ * Describes user compliance data used in Leadping API requests and responses.
13516
13560
  */
13517
13561
  compliance?: UserResponse_compliance | null;
13518
13562
  /**
@@ -13520,7 +13564,7 @@ export interface UserResponse extends AdditionalDataHolder, Parsable {
13520
13564
  */
13521
13565
  createdAt?: Date | null;
13522
13566
  /**
13523
- * Current organization for this user.
13567
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
13524
13568
  */
13525
13569
  currentOrganization?: UserResponse_currentOrganization | null;
13526
13570
  /**
@@ -13560,7 +13604,7 @@ export interface UserResponse extends AdditionalDataHolder, Parsable {
13560
13604
  */
13561
13605
  name?: string | null;
13562
13606
  /**
13563
- * Notification preferences for this user.
13607
+ * Describes user notification preferences data used in Leadping API requests and responses.
13564
13608
  */
13565
13609
  notificationPreferences?: UserResponse_notificationPreferences | null;
13566
13610
  /**
@@ -13598,22 +13642,22 @@ export interface UserResponse extends AdditionalDataHolder, Parsable {
13598
13642
  }
13599
13643
  export type UserResponse_billingPlan = (typeof UserResponse_billingPlanObject)[keyof typeof UserResponse_billingPlanObject];
13600
13644
  /**
13601
- * Customer-safe billing state for the user's currently selected organization.
13645
+ * Customer-safe billing state for a Leadping organization.
13602
13646
  */
13603
13647
  export interface UserResponse_billingState extends OrganizationBillingState, Parsable {
13604
13648
  }
13605
13649
  /**
13606
- * Compliance for this user.
13650
+ * Describes user compliance data used in Leadping API requests and responses.
13607
13651
  */
13608
13652
  export interface UserResponse_compliance extends Parsable, UserCompliance {
13609
13653
  }
13610
13654
  /**
13611
- * Current organization for this user.
13655
+ * Provides a compact API reference to another resource using its stable identifier and human-readable display name.
13612
13656
  */
13613
13657
  export interface UserResponse_currentOrganization extends IdNamePair, Parsable {
13614
13658
  }
13615
13659
  /**
13616
- * Notification preferences for this user.
13660
+ * Describes user notification preferences data used in Leadping API requests and responses.
13617
13661
  */
13618
13662
  export interface UserResponse_notificationPreferences extends Parsable, UserNotificationPreferences {
13619
13663
  }