@leadping/sdk 1.0.31 → 1.0.33

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.
Files changed (95) hide show
  1. package/dist/analytics/my/index.d.ts +9 -0
  2. package/dist/analytics/my/index.d.ts.map +1 -1
  3. package/dist/analytics/my/index.js.map +1 -1
  4. package/dist/automations/index.d.ts +2 -2
  5. package/dist/automations/item/index.d.ts +2 -2
  6. package/dist/automations/preview/index.d.ts +2 -2
  7. package/dist/contact/index.d.ts +2 -2
  8. package/dist/conversations/my/index.d.ts +3 -0
  9. package/dist/conversations/my/index.d.ts.map +1 -1
  10. package/dist/conversations/my/index.js.map +1 -1
  11. package/dist/events/all/my/index.d.ts +9 -0
  12. package/dist/events/all/my/index.d.ts.map +1 -1
  13. package/dist/events/all/my/index.js.map +1 -1
  14. package/dist/events/conversations/item/notes/index.d.ts +2 -2
  15. package/dist/events/organizations/item/index.d.ts +6 -0
  16. package/dist/events/organizations/item/index.d.ts.map +1 -1
  17. package/dist/events/organizations/item/index.js.map +1 -1
  18. package/dist/feedback/index.d.ts +2 -2
  19. package/dist/leadStatusChanges/all/my/index.d.ts +2 -2
  20. package/dist/leadStatuses/index.d.ts +1 -1
  21. package/dist/leads/all/my/index.d.ts +12 -0
  22. package/dist/leads/all/my/index.d.ts.map +1 -1
  23. package/dist/leads/all/my/index.js.map +1 -1
  24. package/dist/leads/index.d.ts +2 -2
  25. package/dist/leads/intake/index.d.ts +2 -2
  26. package/dist/leads/item/archive/index.d.ts +3 -3
  27. package/dist/leads/item/index.d.ts +2 -2
  28. package/dist/leads/item/tags/index.d.ts +5 -5
  29. package/dist/models/index.d.ts +538 -358
  30. package/dist/models/index.d.ts.map +1 -1
  31. package/dist/models/index.js +156 -2
  32. package/dist/models/index.js.map +1 -1
  33. package/dist/notifications/index.d.ts +5 -0
  34. package/dist/notifications/index.d.ts.map +1 -1
  35. package/dist/notifications/index.js +5 -0
  36. package/dist/notifications/index.js.map +1 -1
  37. package/dist/notifications/push/index.d.ts +20 -0
  38. package/dist/notifications/push/index.d.ts.map +1 -0
  39. package/dist/notifications/push/index.js +20 -0
  40. package/dist/notifications/push/index.js.map +1 -0
  41. package/dist/notifications/push/installations/current/index.d.ts +32 -0
  42. package/dist/notifications/push/installations/current/index.d.ts.map +1 -0
  43. package/dist/notifications/push/installations/current/index.js +30 -0
  44. package/dist/notifications/push/installations/current/index.js.map +1 -0
  45. package/dist/notifications/push/installations/index.d.ts +27 -0
  46. package/dist/notifications/push/installations/index.d.ts.map +1 -0
  47. package/dist/notifications/push/installations/index.js +26 -0
  48. package/dist/notifications/push/installations/index.js.map +1 -0
  49. package/dist/notifications/push/installations/item/index.d.ts +28 -0
  50. package/dist/notifications/push/installations/item/index.d.ts.map +1 -0
  51. package/dist/notifications/push/installations/item/index.js +26 -0
  52. package/dist/notifications/push/installations/item/index.js.map +1 -0
  53. package/dist/organizations/invitations/accept/index.d.ts +2 -2
  54. package/dist/organizations/me/index.d.ts +4 -4
  55. package/dist/organizations/me/invitations/index.d.ts +2 -2
  56. package/dist/organizations/me/members/index.d.ts +2 -2
  57. package/dist/organizations/me/members/item/index.d.ts +2 -2
  58. package/dist/organizations/me/switchEscaped/index.d.ts +2 -2
  59. package/dist/paymentMethods/invoices/index.d.ts +1 -1
  60. package/dist/paymentMethods/invoices/item/pdfAccess/index.d.ts +3 -0
  61. package/dist/paymentMethods/invoices/item/pdfAccess/index.d.ts.map +1 -1
  62. package/dist/paymentMethods/invoices/item/pdfAccess/index.js.map +1 -1
  63. package/dist/phoneCall/initiate/index.d.ts +2 -2
  64. package/dist/phoneNumbers/index.d.ts +2 -2
  65. package/dist/phoneNumbers/isAvailableForPurchase/index.d.ts +2 -2
  66. package/dist/phoneNumbers/item/index.d.ts +2 -2
  67. package/dist/phoneNumbers/outgoing/conversation/item/index.d.ts +2 -2
  68. package/dist/phoneNumbers/outgoing/conversation/item/override/index.d.ts +2 -2
  69. package/dist/phoneNumbers/outgoing/manualOverride/index.d.ts +2 -2
  70. package/dist/phoneNumbers/outgoing/newEscaped/index.d.ts +2 -2
  71. package/dist/phoneNumbers/search/index.d.ts +2 -2
  72. package/dist/reports/exports/index.d.ts +1 -1
  73. package/dist/reports/exports/item/download/index.d.ts +3 -0
  74. package/dist/reports/exports/item/download/index.d.ts.map +1 -1
  75. package/dist/reports/exports/item/download/index.js.map +1 -1
  76. package/dist/sms/media/index.d.ts +2 -2
  77. package/dist/sms/send/index.d.ts +2 -2
  78. package/dist/sources/index.d.ts +2 -2
  79. package/dist/sources/item/index.d.ts +2 -2
  80. package/dist/suppressions/all/my/index.d.ts +2 -2
  81. package/dist/suppressions/check/index.d.ts +2 -2
  82. package/dist/suppressions/index.d.ts +3 -3
  83. package/dist/suppressions/item/index.d.ts +2 -2
  84. package/dist/suppressions/release/index.d.ts +2 -2
  85. package/dist/tags/index.d.ts +6 -3
  86. package/dist/tags/index.d.ts.map +1 -1
  87. package/dist/tags/index.js.map +1 -1
  88. package/dist/tags/item/index.d.ts +2 -2
  89. package/dist/transactions/all/my/index.d.ts +6 -0
  90. package/dist/transactions/all/my/index.d.ts.map +1 -1
  91. package/dist/transactions/all/my/index.js.map +1 -1
  92. package/dist/users/changeBillingPlan/index.d.ts +2 -2
  93. package/dist/users/compliance/index.d.ts +2 -2
  94. package/dist/users/me/index.d.ts +2 -2
  95. package/package.json +1 -1
@@ -1,6 +1,6 @@
1
1
  import { type AdditionalDataHolder, type ApiError, type DateOnly, type Parsable, type ParseNode, type SerializationWriter, type UntypedNode } from '@microsoft/kiota-abstractions';
2
2
  /**
3
- * Request payload for accept organization invitation.
3
+ * Defines the input used for accept organization invitation.
4
4
  */
5
5
  export interface AcceptOrganizationInvitationRequest extends AdditionalDataHolder, Parsable {
6
6
  /**
@@ -8,11 +8,11 @@ export interface AcceptOrganizationInvitationRequest extends AdditionalDataHolde
8
8
  */
9
9
  email?: string | null;
10
10
  /**
11
- * The first name value for this organization invitation.
11
+ * First name for this organization invitation.
12
12
  */
13
13
  firstName?: string | null;
14
14
  /**
15
- * The date and time for the last name value on this organization invitation.
15
+ * UTC timestamp for last name on this organization invitation.
16
16
  */
17
17
  lastName?: string | null;
18
18
  /**
@@ -21,7 +21,7 @@ export interface AcceptOrganizationInvitationRequest extends AdditionalDataHolde
21
21
  token?: string | null;
22
22
  }
23
23
  /**
24
- * API DTO containing activation domain option data used by Leadping API contracts.
24
+ * Describes activation domain option data used in Leadping API requests and responses.
25
25
  */
26
26
  export interface ActivationDomainOption extends AdditionalDataHolder, Parsable {
27
27
  /**
@@ -33,11 +33,11 @@ export interface ActivationDomainOption extends AdditionalDataHolder, Parsable {
33
33
  */
34
34
  domainName?: string | null;
35
35
  /**
36
- * The estimated annual cost value for this activation domain option.
36
+ * Estimated annual cost for this activation domain option.
37
37
  */
38
38
  estimatedAnnualCost?: number | null;
39
39
  /**
40
- * The industry relevance value for this activation domain option.
40
+ * Industry relevance for this activation domain option.
41
41
  */
42
42
  industryRelevance?: string | null;
43
43
  /**
@@ -45,11 +45,11 @@ export interface ActivationDomainOption extends AdditionalDataHolder, Parsable {
45
45
  */
46
46
  recommended?: boolean | null;
47
47
  /**
48
- * The trust concerns value for this activation domain option.
48
+ * Trust concerns for this activation domain option.
49
49
  */
50
50
  trustConcerns?: string | null;
51
51
  /**
52
- * The why it fits value for this activation domain option.
52
+ * Why it fits for this activation domain option.
53
53
  */
54
54
  whyItFits?: string | null;
55
55
  }
@@ -59,19 +59,19 @@ export type ActivationPaymentStatus = (typeof ActivationPaymentStatusObject)[key
59
59
  export type ActivationSubscriptionStatus = (typeof ActivationSubscriptionStatusObject)[keyof typeof ActivationSubscriptionStatusObject];
60
60
  export type ActivationTelephonyStatus = (typeof ActivationTelephonyStatusObject)[keyof typeof ActivationTelephonyStatusObject];
61
61
  /**
62
- * API DTO containing activation timeline event data used by Leadping API contracts.
62
+ * Describes activation timeline event data used in Leadping API requests and responses.
63
63
  */
64
64
  export interface ActivationTimelineEvent extends AdditionalDataHolder, Parsable {
65
65
  /**
66
- * The ID and name for this actor.
66
+ * Identifier and display name of the related actor.
67
67
  */
68
68
  actor?: ActivationTimelineEvent_actor | null;
69
69
  /**
70
- * The date and time for the created at value on this activation timeline event.
70
+ * UTC timestamp for created at on this activation timeline event.
71
71
  */
72
72
  createdAt?: Date | null;
73
73
  /**
74
- * The details value for this activation timeline event.
74
+ * Details for this activation timeline event.
75
75
  */
76
76
  details?: string | null;
77
77
  /**
@@ -79,7 +79,7 @@ export interface ActivationTimelineEvent extends AdditionalDataHolder, Parsable
79
79
  */
80
80
  failureReason?: string | null;
81
81
  /**
82
- * The unique ID for this activation timeline event.
82
+ * Unique Leadping identifier for this activation timeline event.
83
83
  */
84
84
  id?: string | null;
85
85
  /**
@@ -87,7 +87,7 @@ export interface ActivationTimelineEvent extends AdditionalDataHolder, Parsable
87
87
  */
88
88
  status?: string | null;
89
89
  /**
90
- * The title value for this activation timeline event.
90
+ * Title for this activation timeline event.
91
91
  */
92
92
  title?: string | null;
93
93
  /**
@@ -96,7 +96,7 @@ export interface ActivationTimelineEvent extends AdditionalDataHolder, Parsable
96
96
  type?: string | null;
97
97
  }
98
98
  /**
99
- * The ID and name for this actor.
99
+ * Identifier and display name of the related actor.
100
100
  */
101
101
  export interface ActivationTimelineEvent_actor extends IdNamePair, Parsable {
102
102
  }
@@ -374,7 +374,7 @@ export interface AutomationPreviewConditionResult extends AdditionalDataHolder,
374
374
  summary?: string | null;
375
375
  }
376
376
  /**
377
- * Request schema for the Leadping API automation preview request, including the fields clients can send.
377
+ * Defines the fields clients can send when working with automation preview.
378
378
  */
379
379
  export interface AutomationPreviewRequest extends AdditionalDataHolder, Parsable {
380
380
  /**
@@ -387,7 +387,7 @@ export interface AutomationPreviewRequest extends AdditionalDataHolder, Parsable
387
387
  triggerType?: string | null;
388
388
  }
389
389
  /**
390
- * Response schema for the Leadping API automation preview response returned to authenticated clients.
390
+ * Describes automation preview data returned by Leadping.
391
391
  */
392
392
  export interface AutomationPreviewResponse extends AdditionalDataHolder, Parsable {
393
393
  /**
@@ -421,7 +421,7 @@ export interface AutomationPreviewResponse extends AdditionalDataHolder, Parsabl
421
421
  export interface AutomationPreviewResponse_samplePayload extends AdditionalDataHolder, Parsable {
422
422
  }
423
423
  /**
424
- * Request schema for the Leadping API automation configuration request, including the fields clients can send.
424
+ * Defines the fields clients can send when working with automation configuration.
425
425
  */
426
426
  export interface AutomationRequest extends AdditionalDataHolder, Parsable {
427
427
  /**
@@ -531,7 +531,7 @@ export interface AutomationRequestSnapshot extends AdditionalDataHolder, Parsabl
531
531
  visibility?: string | null;
532
532
  }
533
533
  /**
534
- * Response schema for the Leadping API automation configuration response returned to authenticated clients.
534
+ * Describes automation configuration data returned by Leadping.
535
535
  */
536
536
  export interface AutomationResponse extends AdditionalDataHolder, Parsable {
537
537
  /**
@@ -695,7 +695,7 @@ export interface AutomationRunRecord extends AdditionalDataHolder, Parsable {
695
695
  triggerType?: string | null;
696
696
  }
697
697
  /**
698
- * List item schema for Leadping API automation table row results shown in searchable tables.
698
+ * Summarizes automation data in paginated and searchable results.
699
699
  */
700
700
  export interface AutomationTableRow extends AdditionalDataHolder, Parsable {
701
701
  /**
@@ -963,7 +963,7 @@ export interface AutomationWorkflowRunResponse extends AdditionalDataHolder, Par
963
963
  */
964
964
  actions?: AutomationWorkflowActionResponse[] | null;
965
965
  /**
966
- * The ID and name for this automation.
966
+ * Identifier and display name of the related automation.
967
967
  */
968
968
  automation?: AutomationWorkflowRunResponse_automation | null;
969
969
  /**
@@ -975,7 +975,7 @@ export interface AutomationWorkflowRunResponse extends AdditionalDataHolder, Par
975
975
  */
976
976
  completedAt?: Date | null;
977
977
  /**
978
- * The ID and name for this currentStep.
978
+ * Identifier and display name of the workflow step currently awaiting or performing work.
979
979
  */
980
980
  currentStep?: AutomationWorkflowRunResponse_currentStep | null;
981
981
  /**
@@ -999,7 +999,7 @@ export interface AutomationWorkflowRunResponse extends AdditionalDataHolder, Par
999
999
  */
1000
1000
  lastActionSummary?: string | null;
1001
1001
  /**
1002
- * Reason or diagnostic code that explains the current outcome for this Leadping automation workflow run.
1002
+ * Machine-readable code for the most recent workflow execution error.
1003
1003
  */
1004
1004
  lastErrorCode?: string | null;
1005
1005
  /**
@@ -1035,7 +1035,7 @@ export interface AutomationWorkflowRunResponse extends AdditionalDataHolder, Par
1035
1035
  */
1036
1036
  retryCount?: number | null;
1037
1037
  /**
1038
- * Reason or diagnostic code that explains the current outcome for this Leadping automation workflow run.
1038
+ * Machine-readable code explaining why the workflow run or action was skipped.
1039
1039
  */
1040
1040
  skipReasonCode?: string | null;
1041
1041
  /**
@@ -1068,12 +1068,12 @@ export interface AutomationWorkflowRunResponse extends AdditionalDataHolder, Par
1068
1068
  updatedAt?: Date | null;
1069
1069
  }
1070
1070
  /**
1071
- * The ID and name for this automation.
1071
+ * Identifier and display name of the related automation.
1072
1072
  */
1073
1073
  export interface AutomationWorkflowRunResponse_automation extends IdNamePair, Parsable {
1074
1074
  }
1075
1075
  /**
1076
- * The ID and name for this currentStep.
1076
+ * Identifier and display name of the workflow step currently awaiting or performing work.
1077
1077
  */
1078
1078
  export interface AutomationWorkflowRunResponse_currentStep extends IdNamePair, Parsable {
1079
1079
  }
@@ -1093,7 +1093,7 @@ export interface AutomationWorkflowStatusResponse extends AdditionalDataHolder,
1093
1093
  export type BillableUnit = (typeof BillableUnitObject)[keyof typeof BillableUnitObject];
1094
1094
  export type BillingPlan = (typeof BillingPlanObject)[keyof typeof BillingPlanObject];
1095
1095
  /**
1096
- * List item schema for Leadping API call event table row results shown in searchable tables.
1096
+ * Summarizes call event data in paginated and searchable results.
1097
1097
  */
1098
1098
  export interface CallEventTableRow extends AdditionalDataHolder, Parsable {
1099
1099
  /**
@@ -1195,11 +1195,11 @@ export interface CallEventTableRow extends AdditionalDataHolder, Parsable {
1195
1195
  }
1196
1196
  export type CallEventTableRow_status = (typeof CallEventTableRow_statusObject)[keyof typeof CallEventTableRow_statusObject];
1197
1197
  /**
1198
- * Request payload for change billing plan.
1198
+ * Defines the input used for change billing plan.
1199
1199
  */
1200
1200
  export interface ChangeBillingPlanRequest extends AdditionalDataHolder, Parsable {
1201
1201
  /**
1202
- * The billing plan value for this billing plan.
1202
+ * Billing plan for this billing plan.
1203
1203
  */
1204
1204
  billingPlan?: BillingPlan | null;
1205
1205
  /**
@@ -1208,25 +1208,25 @@ export interface ChangeBillingPlanRequest extends AdditionalDataHolder, Parsable
1208
1208
  userId?: string | null;
1209
1209
  }
1210
1210
  /**
1211
- * Request payload for compliance update.
1211
+ * Defines the input used for compliance update.
1212
1212
  */
1213
1213
  export interface ComplianceUpdateRequest extends AdditionalDataHolder, Parsable {
1214
1214
  /**
1215
- * The compliance value for this compliance update.
1215
+ * Compliance for this compliance update.
1216
1216
  */
1217
1217
  compliance?: ComplianceUpdateRequest_compliance | null;
1218
1218
  /**
1219
- * The source value for this compliance update.
1219
+ * Source for this compliance update.
1220
1220
  */
1221
1221
  source?: string | null;
1222
1222
  }
1223
1223
  /**
1224
- * The compliance value for this compliance update.
1224
+ * Compliance for this compliance update.
1225
1225
  */
1226
1226
  export interface ComplianceUpdateRequest_compliance extends Parsable, UserCompliance {
1227
1227
  }
1228
1228
  /**
1229
- * Request schema for the Leadping API contact form request, including the fields clients can send.
1229
+ * Defines the fields clients can send when working with contact form.
1230
1230
  */
1231
1231
  export interface ContactRequest extends AdditionalDataHolder, Parsable {
1232
1232
  /**
@@ -1247,7 +1247,7 @@ export interface ContactRequest extends AdditionalDataHolder, Parsable {
1247
1247
  token?: string | null;
1248
1248
  }
1249
1249
  /**
1250
- * Response schema for the Leadping API contact form response returned to authenticated clients.
1250
+ * Describes contact form data returned by Leadping.
1251
1251
  */
1252
1252
  export interface ContactResponse extends AdditionalDataHolder, Parsable {
1253
1253
  /**
@@ -1256,7 +1256,7 @@ export interface ContactResponse extends AdditionalDataHolder, Parsable {
1256
1256
  message?: string | null;
1257
1257
  }
1258
1258
  /**
1259
- * Response schema for the Leadping API conversation response returned to authenticated clients.
1259
+ * Describes conversation data returned by Leadping.
1260
1260
  */
1261
1261
  export interface ConversationResponse extends AdditionalDataHolder, Parsable {
1262
1262
  /**
@@ -1975,11 +1975,11 @@ export declare function createMessageMediaAttachmentFromDiscriminatorValue(parse
1975
1975
  */
1976
1976
  export declare function createMobileDevicePreferencesFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
1977
1977
  /**
1978
- * Request payload for create note.
1978
+ * Defines the input used for create note.
1979
1979
  */
1980
1980
  export interface CreateNoteRequest extends AdditionalDataHolder, Parsable {
1981
1981
  /**
1982
- * The text value for this note.
1982
+ * Plain-text note content to add to the conversation timeline.
1983
1983
  */
1984
1984
  text?: string | null;
1985
1985
  }
@@ -2313,6 +2313,12 @@ export declare function createPhoneCallResponseFromDiscriminatorValue(parseNode:
2313
2313
  * @returns {Phone}
2314
2314
  */
2315
2315
  export declare function createPhoneFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
2316
+ /**
2317
+ * Creates a new instance of the appropriate class based on discriminator value
2318
+ * @param parseNode The parse node to use to read the discriminator value and create the object
2319
+ * @returns {PhoneIdentityLookupAction}
2320
+ */
2321
+ export declare function createPhoneIdentityLookupActionFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
2316
2322
  /**
2317
2323
  * Creates a new instance of the appropriate class based on discriminator value
2318
2324
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -2547,6 +2553,18 @@ export declare function createPhoneNumberTrafficTrendPointFromDiscriminatorValue
2547
2553
  * @returns {ProblemDetails}
2548
2554
  */
2549
2555
  export declare function createProblemDetailsFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
2556
+ /**
2557
+ * Creates a new instance of the appropriate class based on discriminator value
2558
+ * @param parseNode The parse node to use to read the discriminator value and create the object
2559
+ * @returns {PushInstallationRequest_metadata}
2560
+ */
2561
+ export declare function createPushInstallationRequest_metadataFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
2562
+ /**
2563
+ * Creates a new instance of the appropriate class based on discriminator value
2564
+ * @param parseNode The parse node to use to read the discriminator value and create the object
2565
+ * @returns {PushInstallationRequest}
2566
+ */
2567
+ export declare function createPushInstallationRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
2550
2568
  /**
2551
2569
  * Creates a new instance of the appropriate class based on discriminator value
2552
2570
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -4306,6 +4324,12 @@ export declare function deserializeIntoPhone(phone?: Partial<Phone> | undefined)
4306
4324
  * @returns {Record<string, (node: ParseNode) => void>}
4307
4325
  */
4308
4326
  export declare function deserializeIntoPhoneCallResponse(phoneCallResponse?: Partial<PhoneCallResponse> | undefined): Record<string, (node: ParseNode) => void>;
4327
+ /**
4328
+ * The deserialization information for the current model
4329
+ * @param PhoneIdentityLookupAction The instance to deserialize into.
4330
+ * @returns {Record<string, (node: ParseNode) => void>}
4331
+ */
4332
+ export declare function deserializeIntoPhoneIdentityLookupAction(phoneIdentityLookupAction?: Partial<PhoneIdentityLookupAction> | undefined): Record<string, (node: ParseNode) => void>;
4309
4333
  /**
4310
4334
  * The deserialization information for the current model
4311
4335
  * @param PhoneIdentityResponse The instance to deserialize into.
@@ -4540,6 +4564,18 @@ export declare function deserializeIntoPhoneNumberTrafficTrendPoint(phoneNumberT
4540
4564
  * @returns {Record<string, (node: ParseNode) => void>}
4541
4565
  */
4542
4566
  export declare function deserializeIntoProblemDetails(problemDetails?: Partial<ProblemDetails> | undefined): Record<string, (node: ParseNode) => void>;
4567
+ /**
4568
+ * The deserialization information for the current model
4569
+ * @param PushInstallationRequest The instance to deserialize into.
4570
+ * @returns {Record<string, (node: ParseNode) => void>}
4571
+ */
4572
+ export declare function deserializeIntoPushInstallationRequest(pushInstallationRequest?: Partial<PushInstallationRequest> | undefined): Record<string, (node: ParseNode) => void>;
4573
+ /**
4574
+ * The deserialization information for the current model
4575
+ * @param PushInstallationRequest_metadata The instance to deserialize into.
4576
+ * @returns {Record<string, (node: ParseNode) => void>}
4577
+ */
4578
+ export declare function deserializeIntoPushInstallationRequest_metadata(pushInstallationRequest_metadata?: Partial<PushInstallationRequest_metadata> | undefined): Record<string, (node: ParseNode) => void>;
4543
4579
  /**
4544
4580
  * The deserialization information for the current model
4545
4581
  * @param RangeFilter The instance to deserialize into.
@@ -4931,7 +4967,7 @@ export declare function deserializeIntoUserResponse_notificationPreferences(user
4931
4967
  */
4932
4968
  export declare function deserializeIntoWalletResponse(walletResponse?: Partial<WalletResponse> | undefined): Record<string, (node: ParseNode) => void>;
4933
4969
  /**
4934
- * Response schema for the Leadping API eligible outgoing phone number returned to authenticated clients.
4970
+ * Describes a Leadping phone number that is eligible to send an outbound message or place a call.
4935
4971
  */
4936
4972
  export interface EligibleOutgoingNumberResponse extends AdditionalDataHolder, Parsable {
4937
4973
  /**
@@ -4993,7 +5029,7 @@ export interface EligibleOutgoingNumberResponse extends AdditionalDataHolder, Pa
4993
5029
  }
4994
5030
  export type EligibleOutgoingNumberResponse_healthStatus = (typeof EligibleOutgoingNumberResponse_healthStatusObject)[keyof typeof EligibleOutgoingNumberResponse_healthStatusObject];
4995
5031
  /**
4996
- * Response schema for the Leadping API event detail response returned to authenticated clients.
5032
+ * Describes event detail data returned by Leadping.
4997
5033
  */
4998
5034
  export interface EventDetailResponse extends AdditionalDataHolder, Parsable {
4999
5035
  /**
@@ -5129,7 +5165,7 @@ export type EventDetailResponse_timelineType = (typeof EventDetailResponse_timel
5129
5165
  export interface EventDetailResponse_user extends IdNamePair, Parsable {
5130
5166
  }
5131
5167
  /**
5132
- * List item schema for Leadping API event timeline table row results shown in searchable tables.
5168
+ * Summarizes event timeline data in paginated and searchable results.
5133
5169
  */
5134
5170
  export interface EventTableRow extends AdditionalDataHolder, Parsable {
5135
5171
  /**
@@ -5339,7 +5375,7 @@ export interface ExactMatchFilter extends AdditionalDataHolder, Parsable {
5339
5375
  value?: UntypedNode | null;
5340
5376
  }
5341
5377
  /**
5342
- * Request schema for the Leadping API feedback creation request, including the fields clients can send.
5378
+ * Defines the fields clients can send when working with feedback creation.
5343
5379
  */
5344
5380
  export interface FeedbackCreateRequest extends AdditionalDataHolder, Parsable {
5345
5381
  /**
@@ -5369,7 +5405,7 @@ export interface FeedbackCreateRequest extends AdditionalDataHolder, Parsable {
5369
5405
  }
5370
5406
  export type FeedbackCreateRequest_type = (typeof FeedbackCreateRequest_typeObject)[keyof typeof FeedbackCreateRequest_typeObject];
5371
5407
  /**
5372
- * Response schema for the Leadping API feedback item response returned to authenticated clients.
5408
+ * Describes feedback item data returned by Leadping.
5373
5409
  */
5374
5410
  export interface FeedbackResponse extends AdditionalDataHolder, Parsable {
5375
5411
  /**
@@ -5450,7 +5486,7 @@ export interface IdNameValue extends AdditionalDataHolder, Parsable {
5450
5486
  value?: string | null;
5451
5487
  }
5452
5488
  /**
5453
- * Request schema for the Leadping API phone call initiation request, including the fields clients can send.
5489
+ * Defines the fields clients can send when working with phone call initiation.
5454
5490
  */
5455
5491
  export interface InitiateCallRequest extends AdditionalDataHolder, Parsable {
5456
5492
  /**
@@ -5496,7 +5532,7 @@ export interface InvoicePdfAccessResponse extends AdditionalDataHolder, Parsable
5496
5532
  url?: string | null;
5497
5533
  }
5498
5534
  /**
5499
- * Request schema for the Leadping API lead archive request, including the fields clients can send.
5535
+ * Defines the fields clients can send when working with lead archive.
5500
5536
  */
5501
5537
  export interface LeadArchiveRequest extends AdditionalDataHolder, Parsable {
5502
5538
  /**
@@ -5513,7 +5549,7 @@ export interface LeadArchiveRequest extends AdditionalDataHolder, Parsable {
5513
5549
  */
5514
5550
  export interface LeadContact extends AdditionalDataHolder, Parsable {
5515
5551
  /**
5516
- * Optional profile image URL for the contact. Clients fall back to Gravatarand then initials when this value is not supplied.
5552
+ * Optional profile image URL for the contact. Clients fall back to Gravatar and then initials when this value is not supplied.
5517
5553
  */
5518
5554
  avatarUrl?: string | null;
5519
5555
  /**
@@ -5561,7 +5597,7 @@ export interface LeadContact_phone extends Parsable, Phone {
5561
5597
  export interface LeadContact_streetAddress extends Parsable, StreetAddress {
5562
5598
  }
5563
5599
  /**
5564
- * Request schema for the Leadping API lead intake request, including the fields clients can send.
5600
+ * Defines the fields clients can send when working with lead intake.
5565
5601
  */
5566
5602
  export interface LeadIntakeRequest extends AdditionalDataHolder, Parsable {
5567
5603
  /**
@@ -5913,7 +5949,7 @@ export type LeadProfile_employmentType = (typeof LeadProfile_employmentTypeObjec
5913
5949
  export type LeadProfile_gender = (typeof LeadProfile_genderObject)[keyof typeof LeadProfile_genderObject];
5914
5950
  export type LeadProfile_maritalStatus = (typeof LeadProfile_maritalStatusObject)[keyof typeof LeadProfile_maritalStatusObject];
5915
5951
  /**
5916
- * Request schema for the Leadping API lead request, including the fields clients can send.
5952
+ * Defines the fields clients can send when working with lead.
5917
5953
  */
5918
5954
  export interface LeadRequest extends AdditionalDataHolder, Parsable {
5919
5955
  /**
@@ -5946,7 +5982,7 @@ export interface LeadRequest extends AdditionalDataHolder, Parsable {
5946
5982
  tagNames?: string[] | null;
5947
5983
  }
5948
5984
  /**
5949
- * Response schema for the Leadping API lead response returned to authenticated clients.
5985
+ * Describes lead data returned by Leadping.
5950
5986
  */
5951
5987
  export interface LeadResponse extends AdditionalDataHolder, Parsable {
5952
5988
  /**
@@ -6022,19 +6058,19 @@ export interface LeadResponse_phoneIdentity extends Parsable, PhoneIdentityRespo
6022
6058
  }
6023
6059
  export type LeadStatusCategory = (typeof LeadStatusCategoryObject)[keyof typeof LeadStatusCategoryObject];
6024
6060
  /**
6025
- * API response containing lead status change export data returned to callers.
6061
+ * Describes lead status change export data returned by Leadping.
6026
6062
  */
6027
6063
  export interface LeadStatusChangeExportResponse extends AdditionalDataHolder, Parsable {
6028
6064
  /**
6029
- * The content type classification for this lead status change export.
6065
+ * MIME content type of the exported document.
6030
6066
  */
6031
6067
  contentType?: string | null;
6032
6068
  /**
6033
- * The csv value for this lead status change export.
6069
+ * Complete comma-separated values content encoded as text.
6034
6070
  */
6035
6071
  csv?: string | null;
6036
6072
  /**
6037
- * The file name value for this lead status change export.
6073
+ * Suggested file name for the exported CSV document.
6038
6074
  */
6039
6075
  fileName?: string | null;
6040
6076
  /**
@@ -6043,15 +6079,15 @@ export interface LeadStatusChangeExportResponse extends AdditionalDataHolder, Pa
6043
6079
  rows?: LeadStatusChangeExportRow[] | null;
6044
6080
  }
6045
6081
  /**
6046
- * API response containing lead status change export row data returned to callers.
6082
+ * Describes lead status change export row data returned by Leadping.
6047
6083
  */
6048
6084
  export interface LeadStatusChangeExportRow extends AdditionalDataHolder, Parsable {
6049
6085
  /**
6050
- * The date and time for the appointment end at value on this lead status change export row.
6086
+ * UTC timestamp for appointment end at on this lead status change export row.
6051
6087
  */
6052
6088
  appointmentEndAt?: Date | null;
6053
6089
  /**
6054
- * The date and time for the appointment start at value on this lead status change export row.
6090
+ * UTC timestamp for appointment start at on this lead status change export row.
6055
6091
  */
6056
6092
  appointmentStartAt?: Date | null;
6057
6093
  /**
@@ -6059,7 +6095,7 @@ export interface LeadStatusChangeExportRow extends AdditionalDataHolder, Parsabl
6059
6095
  */
6060
6096
  assignedToUserId?: string | null;
6061
6097
  /**
6062
- * The date and time for the callback at value on this lead status change export row.
6098
+ * UTC timestamp for callback at on this lead status change export row.
6063
6099
  */
6064
6100
  callbackAt?: Date | null;
6065
6101
  /**
@@ -6083,7 +6119,7 @@ export interface LeadStatusChangeExportRow extends AdditionalDataHolder, Parsabl
6083
6119
  */
6084
6120
  changeSource?: LeadStatusChangeExportRow_changeSource | null;
6085
6121
  /**
6086
- * The date and time for the created at value on this lead status change export row.
6122
+ * UTC timestamp for created at on this lead status change export row.
6087
6123
  */
6088
6124
  createdAt?: Date | null;
6089
6125
  /**
@@ -6123,7 +6159,7 @@ export interface LeadStatusChangeExportRow extends AdditionalDataHolder, Parsabl
6123
6159
  */
6124
6160
  oldLeadStatusChangeType?: string | null;
6125
6161
  /**
6126
- * The outcome value for this lead status change export row.
6162
+ * Result of the interaction or workflow step represented by this exported row.
6127
6163
  */
6128
6164
  outcome?: string | null;
6129
6165
  /**
@@ -6139,15 +6175,15 @@ export interface LeadStatusChangeExportRow extends AdditionalDataHolder, Parsabl
6139
6175
  */
6140
6176
  sourceId?: string | null;
6141
6177
  /**
6142
- * The date and time for the task due at value on this lead status change export row.
6178
+ * UTC timestamp for task due at on this lead status change export row.
6143
6179
  */
6144
6180
  taskDueAt?: Date | null;
6145
6181
  /**
6146
- * The type classification for this lead status change export row.
6182
+ * Category of status change represented by this exported row.
6147
6183
  */
6148
6184
  type?: string | null;
6149
6185
  /**
6150
- * The date and time for the updated at value on this lead status change export row.
6186
+ * UTC timestamp for updated at on this lead status change export row.
6151
6187
  */
6152
6188
  updatedAt?: Date | null;
6153
6189
  }
@@ -6158,15 +6194,15 @@ export type LeadStatusChangeExportRow_changeSource = (typeof LeadStatusChangeExp
6158
6194
  */
6159
6195
  export interface LeadStatusChangeRequest extends AdditionalDataHolder, Parsable {
6160
6196
  /**
6161
- * The date and time for the appointment end at value on this lead status change.
6197
+ * UTC timestamp for appointment end at on this lead status change.
6162
6198
  */
6163
6199
  appointmentEndAt?: Date | null;
6164
6200
  /**
6165
- * The appointment notes value for this lead status change.
6201
+ * Additional scheduling or preparation notes for the related appointment.
6166
6202
  */
6167
6203
  appointmentNotes?: string | null;
6168
6204
  /**
6169
- * The date and time for the appointment start at value on this lead status change.
6205
+ * UTC timestamp for appointment start at on this lead status change.
6170
6206
  */
6171
6207
  appointmentStartAt?: Date | null;
6172
6208
  /**
@@ -6174,7 +6210,7 @@ export interface LeadStatusChangeRequest extends AdditionalDataHolder, Parsable
6174
6210
  */
6175
6211
  assignedToUserId?: string | null;
6176
6212
  /**
6177
- * The date and time for the callback at value on this lead status change.
6213
+ * UTC timestamp for callback at on this lead status change.
6178
6214
  */
6179
6215
  callbackAt?: Date | null;
6180
6216
  /**
@@ -6202,7 +6238,7 @@ export interface LeadStatusChangeRequest extends AdditionalDataHolder, Parsable
6202
6238
  */
6203
6239
  notes?: string | null;
6204
6240
  /**
6205
- * The outcome value for this lead status change.
6241
+ * Result of the interaction or workflow step that caused the status change.
6206
6242
  */
6207
6243
  outcome?: string | null;
6208
6244
  /**
@@ -6218,15 +6254,15 @@ export interface LeadStatusChangeRequest extends AdditionalDataHolder, Parsable
6218
6254
  */
6219
6255
  sourceId?: string | null;
6220
6256
  /**
6221
- * The date and time for the task due at value on this lead status change.
6257
+ * UTC timestamp for task due at on this lead status change.
6222
6258
  */
6223
6259
  taskDueAt?: Date | null;
6224
6260
  /**
6225
- * The date and time for the timestamp value on this lead status change.
6261
+ * UTC timestamp for timestamp on this lead status change.
6226
6262
  */
6227
6263
  timestamp?: Date | null;
6228
6264
  /**
6229
- * The type classification for this lead status change.
6265
+ * Category of status change being recorded for the lead.
6230
6266
  */
6231
6267
  type?: string | null;
6232
6268
  }
@@ -6237,15 +6273,15 @@ export type LeadStatusChangeRequest_changeSource = (typeof LeadStatusChangeReque
6237
6273
  */
6238
6274
  export interface LeadStatusChangeResponse extends AdditionalDataHolder, Parsable {
6239
6275
  /**
6240
- * The date and time for the appointment end at value on this lead status change.
6276
+ * UTC timestamp for appointment end at on this lead status change.
6241
6277
  */
6242
6278
  appointmentEndAt?: Date | null;
6243
6279
  /**
6244
- * The appointment notes value for this lead status change.
6280
+ * Additional scheduling or preparation notes for the related appointment.
6245
6281
  */
6246
6282
  appointmentNotes?: string | null;
6247
6283
  /**
6248
- * The date and time for the appointment start at value on this lead status change.
6284
+ * UTC timestamp for appointment start at on this lead status change.
6249
6285
  */
6250
6286
  appointmentStartAt?: Date | null;
6251
6287
  /**
@@ -6253,7 +6289,7 @@ export interface LeadStatusChangeResponse extends AdditionalDataHolder, Parsable
6253
6289
  */
6254
6290
  assignedToUserId?: string | null;
6255
6291
  /**
6256
- * The date and time for the callback at value on this lead status change.
6292
+ * UTC timestamp for callback at on this lead status change.
6257
6293
  */
6258
6294
  callbackAt?: Date | null;
6259
6295
  /**
@@ -6277,7 +6313,7 @@ export interface LeadStatusChangeResponse extends AdditionalDataHolder, Parsable
6277
6313
  */
6278
6314
  changeSource?: LeadStatusChangeResponse_changeSource | null;
6279
6315
  /**
6280
- * The date and time for the created at value on this lead status change.
6316
+ * UTC timestamp for created at on this lead status change.
6281
6317
  */
6282
6318
  createdAt?: Date | null;
6283
6319
  /**
@@ -6285,7 +6321,7 @@ export interface LeadStatusChangeResponse extends AdditionalDataHolder, Parsable
6285
6321
  */
6286
6322
  followUpStatus?: string | null;
6287
6323
  /**
6288
- * The unique ID for this lead status change.
6324
+ * Unique Leadping identifier for this lead status change.
6289
6325
  */
6290
6326
  id?: string | null;
6291
6327
  /**
@@ -6321,7 +6357,7 @@ export interface LeadStatusChangeResponse extends AdditionalDataHolder, Parsable
6321
6357
  */
6322
6358
  oldLeadStatusChangeType?: string | null;
6323
6359
  /**
6324
- * The outcome value for this lead status change.
6360
+ * Result of the interaction or workflow step that caused the status change.
6325
6361
  */
6326
6362
  outcome?: string | null;
6327
6363
  /**
@@ -6337,19 +6373,19 @@ export interface LeadStatusChangeResponse extends AdditionalDataHolder, Parsable
6337
6373
  */
6338
6374
  sourceId?: string | null;
6339
6375
  /**
6340
- * The date and time for the task due at value on this lead status change.
6376
+ * UTC timestamp for task due at on this lead status change.
6341
6377
  */
6342
6378
  taskDueAt?: Date | null;
6343
6379
  /**
6344
- * The date and time for the timestamp value on this lead status change.
6380
+ * UTC timestamp for timestamp on this lead status change.
6345
6381
  */
6346
6382
  timestamp?: Date | null;
6347
6383
  /**
6348
- * The type classification for this lead status change.
6384
+ * Category of status change recorded for the lead.
6349
6385
  */
6350
6386
  type?: string | null;
6351
6387
  /**
6352
- * The date and time for the updated at value on this lead status change.
6388
+ * UTC timestamp for updated at on this lead status change.
6353
6389
  */
6354
6390
  updatedAt?: Date | null;
6355
6391
  }
@@ -6415,7 +6451,7 @@ export interface LeadStatusResponse extends AdditionalDataHolder, Parsable {
6415
6451
  sortOrder?: number | null;
6416
6452
  }
6417
6453
  /**
6418
- * List item schema for Leadping API lead table row results shown in searchable tables.
6454
+ * Summarizes lead data in paginated and searchable results.
6419
6455
  */
6420
6456
  export interface LeadTableRow extends AdditionalDataHolder, Parsable {
6421
6457
  /**
@@ -6463,7 +6499,7 @@ export interface LeadTableRow extends AdditionalDataHolder, Parsable {
6463
6499
  */
6464
6500
  lastName?: string | null;
6465
6501
  /**
6466
- * The ID and name for this organization.
6502
+ * Identifier and display name of the related organization.
6467
6503
  */
6468
6504
  organization?: LeadTableRow_organization | null;
6469
6505
  /**
@@ -6475,7 +6511,7 @@ export interface LeadTableRow extends AdditionalDataHolder, Parsable {
6475
6511
  */
6476
6512
  price?: number | null;
6477
6513
  /**
6478
- * The ID and name for this source.
6514
+ * Identifier and display name of the related source.
6479
6515
  */
6480
6516
  source?: LeadTableRow_source | null;
6481
6517
  /**
@@ -6501,17 +6537,17 @@ export interface LeadTableRow extends AdditionalDataHolder, Parsable {
6501
6537
  export interface LeadTableRow_currentLeadStatus extends CurrentLeadStatusSummary, Parsable {
6502
6538
  }
6503
6539
  /**
6504
- * The ID and name for this organization.
6540
+ * Identifier and display name of the related organization.
6505
6541
  */
6506
6542
  export interface LeadTableRow_organization extends IdNamePair, Parsable {
6507
6543
  }
6508
6544
  /**
6509
- * The ID and name for this source.
6545
+ * Identifier and display name of the related source.
6510
6546
  */
6511
6547
  export interface LeadTableRow_source extends IdNamePair, Parsable {
6512
6548
  }
6513
6549
  /**
6514
- * Request schema for the Leadping API lead tag update request, including the fields clients can send.
6550
+ * Defines the fields clients can send when working with lead tag update.
6515
6551
  */
6516
6552
  export interface LeadTagsRequest extends AdditionalDataHolder, Parsable {
6517
6553
  /**
@@ -6553,11 +6589,11 @@ export interface MessageMediaAttachment extends AdditionalDataHolder, Parsable {
6553
6589
  url?: string | null;
6554
6590
  }
6555
6591
  /**
6556
- * API DTO containing Leadping mobile preferences for a single user device.
6592
+ * Describes notification and calling preferences saved for one of the user's mobile devices.
6557
6593
  */
6558
6594
  export interface MobileDevicePreferences extends AdditionalDataHolder, Parsable {
6559
6595
  /**
6560
- * The ID and name for this device.
6596
+ * Identifier and display name of the related device.
6561
6597
  */
6562
6598
  device?: IdNamePair | null;
6563
6599
  /**
@@ -6571,11 +6607,11 @@ export interface MobileDevicePreferences extends AdditionalDataHolder, Parsable
6571
6607
  }
6572
6608
  export type NotificationPriority = (typeof NotificationPriorityObject)[keyof typeof NotificationPriorityObject];
6573
6609
  /**
6574
- * API DTO containing notification data used by Leadping API contracts.
6610
+ * Describes notification data used in Leadping API requests and responses.
6575
6611
  */
6576
6612
  export interface NotificationResponse extends AdditionalDataHolder, Parsable {
6577
6613
  /**
6578
- * The action button text value for this notification.
6614
+ * Action button text for this notification.
6579
6615
  */
6580
6616
  actionButtonText?: string | null;
6581
6617
  /**
@@ -6587,7 +6623,7 @@ export interface NotificationResponse extends AdditionalDataHolder, Parsable {
6587
6623
  */
6588
6624
  createdAt?: Date | null;
6589
6625
  /**
6590
- * The details value for this notification.
6626
+ * Optional supporting details displayed beneath the notification message.
6591
6627
  */
6592
6628
  details?: string | null;
6593
6629
  /**
@@ -6599,7 +6635,7 @@ export interface NotificationResponse extends AdditionalDataHolder, Parsable {
6599
6635
  */
6600
6636
  isRead?: boolean | null;
6601
6637
  /**
6602
- * The message value for this notification.
6638
+ * Message for this notification.
6603
6639
  */
6604
6640
  message?: string | null;
6605
6641
  /**
@@ -6611,11 +6647,15 @@ export interface NotificationResponse extends AdditionalDataHolder, Parsable {
6611
6647
  */
6612
6648
  name?: string | null;
6613
6649
  /**
6614
- * The priority value for this notification.
6650
+ * Priority for this notification.
6615
6651
  */
6616
6652
  priority?: NotificationPriority | null;
6617
6653
  /**
6618
- * The date and time for the read at value on this notification.
6654
+ * Whether this notification should also be delivered as a device push notification.
6655
+ */
6656
+ pushEnabled?: boolean | null;
6657
+ /**
6658
+ * UTC timestamp for read at on this notification.
6619
6659
  */
6620
6660
  readAt?: Date | null;
6621
6661
  /**
@@ -6636,11 +6676,11 @@ export interface NotificationResponse extends AdditionalDataHolder, Parsable {
6636
6676
  userId?: string | null;
6637
6677
  }
6638
6678
  /**
6639
- * API response containing notification data returned to callers.
6679
+ * Describes notification data returned by Leadping.
6640
6680
  */
6641
6681
  export interface NotificationTableRow extends AdditionalDataHolder, Parsable {
6642
6682
  /**
6643
- * The action button text value for this notification.
6683
+ * Action button text for this notification.
6644
6684
  */
6645
6685
  actionButtonText?: string | null;
6646
6686
  /**
@@ -6652,7 +6692,7 @@ export interface NotificationTableRow extends AdditionalDataHolder, Parsable {
6652
6692
  */
6653
6693
  createdAt?: Date | null;
6654
6694
  /**
6655
- * The details value for this notification.
6695
+ * Optional supporting details displayed beneath the notification message.
6656
6696
  */
6657
6697
  details?: string | null;
6658
6698
  /**
@@ -6664,7 +6704,7 @@ export interface NotificationTableRow extends AdditionalDataHolder, Parsable {
6664
6704
  */
6665
6705
  isRead?: boolean | null;
6666
6706
  /**
6667
- * The message value for this notification.
6707
+ * Message for this notification.
6668
6708
  */
6669
6709
  message?: string | null;
6670
6710
  /**
@@ -6676,11 +6716,11 @@ export interface NotificationTableRow extends AdditionalDataHolder, Parsable {
6676
6716
  */
6677
6717
  name?: string | null;
6678
6718
  /**
6679
- * The priority value for this notification.
6719
+ * Priority for this notification.
6680
6720
  */
6681
6721
  priority?: NotificationPriority | null;
6682
6722
  /**
6683
- * The date and time for the read at value on this notification.
6723
+ * UTC timestamp for read at on this notification.
6684
6724
  */
6685
6725
  readAt?: Date | null;
6686
6726
  /**
@@ -6712,11 +6752,11 @@ export interface OrderByOption extends AdditionalDataHolder, Parsable {
6712
6752
  }
6713
6753
  export type OrderByOption_direction = (typeof OrderByOption_directionObject)[keyof typeof OrderByOption_directionObject];
6714
6754
  /**
6715
- * API DTO containing organization activation state data used by Leadping API contracts.
6755
+ * Describes organization activation state data used in Leadping API requests and responses.
6716
6756
  */
6717
6757
  export interface OrganizationActivationState extends AdditionalDataHolder, Parsable {
6718
6758
  /**
6719
- * The date and time for the activated at value on this organization activation state.
6759
+ * UTC timestamp for activated at on this organization activation state.
6720
6760
  */
6721
6761
  activatedAt?: Date | null;
6722
6762
  /**
@@ -6728,7 +6768,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
6728
6768
  */
6729
6769
  billingSubscriptionStatus?: ActivationSubscriptionStatus | null;
6730
6770
  /**
6731
- * The compliance notes value for this organization activation state.
6771
+ * Compliance notes for this organization activation state.
6732
6772
  */
6733
6773
  complianceNotes?: string | null;
6734
6774
  /**
@@ -6736,7 +6776,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
6736
6776
  */
6737
6777
  controlledLaunch?: boolean | null;
6738
6778
  /**
6739
- * The date and time for the created at value on this organization activation state.
6779
+ * UTC timestamp for created at on this organization activation state.
6740
6780
  */
6741
6781
  createdAt?: Date | null;
6742
6782
  /**
@@ -6744,7 +6784,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
6744
6784
  */
6745
6785
  customerFacingStatus?: string | null;
6746
6786
  /**
6747
- * The date and time for the domain approved at value on this organization activation state.
6787
+ * UTC timestamp for domain approved at on this organization activation state.
6748
6788
  */
6749
6789
  domainApprovedAt?: Date | null;
6750
6790
  /**
@@ -6776,19 +6816,19 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
6776
6816
  */
6777
6817
  events?: ActivationTimelineEvent[] | null;
6778
6818
  /**
6779
- * The date and time for the failed at value on this organization activation state.
6819
+ * UTC timestamp for failed at on this organization activation state.
6780
6820
  */
6781
6821
  failedAt?: Date | null;
6782
6822
  /**
6783
- * The industry value for this organization activation state.
6823
+ * Industry for this organization activation state.
6784
6824
  */
6785
6825
  industry?: string | null;
6786
6826
  /**
6787
- * The date and time for the launch approved at value on this organization activation state.
6827
+ * UTC timestamp for launch approved at on this organization activation state.
6788
6828
  */
6789
6829
  launchApprovedAt?: Date | null;
6790
6830
  /**
6791
- * The date and time for the launch review requested at value on this organization activation state.
6831
+ * UTC timestamp for launch review requested at on this organization activation state.
6792
6832
  */
6793
6833
  launchReviewRequestedAt?: Date | null;
6794
6834
  /**
@@ -6796,7 +6836,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
6796
6836
  */
6797
6837
  launchReviewStatus?: ActivationLaunchReviewStatus | null;
6798
6838
  /**
6799
- * The offer value for this organization activation state.
6839
+ * Offer for this organization activation state.
6800
6840
  */
6801
6841
  offer?: string | null;
6802
6842
  /**
@@ -6804,11 +6844,11 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
6804
6844
  */
6805
6845
  onboardingStatus?: ActivationOnboardingStatus | null;
6806
6846
  /**
6807
- * The organization description value for this organization activation state.
6847
+ * Organization description for this organization activation state.
6808
6848
  */
6809
6849
  organizationDescription?: string | null;
6810
6850
  /**
6811
- * The date and time for the payment method confirmed at value on this organization activation state.
6851
+ * UTC timestamp for payment method confirmed at on this organization activation state.
6812
6852
  */
6813
6853
  paymentMethodConfirmedAt?: Date | null;
6814
6854
  /**
@@ -6816,11 +6856,11 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
6816
6856
  */
6817
6857
  paymentStatus?: ActivationPaymentStatus | null;
6818
6858
  /**
6819
- * The selected domain value for this organization activation state.
6859
+ * Selected domain for this organization activation state.
6820
6860
  */
6821
6861
  selectedDomain?: string | null;
6822
6862
  /**
6823
- * The service area value for this organization activation state.
6863
+ * Service area for this organization activation state.
6824
6864
  */
6825
6865
  serviceArea?: string | null;
6826
6866
  /**
@@ -6828,27 +6868,27 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
6828
6868
  */
6829
6869
  status?: CustomerActivationStatus | null;
6830
6870
  /**
6831
- * The date and time for the subscription active at value on this organization activation state.
6871
+ * UTC timestamp for subscription active at on this organization activation state.
6832
6872
  */
6833
6873
  subscriptionActiveAt?: Date | null;
6834
6874
  /**
6835
- * The date and time for the subscription pending at value on this organization activation state.
6875
+ * UTC timestamp for subscription pending at on this organization activation state.
6836
6876
  */
6837
6877
  subscriptionPendingAt?: Date | null;
6838
6878
  /**
6839
- * The target audience value for this organization activation state.
6879
+ * Target audience for this organization activation state.
6840
6880
  */
6841
6881
  targetAudience?: string | null;
6842
6882
  /**
6843
- * The date and time for the telephony partially provisioned at value on this organization activation state.
6883
+ * UTC timestamp for telephony partially provisioned at on this organization activation state.
6844
6884
  */
6845
6885
  telephonyPartiallyProvisionedAt?: Date | null;
6846
6886
  /**
6847
- * The date and time for the telephony provisioning started at value on this organization activation state.
6887
+ * UTC timestamp for telephony provisioning started at on this organization activation state.
6848
6888
  */
6849
6889
  telephonyProvisioningStartedAt?: Date | null;
6850
6890
  /**
6851
- * The date and time for the telephony ready at value on this organization activation state.
6891
+ * UTC timestamp for telephony ready at on this organization activation state.
6852
6892
  */
6853
6893
  telephonyReadyAt?: Date | null;
6854
6894
  /**
@@ -6860,7 +6900,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
6860
6900
  */
6861
6901
  tenDlcApplicationId?: string | null;
6862
6902
  /**
6863
- * The 10DLC draft value for this organization activation state.
6903
+ * 10DLC draft for this organization activation state.
6864
6904
  */
6865
6905
  tenDlcDraft?: OrganizationActivationState_tenDlcDraft | null;
6866
6906
  /**
@@ -6868,7 +6908,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
6868
6908
  */
6869
6909
  tenDlcStatus?: TenDlcApplicationStatus | null;
6870
6910
  /**
6871
- * The date and time for the updated at value on this organization activation state.
6911
+ * UTC timestamp for updated at on this organization activation state.
6872
6912
  */
6873
6913
  updatedAt?: Date | null;
6874
6914
  /**
@@ -6876,7 +6916,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
6876
6916
  */
6877
6917
  websiteGenerationResult?: string | null;
6878
6918
  /**
6879
- * The website needs value for this organization activation state.
6919
+ * Website needs for this organization activation state.
6880
6920
  */
6881
6921
  websiteNeeds?: string | null;
6882
6922
  /**
@@ -6890,7 +6930,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
6890
6930
  }
6891
6931
  export type OrganizationActivationState_domainSearchStage = (typeof OrganizationActivationState_domainSearchStageObject)[keyof typeof OrganizationActivationState_domainSearchStageObject];
6892
6932
  /**
6893
- * The 10DLC draft value for this organization activation state.
6933
+ * 10DLC draft for this organization activation state.
6894
6934
  */
6895
6935
  export interface OrganizationActivationState_tenDlcDraft extends Parsable, TenDlcApplicationDraft {
6896
6936
  }
@@ -6903,11 +6943,11 @@ export interface OrganizationBillingState extends AdditionalDataHolder, Parsable
6903
6943
  */
6904
6944
  billingPlanChangeEffectiveAt?: Date | null;
6905
6945
  /**
6906
- * Gets or sets when the active subscription is scheduled to cancel.
6946
+ * UTC timestamp when the active subscription is scheduled to cancel.
6907
6947
  */
6908
6948
  cancelAt?: Date | null;
6909
6949
  /**
6910
- * Gets or sets the customer-safe payment recovery state for the organization.
6950
+ * Customer-safe payment recovery state for the organization.
6911
6951
  */
6912
6952
  dunning?: OrganizationBillingState_dunning | null;
6913
6953
  /**
@@ -6919,19 +6959,19 @@ export interface OrganizationBillingState extends AdditionalDataHolder, Parsable
6919
6959
  */
6920
6960
  hasStripeCustomer?: boolean | null;
6921
6961
  /**
6922
- * Gets or sets when Leadping last processed a payment-method event for the organization.
6962
+ * UTC timestamp when Leadping last processed a payment-method event for the organization.
6923
6963
  */
6924
6964
  lastPaymentMethodEventAt?: Date | null;
6925
6965
  /**
6926
- * Gets or sets when Leadping last processed a subscription event for the organization.
6966
+ * UTC timestamp when Leadping last processed a subscription event for the organization.
6927
6967
  */
6928
6968
  lastSubscriptionEventAt?: Date | null;
6929
6969
  /**
6930
- * Gets or sets the number of user licenses currently assigned by the organization.
6970
+ * Number of user licenses currently assigned to organization members.
6931
6971
  */
6932
6972
  organizationMemberAssignedQuantity?: number | null;
6933
6973
  /**
6934
- * Gets or sets the number of user licenses included in the organization subscription.
6974
+ * Number of user licenses included in the organization's subscription plan.
6935
6975
  */
6936
6976
  organizationMemberQuantity?: number | null;
6937
6977
  /**
@@ -6939,7 +6979,7 @@ export interface OrganizationBillingState extends AdditionalDataHolder, Parsable
6939
6979
  */
6940
6980
  pendingBillingPlan?: OrganizationBillingState_pendingBillingPlan | null;
6941
6981
  /**
6942
- * Gets or sets the number of phone numbers included in the organization subscription.
6982
+ * Number of phone numbers included in the organization's subscription plan.
6943
6983
  */
6944
6984
  phoneNumberQuantity?: number | null;
6945
6985
  /**
@@ -6952,13 +6992,13 @@ export interface OrganizationBillingState extends AdditionalDataHolder, Parsable
6952
6992
  planRenewalAt?: Date | null;
6953
6993
  }
6954
6994
  /**
6955
- * Gets or sets the customer-safe payment recovery state for the organization.
6995
+ * Customer-safe payment recovery state for the organization.
6956
6996
  */
6957
6997
  export interface OrganizationBillingState_dunning extends OrganizationDunningInfo, Parsable {
6958
6998
  }
6959
6999
  export type OrganizationBillingState_pendingBillingPlan = (typeof OrganizationBillingState_pendingBillingPlanObject)[keyof typeof OrganizationBillingState_pendingBillingPlanObject];
6960
7000
  /**
6961
- * API DTO containing organization compliance policy data used by Leadping API contracts.
7001
+ * Describes organization compliance policy data used in Leadping API requests and responses.
6962
7002
  */
6963
7003
  export interface OrganizationCompliancePolicy extends AdditionalDataHolder, Parsable {
6964
7004
  /**
@@ -7040,7 +7080,7 @@ export interface OrganizationDunningInfo extends AdditionalDataHolder, Parsable
7040
7080
  stage?: string | null;
7041
7081
  }
7042
7082
  /**
7043
- * Request payload for organization invitation.
7083
+ * Defines the input used for organization invitation.
7044
7084
  */
7045
7085
  export interface OrganizationInvitationRequest extends AdditionalDataHolder, Parsable {
7046
7086
  /**
@@ -7048,20 +7088,20 @@ export interface OrganizationInvitationRequest extends AdditionalDataHolder, Par
7048
7088
  */
7049
7089
  email?: string | null;
7050
7090
  /**
7051
- * The role value for this organization invitation.
7091
+ * Role for this organization invitation.
7052
7092
  */
7053
7093
  role?: OrganizationMemberRole | null;
7054
7094
  }
7055
7095
  /**
7056
- * API response containing organization invitation data returned to callers.
7096
+ * Describes organization invitation data returned by Leadping.
7057
7097
  */
7058
7098
  export interface OrganizationInvitationResponse extends AdditionalDataHolder, Parsable {
7059
7099
  /**
7060
- * The date and time for the accepted at value on this organization invitation.
7100
+ * UTC timestamp for accepted at on this organization invitation.
7061
7101
  */
7062
7102
  acceptedAt?: Date | null;
7063
7103
  /**
7064
- * The date and time for the created at value on this organization invitation.
7104
+ * UTC timestamp for created at on this organization invitation.
7065
7105
  */
7066
7106
  createdAt?: Date | null;
7067
7107
  /**
@@ -7069,11 +7109,11 @@ export interface OrganizationInvitationResponse extends AdditionalDataHolder, Pa
7069
7109
  */
7070
7110
  email?: string | null;
7071
7111
  /**
7072
- * The date and time for the expires at value on this organization invitation.
7112
+ * UTC timestamp for expires at on this organization invitation.
7073
7113
  */
7074
7114
  expiresAt?: Date | null;
7075
7115
  /**
7076
- * The unique ID for this organization invitation.
7116
+ * Unique Leadping identifier for this organization invitation.
7077
7117
  */
7078
7118
  id?: string | null;
7079
7119
  /**
@@ -7097,23 +7137,23 @@ export interface OrganizationInvitationResponse extends AdditionalDataHolder, Pa
7097
7137
  */
7098
7138
  licenseRenewalDate?: Date | null;
7099
7139
  /**
7100
- * The ID and name for this organization.
7140
+ * Identifier and display name of the related organization.
7101
7141
  */
7102
7142
  organization?: IdNamePair | null;
7103
7143
  /**
7104
- * The date and time for the resent at value on this organization invitation.
7144
+ * UTC timestamp for resent at on this organization invitation.
7105
7145
  */
7106
7146
  resentAt?: Date | null;
7107
7147
  /**
7108
- * The date and time for the revoked at value on this organization invitation.
7148
+ * UTC timestamp for revoked at on this organization invitation.
7109
7149
  */
7110
7150
  revokedAt?: Date | null;
7111
7151
  /**
7112
- * The role value for this organization invitation.
7152
+ * Role for this organization invitation.
7113
7153
  */
7114
7154
  role?: OrganizationMemberRole | null;
7115
7155
  /**
7116
- * The safe message value for this organization invitation.
7156
+ * Safe message for this organization invitation.
7117
7157
  */
7118
7158
  safeMessage?: string | null;
7119
7159
  /**
@@ -7121,7 +7161,7 @@ export interface OrganizationInvitationResponse extends AdditionalDataHolder, Pa
7121
7161
  */
7122
7162
  sendFailureReason?: string | null;
7123
7163
  /**
7124
- * The date and time for the sent at value on this organization invitation.
7164
+ * UTC timestamp for sent at on this organization invitation.
7125
7165
  */
7126
7166
  sentAt?: Date | null;
7127
7167
  /**
@@ -7131,15 +7171,15 @@ export interface OrganizationInvitationResponse extends AdditionalDataHolder, Pa
7131
7171
  }
7132
7172
  export type OrganizationInvitationStatus = (typeof OrganizationInvitationStatusObject)[keyof typeof OrganizationInvitationStatusObject];
7133
7173
  /**
7134
- * API DTO containing organization invitation data used by Leadping API contracts.
7174
+ * Describes organization invitation data used in Leadping API requests and responses.
7135
7175
  */
7136
7176
  export interface OrganizationInvitationTableRow extends AdditionalDataHolder, Parsable {
7137
7177
  /**
7138
- * The date and time for the accepted at value on this organization invitation.
7178
+ * UTC timestamp for accepted at on this organization invitation.
7139
7179
  */
7140
7180
  acceptedAt?: Date | null;
7141
7181
  /**
7142
- * The date and time for the created at value on this organization invitation.
7182
+ * UTC timestamp for created at on this organization invitation.
7143
7183
  */
7144
7184
  createdAt?: Date | null;
7145
7185
  /**
@@ -7147,11 +7187,11 @@ export interface OrganizationInvitationTableRow extends AdditionalDataHolder, Pa
7147
7187
  */
7148
7188
  email?: string | null;
7149
7189
  /**
7150
- * The date and time for the expires at value on this organization invitation.
7190
+ * UTC timestamp for expires at on this organization invitation.
7151
7191
  */
7152
7192
  expiresAt?: Date | null;
7153
7193
  /**
7154
- * The unique ID for this organization invitation.
7194
+ * Unique Leadping identifier for this organization invitation.
7155
7195
  */
7156
7196
  id?: string | null;
7157
7197
  /**
@@ -7175,19 +7215,19 @@ export interface OrganizationInvitationTableRow extends AdditionalDataHolder, Pa
7175
7215
  */
7176
7216
  licenseRenewalDate?: Date | null;
7177
7217
  /**
7178
- * The ID and name for this organization.
7218
+ * Identifier and display name of the related organization.
7179
7219
  */
7180
7220
  organization?: IdNamePair | null;
7181
7221
  /**
7182
- * The date and time for the resent at value on this organization invitation.
7222
+ * UTC timestamp for resent at on this organization invitation.
7183
7223
  */
7184
7224
  resentAt?: Date | null;
7185
7225
  /**
7186
- * The date and time for the revoked at value on this organization invitation.
7226
+ * UTC timestamp for revoked at on this organization invitation.
7187
7227
  */
7188
7228
  revokedAt?: Date | null;
7189
7229
  /**
7190
- * The role value for this organization invitation.
7230
+ * Role for this organization invitation.
7191
7231
  */
7192
7232
  role?: OrganizationMemberRole | null;
7193
7233
  /**
@@ -7195,7 +7235,7 @@ export interface OrganizationInvitationTableRow extends AdditionalDataHolder, Pa
7195
7235
  */
7196
7236
  sendFailureReason?: string | null;
7197
7237
  /**
7198
- * The date and time for the sent at value on this organization invitation.
7238
+ * UTC timestamp for sent at on this organization invitation.
7199
7239
  */
7200
7240
  sentAt?: Date | null;
7201
7241
  /**
@@ -7204,7 +7244,7 @@ export interface OrganizationInvitationTableRow extends AdditionalDataHolder, Pa
7204
7244
  status?: OrganizationInvitationStatus | null;
7205
7245
  }
7206
7246
  /**
7207
- * Request schema for the Leadping API organization user request, including the fields clients can send.
7247
+ * Defines the fields clients can send when working with organization user.
7208
7248
  */
7209
7249
  export interface OrganizationMemberRequest extends AdditionalDataHolder, Parsable {
7210
7250
  /**
@@ -7221,7 +7261,7 @@ export interface OrganizationMemberRequest extends AdditionalDataHolder, Parsabl
7221
7261
  userId?: string | null;
7222
7262
  }
7223
7263
  /**
7224
- * API response containing organization user data returned to callers.
7264
+ * Describes organization user data returned by Leadping.
7225
7265
  */
7226
7266
  export interface OrganizationMemberResponse extends AdditionalDataHolder, Parsable {
7227
7267
  /**
@@ -7237,7 +7277,7 @@ export interface OrganizationMemberResponse extends AdditionalDataHolder, Parsab
7237
7277
  */
7238
7278
  id?: string | null;
7239
7279
  /**
7240
- * The date and time for the last used at value on this organization user.
7280
+ * UTC timestamp for last used at on this organization user.
7241
7281
  */
7242
7282
  lastUsedAt?: Date | null;
7243
7283
  /**
@@ -7261,11 +7301,11 @@ export interface OrganizationMemberResponse extends AdditionalDataHolder, Parsab
7261
7301
  */
7262
7302
  name?: string | null;
7263
7303
  /**
7264
- * The organization value for this organization user.
7304
+ * Organization for this organization user.
7265
7305
  */
7266
7306
  organization?: IdNamePair | null;
7267
7307
  /**
7268
- * The date and time for the removed at value on this organization user.
7308
+ * UTC timestamp for removed at on this organization user.
7269
7309
  */
7270
7310
  removedAt?: Date | null;
7271
7311
  /**
@@ -7273,29 +7313,29 @@ export interface OrganizationMemberResponse extends AdditionalDataHolder, Parsab
7273
7313
  */
7274
7314
  removedByUserId?: string | null;
7275
7315
  /**
7276
- * The role value for this organization user.
7316
+ * Role for this organization user.
7277
7317
  */
7278
7318
  role?: OrganizationMemberRole | null;
7279
7319
  /**
7280
- * The user value for this organization user.
7320
+ * User for this organization user.
7281
7321
  */
7282
7322
  user?: IdNamePair | null;
7283
7323
  /**
7284
- * The user email value for this organization user.
7324
+ * User email for this organization user.
7285
7325
  */
7286
7326
  userEmail?: string | null;
7287
7327
  }
7288
7328
  export type OrganizationMemberRole = (typeof OrganizationMemberRoleObject)[keyof typeof OrganizationMemberRoleObject];
7289
7329
  /**
7290
- * API DTO containing organization user data used by Leadping API contracts.
7330
+ * Describes organization user data used in Leadping API requests and responses.
7291
7331
  */
7292
7332
  export interface OrganizationMemberTableRow extends AdditionalDataHolder, Parsable {
7293
7333
  /**
7294
- * The date and time for the created at value on this organization user.
7334
+ * UTC timestamp for created at on this organization user.
7295
7335
  */
7296
7336
  createdAt?: Date | null;
7297
7337
  /**
7298
- * The unique ID for this organization user.
7338
+ * Unique Leadping identifier for this organization user.
7299
7339
  */
7300
7340
  id?: string | null;
7301
7341
  /**
@@ -7307,20 +7347,20 @@ export interface OrganizationMemberTableRow extends AdditionalDataHolder, Parsab
7307
7347
  */
7308
7348
  licenseRenewalDate?: Date | null;
7309
7349
  /**
7310
- * The role value for this organization user.
7350
+ * Role for this organization user.
7311
7351
  */
7312
7352
  role?: OrganizationMemberRole | null;
7313
7353
  /**
7314
- * The ID and name for this user.
7354
+ * Identifier and display name of the related user.
7315
7355
  */
7316
7356
  user?: IdNamePair | null;
7317
7357
  /**
7318
- * The user email value for this organization user.
7358
+ * User email for this organization user.
7319
7359
  */
7320
7360
  userEmail?: string | null;
7321
7361
  }
7322
7362
  /**
7323
- * Request schema for the Leadping API organization profile request, including the fields clients can send.
7363
+ * Defines the fields clients can send when working with organization profile.
7324
7364
  */
7325
7365
  export interface OrganizationRequest extends AdditionalDataHolder, Parsable {
7326
7366
  /**
@@ -7430,7 +7470,7 @@ export interface OrganizationRequest_einDocument extends IdNameValue, Parsable {
7430
7470
  }
7431
7471
  export type OrganizationRequest_status = (typeof OrganizationRequest_statusObject)[keyof typeof OrganizationRequest_statusObject];
7432
7472
  /**
7433
- * Response schema for the Leadping API organization profile response returned to authenticated clients.
7473
+ * Describes organization profile data returned by Leadping.
7434
7474
  */
7435
7475
  export interface OrganizationResponse extends AdditionalDataHolder, Parsable {
7436
7476
  /**
@@ -7608,7 +7648,7 @@ export type OrganizationResponse_subscriptionStatus = (typeof OrganizationRespon
7608
7648
  export interface OrganizationResponse_user extends IdNamePair, Parsable {
7609
7649
  }
7610
7650
  /**
7611
- * API DTO containing organization switch option data used by Leadping API contracts.
7651
+ * Describes organization switch option data used in Leadping API requests and responses.
7612
7652
  */
7613
7653
  export interface OrganizationSwitchOption extends AdditionalDataHolder, Parsable {
7614
7654
  /**
@@ -7616,7 +7656,7 @@ export interface OrganizationSwitchOption extends AdditionalDataHolder, Parsable
7616
7656
  */
7617
7657
  activationStatus?: OrganizationSwitchOption_activationStatus | null;
7618
7658
  /**
7619
- * The activation summary value for this organization switch option.
7659
+ * Activation summary for this organization switch option.
7620
7660
  */
7621
7661
  activationSummary?: string | null;
7622
7662
  /**
@@ -7624,7 +7664,7 @@ export interface OrganizationSwitchOption extends AdditionalDataHolder, Parsable
7624
7664
  */
7625
7665
  hasPaymentMethod?: boolean | null;
7626
7666
  /**
7627
- * The unique ID for this organization switch option.
7667
+ * Unique Leadping identifier for this organization switch option.
7628
7668
  */
7629
7669
  id?: string | null;
7630
7670
  /**
@@ -7632,7 +7672,7 @@ export interface OrganizationSwitchOption extends AdditionalDataHolder, Parsable
7632
7672
  */
7633
7673
  isCurrent?: boolean | null;
7634
7674
  /**
7635
- * The date and time for the last used at value on this organization switch option.
7675
+ * UTC timestamp for last used at on this organization switch option.
7636
7676
  */
7637
7677
  lastUsedAt?: Date | null;
7638
7678
  /**
@@ -7652,7 +7692,7 @@ export interface OrganizationSwitchOption extends AdditionalDataHolder, Parsable
7652
7692
  */
7653
7693
  readyForCustomerTraffic?: boolean | null;
7654
7694
  /**
7655
- * The role value for this organization switch option.
7695
+ * Role for this organization switch option.
7656
7696
  */
7657
7697
  role?: OrganizationMemberRole | null;
7658
7698
  /**
@@ -7664,7 +7704,7 @@ export type OrganizationSwitchOption_activationStatus = (typeof OrganizationSwit
7664
7704
  export type OrganizationSwitchOption_organizationStatus = (typeof OrganizationSwitchOption_organizationStatusObject)[keyof typeof OrganizationSwitchOption_organizationStatusObject];
7665
7705
  export type OrganizationSwitchOption_tenDlcStatus = (typeof OrganizationSwitchOption_tenDlcStatusObject)[keyof typeof OrganizationSwitchOption_tenDlcStatusObject];
7666
7706
  /**
7667
- * Request schema for the Leadping API organization switch request, including the fields clients can send.
7707
+ * Defines the fields clients can send when working with organization switch.
7668
7708
  */
7669
7709
  export interface OrganizationSwitchRequest extends AdditionalDataHolder, Parsable {
7670
7710
  /**
@@ -7673,11 +7713,11 @@ export interface OrganizationSwitchRequest extends AdditionalDataHolder, Parsabl
7673
7713
  organizationId?: string | null;
7674
7714
  }
7675
7715
  /**
7676
- * API DTO containing organization data used by Leadping API contracts.
7716
+ * Describes organization data used in Leadping API requests and responses.
7677
7717
  */
7678
7718
  export interface OrganizationTableRow extends AdditionalDataHolder, Parsable {
7679
7719
  /**
7680
- * The account balance value for this organization.
7720
+ * Account balance for this organization.
7681
7721
  */
7682
7722
  accountBalance?: number | null;
7683
7723
  /**
@@ -7721,11 +7761,11 @@ export interface OrganizationTableRow extends AdditionalDataHolder, Parsable {
7721
7761
  */
7722
7762
  enabled?: boolean | null;
7723
7763
  /**
7724
- * The unique ID for this organization.
7764
+ * Unique Leadping identifier for this organization.
7725
7765
  */
7726
7766
  id?: string | null;
7727
7767
  /**
7728
- * The industry value for this organization.
7768
+ * Industry for this organization.
7729
7769
  */
7730
7770
  industry?: string | null;
7731
7771
  /**
@@ -7733,7 +7773,7 @@ export interface OrganizationTableRow extends AdditionalDataHolder, Parsable {
7733
7773
  */
7734
7774
  lastSubscriptionEventAt?: Date | null;
7735
7775
  /**
7736
- * The date and time for the modified at value on this organization.
7776
+ * UTC timestamp for modified at on this organization.
7737
7777
  */
7738
7778
  modifiedAt?: Date | null;
7739
7779
  /**
@@ -7745,7 +7785,7 @@ export interface OrganizationTableRow extends AdditionalDataHolder, Parsable {
7745
7785
  */
7746
7786
  needsAdminReview?: boolean | null;
7747
7787
  /**
7748
- * The ID and name for this organization.
7788
+ * Identifier and display name of the related organization.
7749
7789
  */
7750
7790
  organization?: OrganizationTableRow_organization | null;
7751
7791
  /**
@@ -7792,7 +7832,7 @@ export interface OrganizationTableRow extends AdditionalDataHolder, Parsable {
7792
7832
  export type OrganizationTableRow_activationStatus = (typeof OrganizationTableRow_activationStatusObject)[keyof typeof OrganizationTableRow_activationStatusObject];
7793
7833
  export type OrganizationTableRow_billingPlan = (typeof OrganizationTableRow_billingPlanObject)[keyof typeof OrganizationTableRow_billingPlanObject];
7794
7834
  /**
7795
- * The ID and name for this organization.
7835
+ * Identifier and display name of the related organization.
7796
7836
  */
7797
7837
  export interface OrganizationTableRow_organization extends IdNamePair, Parsable {
7798
7838
  }
@@ -7825,6 +7865,10 @@ export interface OutboundCapacityOverview extends AdditionalDataHolder, Parsable
7825
7865
  * Collection of phone numbers included with this Leadping outbound capacity overview.
7826
7866
  */
7827
7867
  phoneNumbers?: OutboundPhoneNumberCapacity[] | null;
7868
+ /**
7869
+ * Number of phone numbers whose SMS or calling capacity is still ramping up.
7870
+ */
7871
+ rampingPhoneNumbers?: number | null;
7828
7872
  /**
7829
7873
  * Collection of recent decisions included with this Leadping outbound capacity overview.
7830
7874
  */
@@ -7853,6 +7897,10 @@ export interface OutboundPhoneNumberCapacity extends AdditionalDataHolder, Parsa
7853
7897
  * Indicates whether Leadping successfully calculated capacity for this phone number.
7854
7898
  */
7855
7899
  capacityAvailable?: boolean | null;
7900
+ /**
7901
+ * Human-readable reason for the current phone-number health state.
7902
+ */
7903
+ healthReason?: string | null;
7856
7904
  /**
7857
7905
  * Current health status for this Leadping outbound phone number capacity.
7858
7906
  */
@@ -7865,6 +7913,10 @@ export interface OutboundPhoneNumberCapacity extends AdditionalDataHolder, Parsa
7865
7913
  * Unique identifier of the phone number associated with this Leadping outbound phone number capacity.
7866
7914
  */
7867
7915
  phoneNumberId?: string | null;
7916
+ /**
7917
+ * Indicates whether this phone number has an approved 10DLC messaging campaign assignment.
7918
+ */
7919
+ smsApproved?: boolean | null;
7868
7920
  /**
7869
7921
  * Next midnight Eastern time, when SMS daily capacity resets.
7870
7922
  */
@@ -7889,6 +7941,10 @@ export interface OutboundPhoneNumberCapacity extends AdditionalDataHolder, Parsa
7889
7941
  * The next time SMS capacity becomes available in the rolling minute window.
7890
7942
  */
7891
7943
  smsMinutelyResetsAt?: Date | null;
7944
+ /**
7945
+ * Indicates whether SMS limits for this phone number are still ramping up.
7946
+ */
7947
+ smsRamping?: boolean | null;
7892
7948
  /**
7893
7949
  * SMS remaining this hour for the applicable messaging or voice capacity window.
7894
7950
  */
@@ -7937,6 +7993,10 @@ export interface OutboundPhoneNumberCapacity extends AdditionalDataHolder, Parsa
7937
7993
  * The next time voice capacity becomes available in the rolling minute window.
7938
7994
  */
7939
7995
  voiceMinutelyResetsAt?: Date | null;
7996
+ /**
7997
+ * Indicates whether call limits for this phone number are still ramping up.
7998
+ */
7999
+ voiceRamping?: boolean | null;
7940
8000
  /**
7941
8001
  * Voice remaining this hour for the applicable messaging or voice capacity window.
7942
8002
  */
@@ -8001,7 +8061,7 @@ export interface OutboundQueueItem extends AdditionalDataHolder, Parsable {
8001
8061
  }
8002
8062
  export type OutboundQueueItem_reasonCode = (typeof OutboundQueueItem_reasonCodeObject)[keyof typeof OutboundQueueItem_reasonCodeObject];
8003
8063
  /**
8004
- * Request schema for the Leadping API outgoing number manual override request, including the fields clients can send.
8064
+ * Defines the fields clients can send when working with outgoing number manual override.
8005
8065
  */
8006
8066
  export interface OutgoingNumberManualOverrideRequest extends AdditionalDataHolder, Parsable {
8007
8067
  /**
@@ -8015,7 +8075,7 @@ export interface OutgoingNumberManualOverrideRequest extends AdditionalDataHolde
8015
8075
  }
8016
8076
  export type OutgoingNumberSelectionReason = (typeof OutgoingNumberSelectionReasonObject)[keyof typeof OutgoingNumberSelectionReasonObject];
8017
8077
  /**
8018
- * Request schema for the Leadping API outgoing number selection request, including the fields clients can send.
8078
+ * Defines the fields clients can send when working with outgoing number selection.
8019
8079
  */
8020
8080
  export interface OutgoingNumberSelectionRequest extends AdditionalDataHolder, Parsable {
8021
8081
  /**
@@ -8049,7 +8109,7 @@ export interface OutgoingNumberSelectionRequest extends AdditionalDataHolder, Pa
8049
8109
  }
8050
8110
  export type OutgoingNumberSelectionRequest_channel = (typeof OutgoingNumberSelectionRequest_channelObject)[keyof typeof OutgoingNumberSelectionRequest_channelObject];
8051
8111
  /**
8052
- * Response schema for the Leadping API outgoing number selection response returned to authenticated clients.
8112
+ * Describes outgoing number selection data returned by Leadping.
8053
8113
  */
8054
8114
  export interface OutgoingNumberSelectionResponse extends AdditionalDataHolder, Parsable {
8055
8115
  /**
@@ -8423,7 +8483,7 @@ export interface Phone extends AdditionalDataHolder, Parsable {
8423
8483
  type?: string | null;
8424
8484
  }
8425
8485
  /**
8426
- * Response schema for the Leadping API phone call returned to authenticated clients.
8486
+ * Describes a Leadping phone call, including participants, direction, provider state, timing, recording, and billing details.
8427
8487
  */
8428
8488
  export interface PhoneCallResponse extends AdditionalDataHolder, Parsable {
8429
8489
  /**
@@ -8530,7 +8590,34 @@ export interface PhoneCallResponse extends AdditionalDataHolder, Parsable {
8530
8590
  export type PhoneCallResponse_selectionReason = (typeof PhoneCallResponse_selectionReasonObject)[keyof typeof PhoneCallResponse_selectionReasonObject];
8531
8591
  export type PhoneCallStatus = (typeof PhoneCallStatusObject)[keyof typeof PhoneCallStatusObject];
8532
8592
  /**
8533
- * Response schema for a canonical phone identity returned by the Leadping API.
8593
+ * An auditable lookup, enrichment, or reputation check performed for a phone identity.
8594
+ */
8595
+ export interface PhoneIdentityLookupAction extends AdditionalDataHolder, Parsable {
8596
+ /**
8597
+ * The unique identifier of this phone identity lookup action.
8598
+ */
8599
+ id?: string | null;
8600
+ /**
8601
+ * The UTC timestamp when the lookup action occurred.
8602
+ */
8603
+ occurredAt?: Date | null;
8604
+ /**
8605
+ * The provider that performed the phone identity lookup.
8606
+ */
8607
+ provider?: string | null;
8608
+ /**
8609
+ * Identifies the outcome of a phone identity lookup action.
8610
+ */
8611
+ status?: PhoneIdentityLookupActionStatus | null;
8612
+ /**
8613
+ * Identifies the kind of lookup action performed for a phone identity.
8614
+ */
8615
+ type?: PhoneIdentityLookupActionType | null;
8616
+ }
8617
+ export type PhoneIdentityLookupActionStatus = (typeof PhoneIdentityLookupActionStatusObject)[keyof typeof PhoneIdentityLookupActionStatusObject];
8618
+ export type PhoneIdentityLookupActionType = (typeof PhoneIdentityLookupActionTypeObject)[keyof typeof PhoneIdentityLookupActionTypeObject];
8619
+ /**
8620
+ * Describes Leadping's canonical identity for a phone number, including normalization, carrier, line type, reputation, and lookup history.
8534
8621
  */
8535
8622
  export interface PhoneIdentityResponse extends AdditionalDataHolder, Parsable {
8536
8623
  /**
@@ -8549,6 +8636,10 @@ export interface PhoneIdentityResponse extends AdditionalDataHolder, Parsable {
8549
8636
  * Provider lookup and enrichment data for the number.
8550
8637
  */
8551
8638
  lookup?: PhoneIdentityResponse_lookup | null;
8639
+ /**
8640
+ * Lookup, enrichment, and reputation actions performed for this identity.
8641
+ */
8642
+ lookupActions?: PhoneIdentityLookupAction[] | null;
8552
8643
  /**
8553
8644
  * The date and time when the entity was last modified, if applicable.
8554
8645
  */
@@ -8602,7 +8693,7 @@ export interface PhoneLookup extends AdditionalDataHolder, Parsable {
8602
8693
  */
8603
8694
  carrier?: PhoneLookup_carrier | null;
8604
8695
  /**
8605
- * Gets or sets created at.
8696
+ * UTC timestamp when the phone lookup record was created.
8606
8697
  */
8607
8698
  createdAt?: Date | null;
8608
8699
  /**
@@ -8610,7 +8701,7 @@ export interface PhoneLookup extends AdditionalDataHolder, Parsable {
8610
8701
  */
8611
8702
  fraud?: string | null;
8612
8703
  /**
8613
- * Gets or sets id.
8704
+ * Unique Leadping identifier for the saved phone lookup record.
8614
8705
  */
8615
8706
  id?: string | null;
8616
8707
  /**
@@ -8626,7 +8717,7 @@ export interface PhoneLookup extends AdditionalDataHolder, Parsable {
8626
8717
  */
8627
8718
  location?: PhoneLookup_location | null;
8628
8719
  /**
8629
- * Gets or sets modified at.
8720
+ * UTC timestamp when the phone lookup record was last updated.
8630
8721
  */
8631
8722
  modifiedAt?: Date | null;
8632
8723
  /**
@@ -8772,28 +8863,28 @@ export interface PhoneLookupPortability extends AdditionalDataHolder, Parsable {
8772
8863
  */
8773
8864
  export interface PhoneLookupProviderSnapshot extends AdditionalDataHolder, Parsable {
8774
8865
  /**
8775
- * The lookupType property
8866
+ * The provider lookup product or operation that produced this snapshot.
8776
8867
  */
8777
8868
  lookupType?: string | null;
8778
8869
  /**
8779
- * The provider property
8870
+ * The provider that supplied the phone lookup record.
8780
8871
  */
8781
8872
  provider?: string | null;
8782
8873
  /**
8783
- * The rawRecordJson property
8874
+ * The complete provider response serialized as JSON for lossless audit and replay.
8784
8875
  */
8785
8876
  rawRecordJson?: string | null;
8786
8877
  /**
8787
- * The retrievedAt property
8878
+ * The UTC timestamp when Leadping retrieved the provider record.
8788
8879
  */
8789
8880
  retrievedAt?: Date | null;
8790
8881
  /**
8791
- * The schemaVersion property
8882
+ * The Leadping schema version used to interpret the stored provider record.
8792
8883
  */
8793
8884
  schemaVersion?: number | null;
8794
8885
  }
8795
8886
  /**
8796
- * Request schema for checking phone number availability before purchase or assignment.
8887
+ * Defines the phone number and capability requirements Leadping should verify before purchase or assignment.
8797
8888
  */
8798
8889
  export interface PhoneNumberAvailabilityRequest extends AdditionalDataHolder, Parsable {
8799
8890
  /**
@@ -8802,7 +8893,7 @@ export interface PhoneNumberAvailabilityRequest extends AdditionalDataHolder, Pa
8802
8893
  phoneNumber?: string | null;
8803
8894
  }
8804
8895
  /**
8805
- * Response schema for the Leadping API phone number availability result returned to authenticated clients.
8896
+ * Reports whether a phone number is available for purchase or assignment and explains any blocking condition.
8806
8897
  */
8807
8898
  export interface PhoneNumberAvailabilityResponse extends AdditionalDataHolder, Parsable {
8808
8899
  /**
@@ -8888,7 +8979,7 @@ export interface PhoneNumberLocation_coordinateSource extends Parsable, PhoneLoc
8888
8979
  export interface PhoneNumberLocation_timeZoneSource extends Parsable, PhoneLocationSource {
8889
8980
  }
8890
8981
  /**
8891
- * Response schema for the Leadping API phone number messaging event returned to authenticated clients.
8982
+ * Describes a messaging event used to calculate delivery, failure, and opt-out metrics for a phone number.
8892
8983
  */
8893
8984
  export interface PhoneNumberMessagingEventResponse extends AdditionalDataHolder, Parsable {
8894
8985
  /**
@@ -8929,7 +9020,7 @@ export interface PhoneNumberMessagingEventResponse extends AdditionalDataHolder,
8929
9020
  toPhoneNumber?: string | null;
8930
9021
  }
8931
9022
  /**
8932
- * Response schema for the Leadping API phone number opt-out metrics response returned to authenticated clients.
9023
+ * Describes phone number opt-out metrics data returned by Leadping.
8933
9024
  */
8934
9025
  export interface PhoneNumberOptOutMetricsResponse extends AdditionalDataHolder, Parsable {
8935
9026
  /**
@@ -8987,7 +9078,7 @@ export type PhoneNumberReadiness_callStage = (typeof PhoneNumberReadiness_callSt
8987
9078
  export type PhoneNumberReadiness_healthStatus = (typeof PhoneNumberReadiness_healthStatusObject)[keyof typeof PhoneNumberReadiness_healthStatusObject];
8988
9079
  export type PhoneNumberReadiness_state = (typeof PhoneNumberReadiness_stateObject)[keyof typeof PhoneNumberReadiness_stateObject];
8989
9080
  /**
8990
- * Request schema for the Leadping API phone number update request, including the fields clients can send.
9081
+ * Defines the fields clients can send when working with phone number update.
8991
9082
  */
8992
9083
  export interface PhoneNumberRequest extends AdditionalDataHolder, Parsable {
8993
9084
  /**
@@ -9012,7 +9103,7 @@ export interface PhoneNumberRequest extends AdditionalDataHolder, Parsable {
9012
9103
  organizationId?: string | null;
9013
9104
  }
9014
9105
  /**
9015
- * Response schema for the Leadping API phone number returned to authenticated clients.
9106
+ * Describes a Leadping-managed phone number, including capabilities, messaging registration, health, and assignment details.
9016
9107
  */
9017
9108
  export interface PhoneNumberResponse extends AdditionalDataHolder, Parsable {
9018
9109
  /**
@@ -9095,7 +9186,7 @@ export interface PhoneNumberRoutingMetadata extends AdditionalDataHolder, Parsab
9095
9186
  voiceEnabled?: boolean | null;
9096
9187
  }
9097
9188
  /**
9098
- * Request schema for the Leadping API phone number search request, including the fields clients can send.
9189
+ * Defines the fields clients can send when working with phone number search.
9099
9190
  */
9100
9191
  export interface PhoneNumberSearchRequest extends AdditionalDataHolder, Parsable {
9101
9192
  /**
@@ -9113,7 +9204,7 @@ export interface PhoneNumberSearchRequest extends AdditionalDataHolder, Parsable
9113
9204
  export interface PhoneNumberSearchRequest_location extends Parsable, PhoneNumberLocation {
9114
9205
  }
9115
9206
  /**
9116
- * Response schema for the Leadping API phone number search response returned to authenticated clients.
9207
+ * Describes phone number search data returned by Leadping.
9117
9208
  */
9118
9209
  export interface PhoneNumberSearchResponse extends AdditionalDataHolder, Parsable {
9119
9210
  /**
@@ -9140,7 +9231,7 @@ export interface PhoneNumberSearchResult extends AdditionalDataHolder, Parsable
9140
9231
  export interface PhoneNumberSearchResult_location extends Parsable, PhoneNumberLocation {
9141
9232
  }
9142
9233
  /**
9143
- * Response schema for the Leadping API phone number warmup status returned to authenticated clients.
9234
+ * Describes a phone number's current warmup stage, limits, progress, and readiness for production traffic.
9144
9235
  */
9145
9236
  export interface PhoneNumberStatusResponse extends AdditionalDataHolder, Parsable {
9146
9237
  /**
@@ -9187,7 +9278,7 @@ export interface PhoneNumberStatusResponse_outboundCapacity extends OutboundPhon
9187
9278
  export interface PhoneNumberStatusResponse_smsWarmup extends Parsable, SmsReadinessStatusResponse {
9188
9279
  }
9189
9280
  /**
9190
- * List item schema for Leadping API phone number table row results shown in searchable tables.
9281
+ * Summarizes phone number data in paginated and searchable results.
9191
9282
  */
9192
9283
  export interface PhoneNumberTableRow extends AdditionalDataHolder, Parsable {
9193
9284
  /**
@@ -9244,7 +9335,7 @@ export interface PhoneNumberTableRow extends AdditionalDataHolder, Parsable {
9244
9335
  warmup?: PhoneNumberReadiness | null;
9245
9336
  }
9246
9337
  /**
9247
- * Response schema for the Leadping API phone number traffic metrics response returned to authenticated clients.
9338
+ * Describes phone number traffic metrics data returned by Leadping.
9248
9339
  */
9249
9340
  export interface PhoneNumberTrafficMetricsResponse extends AdditionalDataHolder, Parsable {
9250
9341
  /**
@@ -9337,6 +9428,9 @@ export interface PhoneNumberTrafficTrendPoint extends AdditionalDataHolder, Pars
9337
9428
  */
9338
9429
  startAt?: Date | null;
9339
9430
  }
9431
+ /**
9432
+ * Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
9433
+ */
9340
9434
  export interface ProblemDetails extends AdditionalDataHolder, ApiError, Parsable {
9341
9435
  /**
9342
9436
  * Human-readable explanation specific to this occurrence of the problem.
@@ -9359,6 +9453,60 @@ export interface ProblemDetails extends AdditionalDataHolder, ApiError, Parsable
9359
9453
  */
9360
9454
  type?: string | null;
9361
9455
  }
9456
+ /**
9457
+ * Describes a mobile push installation. Identity and Azure tags are derived by the API.
9458
+ */
9459
+ export interface PushInstallationRequest extends AdditionalDataHolder, Parsable {
9460
+ /**
9461
+ * The application build number reported by the client.
9462
+ */
9463
+ appBuild?: string | null;
9464
+ /**
9465
+ * The application bundle identifier or package name.
9466
+ */
9467
+ appIdentifier?: string | null;
9468
+ /**
9469
+ * The human-readable application name reported by the client.
9470
+ */
9471
+ appName?: string | null;
9472
+ /**
9473
+ * The semantic application version reported by the client.
9474
+ */
9475
+ appVersion?: string | null;
9476
+ /**
9477
+ * The device model reported by the client.
9478
+ */
9479
+ deviceModel?: string | null;
9480
+ /**
9481
+ * The mobile operating-system platform reported by the device.
9482
+ */
9483
+ devicePlatform?: string | null;
9484
+ /**
9485
+ * The mobile operating-system version reported by the device.
9486
+ */
9487
+ deviceVersion?: string | null;
9488
+ /**
9489
+ * The stable installation identifier assigned by the mobile client.
9490
+ */
9491
+ installationId?: string | null;
9492
+ /**
9493
+ * Optional client metadata stored with the push installation.
9494
+ */
9495
+ metadata?: PushInstallationRequest_metadata | null;
9496
+ /**
9497
+ * The Azure Notification Hubs platform name, such as apns or fcmv1.
9498
+ */
9499
+ platform?: string | null;
9500
+ /**
9501
+ * The provider-issued push token or channel used to deliver notifications.
9502
+ */
9503
+ pushChannel?: string | null;
9504
+ }
9505
+ /**
9506
+ * Optional client metadata stored with the push installation.
9507
+ */
9508
+ export interface PushInstallationRequest_metadata extends AdditionalDataHolder, Parsable {
9509
+ }
9362
9510
  /**
9363
9511
  * A generic object for handling range filtering during querying
9364
9512
  */
@@ -9422,7 +9570,7 @@ export interface RequestDataOptions extends AdditionalDataHolder, Parsable {
9422
9570
  searchFields?: string[] | null;
9423
9571
  }
9424
9572
  /**
9425
- * Request schema for the Leadping API SMS send request, including the fields clients can send.
9573
+ * Defines the fields clients can send when working with SMS send.
9426
9574
  */
9427
9575
  export interface SendSmsRequest extends AdditionalDataHolder, Parsable {
9428
9576
  /**
@@ -10558,6 +10706,13 @@ export declare function serializePhone(writer: SerializationWriter, phone?: Part
10558
10706
  * @param writer Serialization writer to use to serialize this model
10559
10707
  */
10560
10708
  export declare function serializePhoneCallResponse(writer: SerializationWriter, phoneCallResponse?: Partial<PhoneCallResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
10709
+ /**
10710
+ * Serializes information the current object
10711
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
10712
+ * @param PhoneIdentityLookupAction The instance to serialize from.
10713
+ * @param writer Serialization writer to use to serialize this model
10714
+ */
10715
+ export declare function serializePhoneIdentityLookupAction(writer: SerializationWriter, phoneIdentityLookupAction?: Partial<PhoneIdentityLookupAction> | undefined | null, isSerializingDerivedType?: boolean): void;
10561
10716
  /**
10562
10717
  * Serializes information the current object
10563
10718
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -10831,6 +10986,20 @@ export declare function serializePhoneNumberTrafficTrendPoint(writer: Serializat
10831
10986
  * @param writer Serialization writer to use to serialize this model
10832
10987
  */
10833
10988
  export declare function serializeProblemDetails(writer: SerializationWriter, problemDetails?: Partial<ProblemDetails> | undefined | null, isSerializingDerivedType?: boolean): void;
10989
+ /**
10990
+ * Serializes information the current object
10991
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
10992
+ * @param PushInstallationRequest The instance to serialize from.
10993
+ * @param writer Serialization writer to use to serialize this model
10994
+ */
10995
+ export declare function serializePushInstallationRequest(writer: SerializationWriter, pushInstallationRequest?: Partial<PushInstallationRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
10996
+ /**
10997
+ * Serializes information the current object
10998
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
10999
+ * @param PushInstallationRequest_metadata The instance to serialize from.
11000
+ * @param writer Serialization writer to use to serialize this model
11001
+ */
11002
+ export declare function serializePushInstallationRequest_metadata(writer: SerializationWriter, pushInstallationRequest_metadata?: Partial<PushInstallationRequest_metadata> | undefined | null, isSerializingDerivedType?: boolean): void;
10834
11003
  /**
10835
11004
  * Serializes information the current object
10836
11005
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -11287,7 +11456,7 @@ export declare function serializeUserResponse_notificationPreferences(writer: Se
11287
11456
  */
11288
11457
  export declare function serializeWalletResponse(writer: SerializationWriter, walletResponse?: Partial<WalletResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
11289
11458
  /**
11290
- * List item schema for Leadping API SMS event table row results shown in searchable tables.
11459
+ * Summarizes SMS event data in paginated and searchable results.
11291
11460
  */
11292
11461
  export interface SmsEventTableRow extends AdditionalDataHolder, Parsable {
11293
11462
  /**
@@ -11367,7 +11536,7 @@ export interface SmsEventTableRow extends AdditionalDataHolder, Parsable {
11367
11536
  */
11368
11537
  isAutomated?: boolean | null;
11369
11538
  /**
11370
- * The ID and name for this lead.
11539
+ * Identifier and display name of the related lead.
11371
11540
  */
11372
11541
  lead?: IdNamePair | null;
11373
11542
  /**
@@ -11457,7 +11626,7 @@ export type SmsEventTableRow_trafficType = (typeof SmsEventTableRow_trafficTypeO
11457
11626
  export type SmsReadinessHealthStatus = (typeof SmsReadinessHealthStatusObject)[keyof typeof SmsReadinessHealthStatusObject];
11458
11627
  export type SmsReadinessState = (typeof SmsReadinessStateObject)[keyof typeof SmsReadinessStateObject];
11459
11628
  /**
11460
- * API response containing SMS warmup status data returned to callers.
11629
+ * Describes SMS warmup status data returned by Leadping.
11461
11630
  */
11462
11631
  export interface SmsReadinessStatusResponse extends AdditionalDataHolder, Parsable {
11463
11632
  /**
@@ -11494,7 +11663,7 @@ export interface SmsReadinessStatusResponse extends AdditionalDataHolder, Parsab
11494
11663
  warmupEnabled?: boolean | null;
11495
11664
  }
11496
11665
  /**
11497
- * API DTO containing SMS readiness UI state data used by Leadping API contracts.
11666
+ * Describes SMS readiness UI state data used in Leadping API requests and responses.
11498
11667
  */
11499
11668
  export interface SmsReadinessUiState extends AdditionalDataHolder, Parsable {
11500
11669
  /**
@@ -11506,12 +11675,12 @@ export interface SmsReadinessUiState extends AdditionalDataHolder, Parsable {
11506
11675
  */
11507
11676
  label?: SmsReadinessState | null;
11508
11677
  /**
11509
- * The tone value for this SMS readiness UI state.
11678
+ * Tone for this SMS readiness UI state.
11510
11679
  */
11511
11680
  tone?: string | null;
11512
11681
  }
11513
11682
  /**
11514
- * Response schema for the Leadping API SMS message returned to authenticated clients.
11683
+ * Describes an SMS or MMS message, including participants, delivery state, scheduling, media, and billing details.
11515
11684
  */
11516
11685
  export interface SmsResponse extends AdditionalDataHolder, Parsable {
11517
11686
  /**
@@ -11684,7 +11853,7 @@ export interface SourceMetricsResponse extends AdditionalDataHolder, Parsable {
11684
11853
  totalLeads?: number | null;
11685
11854
  }
11686
11855
  /**
11687
- * Request schema for the Leadping API lead source request, including the fields clients can send.
11856
+ * Defines the fields clients can send when working with lead source.
11688
11857
  */
11689
11858
  export interface SourceRequest extends AdditionalDataHolder, Parsable {
11690
11859
  /**
@@ -11737,7 +11906,7 @@ export interface SourceRequest extends AdditionalDataHolder, Parsable {
11737
11906
  requiresTrustedForm?: boolean | null;
11738
11907
  }
11739
11908
  /**
11740
- * Response schema for the Leadping API lead source response returned to authenticated clients.
11909
+ * Describes lead source data returned by Leadping.
11741
11910
  */
11742
11911
  export interface SourceResponse extends AdditionalDataHolder, Parsable {
11743
11912
  /**
@@ -11846,7 +12015,7 @@ export interface SourceResponse_organization extends IdNamePair, Parsable {
11846
12015
  export interface SourceResponse_user extends IdNamePair, Parsable {
11847
12016
  }
11848
12017
  /**
11849
- * List item schema for Leadping API lead source table row results shown in searchable tables.
12018
+ * Summarizes lead source data in paginated and searchable results.
11850
12019
  */
11851
12020
  export interface SourceTableRow extends AdditionalDataHolder, Parsable {
11852
12021
  /**
@@ -12037,27 +12206,27 @@ export interface StripeInvoiceResponse extends AdditionalDataHolder, Parsable {
12037
12206
  status?: string | null;
12038
12207
  }
12039
12208
  /**
12040
- * API DTO containing stripe payment method data used by Leadping API contracts.
12209
+ * Describes stripe payment method data used in Leadping API requests and responses.
12041
12210
  */
12042
12211
  export interface StripePaymentMethodResponse extends AdditionalDataHolder, Parsable {
12043
12212
  /**
12044
- * The brand value for this Stripe payment method.
12213
+ * Card network brand, such as Visa, Mastercard, or American Express.
12045
12214
  */
12046
12215
  brand?: string | null;
12047
12216
  /**
12048
- * The date and time for the created at value on this Stripe payment method.
12217
+ * UTC timestamp for created at on this Stripe payment method.
12049
12218
  */
12050
12219
  createdAt?: Date | null;
12051
12220
  /**
12052
- * The exp month value for this Stripe payment method.
12221
+ * Two-digit month when the card expires.
12053
12222
  */
12054
12223
  expMonth?: number | null;
12055
12224
  /**
12056
- * The exp year value for this Stripe payment method.
12225
+ * Four-digit year when the card expires.
12057
12226
  */
12058
12227
  expYear?: number | null;
12059
12228
  /**
12060
- * The unique ID for this Stripe payment method.
12229
+ * Unique Leadping identifier for this Stripe payment method.
12061
12230
  */
12062
12231
  id?: string | null;
12063
12232
  /**
@@ -12065,40 +12234,40 @@ export interface StripePaymentMethodResponse extends AdditionalDataHolder, Parsa
12065
12234
  */
12066
12235
  isDefault?: boolean | null;
12067
12236
  /**
12068
- * The date and time for the last4 value on this Stripe payment method.
12237
+ * UTC timestamp for last4 on this Stripe payment method.
12069
12238
  */
12070
12239
  last4?: string | null;
12071
12240
  }
12072
12241
  /**
12073
- * API response containing suppression check result data returned to callers.
12242
+ * Reports whether Leadping may contact a recipient and identifies the active suppression when contact is blocked.
12074
12243
  */
12075
12244
  export interface SuppressionCheckResult extends AdditionalDataHolder, Parsable {
12076
12245
  /**
12077
- * Whether this ion check result allows ed.
12246
+ * Whether outreach to the recipient is allowed for the requested channel.
12078
12247
  */
12079
12248
  allowed?: boolean | null;
12080
12249
  /**
12081
- * The channel value for this ion check result.
12250
+ * Communication channel evaluated by the suppression check.
12082
12251
  */
12083
12252
  channel?: string | null;
12084
12253
  /**
12085
- * The human-readable customer reason explaining this ion check result.
12254
+ * Customer-safe explanation of why contact is blocked or allowed.
12086
12255
  */
12087
12256
  customerReason?: string | null;
12088
12257
  /**
12089
- * The normalized email value for this ion check result.
12258
+ * Email address used for matching, normalized for comparison.
12090
12259
  */
12091
12260
  normalizedEmail?: string | null;
12092
12261
  /**
12093
- * The phone number associated with this ion check result.
12262
+ * Phone number used for matching, normalized to a consistent format.
12094
12263
  */
12095
12264
  normalizedPhoneNumber?: string | null;
12096
12265
  /**
12097
- * The organization ID associated with this ion check result.
12266
+ * Identifier of the organization whose suppression list was checked.
12098
12267
  */
12099
12268
  organizationId?: string | null;
12100
12269
  /**
12101
- * The recipient identifier value for this ion check result.
12270
+ * Provider or customer identifier used to match the recipient.
12102
12271
  */
12103
12272
  recipientIdentifier?: string | null;
12104
12273
  /**
@@ -12110,132 +12279,132 @@ export interface SuppressionCheckResult extends AdditionalDataHolder, Parsable {
12110
12279
  */
12111
12280
  suppressedAt?: Date | null;
12112
12281
  /**
12113
- * The suppression entry ID associated with this ion check result.
12282
+ * Identifier of the active suppression that blocked contact, when one matched.
12114
12283
  */
12115
12284
  suppressionEntryId?: string | null;
12116
12285
  }
12117
12286
  /**
12118
- * API DTO containing ion entry audit data used by Leadping API contracts.
12287
+ * Records one auditable change to a recipient suppression entry.
12119
12288
  */
12120
12289
  export interface SuppressionEntryAudit extends AdditionalDataHolder, Parsable {
12121
12290
  /**
12122
- * The actor ID associated with this ion entry audit.
12291
+ * Identifier of the user or system actor responsible for the change.
12123
12292
  */
12124
12293
  actorId?: string | null;
12125
12294
  /**
12126
- * The unique ID for this ion entry audit.
12295
+ * Unique identifier for this suppression audit record.
12127
12296
  */
12128
12297
  id?: string | null;
12129
12298
  /**
12130
- * The human-readable reason explaining this ion entry audit.
12299
+ * Human-readable reason recorded for the suppression change.
12131
12300
  */
12132
12301
  reason?: string | null;
12133
12302
  /**
12134
- * The safe metadata key-value data carried with this ion entry audit; values must be safe to expose in API responses.
12303
+ * Non-sensitive metadata that provides additional audit context.
12135
12304
  */
12136
12305
  safeMetadata?: SuppressionEntryAudit_safeMetadata | null;
12137
12306
  /**
12138
- * The source value for this ion entry audit.
12307
+ * System or workflow that initiated the change.
12139
12308
  */
12140
12309
  source?: string | null;
12141
12310
  /**
12142
- * The current status for this ion entry audit.
12311
+ * Suppression status established by this change, such as active or released.
12143
12312
  */
12144
12313
  status?: string | null;
12145
12314
  /**
12146
- * The date and time for the timestamp value on this ion entry audit.
12315
+ * UTC timestamp when the suppression change occurred.
12147
12316
  */
12148
12317
  timestamp?: Date | null;
12149
12318
  }
12150
12319
  /**
12151
- * The safe metadata key-value data carried with this ion entry audit; values must be safe to expose in API responses.
12320
+ * Non-sensitive metadata that provides additional audit context.
12152
12321
  */
12153
12322
  export interface SuppressionEntryAudit_safeMetadata extends AdditionalDataHolder, Parsable {
12154
12323
  }
12155
12324
  /**
12156
- * Request payload for suppression entry.
12325
+ * Defines a recipient and communication channel to suppress, release, or check before Leadping sends outreach.
12157
12326
  */
12158
12327
  export interface SuppressionEntryRequest extends AdditionalDataHolder, Parsable {
12159
12328
  /**
12160
- * The channel value for this ion entry.
12329
+ * Communication channel affected by the suppression, such as SMS, voice, email, or all channels.
12161
12330
  */
12162
12331
  channel?: string | null;
12163
12332
  /**
12164
- * The email address associated with this ion entry.
12333
+ * Recipient email address to suppress or check.
12165
12334
  */
12166
12335
  email?: string | null;
12167
12336
  /**
12168
- * The organization ID associated with this ion entry.
12337
+ * Organization whose suppression list should be used.
12169
12338
  */
12170
12339
  organizationId?: string | null;
12171
12340
  /**
12172
- * The phone number associated with this ion entry.
12341
+ * Recipient phone number to suppress or check, preferably in E.164 format.
12173
12342
  */
12174
12343
  phoneNumber?: string | null;
12175
12344
  /**
12176
- * The human-readable reason explaining this ion entry.
12345
+ * Human-readable reason for creating or releasing the suppression.
12177
12346
  */
12178
12347
  reason?: string | null;
12179
12348
  /**
12180
- * The recipient identifier value for this ion entry.
12349
+ * Optional provider or customer identifier that uniquely identifies the recipient.
12181
12350
  */
12182
12351
  recipientIdentifier?: string | null;
12183
12352
  }
12184
12353
  /**
12185
- * API response containing suppression entry data returned to callers.
12354
+ * Describes a recipient suppression that prevents outreach through one or more communication channels.
12186
12355
  */
12187
12356
  export interface SuppressionEntryResponse extends AdditionalDataHolder, Parsable {
12188
12357
  /**
12189
- * The audit included with this ion entry.
12358
+ * Chronological audit history of suppression and release changes.
12190
12359
  */
12191
12360
  audit?: SuppressionEntryAudit[] | null;
12192
12361
  /**
12193
- * The channel value for this ion entry.
12362
+ * Communication channel affected by the suppression, such as SMS, voice, email, or all channels.
12194
12363
  */
12195
12364
  channel?: string | null;
12196
12365
  /**
12197
- * The unique ID for this ion entry.
12366
+ * Unique Leadping identifier for the suppression entry.
12198
12367
  */
12199
12368
  id?: string | null;
12200
12369
  /**
12201
- * The normalized email value for this ion entry.
12370
+ * Suppressed email address normalized for matching.
12202
12371
  */
12203
12372
  normalizedEmail?: string | null;
12204
12373
  /**
12205
- * The phone number associated with this ion entry.
12374
+ * Suppressed phone number normalized to a consistent format.
12206
12375
  */
12207
12376
  normalizedPhoneNumber?: string | null;
12208
12377
  /**
12209
- * The organization ID associated with this ion entry.
12378
+ * Identifier of the organization that owns the suppression entry.
12210
12379
  */
12211
12380
  organizationId?: string | null;
12212
12381
  /**
12213
- * The human-readable reason explaining this ion entry.
12382
+ * Human-readable reason the recipient was suppressed or subsequently released.
12214
12383
  */
12215
12384
  reason?: string | null;
12216
12385
  /**
12217
- * The recipient identifier value for this ion entry.
12386
+ * Provider or customer identifier used to recognize the suppressed recipient.
12218
12387
  */
12219
12388
  recipientIdentifier?: string | null;
12220
12389
  /**
12221
- * The date and time for the released at value on this ion entry.
12390
+ * UTC timestamp when the suppression was released, or while it remains active.
12222
12391
  */
12223
12392
  releasedAt?: Date | null;
12224
12393
  /**
12225
- * The source value for this ion entry.
12394
+ * System or workflow that created the suppression.
12226
12395
  */
12227
12396
  source?: string | null;
12228
12397
  /**
12229
- * The current status for this ion entry.
12398
+ * Current lifecycle state, such as active or released.
12230
12399
  */
12231
12400
  status?: string | null;
12232
12401
  /**
12233
- * The date and time for the suppressed at value on this ion entry.
12402
+ * UTC timestamp when the suppression became active.
12234
12403
  */
12235
12404
  suppressedAt?: Date | null;
12236
12405
  }
12237
12406
  /**
12238
- * Request schema for the Leadping API tag request, including the fields clients can send.
12407
+ * Defines the fields clients can send when working with tag.
12239
12408
  */
12240
12409
  export interface TagRequest extends AdditionalDataHolder, Parsable {
12241
12410
  /**
@@ -12256,7 +12425,7 @@ export interface TagRequest extends AdditionalDataHolder, Parsable {
12256
12425
  name?: string | null;
12257
12426
  }
12258
12427
  /**
12259
- * Response schema for the Leadping API tag response returned to authenticated clients.
12428
+ * Describes tag data returned by Leadping.
12260
12429
  */
12261
12430
  export interface TagResponse extends AdditionalDataHolder, Parsable {
12262
12431
  /**
@@ -12330,12 +12499,12 @@ export interface TagSummary extends AdditionalDataHolder, Parsable {
12330
12499
  */
12331
12500
  export interface TelephonyLoginRequest extends AdditionalDataHolder, Parsable {
12332
12501
  /**
12333
- * The ID and name for this device.
12502
+ * Identifier and display name of the related device.
12334
12503
  */
12335
12504
  device?: TelephonyLoginRequest_device | null;
12336
12505
  }
12337
12506
  /**
12338
- * The ID and name for this device.
12507
+ * Identifier and display name of the related device.
12339
12508
  */
12340
12509
  export interface TelephonyLoginRequest_device extends IdNamePair, Parsable {
12341
12510
  }
@@ -12344,24 +12513,24 @@ export interface TelephonyLoginRequest_device extends IdNamePair, Parsable {
12344
12513
  */
12345
12514
  export interface TelephonyLoginResponse extends AdditionalDataHolder, Parsable {
12346
12515
  /**
12347
- * The callback token value for this telephony login.
12516
+ * Callback token for this telephony login.
12348
12517
  */
12349
12518
  callbackToken?: string | null;
12350
12519
  /**
12351
- * The date and time for the expires at value on this telephony login.
12520
+ * UTC timestamp for expires at on this telephony login.
12352
12521
  */
12353
12522
  expiresAt?: Date | null;
12354
12523
  /**
12355
- * The password value for this telephony login.
12524
+ * Password for this telephony login.
12356
12525
  */
12357
12526
  password?: string | null;
12358
12527
  /**
12359
- * The username value for this telephony login.
12528
+ * Username for this telephony login.
12360
12529
  */
12361
12530
  username?: string | null;
12362
12531
  }
12363
12532
  /**
12364
- * API DTO containing ten dlc application draft data used by Leadping API contracts.
12533
+ * Describes ten dlc application draft data used in Leadping API requests and responses.
12365
12534
  */
12366
12535
  export interface TenDlcApplicationDraft extends AdditionalDataHolder, Parsable {
12367
12536
  /**
@@ -12373,7 +12542,7 @@ export interface TenDlcApplicationDraft extends AdditionalDataHolder, Parsable {
12373
12542
  */
12374
12543
  campaignStatus?: TenDlcRegistrationStatus | null;
12375
12544
  /**
12376
- * The company name value for this 10DLC application draft.
12545
+ * Company name for this 10DLC application draft.
12377
12546
  */
12378
12547
  companyName?: string | null;
12379
12548
  /**
@@ -12381,23 +12550,23 @@ export interface TenDlcApplicationDraft extends AdditionalDataHolder, Parsable {
12381
12550
  */
12382
12551
  complianceWarnings?: string[] | null;
12383
12552
  /**
12384
- * The contact email value for this 10DLC application draft.
12553
+ * Contact email for this 10DLC application draft.
12385
12554
  */
12386
12555
  contactEmail?: string | null;
12387
12556
  /**
12388
- * The contact name value for this 10DLC application draft.
12557
+ * Contact name for this 10DLC application draft.
12389
12558
  */
12390
12559
  contactName?: string | null;
12391
12560
  /**
12392
- * The contact phone value for this 10DLC application draft.
12561
+ * Contact phone for this 10DLC application draft.
12393
12562
  */
12394
12563
  contactPhone?: string | null;
12395
12564
  /**
12396
- * The EIN value for this 10DLC application draft.
12565
+ * EIN for this 10DLC application draft.
12397
12566
  */
12398
12567
  ein?: string | null;
12399
12568
  /**
12400
- * The expected monthly volume value for this 10DLC application draft.
12569
+ * Expected monthly volume for this 10DLC application draft.
12401
12570
  */
12402
12571
  expectedMonthlyVolume?: number | null;
12403
12572
  /**
@@ -12405,13 +12574,9 @@ export interface TenDlcApplicationDraft extends AdditionalDataHolder, Parsable {
12405
12574
  */
12406
12575
  industry?: string | null;
12407
12576
  /**
12408
- * The date and time for the last submitted at value on this 10DLC application draft.
12577
+ * UTC timestamp for last submitted at on this 10DLC application draft.
12409
12578
  */
12410
12579
  lastSubmittedAt?: Date | null;
12411
- /**
12412
- * The lead source value for this 10DLC application draft.
12413
- */
12414
- leadSource?: string | null;
12415
12580
  /**
12416
12581
  * The message examples included with this 10DLC application draft.
12417
12582
  */
@@ -12421,11 +12586,11 @@ export interface TenDlcApplicationDraft extends AdditionalDataHolder, Parsable {
12421
12586
  */
12422
12587
  missingFields?: string[] | null;
12423
12588
  /**
12424
- * The opt in language value for this 10DLC application draft.
12589
+ * Opt in language for this 10DLC application draft.
12425
12590
  */
12426
12591
  optInLanguage?: string | null;
12427
12592
  /**
12428
- * The URL associated with this 10DLC application draft.
12593
+ * Public privacy-policy URL that explains how messaging recipient data is handled.
12429
12594
  */
12430
12595
  privacyPolicyUrl?: string | null;
12431
12596
  /**
@@ -12433,7 +12598,7 @@ export interface TenDlcApplicationDraft extends AdditionalDataHolder, Parsable {
12433
12598
  */
12434
12599
  rejectionReason?: string | null;
12435
12600
  /**
12436
- * The URL associated with this 10DLC application draft.
12601
+ * Public terms-of-service URL governing the messaging program.
12437
12602
  */
12438
12603
  termsUrl?: string | null;
12439
12604
  /**
@@ -12441,23 +12606,23 @@ export interface TenDlcApplicationDraft extends AdditionalDataHolder, Parsable {
12441
12606
  */
12442
12607
  trustedFormRequired?: boolean | null;
12443
12608
  /**
12444
- * The date and time for the updated at value on this 10DLC application draft.
12609
+ * UTC timestamp for updated at on this 10DLC application draft.
12445
12610
  */
12446
12611
  updatedAt?: Date | null;
12447
12612
  /**
12448
- * The use case value for this 10DLC application draft.
12613
+ * Use case for this 10DLC application draft.
12449
12614
  */
12450
12615
  useCase?: string | null;
12451
12616
  /**
12452
- * The use case description value for this 10DLC application draft.
12617
+ * Use case description for this 10DLC application draft.
12453
12618
  */
12454
12619
  useCaseDescription?: string | null;
12455
12620
  /**
12456
- * The version value for this 10DLC application draft.
12621
+ * Version for this 10DLC application draft.
12457
12622
  */
12458
12623
  version?: number | null;
12459
12624
  /**
12460
- * The URL associated with this 10DLC application draft.
12625
+ * Public business website URL submitted to carriers during brand review.
12461
12626
  */
12462
12627
  websiteUrl?: string | null;
12463
12628
  }
@@ -12473,7 +12638,7 @@ export interface TenDlcNotesRequest extends AdditionalDataHolder, Parsable {
12473
12638
  }
12474
12639
  export type TenDlcRegistrationStatus = (typeof TenDlcRegistrationStatusObject)[keyof typeof TenDlcRegistrationStatusObject];
12475
12640
  /**
12476
- * Response schema for the Leadping API billing transaction response returned to authenticated clients.
12641
+ * Describes billing transaction data returned by Leadping.
12477
12642
  */
12478
12643
  export interface TransactionResponse extends AdditionalDataHolder, Parsable {
12479
12644
  /**
@@ -12485,7 +12650,7 @@ export interface TransactionResponse extends AdditionalDataHolder, Parsable {
12485
12650
  */
12486
12651
  billableUnit?: TransactionResponse_billableUnit | null;
12487
12652
  /**
12488
- * The billedAmount property
12653
+ * Customer-facing amount billed for the transaction.
12489
12654
  */
12490
12655
  billedAmount?: number | null;
12491
12656
  /**
@@ -12513,7 +12678,7 @@ export interface TransactionResponse extends AdditionalDataHolder, Parsable {
12513
12678
  */
12514
12679
  id?: string | null;
12515
12680
  /**
12516
- * The ID and name for this lead.
12681
+ * Identifier and display name of the related lead.
12517
12682
  */
12518
12683
  lead?: TransactionResponse_lead | null;
12519
12684
  /**
@@ -12529,7 +12694,7 @@ export interface TransactionResponse extends AdditionalDataHolder, Parsable {
12529
12694
  */
12530
12695
  notes?: string | null;
12531
12696
  /**
12532
- * The ID and name for this organization.
12697
+ * Identifier and display name of the related organization.
12533
12698
  */
12534
12699
  organization?: TransactionResponse_organization | null;
12535
12700
  /**
@@ -12552,18 +12717,18 @@ export interface TransactionResponse extends AdditionalDataHolder, Parsable {
12552
12717
  export type TransactionResponse_billableUnit = (typeof TransactionResponse_billableUnitObject)[keyof typeof TransactionResponse_billableUnitObject];
12553
12718
  export type TransactionResponse_billingChannel = (typeof TransactionResponse_billingChannelObject)[keyof typeof TransactionResponse_billingChannelObject];
12554
12719
  /**
12555
- * The ID and name for this lead.
12720
+ * Identifier and display name of the related lead.
12556
12721
  */
12557
12722
  export interface TransactionResponse_lead extends IdNamePair, Parsable {
12558
12723
  }
12559
12724
  /**
12560
- * The ID and name for this organization.
12725
+ * Identifier and display name of the related organization.
12561
12726
  */
12562
12727
  export interface TransactionResponse_organization extends IdNamePair, Parsable {
12563
12728
  }
12564
12729
  export type TransactionStatus = (typeof TransactionStatusObject)[keyof typeof TransactionStatusObject];
12565
12730
  /**
12566
- * List item schema for Leadping API billing transaction table row results shown in searchable tables.
12731
+ * Summarizes billing transaction data in paginated and searchable results.
12567
12732
  */
12568
12733
  export interface TransactionTableRow extends AdditionalDataHolder, Parsable {
12569
12734
  /**
@@ -12575,7 +12740,7 @@ export interface TransactionTableRow extends AdditionalDataHolder, Parsable {
12575
12740
  */
12576
12741
  billableUnit?: TransactionTableRow_billableUnit | null;
12577
12742
  /**
12578
- * The billedAmount property
12743
+ * Customer-facing amount billed for the metered usage or wallet transaction.
12579
12744
  */
12580
12745
  billedAmount?: number | null;
12581
12746
  /**
@@ -12595,7 +12760,7 @@ export interface TransactionTableRow extends AdditionalDataHolder, Parsable {
12595
12760
  */
12596
12761
  id?: string | null;
12597
12762
  /**
12598
- * The ID and name for this lead.
12763
+ * Identifier and display name of the related lead.
12599
12764
  */
12600
12765
  lead?: TransactionTableRow_lead | null;
12601
12766
  /**
@@ -12603,7 +12768,7 @@ export interface TransactionTableRow extends AdditionalDataHolder, Parsable {
12603
12768
  */
12604
12769
  netAmount?: number | null;
12605
12770
  /**
12606
- * The ID and name for this organization.
12771
+ * Identifier and display name of the related organization.
12607
12772
  */
12608
12773
  organization?: TransactionTableRow_organization | null;
12609
12774
  /**
@@ -12611,19 +12776,19 @@ export interface TransactionTableRow extends AdditionalDataHolder, Parsable {
12611
12776
  */
12612
12777
  paymentMethodDisplay?: string | null;
12613
12778
  /**
12614
- * The pricingVersion property
12779
+ * Version of the pricing rules used to calculate the billed amount.
12615
12780
  */
12616
12781
  pricingVersion?: string | null;
12617
12782
  /**
12618
- * The quantity property
12783
+ * Number of billable units measured for this transaction, when usage-based pricing applies.
12619
12784
  */
12620
12785
  quantity?: number | null;
12621
12786
  /**
12622
- * The sourceEventId property
12787
+ * Identifier of the event that created this billing transaction, when available.
12623
12788
  */
12624
12789
  sourceEventId?: string | null;
12625
12790
  /**
12626
- * The sourceEventType property
12791
+ * Event type that created this billing transaction, when available.
12627
12792
  */
12628
12793
  sourceEventType?: string | null;
12629
12794
  /**
@@ -12635,37 +12800,37 @@ export interface TransactionTableRow extends AdditionalDataHolder, Parsable {
12635
12800
  */
12636
12801
  transactionType?: TransactionType | null;
12637
12802
  /**
12638
- * The unitPrice property
12803
+ * Price charged per billable unit when usage-based pricing applies.
12639
12804
  */
12640
12805
  unitPrice?: number | null;
12641
12806
  }
12642
12807
  export type TransactionTableRow_billableUnit = (typeof TransactionTableRow_billableUnitObject)[keyof typeof TransactionTableRow_billableUnitObject];
12643
12808
  export type TransactionTableRow_billingChannel = (typeof TransactionTableRow_billingChannelObject)[keyof typeof TransactionTableRow_billingChannelObject];
12644
12809
  /**
12645
- * The ID and name for this lead.
12810
+ * Identifier and display name of the related lead.
12646
12811
  */
12647
12812
  export interface TransactionTableRow_lead extends IdNamePair, Parsable {
12648
12813
  }
12649
12814
  /**
12650
- * The ID and name for this organization.
12815
+ * Identifier and display name of the related organization.
12651
12816
  */
12652
12817
  export interface TransactionTableRow_organization extends IdNamePair, Parsable {
12653
12818
  }
12654
12819
  export type TransactionType = (typeof TransactionTypeObject)[keyof typeof TransactionTypeObject];
12655
12820
  /**
12656
- * API DTO containing trusted form certificate data used by Leadping API contracts.
12821
+ * Describes trusted form certificate data used in Leadping API requests and responses.
12657
12822
  */
12658
12823
  export interface TrustedFormCertificate extends AdditionalDataHolder, Parsable {
12659
12824
  /**
12660
- * The date and time for the created at value on this TrustedForm certificate.
12825
+ * UTC timestamp for created at on this TrustedForm certificate.
12661
12826
  */
12662
12827
  createdAt?: Date | null;
12663
12828
  /**
12664
- * The unique ID for this TrustedForm certificate.
12829
+ * Unique Leadping identifier for this TrustedForm certificate.
12665
12830
  */
12666
12831
  id?: string | null;
12667
12832
  /**
12668
- * The source value for this TrustedForm certificate.
12833
+ * Source for this TrustedForm certificate.
12669
12834
  */
12670
12835
  source?: string | null;
12671
12836
  /**
@@ -12675,7 +12840,7 @@ export interface TrustedFormCertificate extends AdditionalDataHolder, Parsable {
12675
12840
  }
12676
12841
  export type UsageChannel = (typeof UsageChannelObject)[keyof typeof UsageChannelObject];
12677
12842
  /**
12678
- * API DTO containing a named usage counter shown in usage summaries.
12843
+ * Describes one named usage total displayed in organization billing and activity summaries.
12679
12844
  */
12680
12845
  export interface UsageCounterLine extends AdditionalDataHolder, Parsable {
12681
12846
  /**
@@ -12695,28 +12860,28 @@ export interface UsageCounterLine extends AdditionalDataHolder, Parsable {
12695
12860
  */
12696
12861
  unit?: string | null;
12697
12862
  /**
12698
- * The numeric value for this usage counter.
12863
+ * Numeric for this usage counter.
12699
12864
  */
12700
12865
  value?: number | null;
12701
12866
  }
12702
12867
  /**
12703
- * API DTO containing usage ledger data used by Leadping API contracts.
12868
+ * Describes usage ledger data used in Leadping API requests and responses.
12704
12869
  */
12705
12870
  export interface UsageLedgerTableRow extends AdditionalDataHolder, Parsable {
12706
12871
  /**
12707
- * The billable seconds value for this usage ledger.
12872
+ * Billable seconds for this usage ledger.
12708
12873
  */
12709
12874
  billableSeconds?: number | null;
12710
12875
  /**
12711
- * The billable unit value for this usage ledger.
12876
+ * Billable unit for this usage ledger.
12712
12877
  */
12713
12878
  billableUnit?: BillableUnit | null;
12714
12879
  /**
12715
- * The channel value for this usage ledger.
12880
+ * Channel for this usage ledger.
12716
12881
  */
12717
12882
  channel?: UsageChannel | null;
12718
12883
  /**
12719
- * The date and time for the created at value on this usage ledger.
12884
+ * UTC timestamp for created at on this usage ledger.
12720
12885
  */
12721
12886
  createdAt?: Date | null;
12722
12887
  /**
@@ -12728,11 +12893,11 @@ export interface UsageLedgerTableRow extends AdditionalDataHolder, Parsable {
12728
12893
  */
12729
12894
  description?: string | null;
12730
12895
  /**
12731
- * The duration seconds value for this usage ledger.
12896
+ * Duration seconds for this usage ledger.
12732
12897
  */
12733
12898
  durationSeconds?: number | null;
12734
12899
  /**
12735
- * The unique ID for this usage ledger.
12900
+ * Unique Leadping identifier for this usage ledger.
12736
12901
  */
12737
12902
  id?: string | null;
12738
12903
  /**
@@ -12740,11 +12905,11 @@ export interface UsageLedgerTableRow extends AdditionalDataHolder, Parsable {
12740
12905
  */
12741
12906
  isBillable?: boolean | null;
12742
12907
  /**
12743
- * The ID and name for this lead.
12908
+ * Identifier and display name of the related lead.
12744
12909
  */
12745
12910
  lead?: UsageLedgerTableRow_lead | null;
12746
12911
  /**
12747
- * The ID and name for this organization.
12912
+ * Identifier and display name of the related organization.
12748
12913
  */
12749
12914
  organization?: UsageLedgerTableRow_organization | null;
12750
12915
  /**
@@ -12756,11 +12921,11 @@ export interface UsageLedgerTableRow extends AdditionalDataHolder, Parsable {
12756
12921
  */
12757
12922
  phoneNumberId?: string | null;
12758
12923
  /**
12759
- * The quantity value for this usage ledger.
12924
+ * Quantity for this usage ledger.
12760
12925
  */
12761
12926
  quantity?: number | null;
12762
12927
  /**
12763
- * The SMS segments value for this usage ledger.
12928
+ * SMS segments for this usage ledger.
12764
12929
  */
12765
12930
  smsSegments?: number | null;
12766
12931
  /**
@@ -12768,40 +12933,40 @@ export interface UsageLedgerTableRow extends AdditionalDataHolder, Parsable {
12768
12933
  */
12769
12934
  status?: UsageStatus | null;
12770
12935
  /**
12771
- * The unit price value for this usage ledger.
12936
+ * Unit price for this usage ledger.
12772
12937
  */
12773
12938
  unitPrice?: number | null;
12774
12939
  /**
12775
- * The ID and name for this user.
12940
+ * Identifier and display name of the related user.
12776
12941
  */
12777
12942
  user?: UsageLedgerTableRow_user | null;
12778
12943
  }
12779
12944
  /**
12780
- * The ID and name for this lead.
12945
+ * Identifier and display name of the related lead.
12781
12946
  */
12782
12947
  export interface UsageLedgerTableRow_lead extends IdNamePair, Parsable {
12783
12948
  }
12784
12949
  /**
12785
- * The ID and name for this organization.
12950
+ * Identifier and display name of the related organization.
12786
12951
  */
12787
12952
  export interface UsageLedgerTableRow_organization extends IdNamePair, Parsable {
12788
12953
  }
12789
12954
  /**
12790
- * The ID and name for this user.
12955
+ * Identifier and display name of the related user.
12791
12956
  */
12792
12957
  export interface UsageLedgerTableRow_user extends IdNamePair, Parsable {
12793
12958
  }
12794
12959
  export type UsageStatus = (typeof UsageStatusObject)[keyof typeof UsageStatusObject];
12795
12960
  /**
12796
- * API DTO containing usage summary line data used by Leadping API contracts.
12961
+ * Describes usage summary line data used in Leadping API requests and responses.
12797
12962
  */
12798
12963
  export interface UsageSummaryLine extends AdditionalDataHolder, Parsable {
12799
12964
  /**
12800
- * The billable unit value for this usage summary line.
12965
+ * Billable unit for this usage summary line.
12801
12966
  */
12802
12967
  billableUnit?: BillableUnit | null;
12803
12968
  /**
12804
- * The channel value for this usage summary line.
12969
+ * Channel for this usage summary line.
12805
12970
  */
12806
12971
  channel?: UsageChannel | null;
12807
12972
  /**
@@ -12809,7 +12974,7 @@ export interface UsageSummaryLine extends AdditionalDataHolder, Parsable {
12809
12974
  */
12810
12975
  customerChargeAmount?: number | null;
12811
12976
  /**
12812
- * The quantity value for this usage summary line.
12977
+ * Quantity for this usage summary line.
12813
12978
  */
12814
12979
  quantity?: number | null;
12815
12980
  /**
@@ -12822,7 +12987,7 @@ export interface UsageSummaryLine extends AdditionalDataHolder, Parsable {
12822
12987
  status?: UsageStatus | null;
12823
12988
  }
12824
12989
  /**
12825
- * API DTO containing usage summary response data.
12990
+ * Describes usage summary response data used by Leadping.
12826
12991
  */
12827
12992
  export interface UsageSummaryResponse extends AdditionalDataHolder, Parsable {
12828
12993
  /**
@@ -12850,11 +13015,11 @@ export interface UsageSummaryResponse extends AdditionalDataHolder, Parsable {
12850
13015
  */
12851
13016
  pendingInvoiceCount?: number | null;
12852
13017
  /**
12853
- * The date and time for the period end value on this usage summary.
13018
+ * UTC timestamp for period end on this usage summary.
12854
13019
  */
12855
13020
  periodEnd?: Date | null;
12856
13021
  /**
12857
- * The date and time for the period start value on this usage summary.
13022
+ * UTC timestamp for period start on this usage summary.
12858
13023
  */
12859
13024
  periodStart?: Date | null;
12860
13025
  /**
@@ -12863,7 +13028,7 @@ export interface UsageSummaryResponse extends AdditionalDataHolder, Parsable {
12863
13028
  transactionCount?: number | null;
12864
13029
  }
12865
13030
  /**
12866
- * API DTO containing user compliance data used by Leadping API contracts.
13031
+ * Describes user compliance data used in Leadping API requests and responses.
12867
13032
  */
12868
13033
  export interface UserCompliance extends AdditionalDataHolder, Parsable {
12869
13034
  /**
@@ -12965,7 +13130,7 @@ export interface UserDataExportResponse extends AdditionalDataHolder, Parsable {
12965
13130
  */
12966
13131
  requestedAt?: Date | null;
12967
13132
  /**
12968
- * File size in bytes.
13133
+ * Size of the generated export archive in bytes, when the export is ready.
12969
13134
  */
12970
13135
  sizeBytes?: number | null;
12971
13136
  /**
@@ -12983,20 +13148,20 @@ export type UserDataExportStatuses = (typeof UserDataExportStatusesObject)[keyof
12983
13148
  */
12984
13149
  export interface UserIdentity extends AdditionalDataHolder, Parsable {
12985
13150
  /**
12986
- * Gets or sets the identity provider that issued the sign-in identity (e.g., "contoso.com" or "facebook.com").
13151
+ * Identity provider or tenant that issued the user's sign-in identity.
12987
13152
  */
12988
13153
  issuer?: string | null;
12989
13154
  /**
12990
- * Gets or sets the unique identifier assigned to the user by the identity provider.
13155
+ * Unique user identifier assigned by the identity provider.
12991
13156
  */
12992
13157
  issuerAssignedId?: string | null;
12993
13158
  /**
12994
- * Gets or sets the method of sign-in used by the identity (e.g., "emailAddress", "userName", or "federated").
13159
+ * Sign-in method represented by the identity, such as email address, username, or federated login.
12995
13160
  */
12996
13161
  signInType?: string | null;
12997
13162
  }
12998
13163
  /**
12999
- * API DTO containing user notification preferences data used by Leadping API contracts.
13164
+ * Describes user notification preferences data used in Leadping API requests and responses.
13000
13165
  */
13001
13166
  export interface UserNotificationPreferences extends AdditionalDataHolder, Parsable {
13002
13167
  /**
@@ -13114,7 +13279,7 @@ export interface UserNotificationPreferences extends AdditionalDataHolder, Parsa
13114
13279
  export interface UserNotificationPreferences_smsConsentTrustedFormCertificate extends Parsable, TrustedFormCertificate {
13115
13280
  }
13116
13281
  /**
13117
- * Request schema for the Leadping API user profile request, including the fields clients can send.
13282
+ * Defines the fields clients can send when working with user profile.
13118
13283
  */
13119
13284
  export interface UserRequest extends AdditionalDataHolder, Parsable {
13120
13285
  /**
@@ -13183,7 +13348,7 @@ export interface UserRequest_currentOrganization extends IdNamePair, Parsable {
13183
13348
  export interface UserRequest_notificationPreferences extends Parsable, UserNotificationPreferences {
13184
13349
  }
13185
13350
  /**
13186
- * API response containing user data returned to callers.
13351
+ * Describes user data returned by Leadping.
13187
13352
  */
13188
13353
  export interface UserResponse extends AdditionalDataHolder, Parsable {
13189
13354
  /**
@@ -13195,7 +13360,7 @@ export interface UserResponse extends AdditionalDataHolder, Parsable {
13195
13360
  */
13196
13361
  billingState?: UserResponse_billingState | null;
13197
13362
  /**
13198
- * The compliance value for this user.
13363
+ * Compliance for this user.
13199
13364
  */
13200
13365
  compliance?: UserResponse_compliance | null;
13201
13366
  /**
@@ -13203,7 +13368,7 @@ export interface UserResponse extends AdditionalDataHolder, Parsable {
13203
13368
  */
13204
13369
  createdAt?: Date | null;
13205
13370
  /**
13206
- * The current organization value for this user.
13371
+ * Current organization for this user.
13207
13372
  */
13208
13373
  currentOrganization?: UserResponse_currentOrganization | null;
13209
13374
  /**
@@ -13211,7 +13376,7 @@ export interface UserResponse extends AdditionalDataHolder, Parsable {
13211
13376
  */
13212
13377
  email?: string | null;
13213
13378
  /**
13214
- * The first name value for this user.
13379
+ * First name for this user.
13215
13380
  */
13216
13381
  firstName?: string | null;
13217
13382
  /**
@@ -13227,7 +13392,7 @@ export interface UserResponse extends AdditionalDataHolder, Parsable {
13227
13392
  */
13228
13393
  lastLoggedInAt?: Date | null;
13229
13394
  /**
13230
- * The date and time for the last name value on this user.
13395
+ * UTC timestamp for last name on this user.
13231
13396
  */
13232
13397
  lastName?: string | null;
13233
13398
  /**
@@ -13243,11 +13408,11 @@ export interface UserResponse extends AdditionalDataHolder, Parsable {
13243
13408
  */
13244
13409
  name?: string | null;
13245
13410
  /**
13246
- * The notification preferences value for this user.
13411
+ * Notification preferences for this user.
13247
13412
  */
13248
13413
  notificationPreferences?: UserResponse_notificationPreferences | null;
13249
13414
  /**
13250
- * The date and time for the personal data deleted at value on this user.
13415
+ * UTC timestamp for personal data deleted at on this user.
13251
13416
  */
13252
13417
  personalDataDeletedAt?: Date | null;
13253
13418
  /**
@@ -13255,7 +13420,7 @@ export interface UserResponse extends AdditionalDataHolder, Parsable {
13255
13420
  */
13256
13421
  personalDataDeletionReason?: string | null;
13257
13422
  /**
13258
- * The date and time for the personal data deletion requested at value on this user.
13423
+ * UTC timestamp for personal data deletion requested at on this user.
13259
13424
  */
13260
13425
  personalDataDeletionRequestedAt?: Date | null;
13261
13426
  /**
@@ -13286,23 +13451,23 @@ export type UserResponse_billingPlan = (typeof UserResponse_billingPlanObject)[k
13286
13451
  export interface UserResponse_billingState extends OrganizationBillingState, Parsable {
13287
13452
  }
13288
13453
  /**
13289
- * The compliance value for this user.
13454
+ * Compliance for this user.
13290
13455
  */
13291
13456
  export interface UserResponse_compliance extends Parsable, UserCompliance {
13292
13457
  }
13293
13458
  /**
13294
- * The current organization value for this user.
13459
+ * Current organization for this user.
13295
13460
  */
13296
13461
  export interface UserResponse_currentOrganization extends IdNamePair, Parsable {
13297
13462
  }
13298
13463
  /**
13299
- * The notification preferences value for this user.
13464
+ * Notification preferences for this user.
13300
13465
  */
13301
13466
  export interface UserResponse_notificationPreferences extends Parsable, UserNotificationPreferences {
13302
13467
  }
13303
13468
  export type UserResponse_subscriptionStatus = (typeof UserResponse_subscriptionStatusObject)[keyof typeof UserResponse_subscriptionStatusObject];
13304
13469
  /**
13305
- * Response schema for the Leadping API billing wallet response returned to authenticated clients.
13470
+ * Describes billing wallet data returned by Leadping.
13306
13471
  */
13307
13472
  export interface WalletResponse extends AdditionalDataHolder, Parsable {
13308
13473
  /**
@@ -14212,6 +14377,21 @@ export declare const PhoneCallStatusObject: {
14212
14377
  readonly Blocked_permission: "blocked_permission";
14213
14378
  readonly Configuration_required: "configuration_required";
14214
14379
  };
14380
+ /**
14381
+ * Identifies the outcome of a phone identity lookup action.
14382
+ */
14383
+ export declare const PhoneIdentityLookupActionStatusObject: {
14384
+ readonly Succeeded: "succeeded";
14385
+ readonly Failed: "failed";
14386
+ };
14387
+ /**
14388
+ * Identifies the kind of lookup action performed for a phone identity.
14389
+ */
14390
+ export declare const PhoneIdentityLookupActionTypeObject: {
14391
+ readonly Validation: "validation";
14392
+ readonly Enrichment: "enrichment";
14393
+ readonly UnwantedNumberCheck: "unwanted-number-check";
14394
+ };
14215
14395
  /**
14216
14396
  * An enumerator describing phone line types
14217
14397
  */