@leadping/sdk 1.0.32 → 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.
- package/dist/analytics/my/index.d.ts +9 -0
- package/dist/analytics/my/index.d.ts.map +1 -1
- package/dist/analytics/my/index.js.map +1 -1
- package/dist/automations/index.d.ts +2 -2
- package/dist/automations/item/index.d.ts +2 -2
- package/dist/automations/preview/index.d.ts +2 -2
- package/dist/contact/index.d.ts +2 -2
- package/dist/conversations/my/index.d.ts +3 -0
- package/dist/conversations/my/index.d.ts.map +1 -1
- package/dist/conversations/my/index.js.map +1 -1
- package/dist/events/all/my/index.d.ts +9 -0
- package/dist/events/all/my/index.d.ts.map +1 -1
- package/dist/events/all/my/index.js.map +1 -1
- package/dist/events/conversations/item/notes/index.d.ts +2 -2
- package/dist/events/organizations/item/index.d.ts +6 -0
- package/dist/events/organizations/item/index.d.ts.map +1 -1
- package/dist/events/organizations/item/index.js.map +1 -1
- package/dist/feedback/index.d.ts +2 -2
- package/dist/leadStatusChanges/all/my/index.d.ts +2 -2
- package/dist/leadStatuses/index.d.ts +1 -1
- package/dist/leads/all/my/index.d.ts +12 -0
- package/dist/leads/all/my/index.d.ts.map +1 -1
- package/dist/leads/all/my/index.js.map +1 -1
- package/dist/leads/index.d.ts +2 -2
- package/dist/leads/intake/index.d.ts +2 -2
- package/dist/leads/item/archive/index.d.ts +3 -3
- package/dist/leads/item/index.d.ts +2 -2
- package/dist/leads/item/tags/index.d.ts +5 -5
- package/dist/models/index.d.ts +456 -369
- package/dist/models/index.d.ts.map +1 -1
- package/dist/models/index.js +69 -2
- package/dist/models/index.js.map +1 -1
- package/dist/notifications/push/installations/current/index.d.ts +2 -2
- package/dist/notifications/push/installations/index.d.ts +1 -1
- package/dist/notifications/push/installations/item/index.d.ts +2 -2
- package/dist/organizations/invitations/accept/index.d.ts +2 -2
- package/dist/organizations/me/index.d.ts +4 -4
- package/dist/organizations/me/invitations/index.d.ts +2 -2
- package/dist/organizations/me/members/index.d.ts +2 -2
- package/dist/organizations/me/members/item/index.d.ts +2 -2
- package/dist/organizations/me/switchEscaped/index.d.ts +2 -2
- package/dist/paymentMethods/invoices/index.d.ts +1 -1
- package/dist/paymentMethods/invoices/item/pdfAccess/index.d.ts +3 -0
- package/dist/paymentMethods/invoices/item/pdfAccess/index.d.ts.map +1 -1
- package/dist/paymentMethods/invoices/item/pdfAccess/index.js.map +1 -1
- package/dist/phoneCall/initiate/index.d.ts +2 -2
- package/dist/phoneNumbers/index.d.ts +2 -2
- package/dist/phoneNumbers/isAvailableForPurchase/index.d.ts +2 -2
- package/dist/phoneNumbers/item/index.d.ts +2 -2
- package/dist/phoneNumbers/outgoing/conversation/item/index.d.ts +2 -2
- package/dist/phoneNumbers/outgoing/conversation/item/override/index.d.ts +2 -2
- package/dist/phoneNumbers/outgoing/manualOverride/index.d.ts +2 -2
- package/dist/phoneNumbers/outgoing/newEscaped/index.d.ts +2 -2
- package/dist/phoneNumbers/search/index.d.ts +2 -2
- package/dist/reports/exports/index.d.ts +1 -1
- package/dist/reports/exports/item/download/index.d.ts +3 -0
- package/dist/reports/exports/item/download/index.d.ts.map +1 -1
- package/dist/reports/exports/item/download/index.js.map +1 -1
- package/dist/sms/media/index.d.ts +2 -2
- package/dist/sms/send/index.d.ts +2 -2
- package/dist/sources/index.d.ts +2 -2
- package/dist/sources/item/index.d.ts +2 -2
- package/dist/suppressions/all/my/index.d.ts +2 -2
- package/dist/suppressions/check/index.d.ts +2 -2
- package/dist/suppressions/index.d.ts +3 -3
- package/dist/suppressions/item/index.d.ts +2 -2
- package/dist/suppressions/release/index.d.ts +2 -2
- package/dist/tags/index.d.ts +6 -3
- package/dist/tags/index.d.ts.map +1 -1
- package/dist/tags/index.js.map +1 -1
- package/dist/tags/item/index.d.ts +2 -2
- package/dist/transactions/all/my/index.d.ts +6 -0
- package/dist/transactions/all/my/index.d.ts.map +1 -1
- package/dist/transactions/all/my/index.js.map +1 -1
- package/dist/users/changeBillingPlan/index.d.ts +2 -2
- package/dist/users/compliance/index.d.ts +2 -2
- package/dist/users/me/index.d.ts +2 -2
- package/package.json +1 -1
package/dist/models/index.d.ts
CHANGED
|
@@ -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
|
-
*
|
|
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
|
-
*
|
|
11
|
+
* First name for this organization invitation.
|
|
12
12
|
*/
|
|
13
13
|
firstName?: string | null;
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
36
|
+
* Estimated annual cost for this activation domain option.
|
|
37
37
|
*/
|
|
38
38
|
estimatedAnnualCost?: number | null;
|
|
39
39
|
/**
|
|
40
|
-
*
|
|
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
|
-
*
|
|
48
|
+
* Trust concerns for this activation domain option.
|
|
49
49
|
*/
|
|
50
50
|
trustConcerns?: string | null;
|
|
51
51
|
/**
|
|
52
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
66
|
+
* Identifier and display name of the related actor.
|
|
67
67
|
*/
|
|
68
68
|
actor?: ActivationTimelineEvent_actor | null;
|
|
69
69
|
/**
|
|
70
|
-
*
|
|
70
|
+
* UTC timestamp for created at on this activation timeline event.
|
|
71
71
|
*/
|
|
72
72
|
createdAt?: Date | null;
|
|
73
73
|
/**
|
|
74
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
1198
|
+
* Defines the input used for change billing plan.
|
|
1199
1199
|
*/
|
|
1200
1200
|
export interface ChangeBillingPlanRequest extends AdditionalDataHolder, Parsable {
|
|
1201
1201
|
/**
|
|
1202
|
-
*
|
|
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
|
-
*
|
|
1211
|
+
* Defines the input used for compliance update.
|
|
1212
1212
|
*/
|
|
1213
1213
|
export interface ComplianceUpdateRequest extends AdditionalDataHolder, Parsable {
|
|
1214
1214
|
/**
|
|
1215
|
-
*
|
|
1215
|
+
* Compliance for this compliance update.
|
|
1216
1216
|
*/
|
|
1217
1217
|
compliance?: ComplianceUpdateRequest_compliance | null;
|
|
1218
1218
|
/**
|
|
1219
|
-
*
|
|
1219
|
+
* Source for this compliance update.
|
|
1220
1220
|
*/
|
|
1221
1221
|
source?: string | null;
|
|
1222
1222
|
}
|
|
1223
1223
|
/**
|
|
1224
|
-
*
|
|
1224
|
+
* Compliance for this compliance update.
|
|
1225
1225
|
*/
|
|
1226
1226
|
export interface ComplianceUpdateRequest_compliance extends Parsable, UserCompliance {
|
|
1227
1227
|
}
|
|
1228
1228
|
/**
|
|
1229
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
1978
|
+
* Defines the input used for create note.
|
|
1979
1979
|
*/
|
|
1980
1980
|
export interface CreateNoteRequest extends AdditionalDataHolder, Parsable {
|
|
1981
1981
|
/**
|
|
1982
|
-
*
|
|
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
|
|
@@ -4318,6 +4324,12 @@ export declare function deserializeIntoPhone(phone?: Partial<Phone> | undefined)
|
|
|
4318
4324
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
4319
4325
|
*/
|
|
4320
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>;
|
|
4321
4333
|
/**
|
|
4322
4334
|
* The deserialization information for the current model
|
|
4323
4335
|
* @param PhoneIdentityResponse The instance to deserialize into.
|
|
@@ -4955,7 +4967,7 @@ export declare function deserializeIntoUserResponse_notificationPreferences(user
|
|
|
4955
4967
|
*/
|
|
4956
4968
|
export declare function deserializeIntoWalletResponse(walletResponse?: Partial<WalletResponse> | undefined): Record<string, (node: ParseNode) => void>;
|
|
4957
4969
|
/**
|
|
4958
|
-
*
|
|
4970
|
+
* Describes a Leadping phone number that is eligible to send an outbound message or place a call.
|
|
4959
4971
|
*/
|
|
4960
4972
|
export interface EligibleOutgoingNumberResponse extends AdditionalDataHolder, Parsable {
|
|
4961
4973
|
/**
|
|
@@ -5017,7 +5029,7 @@ export interface EligibleOutgoingNumberResponse extends AdditionalDataHolder, Pa
|
|
|
5017
5029
|
}
|
|
5018
5030
|
export type EligibleOutgoingNumberResponse_healthStatus = (typeof EligibleOutgoingNumberResponse_healthStatusObject)[keyof typeof EligibleOutgoingNumberResponse_healthStatusObject];
|
|
5019
5031
|
/**
|
|
5020
|
-
*
|
|
5032
|
+
* Describes event detail data returned by Leadping.
|
|
5021
5033
|
*/
|
|
5022
5034
|
export interface EventDetailResponse extends AdditionalDataHolder, Parsable {
|
|
5023
5035
|
/**
|
|
@@ -5153,7 +5165,7 @@ export type EventDetailResponse_timelineType = (typeof EventDetailResponse_timel
|
|
|
5153
5165
|
export interface EventDetailResponse_user extends IdNamePair, Parsable {
|
|
5154
5166
|
}
|
|
5155
5167
|
/**
|
|
5156
|
-
*
|
|
5168
|
+
* Summarizes event timeline data in paginated and searchable results.
|
|
5157
5169
|
*/
|
|
5158
5170
|
export interface EventTableRow extends AdditionalDataHolder, Parsable {
|
|
5159
5171
|
/**
|
|
@@ -5363,7 +5375,7 @@ export interface ExactMatchFilter extends AdditionalDataHolder, Parsable {
|
|
|
5363
5375
|
value?: UntypedNode | null;
|
|
5364
5376
|
}
|
|
5365
5377
|
/**
|
|
5366
|
-
*
|
|
5378
|
+
* Defines the fields clients can send when working with feedback creation.
|
|
5367
5379
|
*/
|
|
5368
5380
|
export interface FeedbackCreateRequest extends AdditionalDataHolder, Parsable {
|
|
5369
5381
|
/**
|
|
@@ -5393,7 +5405,7 @@ export interface FeedbackCreateRequest extends AdditionalDataHolder, Parsable {
|
|
|
5393
5405
|
}
|
|
5394
5406
|
export type FeedbackCreateRequest_type = (typeof FeedbackCreateRequest_typeObject)[keyof typeof FeedbackCreateRequest_typeObject];
|
|
5395
5407
|
/**
|
|
5396
|
-
*
|
|
5408
|
+
* Describes feedback item data returned by Leadping.
|
|
5397
5409
|
*/
|
|
5398
5410
|
export interface FeedbackResponse extends AdditionalDataHolder, Parsable {
|
|
5399
5411
|
/**
|
|
@@ -5474,7 +5486,7 @@ export interface IdNameValue extends AdditionalDataHolder, Parsable {
|
|
|
5474
5486
|
value?: string | null;
|
|
5475
5487
|
}
|
|
5476
5488
|
/**
|
|
5477
|
-
*
|
|
5489
|
+
* Defines the fields clients can send when working with phone call initiation.
|
|
5478
5490
|
*/
|
|
5479
5491
|
export interface InitiateCallRequest extends AdditionalDataHolder, Parsable {
|
|
5480
5492
|
/**
|
|
@@ -5520,7 +5532,7 @@ export interface InvoicePdfAccessResponse extends AdditionalDataHolder, Parsable
|
|
|
5520
5532
|
url?: string | null;
|
|
5521
5533
|
}
|
|
5522
5534
|
/**
|
|
5523
|
-
*
|
|
5535
|
+
* Defines the fields clients can send when working with lead archive.
|
|
5524
5536
|
*/
|
|
5525
5537
|
export interface LeadArchiveRequest extends AdditionalDataHolder, Parsable {
|
|
5526
5538
|
/**
|
|
@@ -5537,7 +5549,7 @@ export interface LeadArchiveRequest extends AdditionalDataHolder, Parsable {
|
|
|
5537
5549
|
*/
|
|
5538
5550
|
export interface LeadContact extends AdditionalDataHolder, Parsable {
|
|
5539
5551
|
/**
|
|
5540
|
-
* Optional profile image URL for the contact. Clients fall back to
|
|
5552
|
+
* Optional profile image URL for the contact. Clients fall back to Gravatar and then initials when this value is not supplied.
|
|
5541
5553
|
*/
|
|
5542
5554
|
avatarUrl?: string | null;
|
|
5543
5555
|
/**
|
|
@@ -5585,7 +5597,7 @@ export interface LeadContact_phone extends Parsable, Phone {
|
|
|
5585
5597
|
export interface LeadContact_streetAddress extends Parsable, StreetAddress {
|
|
5586
5598
|
}
|
|
5587
5599
|
/**
|
|
5588
|
-
*
|
|
5600
|
+
* Defines the fields clients can send when working with lead intake.
|
|
5589
5601
|
*/
|
|
5590
5602
|
export interface LeadIntakeRequest extends AdditionalDataHolder, Parsable {
|
|
5591
5603
|
/**
|
|
@@ -5937,7 +5949,7 @@ export type LeadProfile_employmentType = (typeof LeadProfile_employmentTypeObjec
|
|
|
5937
5949
|
export type LeadProfile_gender = (typeof LeadProfile_genderObject)[keyof typeof LeadProfile_genderObject];
|
|
5938
5950
|
export type LeadProfile_maritalStatus = (typeof LeadProfile_maritalStatusObject)[keyof typeof LeadProfile_maritalStatusObject];
|
|
5939
5951
|
/**
|
|
5940
|
-
*
|
|
5952
|
+
* Defines the fields clients can send when working with lead.
|
|
5941
5953
|
*/
|
|
5942
5954
|
export interface LeadRequest extends AdditionalDataHolder, Parsable {
|
|
5943
5955
|
/**
|
|
@@ -5970,7 +5982,7 @@ export interface LeadRequest extends AdditionalDataHolder, Parsable {
|
|
|
5970
5982
|
tagNames?: string[] | null;
|
|
5971
5983
|
}
|
|
5972
5984
|
/**
|
|
5973
|
-
*
|
|
5985
|
+
* Describes lead data returned by Leadping.
|
|
5974
5986
|
*/
|
|
5975
5987
|
export interface LeadResponse extends AdditionalDataHolder, Parsable {
|
|
5976
5988
|
/**
|
|
@@ -6046,19 +6058,19 @@ export interface LeadResponse_phoneIdentity extends Parsable, PhoneIdentityRespo
|
|
|
6046
6058
|
}
|
|
6047
6059
|
export type LeadStatusCategory = (typeof LeadStatusCategoryObject)[keyof typeof LeadStatusCategoryObject];
|
|
6048
6060
|
/**
|
|
6049
|
-
*
|
|
6061
|
+
* Describes lead status change export data returned by Leadping.
|
|
6050
6062
|
*/
|
|
6051
6063
|
export interface LeadStatusChangeExportResponse extends AdditionalDataHolder, Parsable {
|
|
6052
6064
|
/**
|
|
6053
|
-
*
|
|
6065
|
+
* MIME content type of the exported document.
|
|
6054
6066
|
*/
|
|
6055
6067
|
contentType?: string | null;
|
|
6056
6068
|
/**
|
|
6057
|
-
*
|
|
6069
|
+
* Complete comma-separated values content encoded as text.
|
|
6058
6070
|
*/
|
|
6059
6071
|
csv?: string | null;
|
|
6060
6072
|
/**
|
|
6061
|
-
*
|
|
6073
|
+
* Suggested file name for the exported CSV document.
|
|
6062
6074
|
*/
|
|
6063
6075
|
fileName?: string | null;
|
|
6064
6076
|
/**
|
|
@@ -6067,15 +6079,15 @@ export interface LeadStatusChangeExportResponse extends AdditionalDataHolder, Pa
|
|
|
6067
6079
|
rows?: LeadStatusChangeExportRow[] | null;
|
|
6068
6080
|
}
|
|
6069
6081
|
/**
|
|
6070
|
-
*
|
|
6082
|
+
* Describes lead status change export row data returned by Leadping.
|
|
6071
6083
|
*/
|
|
6072
6084
|
export interface LeadStatusChangeExportRow extends AdditionalDataHolder, Parsable {
|
|
6073
6085
|
/**
|
|
6074
|
-
*
|
|
6086
|
+
* UTC timestamp for appointment end at on this lead status change export row.
|
|
6075
6087
|
*/
|
|
6076
6088
|
appointmentEndAt?: Date | null;
|
|
6077
6089
|
/**
|
|
6078
|
-
*
|
|
6090
|
+
* UTC timestamp for appointment start at on this lead status change export row.
|
|
6079
6091
|
*/
|
|
6080
6092
|
appointmentStartAt?: Date | null;
|
|
6081
6093
|
/**
|
|
@@ -6083,7 +6095,7 @@ export interface LeadStatusChangeExportRow extends AdditionalDataHolder, Parsabl
|
|
|
6083
6095
|
*/
|
|
6084
6096
|
assignedToUserId?: string | null;
|
|
6085
6097
|
/**
|
|
6086
|
-
*
|
|
6098
|
+
* UTC timestamp for callback at on this lead status change export row.
|
|
6087
6099
|
*/
|
|
6088
6100
|
callbackAt?: Date | null;
|
|
6089
6101
|
/**
|
|
@@ -6107,7 +6119,7 @@ export interface LeadStatusChangeExportRow extends AdditionalDataHolder, Parsabl
|
|
|
6107
6119
|
*/
|
|
6108
6120
|
changeSource?: LeadStatusChangeExportRow_changeSource | null;
|
|
6109
6121
|
/**
|
|
6110
|
-
*
|
|
6122
|
+
* UTC timestamp for created at on this lead status change export row.
|
|
6111
6123
|
*/
|
|
6112
6124
|
createdAt?: Date | null;
|
|
6113
6125
|
/**
|
|
@@ -6147,7 +6159,7 @@ export interface LeadStatusChangeExportRow extends AdditionalDataHolder, Parsabl
|
|
|
6147
6159
|
*/
|
|
6148
6160
|
oldLeadStatusChangeType?: string | null;
|
|
6149
6161
|
/**
|
|
6150
|
-
*
|
|
6162
|
+
* Result of the interaction or workflow step represented by this exported row.
|
|
6151
6163
|
*/
|
|
6152
6164
|
outcome?: string | null;
|
|
6153
6165
|
/**
|
|
@@ -6163,15 +6175,15 @@ export interface LeadStatusChangeExportRow extends AdditionalDataHolder, Parsabl
|
|
|
6163
6175
|
*/
|
|
6164
6176
|
sourceId?: string | null;
|
|
6165
6177
|
/**
|
|
6166
|
-
*
|
|
6178
|
+
* UTC timestamp for task due at on this lead status change export row.
|
|
6167
6179
|
*/
|
|
6168
6180
|
taskDueAt?: Date | null;
|
|
6169
6181
|
/**
|
|
6170
|
-
*
|
|
6182
|
+
* Category of status change represented by this exported row.
|
|
6171
6183
|
*/
|
|
6172
6184
|
type?: string | null;
|
|
6173
6185
|
/**
|
|
6174
|
-
*
|
|
6186
|
+
* UTC timestamp for updated at on this lead status change export row.
|
|
6175
6187
|
*/
|
|
6176
6188
|
updatedAt?: Date | null;
|
|
6177
6189
|
}
|
|
@@ -6182,15 +6194,15 @@ export type LeadStatusChangeExportRow_changeSource = (typeof LeadStatusChangeExp
|
|
|
6182
6194
|
*/
|
|
6183
6195
|
export interface LeadStatusChangeRequest extends AdditionalDataHolder, Parsable {
|
|
6184
6196
|
/**
|
|
6185
|
-
*
|
|
6197
|
+
* UTC timestamp for appointment end at on this lead status change.
|
|
6186
6198
|
*/
|
|
6187
6199
|
appointmentEndAt?: Date | null;
|
|
6188
6200
|
/**
|
|
6189
|
-
*
|
|
6201
|
+
* Additional scheduling or preparation notes for the related appointment.
|
|
6190
6202
|
*/
|
|
6191
6203
|
appointmentNotes?: string | null;
|
|
6192
6204
|
/**
|
|
6193
|
-
*
|
|
6205
|
+
* UTC timestamp for appointment start at on this lead status change.
|
|
6194
6206
|
*/
|
|
6195
6207
|
appointmentStartAt?: Date | null;
|
|
6196
6208
|
/**
|
|
@@ -6198,7 +6210,7 @@ export interface LeadStatusChangeRequest extends AdditionalDataHolder, Parsable
|
|
|
6198
6210
|
*/
|
|
6199
6211
|
assignedToUserId?: string | null;
|
|
6200
6212
|
/**
|
|
6201
|
-
*
|
|
6213
|
+
* UTC timestamp for callback at on this lead status change.
|
|
6202
6214
|
*/
|
|
6203
6215
|
callbackAt?: Date | null;
|
|
6204
6216
|
/**
|
|
@@ -6226,7 +6238,7 @@ export interface LeadStatusChangeRequest extends AdditionalDataHolder, Parsable
|
|
|
6226
6238
|
*/
|
|
6227
6239
|
notes?: string | null;
|
|
6228
6240
|
/**
|
|
6229
|
-
*
|
|
6241
|
+
* Result of the interaction or workflow step that caused the status change.
|
|
6230
6242
|
*/
|
|
6231
6243
|
outcome?: string | null;
|
|
6232
6244
|
/**
|
|
@@ -6242,15 +6254,15 @@ export interface LeadStatusChangeRequest extends AdditionalDataHolder, Parsable
|
|
|
6242
6254
|
*/
|
|
6243
6255
|
sourceId?: string | null;
|
|
6244
6256
|
/**
|
|
6245
|
-
*
|
|
6257
|
+
* UTC timestamp for task due at on this lead status change.
|
|
6246
6258
|
*/
|
|
6247
6259
|
taskDueAt?: Date | null;
|
|
6248
6260
|
/**
|
|
6249
|
-
*
|
|
6261
|
+
* UTC timestamp for timestamp on this lead status change.
|
|
6250
6262
|
*/
|
|
6251
6263
|
timestamp?: Date | null;
|
|
6252
6264
|
/**
|
|
6253
|
-
*
|
|
6265
|
+
* Category of status change being recorded for the lead.
|
|
6254
6266
|
*/
|
|
6255
6267
|
type?: string | null;
|
|
6256
6268
|
}
|
|
@@ -6261,15 +6273,15 @@ export type LeadStatusChangeRequest_changeSource = (typeof LeadStatusChangeReque
|
|
|
6261
6273
|
*/
|
|
6262
6274
|
export interface LeadStatusChangeResponse extends AdditionalDataHolder, Parsable {
|
|
6263
6275
|
/**
|
|
6264
|
-
*
|
|
6276
|
+
* UTC timestamp for appointment end at on this lead status change.
|
|
6265
6277
|
*/
|
|
6266
6278
|
appointmentEndAt?: Date | null;
|
|
6267
6279
|
/**
|
|
6268
|
-
*
|
|
6280
|
+
* Additional scheduling or preparation notes for the related appointment.
|
|
6269
6281
|
*/
|
|
6270
6282
|
appointmentNotes?: string | null;
|
|
6271
6283
|
/**
|
|
6272
|
-
*
|
|
6284
|
+
* UTC timestamp for appointment start at on this lead status change.
|
|
6273
6285
|
*/
|
|
6274
6286
|
appointmentStartAt?: Date | null;
|
|
6275
6287
|
/**
|
|
@@ -6277,7 +6289,7 @@ export interface LeadStatusChangeResponse extends AdditionalDataHolder, Parsable
|
|
|
6277
6289
|
*/
|
|
6278
6290
|
assignedToUserId?: string | null;
|
|
6279
6291
|
/**
|
|
6280
|
-
*
|
|
6292
|
+
* UTC timestamp for callback at on this lead status change.
|
|
6281
6293
|
*/
|
|
6282
6294
|
callbackAt?: Date | null;
|
|
6283
6295
|
/**
|
|
@@ -6301,7 +6313,7 @@ export interface LeadStatusChangeResponse extends AdditionalDataHolder, Parsable
|
|
|
6301
6313
|
*/
|
|
6302
6314
|
changeSource?: LeadStatusChangeResponse_changeSource | null;
|
|
6303
6315
|
/**
|
|
6304
|
-
*
|
|
6316
|
+
* UTC timestamp for created at on this lead status change.
|
|
6305
6317
|
*/
|
|
6306
6318
|
createdAt?: Date | null;
|
|
6307
6319
|
/**
|
|
@@ -6309,7 +6321,7 @@ export interface LeadStatusChangeResponse extends AdditionalDataHolder, Parsable
|
|
|
6309
6321
|
*/
|
|
6310
6322
|
followUpStatus?: string | null;
|
|
6311
6323
|
/**
|
|
6312
|
-
*
|
|
6324
|
+
* Unique Leadping identifier for this lead status change.
|
|
6313
6325
|
*/
|
|
6314
6326
|
id?: string | null;
|
|
6315
6327
|
/**
|
|
@@ -6345,7 +6357,7 @@ export interface LeadStatusChangeResponse extends AdditionalDataHolder, Parsable
|
|
|
6345
6357
|
*/
|
|
6346
6358
|
oldLeadStatusChangeType?: string | null;
|
|
6347
6359
|
/**
|
|
6348
|
-
*
|
|
6360
|
+
* Result of the interaction or workflow step that caused the status change.
|
|
6349
6361
|
*/
|
|
6350
6362
|
outcome?: string | null;
|
|
6351
6363
|
/**
|
|
@@ -6361,19 +6373,19 @@ export interface LeadStatusChangeResponse extends AdditionalDataHolder, Parsable
|
|
|
6361
6373
|
*/
|
|
6362
6374
|
sourceId?: string | null;
|
|
6363
6375
|
/**
|
|
6364
|
-
*
|
|
6376
|
+
* UTC timestamp for task due at on this lead status change.
|
|
6365
6377
|
*/
|
|
6366
6378
|
taskDueAt?: Date | null;
|
|
6367
6379
|
/**
|
|
6368
|
-
*
|
|
6380
|
+
* UTC timestamp for timestamp on this lead status change.
|
|
6369
6381
|
*/
|
|
6370
6382
|
timestamp?: Date | null;
|
|
6371
6383
|
/**
|
|
6372
|
-
*
|
|
6384
|
+
* Category of status change recorded for the lead.
|
|
6373
6385
|
*/
|
|
6374
6386
|
type?: string | null;
|
|
6375
6387
|
/**
|
|
6376
|
-
*
|
|
6388
|
+
* UTC timestamp for updated at on this lead status change.
|
|
6377
6389
|
*/
|
|
6378
6390
|
updatedAt?: Date | null;
|
|
6379
6391
|
}
|
|
@@ -6439,7 +6451,7 @@ export interface LeadStatusResponse extends AdditionalDataHolder, Parsable {
|
|
|
6439
6451
|
sortOrder?: number | null;
|
|
6440
6452
|
}
|
|
6441
6453
|
/**
|
|
6442
|
-
*
|
|
6454
|
+
* Summarizes lead data in paginated and searchable results.
|
|
6443
6455
|
*/
|
|
6444
6456
|
export interface LeadTableRow extends AdditionalDataHolder, Parsable {
|
|
6445
6457
|
/**
|
|
@@ -6487,7 +6499,7 @@ export interface LeadTableRow extends AdditionalDataHolder, Parsable {
|
|
|
6487
6499
|
*/
|
|
6488
6500
|
lastName?: string | null;
|
|
6489
6501
|
/**
|
|
6490
|
-
*
|
|
6502
|
+
* Identifier and display name of the related organization.
|
|
6491
6503
|
*/
|
|
6492
6504
|
organization?: LeadTableRow_organization | null;
|
|
6493
6505
|
/**
|
|
@@ -6499,7 +6511,7 @@ export interface LeadTableRow extends AdditionalDataHolder, Parsable {
|
|
|
6499
6511
|
*/
|
|
6500
6512
|
price?: number | null;
|
|
6501
6513
|
/**
|
|
6502
|
-
*
|
|
6514
|
+
* Identifier and display name of the related source.
|
|
6503
6515
|
*/
|
|
6504
6516
|
source?: LeadTableRow_source | null;
|
|
6505
6517
|
/**
|
|
@@ -6525,17 +6537,17 @@ export interface LeadTableRow extends AdditionalDataHolder, Parsable {
|
|
|
6525
6537
|
export interface LeadTableRow_currentLeadStatus extends CurrentLeadStatusSummary, Parsable {
|
|
6526
6538
|
}
|
|
6527
6539
|
/**
|
|
6528
|
-
*
|
|
6540
|
+
* Identifier and display name of the related organization.
|
|
6529
6541
|
*/
|
|
6530
6542
|
export interface LeadTableRow_organization extends IdNamePair, Parsable {
|
|
6531
6543
|
}
|
|
6532
6544
|
/**
|
|
6533
|
-
*
|
|
6545
|
+
* Identifier and display name of the related source.
|
|
6534
6546
|
*/
|
|
6535
6547
|
export interface LeadTableRow_source extends IdNamePair, Parsable {
|
|
6536
6548
|
}
|
|
6537
6549
|
/**
|
|
6538
|
-
*
|
|
6550
|
+
* Defines the fields clients can send when working with lead tag update.
|
|
6539
6551
|
*/
|
|
6540
6552
|
export interface LeadTagsRequest extends AdditionalDataHolder, Parsable {
|
|
6541
6553
|
/**
|
|
@@ -6577,11 +6589,11 @@ export interface MessageMediaAttachment extends AdditionalDataHolder, Parsable {
|
|
|
6577
6589
|
url?: string | null;
|
|
6578
6590
|
}
|
|
6579
6591
|
/**
|
|
6580
|
-
*
|
|
6592
|
+
* Describes notification and calling preferences saved for one of the user's mobile devices.
|
|
6581
6593
|
*/
|
|
6582
6594
|
export interface MobileDevicePreferences extends AdditionalDataHolder, Parsable {
|
|
6583
6595
|
/**
|
|
6584
|
-
*
|
|
6596
|
+
* Identifier and display name of the related device.
|
|
6585
6597
|
*/
|
|
6586
6598
|
device?: IdNamePair | null;
|
|
6587
6599
|
/**
|
|
@@ -6595,11 +6607,11 @@ export interface MobileDevicePreferences extends AdditionalDataHolder, Parsable
|
|
|
6595
6607
|
}
|
|
6596
6608
|
export type NotificationPriority = (typeof NotificationPriorityObject)[keyof typeof NotificationPriorityObject];
|
|
6597
6609
|
/**
|
|
6598
|
-
*
|
|
6610
|
+
* Describes notification data used in Leadping API requests and responses.
|
|
6599
6611
|
*/
|
|
6600
6612
|
export interface NotificationResponse extends AdditionalDataHolder, Parsable {
|
|
6601
6613
|
/**
|
|
6602
|
-
*
|
|
6614
|
+
* Action button text for this notification.
|
|
6603
6615
|
*/
|
|
6604
6616
|
actionButtonText?: string | null;
|
|
6605
6617
|
/**
|
|
@@ -6611,7 +6623,7 @@ export interface NotificationResponse extends AdditionalDataHolder, Parsable {
|
|
|
6611
6623
|
*/
|
|
6612
6624
|
createdAt?: Date | null;
|
|
6613
6625
|
/**
|
|
6614
|
-
*
|
|
6626
|
+
* Optional supporting details displayed beneath the notification message.
|
|
6615
6627
|
*/
|
|
6616
6628
|
details?: string | null;
|
|
6617
6629
|
/**
|
|
@@ -6623,7 +6635,7 @@ export interface NotificationResponse extends AdditionalDataHolder, Parsable {
|
|
|
6623
6635
|
*/
|
|
6624
6636
|
isRead?: boolean | null;
|
|
6625
6637
|
/**
|
|
6626
|
-
*
|
|
6638
|
+
* Message for this notification.
|
|
6627
6639
|
*/
|
|
6628
6640
|
message?: string | null;
|
|
6629
6641
|
/**
|
|
@@ -6635,7 +6647,7 @@ export interface NotificationResponse extends AdditionalDataHolder, Parsable {
|
|
|
6635
6647
|
*/
|
|
6636
6648
|
name?: string | null;
|
|
6637
6649
|
/**
|
|
6638
|
-
*
|
|
6650
|
+
* Priority for this notification.
|
|
6639
6651
|
*/
|
|
6640
6652
|
priority?: NotificationPriority | null;
|
|
6641
6653
|
/**
|
|
@@ -6643,7 +6655,7 @@ export interface NotificationResponse extends AdditionalDataHolder, Parsable {
|
|
|
6643
6655
|
*/
|
|
6644
6656
|
pushEnabled?: boolean | null;
|
|
6645
6657
|
/**
|
|
6646
|
-
*
|
|
6658
|
+
* UTC timestamp for read at on this notification.
|
|
6647
6659
|
*/
|
|
6648
6660
|
readAt?: Date | null;
|
|
6649
6661
|
/**
|
|
@@ -6664,11 +6676,11 @@ export interface NotificationResponse extends AdditionalDataHolder, Parsable {
|
|
|
6664
6676
|
userId?: string | null;
|
|
6665
6677
|
}
|
|
6666
6678
|
/**
|
|
6667
|
-
*
|
|
6679
|
+
* Describes notification data returned by Leadping.
|
|
6668
6680
|
*/
|
|
6669
6681
|
export interface NotificationTableRow extends AdditionalDataHolder, Parsable {
|
|
6670
6682
|
/**
|
|
6671
|
-
*
|
|
6683
|
+
* Action button text for this notification.
|
|
6672
6684
|
*/
|
|
6673
6685
|
actionButtonText?: string | null;
|
|
6674
6686
|
/**
|
|
@@ -6680,7 +6692,7 @@ export interface NotificationTableRow extends AdditionalDataHolder, Parsable {
|
|
|
6680
6692
|
*/
|
|
6681
6693
|
createdAt?: Date | null;
|
|
6682
6694
|
/**
|
|
6683
|
-
*
|
|
6695
|
+
* Optional supporting details displayed beneath the notification message.
|
|
6684
6696
|
*/
|
|
6685
6697
|
details?: string | null;
|
|
6686
6698
|
/**
|
|
@@ -6692,7 +6704,7 @@ export interface NotificationTableRow extends AdditionalDataHolder, Parsable {
|
|
|
6692
6704
|
*/
|
|
6693
6705
|
isRead?: boolean | null;
|
|
6694
6706
|
/**
|
|
6695
|
-
*
|
|
6707
|
+
* Message for this notification.
|
|
6696
6708
|
*/
|
|
6697
6709
|
message?: string | null;
|
|
6698
6710
|
/**
|
|
@@ -6704,11 +6716,11 @@ export interface NotificationTableRow extends AdditionalDataHolder, Parsable {
|
|
|
6704
6716
|
*/
|
|
6705
6717
|
name?: string | null;
|
|
6706
6718
|
/**
|
|
6707
|
-
*
|
|
6719
|
+
* Priority for this notification.
|
|
6708
6720
|
*/
|
|
6709
6721
|
priority?: NotificationPriority | null;
|
|
6710
6722
|
/**
|
|
6711
|
-
*
|
|
6723
|
+
* UTC timestamp for read at on this notification.
|
|
6712
6724
|
*/
|
|
6713
6725
|
readAt?: Date | null;
|
|
6714
6726
|
/**
|
|
@@ -6740,11 +6752,11 @@ export interface OrderByOption extends AdditionalDataHolder, Parsable {
|
|
|
6740
6752
|
}
|
|
6741
6753
|
export type OrderByOption_direction = (typeof OrderByOption_directionObject)[keyof typeof OrderByOption_directionObject];
|
|
6742
6754
|
/**
|
|
6743
|
-
*
|
|
6755
|
+
* Describes organization activation state data used in Leadping API requests and responses.
|
|
6744
6756
|
*/
|
|
6745
6757
|
export interface OrganizationActivationState extends AdditionalDataHolder, Parsable {
|
|
6746
6758
|
/**
|
|
6747
|
-
*
|
|
6759
|
+
* UTC timestamp for activated at on this organization activation state.
|
|
6748
6760
|
*/
|
|
6749
6761
|
activatedAt?: Date | null;
|
|
6750
6762
|
/**
|
|
@@ -6756,7 +6768,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
|
|
|
6756
6768
|
*/
|
|
6757
6769
|
billingSubscriptionStatus?: ActivationSubscriptionStatus | null;
|
|
6758
6770
|
/**
|
|
6759
|
-
*
|
|
6771
|
+
* Compliance notes for this organization activation state.
|
|
6760
6772
|
*/
|
|
6761
6773
|
complianceNotes?: string | null;
|
|
6762
6774
|
/**
|
|
@@ -6764,7 +6776,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
|
|
|
6764
6776
|
*/
|
|
6765
6777
|
controlledLaunch?: boolean | null;
|
|
6766
6778
|
/**
|
|
6767
|
-
*
|
|
6779
|
+
* UTC timestamp for created at on this organization activation state.
|
|
6768
6780
|
*/
|
|
6769
6781
|
createdAt?: Date | null;
|
|
6770
6782
|
/**
|
|
@@ -6772,7 +6784,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
|
|
|
6772
6784
|
*/
|
|
6773
6785
|
customerFacingStatus?: string | null;
|
|
6774
6786
|
/**
|
|
6775
|
-
*
|
|
6787
|
+
* UTC timestamp for domain approved at on this organization activation state.
|
|
6776
6788
|
*/
|
|
6777
6789
|
domainApprovedAt?: Date | null;
|
|
6778
6790
|
/**
|
|
@@ -6804,19 +6816,19 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
|
|
|
6804
6816
|
*/
|
|
6805
6817
|
events?: ActivationTimelineEvent[] | null;
|
|
6806
6818
|
/**
|
|
6807
|
-
*
|
|
6819
|
+
* UTC timestamp for failed at on this organization activation state.
|
|
6808
6820
|
*/
|
|
6809
6821
|
failedAt?: Date | null;
|
|
6810
6822
|
/**
|
|
6811
|
-
*
|
|
6823
|
+
* Industry for this organization activation state.
|
|
6812
6824
|
*/
|
|
6813
6825
|
industry?: string | null;
|
|
6814
6826
|
/**
|
|
6815
|
-
*
|
|
6827
|
+
* UTC timestamp for launch approved at on this organization activation state.
|
|
6816
6828
|
*/
|
|
6817
6829
|
launchApprovedAt?: Date | null;
|
|
6818
6830
|
/**
|
|
6819
|
-
*
|
|
6831
|
+
* UTC timestamp for launch review requested at on this organization activation state.
|
|
6820
6832
|
*/
|
|
6821
6833
|
launchReviewRequestedAt?: Date | null;
|
|
6822
6834
|
/**
|
|
@@ -6824,7 +6836,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
|
|
|
6824
6836
|
*/
|
|
6825
6837
|
launchReviewStatus?: ActivationLaunchReviewStatus | null;
|
|
6826
6838
|
/**
|
|
6827
|
-
*
|
|
6839
|
+
* Offer for this organization activation state.
|
|
6828
6840
|
*/
|
|
6829
6841
|
offer?: string | null;
|
|
6830
6842
|
/**
|
|
@@ -6832,11 +6844,11 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
|
|
|
6832
6844
|
*/
|
|
6833
6845
|
onboardingStatus?: ActivationOnboardingStatus | null;
|
|
6834
6846
|
/**
|
|
6835
|
-
*
|
|
6847
|
+
* Organization description for this organization activation state.
|
|
6836
6848
|
*/
|
|
6837
6849
|
organizationDescription?: string | null;
|
|
6838
6850
|
/**
|
|
6839
|
-
*
|
|
6851
|
+
* UTC timestamp for payment method confirmed at on this organization activation state.
|
|
6840
6852
|
*/
|
|
6841
6853
|
paymentMethodConfirmedAt?: Date | null;
|
|
6842
6854
|
/**
|
|
@@ -6844,11 +6856,11 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
|
|
|
6844
6856
|
*/
|
|
6845
6857
|
paymentStatus?: ActivationPaymentStatus | null;
|
|
6846
6858
|
/**
|
|
6847
|
-
*
|
|
6859
|
+
* Selected domain for this organization activation state.
|
|
6848
6860
|
*/
|
|
6849
6861
|
selectedDomain?: string | null;
|
|
6850
6862
|
/**
|
|
6851
|
-
*
|
|
6863
|
+
* Service area for this organization activation state.
|
|
6852
6864
|
*/
|
|
6853
6865
|
serviceArea?: string | null;
|
|
6854
6866
|
/**
|
|
@@ -6856,27 +6868,27 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
|
|
|
6856
6868
|
*/
|
|
6857
6869
|
status?: CustomerActivationStatus | null;
|
|
6858
6870
|
/**
|
|
6859
|
-
*
|
|
6871
|
+
* UTC timestamp for subscription active at on this organization activation state.
|
|
6860
6872
|
*/
|
|
6861
6873
|
subscriptionActiveAt?: Date | null;
|
|
6862
6874
|
/**
|
|
6863
|
-
*
|
|
6875
|
+
* UTC timestamp for subscription pending at on this organization activation state.
|
|
6864
6876
|
*/
|
|
6865
6877
|
subscriptionPendingAt?: Date | null;
|
|
6866
6878
|
/**
|
|
6867
|
-
*
|
|
6879
|
+
* Target audience for this organization activation state.
|
|
6868
6880
|
*/
|
|
6869
6881
|
targetAudience?: string | null;
|
|
6870
6882
|
/**
|
|
6871
|
-
*
|
|
6883
|
+
* UTC timestamp for telephony partially provisioned at on this organization activation state.
|
|
6872
6884
|
*/
|
|
6873
6885
|
telephonyPartiallyProvisionedAt?: Date | null;
|
|
6874
6886
|
/**
|
|
6875
|
-
*
|
|
6887
|
+
* UTC timestamp for telephony provisioning started at on this organization activation state.
|
|
6876
6888
|
*/
|
|
6877
6889
|
telephonyProvisioningStartedAt?: Date | null;
|
|
6878
6890
|
/**
|
|
6879
|
-
*
|
|
6891
|
+
* UTC timestamp for telephony ready at on this organization activation state.
|
|
6880
6892
|
*/
|
|
6881
6893
|
telephonyReadyAt?: Date | null;
|
|
6882
6894
|
/**
|
|
@@ -6888,7 +6900,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
|
|
|
6888
6900
|
*/
|
|
6889
6901
|
tenDlcApplicationId?: string | null;
|
|
6890
6902
|
/**
|
|
6891
|
-
*
|
|
6903
|
+
* 10DLC draft for this organization activation state.
|
|
6892
6904
|
*/
|
|
6893
6905
|
tenDlcDraft?: OrganizationActivationState_tenDlcDraft | null;
|
|
6894
6906
|
/**
|
|
@@ -6896,7 +6908,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
|
|
|
6896
6908
|
*/
|
|
6897
6909
|
tenDlcStatus?: TenDlcApplicationStatus | null;
|
|
6898
6910
|
/**
|
|
6899
|
-
*
|
|
6911
|
+
* UTC timestamp for updated at on this organization activation state.
|
|
6900
6912
|
*/
|
|
6901
6913
|
updatedAt?: Date | null;
|
|
6902
6914
|
/**
|
|
@@ -6904,7 +6916,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
|
|
|
6904
6916
|
*/
|
|
6905
6917
|
websiteGenerationResult?: string | null;
|
|
6906
6918
|
/**
|
|
6907
|
-
*
|
|
6919
|
+
* Website needs for this organization activation state.
|
|
6908
6920
|
*/
|
|
6909
6921
|
websiteNeeds?: string | null;
|
|
6910
6922
|
/**
|
|
@@ -6918,7 +6930,7 @@ export interface OrganizationActivationState extends AdditionalDataHolder, Parsa
|
|
|
6918
6930
|
}
|
|
6919
6931
|
export type OrganizationActivationState_domainSearchStage = (typeof OrganizationActivationState_domainSearchStageObject)[keyof typeof OrganizationActivationState_domainSearchStageObject];
|
|
6920
6932
|
/**
|
|
6921
|
-
*
|
|
6933
|
+
* 10DLC draft for this organization activation state.
|
|
6922
6934
|
*/
|
|
6923
6935
|
export interface OrganizationActivationState_tenDlcDraft extends Parsable, TenDlcApplicationDraft {
|
|
6924
6936
|
}
|
|
@@ -6931,11 +6943,11 @@ export interface OrganizationBillingState extends AdditionalDataHolder, Parsable
|
|
|
6931
6943
|
*/
|
|
6932
6944
|
billingPlanChangeEffectiveAt?: Date | null;
|
|
6933
6945
|
/**
|
|
6934
|
-
*
|
|
6946
|
+
* UTC timestamp when the active subscription is scheduled to cancel.
|
|
6935
6947
|
*/
|
|
6936
6948
|
cancelAt?: Date | null;
|
|
6937
6949
|
/**
|
|
6938
|
-
*
|
|
6950
|
+
* Customer-safe payment recovery state for the organization.
|
|
6939
6951
|
*/
|
|
6940
6952
|
dunning?: OrganizationBillingState_dunning | null;
|
|
6941
6953
|
/**
|
|
@@ -6947,19 +6959,19 @@ export interface OrganizationBillingState extends AdditionalDataHolder, Parsable
|
|
|
6947
6959
|
*/
|
|
6948
6960
|
hasStripeCustomer?: boolean | null;
|
|
6949
6961
|
/**
|
|
6950
|
-
*
|
|
6962
|
+
* UTC timestamp when Leadping last processed a payment-method event for the organization.
|
|
6951
6963
|
*/
|
|
6952
6964
|
lastPaymentMethodEventAt?: Date | null;
|
|
6953
6965
|
/**
|
|
6954
|
-
*
|
|
6966
|
+
* UTC timestamp when Leadping last processed a subscription event for the organization.
|
|
6955
6967
|
*/
|
|
6956
6968
|
lastSubscriptionEventAt?: Date | null;
|
|
6957
6969
|
/**
|
|
6958
|
-
*
|
|
6970
|
+
* Number of user licenses currently assigned to organization members.
|
|
6959
6971
|
*/
|
|
6960
6972
|
organizationMemberAssignedQuantity?: number | null;
|
|
6961
6973
|
/**
|
|
6962
|
-
*
|
|
6974
|
+
* Number of user licenses included in the organization's subscription plan.
|
|
6963
6975
|
*/
|
|
6964
6976
|
organizationMemberQuantity?: number | null;
|
|
6965
6977
|
/**
|
|
@@ -6967,7 +6979,7 @@ export interface OrganizationBillingState extends AdditionalDataHolder, Parsable
|
|
|
6967
6979
|
*/
|
|
6968
6980
|
pendingBillingPlan?: OrganizationBillingState_pendingBillingPlan | null;
|
|
6969
6981
|
/**
|
|
6970
|
-
*
|
|
6982
|
+
* Number of phone numbers included in the organization's subscription plan.
|
|
6971
6983
|
*/
|
|
6972
6984
|
phoneNumberQuantity?: number | null;
|
|
6973
6985
|
/**
|
|
@@ -6980,13 +6992,13 @@ export interface OrganizationBillingState extends AdditionalDataHolder, Parsable
|
|
|
6980
6992
|
planRenewalAt?: Date | null;
|
|
6981
6993
|
}
|
|
6982
6994
|
/**
|
|
6983
|
-
*
|
|
6995
|
+
* Customer-safe payment recovery state for the organization.
|
|
6984
6996
|
*/
|
|
6985
6997
|
export interface OrganizationBillingState_dunning extends OrganizationDunningInfo, Parsable {
|
|
6986
6998
|
}
|
|
6987
6999
|
export type OrganizationBillingState_pendingBillingPlan = (typeof OrganizationBillingState_pendingBillingPlanObject)[keyof typeof OrganizationBillingState_pendingBillingPlanObject];
|
|
6988
7000
|
/**
|
|
6989
|
-
*
|
|
7001
|
+
* Describes organization compliance policy data used in Leadping API requests and responses.
|
|
6990
7002
|
*/
|
|
6991
7003
|
export interface OrganizationCompliancePolicy extends AdditionalDataHolder, Parsable {
|
|
6992
7004
|
/**
|
|
@@ -7068,7 +7080,7 @@ export interface OrganizationDunningInfo extends AdditionalDataHolder, Parsable
|
|
|
7068
7080
|
stage?: string | null;
|
|
7069
7081
|
}
|
|
7070
7082
|
/**
|
|
7071
|
-
*
|
|
7083
|
+
* Defines the input used for organization invitation.
|
|
7072
7084
|
*/
|
|
7073
7085
|
export interface OrganizationInvitationRequest extends AdditionalDataHolder, Parsable {
|
|
7074
7086
|
/**
|
|
@@ -7076,20 +7088,20 @@ export interface OrganizationInvitationRequest extends AdditionalDataHolder, Par
|
|
|
7076
7088
|
*/
|
|
7077
7089
|
email?: string | null;
|
|
7078
7090
|
/**
|
|
7079
|
-
*
|
|
7091
|
+
* Role for this organization invitation.
|
|
7080
7092
|
*/
|
|
7081
7093
|
role?: OrganizationMemberRole | null;
|
|
7082
7094
|
}
|
|
7083
7095
|
/**
|
|
7084
|
-
*
|
|
7096
|
+
* Describes organization invitation data returned by Leadping.
|
|
7085
7097
|
*/
|
|
7086
7098
|
export interface OrganizationInvitationResponse extends AdditionalDataHolder, Parsable {
|
|
7087
7099
|
/**
|
|
7088
|
-
*
|
|
7100
|
+
* UTC timestamp for accepted at on this organization invitation.
|
|
7089
7101
|
*/
|
|
7090
7102
|
acceptedAt?: Date | null;
|
|
7091
7103
|
/**
|
|
7092
|
-
*
|
|
7104
|
+
* UTC timestamp for created at on this organization invitation.
|
|
7093
7105
|
*/
|
|
7094
7106
|
createdAt?: Date | null;
|
|
7095
7107
|
/**
|
|
@@ -7097,11 +7109,11 @@ export interface OrganizationInvitationResponse extends AdditionalDataHolder, Pa
|
|
|
7097
7109
|
*/
|
|
7098
7110
|
email?: string | null;
|
|
7099
7111
|
/**
|
|
7100
|
-
*
|
|
7112
|
+
* UTC timestamp for expires at on this organization invitation.
|
|
7101
7113
|
*/
|
|
7102
7114
|
expiresAt?: Date | null;
|
|
7103
7115
|
/**
|
|
7104
|
-
*
|
|
7116
|
+
* Unique Leadping identifier for this organization invitation.
|
|
7105
7117
|
*/
|
|
7106
7118
|
id?: string | null;
|
|
7107
7119
|
/**
|
|
@@ -7125,23 +7137,23 @@ export interface OrganizationInvitationResponse extends AdditionalDataHolder, Pa
|
|
|
7125
7137
|
*/
|
|
7126
7138
|
licenseRenewalDate?: Date | null;
|
|
7127
7139
|
/**
|
|
7128
|
-
*
|
|
7140
|
+
* Identifier and display name of the related organization.
|
|
7129
7141
|
*/
|
|
7130
7142
|
organization?: IdNamePair | null;
|
|
7131
7143
|
/**
|
|
7132
|
-
*
|
|
7144
|
+
* UTC timestamp for resent at on this organization invitation.
|
|
7133
7145
|
*/
|
|
7134
7146
|
resentAt?: Date | null;
|
|
7135
7147
|
/**
|
|
7136
|
-
*
|
|
7148
|
+
* UTC timestamp for revoked at on this organization invitation.
|
|
7137
7149
|
*/
|
|
7138
7150
|
revokedAt?: Date | null;
|
|
7139
7151
|
/**
|
|
7140
|
-
*
|
|
7152
|
+
* Role for this organization invitation.
|
|
7141
7153
|
*/
|
|
7142
7154
|
role?: OrganizationMemberRole | null;
|
|
7143
7155
|
/**
|
|
7144
|
-
*
|
|
7156
|
+
* Safe message for this organization invitation.
|
|
7145
7157
|
*/
|
|
7146
7158
|
safeMessage?: string | null;
|
|
7147
7159
|
/**
|
|
@@ -7149,7 +7161,7 @@ export interface OrganizationInvitationResponse extends AdditionalDataHolder, Pa
|
|
|
7149
7161
|
*/
|
|
7150
7162
|
sendFailureReason?: string | null;
|
|
7151
7163
|
/**
|
|
7152
|
-
*
|
|
7164
|
+
* UTC timestamp for sent at on this organization invitation.
|
|
7153
7165
|
*/
|
|
7154
7166
|
sentAt?: Date | null;
|
|
7155
7167
|
/**
|
|
@@ -7159,15 +7171,15 @@ export interface OrganizationInvitationResponse extends AdditionalDataHolder, Pa
|
|
|
7159
7171
|
}
|
|
7160
7172
|
export type OrganizationInvitationStatus = (typeof OrganizationInvitationStatusObject)[keyof typeof OrganizationInvitationStatusObject];
|
|
7161
7173
|
/**
|
|
7162
|
-
*
|
|
7174
|
+
* Describes organization invitation data used in Leadping API requests and responses.
|
|
7163
7175
|
*/
|
|
7164
7176
|
export interface OrganizationInvitationTableRow extends AdditionalDataHolder, Parsable {
|
|
7165
7177
|
/**
|
|
7166
|
-
*
|
|
7178
|
+
* UTC timestamp for accepted at on this organization invitation.
|
|
7167
7179
|
*/
|
|
7168
7180
|
acceptedAt?: Date | null;
|
|
7169
7181
|
/**
|
|
7170
|
-
*
|
|
7182
|
+
* UTC timestamp for created at on this organization invitation.
|
|
7171
7183
|
*/
|
|
7172
7184
|
createdAt?: Date | null;
|
|
7173
7185
|
/**
|
|
@@ -7175,11 +7187,11 @@ export interface OrganizationInvitationTableRow extends AdditionalDataHolder, Pa
|
|
|
7175
7187
|
*/
|
|
7176
7188
|
email?: string | null;
|
|
7177
7189
|
/**
|
|
7178
|
-
*
|
|
7190
|
+
* UTC timestamp for expires at on this organization invitation.
|
|
7179
7191
|
*/
|
|
7180
7192
|
expiresAt?: Date | null;
|
|
7181
7193
|
/**
|
|
7182
|
-
*
|
|
7194
|
+
* Unique Leadping identifier for this organization invitation.
|
|
7183
7195
|
*/
|
|
7184
7196
|
id?: string | null;
|
|
7185
7197
|
/**
|
|
@@ -7203,19 +7215,19 @@ export interface OrganizationInvitationTableRow extends AdditionalDataHolder, Pa
|
|
|
7203
7215
|
*/
|
|
7204
7216
|
licenseRenewalDate?: Date | null;
|
|
7205
7217
|
/**
|
|
7206
|
-
*
|
|
7218
|
+
* Identifier and display name of the related organization.
|
|
7207
7219
|
*/
|
|
7208
7220
|
organization?: IdNamePair | null;
|
|
7209
7221
|
/**
|
|
7210
|
-
*
|
|
7222
|
+
* UTC timestamp for resent at on this organization invitation.
|
|
7211
7223
|
*/
|
|
7212
7224
|
resentAt?: Date | null;
|
|
7213
7225
|
/**
|
|
7214
|
-
*
|
|
7226
|
+
* UTC timestamp for revoked at on this organization invitation.
|
|
7215
7227
|
*/
|
|
7216
7228
|
revokedAt?: Date | null;
|
|
7217
7229
|
/**
|
|
7218
|
-
*
|
|
7230
|
+
* Role for this organization invitation.
|
|
7219
7231
|
*/
|
|
7220
7232
|
role?: OrganizationMemberRole | null;
|
|
7221
7233
|
/**
|
|
@@ -7223,7 +7235,7 @@ export interface OrganizationInvitationTableRow extends AdditionalDataHolder, Pa
|
|
|
7223
7235
|
*/
|
|
7224
7236
|
sendFailureReason?: string | null;
|
|
7225
7237
|
/**
|
|
7226
|
-
*
|
|
7238
|
+
* UTC timestamp for sent at on this organization invitation.
|
|
7227
7239
|
*/
|
|
7228
7240
|
sentAt?: Date | null;
|
|
7229
7241
|
/**
|
|
@@ -7232,7 +7244,7 @@ export interface OrganizationInvitationTableRow extends AdditionalDataHolder, Pa
|
|
|
7232
7244
|
status?: OrganizationInvitationStatus | null;
|
|
7233
7245
|
}
|
|
7234
7246
|
/**
|
|
7235
|
-
*
|
|
7247
|
+
* Defines the fields clients can send when working with organization user.
|
|
7236
7248
|
*/
|
|
7237
7249
|
export interface OrganizationMemberRequest extends AdditionalDataHolder, Parsable {
|
|
7238
7250
|
/**
|
|
@@ -7249,7 +7261,7 @@ export interface OrganizationMemberRequest extends AdditionalDataHolder, Parsabl
|
|
|
7249
7261
|
userId?: string | null;
|
|
7250
7262
|
}
|
|
7251
7263
|
/**
|
|
7252
|
-
*
|
|
7264
|
+
* Describes organization user data returned by Leadping.
|
|
7253
7265
|
*/
|
|
7254
7266
|
export interface OrganizationMemberResponse extends AdditionalDataHolder, Parsable {
|
|
7255
7267
|
/**
|
|
@@ -7265,7 +7277,7 @@ export interface OrganizationMemberResponse extends AdditionalDataHolder, Parsab
|
|
|
7265
7277
|
*/
|
|
7266
7278
|
id?: string | null;
|
|
7267
7279
|
/**
|
|
7268
|
-
*
|
|
7280
|
+
* UTC timestamp for last used at on this organization user.
|
|
7269
7281
|
*/
|
|
7270
7282
|
lastUsedAt?: Date | null;
|
|
7271
7283
|
/**
|
|
@@ -7289,11 +7301,11 @@ export interface OrganizationMemberResponse extends AdditionalDataHolder, Parsab
|
|
|
7289
7301
|
*/
|
|
7290
7302
|
name?: string | null;
|
|
7291
7303
|
/**
|
|
7292
|
-
*
|
|
7304
|
+
* Organization for this organization user.
|
|
7293
7305
|
*/
|
|
7294
7306
|
organization?: IdNamePair | null;
|
|
7295
7307
|
/**
|
|
7296
|
-
*
|
|
7308
|
+
* UTC timestamp for removed at on this organization user.
|
|
7297
7309
|
*/
|
|
7298
7310
|
removedAt?: Date | null;
|
|
7299
7311
|
/**
|
|
@@ -7301,29 +7313,29 @@ export interface OrganizationMemberResponse extends AdditionalDataHolder, Parsab
|
|
|
7301
7313
|
*/
|
|
7302
7314
|
removedByUserId?: string | null;
|
|
7303
7315
|
/**
|
|
7304
|
-
*
|
|
7316
|
+
* Role for this organization user.
|
|
7305
7317
|
*/
|
|
7306
7318
|
role?: OrganizationMemberRole | null;
|
|
7307
7319
|
/**
|
|
7308
|
-
*
|
|
7320
|
+
* User for this organization user.
|
|
7309
7321
|
*/
|
|
7310
7322
|
user?: IdNamePair | null;
|
|
7311
7323
|
/**
|
|
7312
|
-
*
|
|
7324
|
+
* User email for this organization user.
|
|
7313
7325
|
*/
|
|
7314
7326
|
userEmail?: string | null;
|
|
7315
7327
|
}
|
|
7316
7328
|
export type OrganizationMemberRole = (typeof OrganizationMemberRoleObject)[keyof typeof OrganizationMemberRoleObject];
|
|
7317
7329
|
/**
|
|
7318
|
-
*
|
|
7330
|
+
* Describes organization user data used in Leadping API requests and responses.
|
|
7319
7331
|
*/
|
|
7320
7332
|
export interface OrganizationMemberTableRow extends AdditionalDataHolder, Parsable {
|
|
7321
7333
|
/**
|
|
7322
|
-
*
|
|
7334
|
+
* UTC timestamp for created at on this organization user.
|
|
7323
7335
|
*/
|
|
7324
7336
|
createdAt?: Date | null;
|
|
7325
7337
|
/**
|
|
7326
|
-
*
|
|
7338
|
+
* Unique Leadping identifier for this organization user.
|
|
7327
7339
|
*/
|
|
7328
7340
|
id?: string | null;
|
|
7329
7341
|
/**
|
|
@@ -7335,20 +7347,20 @@ export interface OrganizationMemberTableRow extends AdditionalDataHolder, Parsab
|
|
|
7335
7347
|
*/
|
|
7336
7348
|
licenseRenewalDate?: Date | null;
|
|
7337
7349
|
/**
|
|
7338
|
-
*
|
|
7350
|
+
* Role for this organization user.
|
|
7339
7351
|
*/
|
|
7340
7352
|
role?: OrganizationMemberRole | null;
|
|
7341
7353
|
/**
|
|
7342
|
-
*
|
|
7354
|
+
* Identifier and display name of the related user.
|
|
7343
7355
|
*/
|
|
7344
7356
|
user?: IdNamePair | null;
|
|
7345
7357
|
/**
|
|
7346
|
-
*
|
|
7358
|
+
* User email for this organization user.
|
|
7347
7359
|
*/
|
|
7348
7360
|
userEmail?: string | null;
|
|
7349
7361
|
}
|
|
7350
7362
|
/**
|
|
7351
|
-
*
|
|
7363
|
+
* Defines the fields clients can send when working with organization profile.
|
|
7352
7364
|
*/
|
|
7353
7365
|
export interface OrganizationRequest extends AdditionalDataHolder, Parsable {
|
|
7354
7366
|
/**
|
|
@@ -7458,7 +7470,7 @@ export interface OrganizationRequest_einDocument extends IdNameValue, Parsable {
|
|
|
7458
7470
|
}
|
|
7459
7471
|
export type OrganizationRequest_status = (typeof OrganizationRequest_statusObject)[keyof typeof OrganizationRequest_statusObject];
|
|
7460
7472
|
/**
|
|
7461
|
-
*
|
|
7473
|
+
* Describes organization profile data returned by Leadping.
|
|
7462
7474
|
*/
|
|
7463
7475
|
export interface OrganizationResponse extends AdditionalDataHolder, Parsable {
|
|
7464
7476
|
/**
|
|
@@ -7636,7 +7648,7 @@ export type OrganizationResponse_subscriptionStatus = (typeof OrganizationRespon
|
|
|
7636
7648
|
export interface OrganizationResponse_user extends IdNamePair, Parsable {
|
|
7637
7649
|
}
|
|
7638
7650
|
/**
|
|
7639
|
-
*
|
|
7651
|
+
* Describes organization switch option data used in Leadping API requests and responses.
|
|
7640
7652
|
*/
|
|
7641
7653
|
export interface OrganizationSwitchOption extends AdditionalDataHolder, Parsable {
|
|
7642
7654
|
/**
|
|
@@ -7644,7 +7656,7 @@ export interface OrganizationSwitchOption extends AdditionalDataHolder, Parsable
|
|
|
7644
7656
|
*/
|
|
7645
7657
|
activationStatus?: OrganizationSwitchOption_activationStatus | null;
|
|
7646
7658
|
/**
|
|
7647
|
-
*
|
|
7659
|
+
* Activation summary for this organization switch option.
|
|
7648
7660
|
*/
|
|
7649
7661
|
activationSummary?: string | null;
|
|
7650
7662
|
/**
|
|
@@ -7652,7 +7664,7 @@ export interface OrganizationSwitchOption extends AdditionalDataHolder, Parsable
|
|
|
7652
7664
|
*/
|
|
7653
7665
|
hasPaymentMethod?: boolean | null;
|
|
7654
7666
|
/**
|
|
7655
|
-
*
|
|
7667
|
+
* Unique Leadping identifier for this organization switch option.
|
|
7656
7668
|
*/
|
|
7657
7669
|
id?: string | null;
|
|
7658
7670
|
/**
|
|
@@ -7660,7 +7672,7 @@ export interface OrganizationSwitchOption extends AdditionalDataHolder, Parsable
|
|
|
7660
7672
|
*/
|
|
7661
7673
|
isCurrent?: boolean | null;
|
|
7662
7674
|
/**
|
|
7663
|
-
*
|
|
7675
|
+
* UTC timestamp for last used at on this organization switch option.
|
|
7664
7676
|
*/
|
|
7665
7677
|
lastUsedAt?: Date | null;
|
|
7666
7678
|
/**
|
|
@@ -7680,7 +7692,7 @@ export interface OrganizationSwitchOption extends AdditionalDataHolder, Parsable
|
|
|
7680
7692
|
*/
|
|
7681
7693
|
readyForCustomerTraffic?: boolean | null;
|
|
7682
7694
|
/**
|
|
7683
|
-
*
|
|
7695
|
+
* Role for this organization switch option.
|
|
7684
7696
|
*/
|
|
7685
7697
|
role?: OrganizationMemberRole | null;
|
|
7686
7698
|
/**
|
|
@@ -7692,7 +7704,7 @@ export type OrganizationSwitchOption_activationStatus = (typeof OrganizationSwit
|
|
|
7692
7704
|
export type OrganizationSwitchOption_organizationStatus = (typeof OrganizationSwitchOption_organizationStatusObject)[keyof typeof OrganizationSwitchOption_organizationStatusObject];
|
|
7693
7705
|
export type OrganizationSwitchOption_tenDlcStatus = (typeof OrganizationSwitchOption_tenDlcStatusObject)[keyof typeof OrganizationSwitchOption_tenDlcStatusObject];
|
|
7694
7706
|
/**
|
|
7695
|
-
*
|
|
7707
|
+
* Defines the fields clients can send when working with organization switch.
|
|
7696
7708
|
*/
|
|
7697
7709
|
export interface OrganizationSwitchRequest extends AdditionalDataHolder, Parsable {
|
|
7698
7710
|
/**
|
|
@@ -7701,11 +7713,11 @@ export interface OrganizationSwitchRequest extends AdditionalDataHolder, Parsabl
|
|
|
7701
7713
|
organizationId?: string | null;
|
|
7702
7714
|
}
|
|
7703
7715
|
/**
|
|
7704
|
-
*
|
|
7716
|
+
* Describes organization data used in Leadping API requests and responses.
|
|
7705
7717
|
*/
|
|
7706
7718
|
export interface OrganizationTableRow extends AdditionalDataHolder, Parsable {
|
|
7707
7719
|
/**
|
|
7708
|
-
*
|
|
7720
|
+
* Account balance for this organization.
|
|
7709
7721
|
*/
|
|
7710
7722
|
accountBalance?: number | null;
|
|
7711
7723
|
/**
|
|
@@ -7749,11 +7761,11 @@ export interface OrganizationTableRow extends AdditionalDataHolder, Parsable {
|
|
|
7749
7761
|
*/
|
|
7750
7762
|
enabled?: boolean | null;
|
|
7751
7763
|
/**
|
|
7752
|
-
*
|
|
7764
|
+
* Unique Leadping identifier for this organization.
|
|
7753
7765
|
*/
|
|
7754
7766
|
id?: string | null;
|
|
7755
7767
|
/**
|
|
7756
|
-
*
|
|
7768
|
+
* Industry for this organization.
|
|
7757
7769
|
*/
|
|
7758
7770
|
industry?: string | null;
|
|
7759
7771
|
/**
|
|
@@ -7761,7 +7773,7 @@ export interface OrganizationTableRow extends AdditionalDataHolder, Parsable {
|
|
|
7761
7773
|
*/
|
|
7762
7774
|
lastSubscriptionEventAt?: Date | null;
|
|
7763
7775
|
/**
|
|
7764
|
-
*
|
|
7776
|
+
* UTC timestamp for modified at on this organization.
|
|
7765
7777
|
*/
|
|
7766
7778
|
modifiedAt?: Date | null;
|
|
7767
7779
|
/**
|
|
@@ -7773,7 +7785,7 @@ export interface OrganizationTableRow extends AdditionalDataHolder, Parsable {
|
|
|
7773
7785
|
*/
|
|
7774
7786
|
needsAdminReview?: boolean | null;
|
|
7775
7787
|
/**
|
|
7776
|
-
*
|
|
7788
|
+
* Identifier and display name of the related organization.
|
|
7777
7789
|
*/
|
|
7778
7790
|
organization?: OrganizationTableRow_organization | null;
|
|
7779
7791
|
/**
|
|
@@ -7820,7 +7832,7 @@ export interface OrganizationTableRow extends AdditionalDataHolder, Parsable {
|
|
|
7820
7832
|
export type OrganizationTableRow_activationStatus = (typeof OrganizationTableRow_activationStatusObject)[keyof typeof OrganizationTableRow_activationStatusObject];
|
|
7821
7833
|
export type OrganizationTableRow_billingPlan = (typeof OrganizationTableRow_billingPlanObject)[keyof typeof OrganizationTableRow_billingPlanObject];
|
|
7822
7834
|
/**
|
|
7823
|
-
*
|
|
7835
|
+
* Identifier and display name of the related organization.
|
|
7824
7836
|
*/
|
|
7825
7837
|
export interface OrganizationTableRow_organization extends IdNamePair, Parsable {
|
|
7826
7838
|
}
|
|
@@ -7853,6 +7865,10 @@ export interface OutboundCapacityOverview extends AdditionalDataHolder, Parsable
|
|
|
7853
7865
|
* Collection of phone numbers included with this Leadping outbound capacity overview.
|
|
7854
7866
|
*/
|
|
7855
7867
|
phoneNumbers?: OutboundPhoneNumberCapacity[] | null;
|
|
7868
|
+
/**
|
|
7869
|
+
* Number of phone numbers whose SMS or calling capacity is still ramping up.
|
|
7870
|
+
*/
|
|
7871
|
+
rampingPhoneNumbers?: number | null;
|
|
7856
7872
|
/**
|
|
7857
7873
|
* Collection of recent decisions included with this Leadping outbound capacity overview.
|
|
7858
7874
|
*/
|
|
@@ -7881,6 +7897,10 @@ export interface OutboundPhoneNumberCapacity extends AdditionalDataHolder, Parsa
|
|
|
7881
7897
|
* Indicates whether Leadping successfully calculated capacity for this phone number.
|
|
7882
7898
|
*/
|
|
7883
7899
|
capacityAvailable?: boolean | null;
|
|
7900
|
+
/**
|
|
7901
|
+
* Human-readable reason for the current phone-number health state.
|
|
7902
|
+
*/
|
|
7903
|
+
healthReason?: string | null;
|
|
7884
7904
|
/**
|
|
7885
7905
|
* Current health status for this Leadping outbound phone number capacity.
|
|
7886
7906
|
*/
|
|
@@ -7893,6 +7913,10 @@ export interface OutboundPhoneNumberCapacity extends AdditionalDataHolder, Parsa
|
|
|
7893
7913
|
* Unique identifier of the phone number associated with this Leadping outbound phone number capacity.
|
|
7894
7914
|
*/
|
|
7895
7915
|
phoneNumberId?: string | null;
|
|
7916
|
+
/**
|
|
7917
|
+
* Indicates whether this phone number has an approved 10DLC messaging campaign assignment.
|
|
7918
|
+
*/
|
|
7919
|
+
smsApproved?: boolean | null;
|
|
7896
7920
|
/**
|
|
7897
7921
|
* Next midnight Eastern time, when SMS daily capacity resets.
|
|
7898
7922
|
*/
|
|
@@ -7917,6 +7941,10 @@ export interface OutboundPhoneNumberCapacity extends AdditionalDataHolder, Parsa
|
|
|
7917
7941
|
* The next time SMS capacity becomes available in the rolling minute window.
|
|
7918
7942
|
*/
|
|
7919
7943
|
smsMinutelyResetsAt?: Date | null;
|
|
7944
|
+
/**
|
|
7945
|
+
* Indicates whether SMS limits for this phone number are still ramping up.
|
|
7946
|
+
*/
|
|
7947
|
+
smsRamping?: boolean | null;
|
|
7920
7948
|
/**
|
|
7921
7949
|
* SMS remaining this hour for the applicable messaging or voice capacity window.
|
|
7922
7950
|
*/
|
|
@@ -7965,6 +7993,10 @@ export interface OutboundPhoneNumberCapacity extends AdditionalDataHolder, Parsa
|
|
|
7965
7993
|
* The next time voice capacity becomes available in the rolling minute window.
|
|
7966
7994
|
*/
|
|
7967
7995
|
voiceMinutelyResetsAt?: Date | null;
|
|
7996
|
+
/**
|
|
7997
|
+
* Indicates whether call limits for this phone number are still ramping up.
|
|
7998
|
+
*/
|
|
7999
|
+
voiceRamping?: boolean | null;
|
|
7968
8000
|
/**
|
|
7969
8001
|
* Voice remaining this hour for the applicable messaging or voice capacity window.
|
|
7970
8002
|
*/
|
|
@@ -8029,7 +8061,7 @@ export interface OutboundQueueItem extends AdditionalDataHolder, Parsable {
|
|
|
8029
8061
|
}
|
|
8030
8062
|
export type OutboundQueueItem_reasonCode = (typeof OutboundQueueItem_reasonCodeObject)[keyof typeof OutboundQueueItem_reasonCodeObject];
|
|
8031
8063
|
/**
|
|
8032
|
-
*
|
|
8064
|
+
* Defines the fields clients can send when working with outgoing number manual override.
|
|
8033
8065
|
*/
|
|
8034
8066
|
export interface OutgoingNumberManualOverrideRequest extends AdditionalDataHolder, Parsable {
|
|
8035
8067
|
/**
|
|
@@ -8043,7 +8075,7 @@ export interface OutgoingNumberManualOverrideRequest extends AdditionalDataHolde
|
|
|
8043
8075
|
}
|
|
8044
8076
|
export type OutgoingNumberSelectionReason = (typeof OutgoingNumberSelectionReasonObject)[keyof typeof OutgoingNumberSelectionReasonObject];
|
|
8045
8077
|
/**
|
|
8046
|
-
*
|
|
8078
|
+
* Defines the fields clients can send when working with outgoing number selection.
|
|
8047
8079
|
*/
|
|
8048
8080
|
export interface OutgoingNumberSelectionRequest extends AdditionalDataHolder, Parsable {
|
|
8049
8081
|
/**
|
|
@@ -8077,7 +8109,7 @@ export interface OutgoingNumberSelectionRequest extends AdditionalDataHolder, Pa
|
|
|
8077
8109
|
}
|
|
8078
8110
|
export type OutgoingNumberSelectionRequest_channel = (typeof OutgoingNumberSelectionRequest_channelObject)[keyof typeof OutgoingNumberSelectionRequest_channelObject];
|
|
8079
8111
|
/**
|
|
8080
|
-
*
|
|
8112
|
+
* Describes outgoing number selection data returned by Leadping.
|
|
8081
8113
|
*/
|
|
8082
8114
|
export interface OutgoingNumberSelectionResponse extends AdditionalDataHolder, Parsable {
|
|
8083
8115
|
/**
|
|
@@ -8451,7 +8483,7 @@ export interface Phone extends AdditionalDataHolder, Parsable {
|
|
|
8451
8483
|
type?: string | null;
|
|
8452
8484
|
}
|
|
8453
8485
|
/**
|
|
8454
|
-
*
|
|
8486
|
+
* Describes a Leadping phone call, including participants, direction, provider state, timing, recording, and billing details.
|
|
8455
8487
|
*/
|
|
8456
8488
|
export interface PhoneCallResponse extends AdditionalDataHolder, Parsable {
|
|
8457
8489
|
/**
|
|
@@ -8558,7 +8590,34 @@ export interface PhoneCallResponse extends AdditionalDataHolder, Parsable {
|
|
|
8558
8590
|
export type PhoneCallResponse_selectionReason = (typeof PhoneCallResponse_selectionReasonObject)[keyof typeof PhoneCallResponse_selectionReasonObject];
|
|
8559
8591
|
export type PhoneCallStatus = (typeof PhoneCallStatusObject)[keyof typeof PhoneCallStatusObject];
|
|
8560
8592
|
/**
|
|
8561
|
-
*
|
|
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.
|
|
8562
8621
|
*/
|
|
8563
8622
|
export interface PhoneIdentityResponse extends AdditionalDataHolder, Parsable {
|
|
8564
8623
|
/**
|
|
@@ -8577,6 +8636,10 @@ export interface PhoneIdentityResponse extends AdditionalDataHolder, Parsable {
|
|
|
8577
8636
|
* Provider lookup and enrichment data for the number.
|
|
8578
8637
|
*/
|
|
8579
8638
|
lookup?: PhoneIdentityResponse_lookup | null;
|
|
8639
|
+
/**
|
|
8640
|
+
* Lookup, enrichment, and reputation actions performed for this identity.
|
|
8641
|
+
*/
|
|
8642
|
+
lookupActions?: PhoneIdentityLookupAction[] | null;
|
|
8580
8643
|
/**
|
|
8581
8644
|
* The date and time when the entity was last modified, if applicable.
|
|
8582
8645
|
*/
|
|
@@ -8630,7 +8693,7 @@ export interface PhoneLookup extends AdditionalDataHolder, Parsable {
|
|
|
8630
8693
|
*/
|
|
8631
8694
|
carrier?: PhoneLookup_carrier | null;
|
|
8632
8695
|
/**
|
|
8633
|
-
*
|
|
8696
|
+
* UTC timestamp when the phone lookup record was created.
|
|
8634
8697
|
*/
|
|
8635
8698
|
createdAt?: Date | null;
|
|
8636
8699
|
/**
|
|
@@ -8638,7 +8701,7 @@ export interface PhoneLookup extends AdditionalDataHolder, Parsable {
|
|
|
8638
8701
|
*/
|
|
8639
8702
|
fraud?: string | null;
|
|
8640
8703
|
/**
|
|
8641
|
-
*
|
|
8704
|
+
* Unique Leadping identifier for the saved phone lookup record.
|
|
8642
8705
|
*/
|
|
8643
8706
|
id?: string | null;
|
|
8644
8707
|
/**
|
|
@@ -8654,7 +8717,7 @@ export interface PhoneLookup extends AdditionalDataHolder, Parsable {
|
|
|
8654
8717
|
*/
|
|
8655
8718
|
location?: PhoneLookup_location | null;
|
|
8656
8719
|
/**
|
|
8657
|
-
*
|
|
8720
|
+
* UTC timestamp when the phone lookup record was last updated.
|
|
8658
8721
|
*/
|
|
8659
8722
|
modifiedAt?: Date | null;
|
|
8660
8723
|
/**
|
|
@@ -8800,28 +8863,28 @@ export interface PhoneLookupPortability extends AdditionalDataHolder, Parsable {
|
|
|
8800
8863
|
*/
|
|
8801
8864
|
export interface PhoneLookupProviderSnapshot extends AdditionalDataHolder, Parsable {
|
|
8802
8865
|
/**
|
|
8803
|
-
* The
|
|
8866
|
+
* The provider lookup product or operation that produced this snapshot.
|
|
8804
8867
|
*/
|
|
8805
8868
|
lookupType?: string | null;
|
|
8806
8869
|
/**
|
|
8807
|
-
* The provider
|
|
8870
|
+
* The provider that supplied the phone lookup record.
|
|
8808
8871
|
*/
|
|
8809
8872
|
provider?: string | null;
|
|
8810
8873
|
/**
|
|
8811
|
-
* The
|
|
8874
|
+
* The complete provider response serialized as JSON for lossless audit and replay.
|
|
8812
8875
|
*/
|
|
8813
8876
|
rawRecordJson?: string | null;
|
|
8814
8877
|
/**
|
|
8815
|
-
* The
|
|
8878
|
+
* The UTC timestamp when Leadping retrieved the provider record.
|
|
8816
8879
|
*/
|
|
8817
8880
|
retrievedAt?: Date | null;
|
|
8818
8881
|
/**
|
|
8819
|
-
* The
|
|
8882
|
+
* The Leadping schema version used to interpret the stored provider record.
|
|
8820
8883
|
*/
|
|
8821
8884
|
schemaVersion?: number | null;
|
|
8822
8885
|
}
|
|
8823
8886
|
/**
|
|
8824
|
-
*
|
|
8887
|
+
* Defines the phone number and capability requirements Leadping should verify before purchase or assignment.
|
|
8825
8888
|
*/
|
|
8826
8889
|
export interface PhoneNumberAvailabilityRequest extends AdditionalDataHolder, Parsable {
|
|
8827
8890
|
/**
|
|
@@ -8830,7 +8893,7 @@ export interface PhoneNumberAvailabilityRequest extends AdditionalDataHolder, Pa
|
|
|
8830
8893
|
phoneNumber?: string | null;
|
|
8831
8894
|
}
|
|
8832
8895
|
/**
|
|
8833
|
-
*
|
|
8896
|
+
* Reports whether a phone number is available for purchase or assignment and explains any blocking condition.
|
|
8834
8897
|
*/
|
|
8835
8898
|
export interface PhoneNumberAvailabilityResponse extends AdditionalDataHolder, Parsable {
|
|
8836
8899
|
/**
|
|
@@ -8916,7 +8979,7 @@ export interface PhoneNumberLocation_coordinateSource extends Parsable, PhoneLoc
|
|
|
8916
8979
|
export interface PhoneNumberLocation_timeZoneSource extends Parsable, PhoneLocationSource {
|
|
8917
8980
|
}
|
|
8918
8981
|
/**
|
|
8919
|
-
*
|
|
8982
|
+
* Describes a messaging event used to calculate delivery, failure, and opt-out metrics for a phone number.
|
|
8920
8983
|
*/
|
|
8921
8984
|
export interface PhoneNumberMessagingEventResponse extends AdditionalDataHolder, Parsable {
|
|
8922
8985
|
/**
|
|
@@ -8957,7 +9020,7 @@ export interface PhoneNumberMessagingEventResponse extends AdditionalDataHolder,
|
|
|
8957
9020
|
toPhoneNumber?: string | null;
|
|
8958
9021
|
}
|
|
8959
9022
|
/**
|
|
8960
|
-
*
|
|
9023
|
+
* Describes phone number opt-out metrics data returned by Leadping.
|
|
8961
9024
|
*/
|
|
8962
9025
|
export interface PhoneNumberOptOutMetricsResponse extends AdditionalDataHolder, Parsable {
|
|
8963
9026
|
/**
|
|
@@ -9015,7 +9078,7 @@ export type PhoneNumberReadiness_callStage = (typeof PhoneNumberReadiness_callSt
|
|
|
9015
9078
|
export type PhoneNumberReadiness_healthStatus = (typeof PhoneNumberReadiness_healthStatusObject)[keyof typeof PhoneNumberReadiness_healthStatusObject];
|
|
9016
9079
|
export type PhoneNumberReadiness_state = (typeof PhoneNumberReadiness_stateObject)[keyof typeof PhoneNumberReadiness_stateObject];
|
|
9017
9080
|
/**
|
|
9018
|
-
*
|
|
9081
|
+
* Defines the fields clients can send when working with phone number update.
|
|
9019
9082
|
*/
|
|
9020
9083
|
export interface PhoneNumberRequest extends AdditionalDataHolder, Parsable {
|
|
9021
9084
|
/**
|
|
@@ -9040,7 +9103,7 @@ export interface PhoneNumberRequest extends AdditionalDataHolder, Parsable {
|
|
|
9040
9103
|
organizationId?: string | null;
|
|
9041
9104
|
}
|
|
9042
9105
|
/**
|
|
9043
|
-
*
|
|
9106
|
+
* Describes a Leadping-managed phone number, including capabilities, messaging registration, health, and assignment details.
|
|
9044
9107
|
*/
|
|
9045
9108
|
export interface PhoneNumberResponse extends AdditionalDataHolder, Parsable {
|
|
9046
9109
|
/**
|
|
@@ -9123,7 +9186,7 @@ export interface PhoneNumberRoutingMetadata extends AdditionalDataHolder, Parsab
|
|
|
9123
9186
|
voiceEnabled?: boolean | null;
|
|
9124
9187
|
}
|
|
9125
9188
|
/**
|
|
9126
|
-
*
|
|
9189
|
+
* Defines the fields clients can send when working with phone number search.
|
|
9127
9190
|
*/
|
|
9128
9191
|
export interface PhoneNumberSearchRequest extends AdditionalDataHolder, Parsable {
|
|
9129
9192
|
/**
|
|
@@ -9141,7 +9204,7 @@ export interface PhoneNumberSearchRequest extends AdditionalDataHolder, Parsable
|
|
|
9141
9204
|
export interface PhoneNumberSearchRequest_location extends Parsable, PhoneNumberLocation {
|
|
9142
9205
|
}
|
|
9143
9206
|
/**
|
|
9144
|
-
*
|
|
9207
|
+
* Describes phone number search data returned by Leadping.
|
|
9145
9208
|
*/
|
|
9146
9209
|
export interface PhoneNumberSearchResponse extends AdditionalDataHolder, Parsable {
|
|
9147
9210
|
/**
|
|
@@ -9168,7 +9231,7 @@ export interface PhoneNumberSearchResult extends AdditionalDataHolder, Parsable
|
|
|
9168
9231
|
export interface PhoneNumberSearchResult_location extends Parsable, PhoneNumberLocation {
|
|
9169
9232
|
}
|
|
9170
9233
|
/**
|
|
9171
|
-
*
|
|
9234
|
+
* Describes a phone number's current warmup stage, limits, progress, and readiness for production traffic.
|
|
9172
9235
|
*/
|
|
9173
9236
|
export interface PhoneNumberStatusResponse extends AdditionalDataHolder, Parsable {
|
|
9174
9237
|
/**
|
|
@@ -9215,7 +9278,7 @@ export interface PhoneNumberStatusResponse_outboundCapacity extends OutboundPhon
|
|
|
9215
9278
|
export interface PhoneNumberStatusResponse_smsWarmup extends Parsable, SmsReadinessStatusResponse {
|
|
9216
9279
|
}
|
|
9217
9280
|
/**
|
|
9218
|
-
*
|
|
9281
|
+
* Summarizes phone number data in paginated and searchable results.
|
|
9219
9282
|
*/
|
|
9220
9283
|
export interface PhoneNumberTableRow extends AdditionalDataHolder, Parsable {
|
|
9221
9284
|
/**
|
|
@@ -9272,7 +9335,7 @@ export interface PhoneNumberTableRow extends AdditionalDataHolder, Parsable {
|
|
|
9272
9335
|
warmup?: PhoneNumberReadiness | null;
|
|
9273
9336
|
}
|
|
9274
9337
|
/**
|
|
9275
|
-
*
|
|
9338
|
+
* Describes phone number traffic metrics data returned by Leadping.
|
|
9276
9339
|
*/
|
|
9277
9340
|
export interface PhoneNumberTrafficMetricsResponse extends AdditionalDataHolder, Parsable {
|
|
9278
9341
|
/**
|
|
@@ -9365,6 +9428,9 @@ export interface PhoneNumberTrafficTrendPoint extends AdditionalDataHolder, Pars
|
|
|
9365
9428
|
*/
|
|
9366
9429
|
startAt?: Date | null;
|
|
9367
9430
|
}
|
|
9431
|
+
/**
|
|
9432
|
+
* Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
|
|
9433
|
+
*/
|
|
9368
9434
|
export interface ProblemDetails extends AdditionalDataHolder, ApiError, Parsable {
|
|
9369
9435
|
/**
|
|
9370
9436
|
* Human-readable explanation specific to this occurrence of the problem.
|
|
@@ -9392,50 +9458,53 @@ export interface ProblemDetails extends AdditionalDataHolder, ApiError, Parsable
|
|
|
9392
9458
|
*/
|
|
9393
9459
|
export interface PushInstallationRequest extends AdditionalDataHolder, Parsable {
|
|
9394
9460
|
/**
|
|
9395
|
-
* The
|
|
9461
|
+
* The application build number reported by the client.
|
|
9396
9462
|
*/
|
|
9397
9463
|
appBuild?: string | null;
|
|
9398
9464
|
/**
|
|
9399
|
-
* The
|
|
9465
|
+
* The application bundle identifier or package name.
|
|
9400
9466
|
*/
|
|
9401
9467
|
appIdentifier?: string | null;
|
|
9402
9468
|
/**
|
|
9403
|
-
* The
|
|
9469
|
+
* The human-readable application name reported by the client.
|
|
9404
9470
|
*/
|
|
9405
9471
|
appName?: string | null;
|
|
9406
9472
|
/**
|
|
9407
|
-
* The
|
|
9473
|
+
* The semantic application version reported by the client.
|
|
9408
9474
|
*/
|
|
9409
9475
|
appVersion?: string | null;
|
|
9410
9476
|
/**
|
|
9411
|
-
* The
|
|
9477
|
+
* The device model reported by the client.
|
|
9412
9478
|
*/
|
|
9413
9479
|
deviceModel?: string | null;
|
|
9414
9480
|
/**
|
|
9415
|
-
* The
|
|
9481
|
+
* The mobile operating-system platform reported by the device.
|
|
9416
9482
|
*/
|
|
9417
9483
|
devicePlatform?: string | null;
|
|
9418
9484
|
/**
|
|
9419
|
-
* The
|
|
9485
|
+
* The mobile operating-system version reported by the device.
|
|
9420
9486
|
*/
|
|
9421
9487
|
deviceVersion?: string | null;
|
|
9422
9488
|
/**
|
|
9423
|
-
* The
|
|
9489
|
+
* The stable installation identifier assigned by the mobile client.
|
|
9424
9490
|
*/
|
|
9425
9491
|
installationId?: string | null;
|
|
9426
9492
|
/**
|
|
9427
|
-
*
|
|
9493
|
+
* Optional client metadata stored with the push installation.
|
|
9428
9494
|
*/
|
|
9429
9495
|
metadata?: PushInstallationRequest_metadata | null;
|
|
9430
9496
|
/**
|
|
9431
|
-
* The platform
|
|
9497
|
+
* The Azure Notification Hubs platform name, such as apns or fcmv1.
|
|
9432
9498
|
*/
|
|
9433
9499
|
platform?: string | null;
|
|
9434
9500
|
/**
|
|
9435
|
-
* The
|
|
9501
|
+
* The provider-issued push token or channel used to deliver notifications.
|
|
9436
9502
|
*/
|
|
9437
9503
|
pushChannel?: string | null;
|
|
9438
9504
|
}
|
|
9505
|
+
/**
|
|
9506
|
+
* Optional client metadata stored with the push installation.
|
|
9507
|
+
*/
|
|
9439
9508
|
export interface PushInstallationRequest_metadata extends AdditionalDataHolder, Parsable {
|
|
9440
9509
|
}
|
|
9441
9510
|
/**
|
|
@@ -9501,7 +9570,7 @@ export interface RequestDataOptions extends AdditionalDataHolder, Parsable {
|
|
|
9501
9570
|
searchFields?: string[] | null;
|
|
9502
9571
|
}
|
|
9503
9572
|
/**
|
|
9504
|
-
*
|
|
9573
|
+
* Defines the fields clients can send when working with SMS send.
|
|
9505
9574
|
*/
|
|
9506
9575
|
export interface SendSmsRequest extends AdditionalDataHolder, Parsable {
|
|
9507
9576
|
/**
|
|
@@ -10637,6 +10706,13 @@ export declare function serializePhone(writer: SerializationWriter, phone?: Part
|
|
|
10637
10706
|
* @param writer Serialization writer to use to serialize this model
|
|
10638
10707
|
*/
|
|
10639
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;
|
|
10640
10716
|
/**
|
|
10641
10717
|
* Serializes information the current object
|
|
10642
10718
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
@@ -11380,7 +11456,7 @@ export declare function serializeUserResponse_notificationPreferences(writer: Se
|
|
|
11380
11456
|
*/
|
|
11381
11457
|
export declare function serializeWalletResponse(writer: SerializationWriter, walletResponse?: Partial<WalletResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
11382
11458
|
/**
|
|
11383
|
-
*
|
|
11459
|
+
* Summarizes SMS event data in paginated and searchable results.
|
|
11384
11460
|
*/
|
|
11385
11461
|
export interface SmsEventTableRow extends AdditionalDataHolder, Parsable {
|
|
11386
11462
|
/**
|
|
@@ -11460,7 +11536,7 @@ export interface SmsEventTableRow extends AdditionalDataHolder, Parsable {
|
|
|
11460
11536
|
*/
|
|
11461
11537
|
isAutomated?: boolean | null;
|
|
11462
11538
|
/**
|
|
11463
|
-
*
|
|
11539
|
+
* Identifier and display name of the related lead.
|
|
11464
11540
|
*/
|
|
11465
11541
|
lead?: IdNamePair | null;
|
|
11466
11542
|
/**
|
|
@@ -11550,7 +11626,7 @@ export type SmsEventTableRow_trafficType = (typeof SmsEventTableRow_trafficTypeO
|
|
|
11550
11626
|
export type SmsReadinessHealthStatus = (typeof SmsReadinessHealthStatusObject)[keyof typeof SmsReadinessHealthStatusObject];
|
|
11551
11627
|
export type SmsReadinessState = (typeof SmsReadinessStateObject)[keyof typeof SmsReadinessStateObject];
|
|
11552
11628
|
/**
|
|
11553
|
-
*
|
|
11629
|
+
* Describes SMS warmup status data returned by Leadping.
|
|
11554
11630
|
*/
|
|
11555
11631
|
export interface SmsReadinessStatusResponse extends AdditionalDataHolder, Parsable {
|
|
11556
11632
|
/**
|
|
@@ -11587,7 +11663,7 @@ export interface SmsReadinessStatusResponse extends AdditionalDataHolder, Parsab
|
|
|
11587
11663
|
warmupEnabled?: boolean | null;
|
|
11588
11664
|
}
|
|
11589
11665
|
/**
|
|
11590
|
-
*
|
|
11666
|
+
* Describes SMS readiness UI state data used in Leadping API requests and responses.
|
|
11591
11667
|
*/
|
|
11592
11668
|
export interface SmsReadinessUiState extends AdditionalDataHolder, Parsable {
|
|
11593
11669
|
/**
|
|
@@ -11599,12 +11675,12 @@ export interface SmsReadinessUiState extends AdditionalDataHolder, Parsable {
|
|
|
11599
11675
|
*/
|
|
11600
11676
|
label?: SmsReadinessState | null;
|
|
11601
11677
|
/**
|
|
11602
|
-
*
|
|
11678
|
+
* Tone for this SMS readiness UI state.
|
|
11603
11679
|
*/
|
|
11604
11680
|
tone?: string | null;
|
|
11605
11681
|
}
|
|
11606
11682
|
/**
|
|
11607
|
-
*
|
|
11683
|
+
* Describes an SMS or MMS message, including participants, delivery state, scheduling, media, and billing details.
|
|
11608
11684
|
*/
|
|
11609
11685
|
export interface SmsResponse extends AdditionalDataHolder, Parsable {
|
|
11610
11686
|
/**
|
|
@@ -11777,7 +11853,7 @@ export interface SourceMetricsResponse extends AdditionalDataHolder, Parsable {
|
|
|
11777
11853
|
totalLeads?: number | null;
|
|
11778
11854
|
}
|
|
11779
11855
|
/**
|
|
11780
|
-
*
|
|
11856
|
+
* Defines the fields clients can send when working with lead source.
|
|
11781
11857
|
*/
|
|
11782
11858
|
export interface SourceRequest extends AdditionalDataHolder, Parsable {
|
|
11783
11859
|
/**
|
|
@@ -11830,7 +11906,7 @@ export interface SourceRequest extends AdditionalDataHolder, Parsable {
|
|
|
11830
11906
|
requiresTrustedForm?: boolean | null;
|
|
11831
11907
|
}
|
|
11832
11908
|
/**
|
|
11833
|
-
*
|
|
11909
|
+
* Describes lead source data returned by Leadping.
|
|
11834
11910
|
*/
|
|
11835
11911
|
export interface SourceResponse extends AdditionalDataHolder, Parsable {
|
|
11836
11912
|
/**
|
|
@@ -11939,7 +12015,7 @@ export interface SourceResponse_organization extends IdNamePair, Parsable {
|
|
|
11939
12015
|
export interface SourceResponse_user extends IdNamePair, Parsable {
|
|
11940
12016
|
}
|
|
11941
12017
|
/**
|
|
11942
|
-
*
|
|
12018
|
+
* Summarizes lead source data in paginated and searchable results.
|
|
11943
12019
|
*/
|
|
11944
12020
|
export interface SourceTableRow extends AdditionalDataHolder, Parsable {
|
|
11945
12021
|
/**
|
|
@@ -12130,27 +12206,27 @@ export interface StripeInvoiceResponse extends AdditionalDataHolder, Parsable {
|
|
|
12130
12206
|
status?: string | null;
|
|
12131
12207
|
}
|
|
12132
12208
|
/**
|
|
12133
|
-
*
|
|
12209
|
+
* Describes stripe payment method data used in Leadping API requests and responses.
|
|
12134
12210
|
*/
|
|
12135
12211
|
export interface StripePaymentMethodResponse extends AdditionalDataHolder, Parsable {
|
|
12136
12212
|
/**
|
|
12137
|
-
*
|
|
12213
|
+
* Card network brand, such as Visa, Mastercard, or American Express.
|
|
12138
12214
|
*/
|
|
12139
12215
|
brand?: string | null;
|
|
12140
12216
|
/**
|
|
12141
|
-
*
|
|
12217
|
+
* UTC timestamp for created at on this Stripe payment method.
|
|
12142
12218
|
*/
|
|
12143
12219
|
createdAt?: Date | null;
|
|
12144
12220
|
/**
|
|
12145
|
-
*
|
|
12221
|
+
* Two-digit month when the card expires.
|
|
12146
12222
|
*/
|
|
12147
12223
|
expMonth?: number | null;
|
|
12148
12224
|
/**
|
|
12149
|
-
*
|
|
12225
|
+
* Four-digit year when the card expires.
|
|
12150
12226
|
*/
|
|
12151
12227
|
expYear?: number | null;
|
|
12152
12228
|
/**
|
|
12153
|
-
*
|
|
12229
|
+
* Unique Leadping identifier for this Stripe payment method.
|
|
12154
12230
|
*/
|
|
12155
12231
|
id?: string | null;
|
|
12156
12232
|
/**
|
|
@@ -12158,40 +12234,40 @@ export interface StripePaymentMethodResponse extends AdditionalDataHolder, Parsa
|
|
|
12158
12234
|
*/
|
|
12159
12235
|
isDefault?: boolean | null;
|
|
12160
12236
|
/**
|
|
12161
|
-
*
|
|
12237
|
+
* UTC timestamp for last4 on this Stripe payment method.
|
|
12162
12238
|
*/
|
|
12163
12239
|
last4?: string | null;
|
|
12164
12240
|
}
|
|
12165
12241
|
/**
|
|
12166
|
-
*
|
|
12242
|
+
* Reports whether Leadping may contact a recipient and identifies the active suppression when contact is blocked.
|
|
12167
12243
|
*/
|
|
12168
12244
|
export interface SuppressionCheckResult extends AdditionalDataHolder, Parsable {
|
|
12169
12245
|
/**
|
|
12170
|
-
* Whether
|
|
12246
|
+
* Whether outreach to the recipient is allowed for the requested channel.
|
|
12171
12247
|
*/
|
|
12172
12248
|
allowed?: boolean | null;
|
|
12173
12249
|
/**
|
|
12174
|
-
*
|
|
12250
|
+
* Communication channel evaluated by the suppression check.
|
|
12175
12251
|
*/
|
|
12176
12252
|
channel?: string | null;
|
|
12177
12253
|
/**
|
|
12178
|
-
*
|
|
12254
|
+
* Customer-safe explanation of why contact is blocked or allowed.
|
|
12179
12255
|
*/
|
|
12180
12256
|
customerReason?: string | null;
|
|
12181
12257
|
/**
|
|
12182
|
-
*
|
|
12258
|
+
* Email address used for matching, normalized for comparison.
|
|
12183
12259
|
*/
|
|
12184
12260
|
normalizedEmail?: string | null;
|
|
12185
12261
|
/**
|
|
12186
|
-
*
|
|
12262
|
+
* Phone number used for matching, normalized to a consistent format.
|
|
12187
12263
|
*/
|
|
12188
12264
|
normalizedPhoneNumber?: string | null;
|
|
12189
12265
|
/**
|
|
12190
|
-
*
|
|
12266
|
+
* Identifier of the organization whose suppression list was checked.
|
|
12191
12267
|
*/
|
|
12192
12268
|
organizationId?: string | null;
|
|
12193
12269
|
/**
|
|
12194
|
-
*
|
|
12270
|
+
* Provider or customer identifier used to match the recipient.
|
|
12195
12271
|
*/
|
|
12196
12272
|
recipientIdentifier?: string | null;
|
|
12197
12273
|
/**
|
|
@@ -12203,132 +12279,132 @@ export interface SuppressionCheckResult extends AdditionalDataHolder, Parsable {
|
|
|
12203
12279
|
*/
|
|
12204
12280
|
suppressedAt?: Date | null;
|
|
12205
12281
|
/**
|
|
12206
|
-
*
|
|
12282
|
+
* Identifier of the active suppression that blocked contact, when one matched.
|
|
12207
12283
|
*/
|
|
12208
12284
|
suppressionEntryId?: string | null;
|
|
12209
12285
|
}
|
|
12210
12286
|
/**
|
|
12211
|
-
*
|
|
12287
|
+
* Records one auditable change to a recipient suppression entry.
|
|
12212
12288
|
*/
|
|
12213
12289
|
export interface SuppressionEntryAudit extends AdditionalDataHolder, Parsable {
|
|
12214
12290
|
/**
|
|
12215
|
-
*
|
|
12291
|
+
* Identifier of the user or system actor responsible for the change.
|
|
12216
12292
|
*/
|
|
12217
12293
|
actorId?: string | null;
|
|
12218
12294
|
/**
|
|
12219
|
-
*
|
|
12295
|
+
* Unique identifier for this suppression audit record.
|
|
12220
12296
|
*/
|
|
12221
12297
|
id?: string | null;
|
|
12222
12298
|
/**
|
|
12223
|
-
*
|
|
12299
|
+
* Human-readable reason recorded for the suppression change.
|
|
12224
12300
|
*/
|
|
12225
12301
|
reason?: string | null;
|
|
12226
12302
|
/**
|
|
12227
|
-
*
|
|
12303
|
+
* Non-sensitive metadata that provides additional audit context.
|
|
12228
12304
|
*/
|
|
12229
12305
|
safeMetadata?: SuppressionEntryAudit_safeMetadata | null;
|
|
12230
12306
|
/**
|
|
12231
|
-
*
|
|
12307
|
+
* System or workflow that initiated the change.
|
|
12232
12308
|
*/
|
|
12233
12309
|
source?: string | null;
|
|
12234
12310
|
/**
|
|
12235
|
-
*
|
|
12311
|
+
* Suppression status established by this change, such as active or released.
|
|
12236
12312
|
*/
|
|
12237
12313
|
status?: string | null;
|
|
12238
12314
|
/**
|
|
12239
|
-
*
|
|
12315
|
+
* UTC timestamp when the suppression change occurred.
|
|
12240
12316
|
*/
|
|
12241
12317
|
timestamp?: Date | null;
|
|
12242
12318
|
}
|
|
12243
12319
|
/**
|
|
12244
|
-
*
|
|
12320
|
+
* Non-sensitive metadata that provides additional audit context.
|
|
12245
12321
|
*/
|
|
12246
12322
|
export interface SuppressionEntryAudit_safeMetadata extends AdditionalDataHolder, Parsable {
|
|
12247
12323
|
}
|
|
12248
12324
|
/**
|
|
12249
|
-
*
|
|
12325
|
+
* Defines a recipient and communication channel to suppress, release, or check before Leadping sends outreach.
|
|
12250
12326
|
*/
|
|
12251
12327
|
export interface SuppressionEntryRequest extends AdditionalDataHolder, Parsable {
|
|
12252
12328
|
/**
|
|
12253
|
-
*
|
|
12329
|
+
* Communication channel affected by the suppression, such as SMS, voice, email, or all channels.
|
|
12254
12330
|
*/
|
|
12255
12331
|
channel?: string | null;
|
|
12256
12332
|
/**
|
|
12257
|
-
*
|
|
12333
|
+
* Recipient email address to suppress or check.
|
|
12258
12334
|
*/
|
|
12259
12335
|
email?: string | null;
|
|
12260
12336
|
/**
|
|
12261
|
-
*
|
|
12337
|
+
* Organization whose suppression list should be used.
|
|
12262
12338
|
*/
|
|
12263
12339
|
organizationId?: string | null;
|
|
12264
12340
|
/**
|
|
12265
|
-
*
|
|
12341
|
+
* Recipient phone number to suppress or check, preferably in E.164 format.
|
|
12266
12342
|
*/
|
|
12267
12343
|
phoneNumber?: string | null;
|
|
12268
12344
|
/**
|
|
12269
|
-
*
|
|
12345
|
+
* Human-readable reason for creating or releasing the suppression.
|
|
12270
12346
|
*/
|
|
12271
12347
|
reason?: string | null;
|
|
12272
12348
|
/**
|
|
12273
|
-
*
|
|
12349
|
+
* Optional provider or customer identifier that uniquely identifies the recipient.
|
|
12274
12350
|
*/
|
|
12275
12351
|
recipientIdentifier?: string | null;
|
|
12276
12352
|
}
|
|
12277
12353
|
/**
|
|
12278
|
-
*
|
|
12354
|
+
* Describes a recipient suppression that prevents outreach through one or more communication channels.
|
|
12279
12355
|
*/
|
|
12280
12356
|
export interface SuppressionEntryResponse extends AdditionalDataHolder, Parsable {
|
|
12281
12357
|
/**
|
|
12282
|
-
*
|
|
12358
|
+
* Chronological audit history of suppression and release changes.
|
|
12283
12359
|
*/
|
|
12284
12360
|
audit?: SuppressionEntryAudit[] | null;
|
|
12285
12361
|
/**
|
|
12286
|
-
*
|
|
12362
|
+
* Communication channel affected by the suppression, such as SMS, voice, email, or all channels.
|
|
12287
12363
|
*/
|
|
12288
12364
|
channel?: string | null;
|
|
12289
12365
|
/**
|
|
12290
|
-
*
|
|
12366
|
+
* Unique Leadping identifier for the suppression entry.
|
|
12291
12367
|
*/
|
|
12292
12368
|
id?: string | null;
|
|
12293
12369
|
/**
|
|
12294
|
-
*
|
|
12370
|
+
* Suppressed email address normalized for matching.
|
|
12295
12371
|
*/
|
|
12296
12372
|
normalizedEmail?: string | null;
|
|
12297
12373
|
/**
|
|
12298
|
-
*
|
|
12374
|
+
* Suppressed phone number normalized to a consistent format.
|
|
12299
12375
|
*/
|
|
12300
12376
|
normalizedPhoneNumber?: string | null;
|
|
12301
12377
|
/**
|
|
12302
|
-
*
|
|
12378
|
+
* Identifier of the organization that owns the suppression entry.
|
|
12303
12379
|
*/
|
|
12304
12380
|
organizationId?: string | null;
|
|
12305
12381
|
/**
|
|
12306
|
-
*
|
|
12382
|
+
* Human-readable reason the recipient was suppressed or subsequently released.
|
|
12307
12383
|
*/
|
|
12308
12384
|
reason?: string | null;
|
|
12309
12385
|
/**
|
|
12310
|
-
*
|
|
12386
|
+
* Provider or customer identifier used to recognize the suppressed recipient.
|
|
12311
12387
|
*/
|
|
12312
12388
|
recipientIdentifier?: string | null;
|
|
12313
12389
|
/**
|
|
12314
|
-
*
|
|
12390
|
+
* UTC timestamp when the suppression was released, or while it remains active.
|
|
12315
12391
|
*/
|
|
12316
12392
|
releasedAt?: Date | null;
|
|
12317
12393
|
/**
|
|
12318
|
-
*
|
|
12394
|
+
* System or workflow that created the suppression.
|
|
12319
12395
|
*/
|
|
12320
12396
|
source?: string | null;
|
|
12321
12397
|
/**
|
|
12322
|
-
*
|
|
12398
|
+
* Current lifecycle state, such as active or released.
|
|
12323
12399
|
*/
|
|
12324
12400
|
status?: string | null;
|
|
12325
12401
|
/**
|
|
12326
|
-
*
|
|
12402
|
+
* UTC timestamp when the suppression became active.
|
|
12327
12403
|
*/
|
|
12328
12404
|
suppressedAt?: Date | null;
|
|
12329
12405
|
}
|
|
12330
12406
|
/**
|
|
12331
|
-
*
|
|
12407
|
+
* Defines the fields clients can send when working with tag.
|
|
12332
12408
|
*/
|
|
12333
12409
|
export interface TagRequest extends AdditionalDataHolder, Parsable {
|
|
12334
12410
|
/**
|
|
@@ -12349,7 +12425,7 @@ export interface TagRequest extends AdditionalDataHolder, Parsable {
|
|
|
12349
12425
|
name?: string | null;
|
|
12350
12426
|
}
|
|
12351
12427
|
/**
|
|
12352
|
-
*
|
|
12428
|
+
* Describes tag data returned by Leadping.
|
|
12353
12429
|
*/
|
|
12354
12430
|
export interface TagResponse extends AdditionalDataHolder, Parsable {
|
|
12355
12431
|
/**
|
|
@@ -12423,12 +12499,12 @@ export interface TagSummary extends AdditionalDataHolder, Parsable {
|
|
|
12423
12499
|
*/
|
|
12424
12500
|
export interface TelephonyLoginRequest extends AdditionalDataHolder, Parsable {
|
|
12425
12501
|
/**
|
|
12426
|
-
*
|
|
12502
|
+
* Identifier and display name of the related device.
|
|
12427
12503
|
*/
|
|
12428
12504
|
device?: TelephonyLoginRequest_device | null;
|
|
12429
12505
|
}
|
|
12430
12506
|
/**
|
|
12431
|
-
*
|
|
12507
|
+
* Identifier and display name of the related device.
|
|
12432
12508
|
*/
|
|
12433
12509
|
export interface TelephonyLoginRequest_device extends IdNamePair, Parsable {
|
|
12434
12510
|
}
|
|
@@ -12437,24 +12513,24 @@ export interface TelephonyLoginRequest_device extends IdNamePair, Parsable {
|
|
|
12437
12513
|
*/
|
|
12438
12514
|
export interface TelephonyLoginResponse extends AdditionalDataHolder, Parsable {
|
|
12439
12515
|
/**
|
|
12440
|
-
*
|
|
12516
|
+
* Callback token for this telephony login.
|
|
12441
12517
|
*/
|
|
12442
12518
|
callbackToken?: string | null;
|
|
12443
12519
|
/**
|
|
12444
|
-
*
|
|
12520
|
+
* UTC timestamp for expires at on this telephony login.
|
|
12445
12521
|
*/
|
|
12446
12522
|
expiresAt?: Date | null;
|
|
12447
12523
|
/**
|
|
12448
|
-
*
|
|
12524
|
+
* Password for this telephony login.
|
|
12449
12525
|
*/
|
|
12450
12526
|
password?: string | null;
|
|
12451
12527
|
/**
|
|
12452
|
-
*
|
|
12528
|
+
* Username for this telephony login.
|
|
12453
12529
|
*/
|
|
12454
12530
|
username?: string | null;
|
|
12455
12531
|
}
|
|
12456
12532
|
/**
|
|
12457
|
-
*
|
|
12533
|
+
* Describes ten dlc application draft data used in Leadping API requests and responses.
|
|
12458
12534
|
*/
|
|
12459
12535
|
export interface TenDlcApplicationDraft extends AdditionalDataHolder, Parsable {
|
|
12460
12536
|
/**
|
|
@@ -12466,7 +12542,7 @@ export interface TenDlcApplicationDraft extends AdditionalDataHolder, Parsable {
|
|
|
12466
12542
|
*/
|
|
12467
12543
|
campaignStatus?: TenDlcRegistrationStatus | null;
|
|
12468
12544
|
/**
|
|
12469
|
-
*
|
|
12545
|
+
* Company name for this 10DLC application draft.
|
|
12470
12546
|
*/
|
|
12471
12547
|
companyName?: string | null;
|
|
12472
12548
|
/**
|
|
@@ -12474,23 +12550,23 @@ export interface TenDlcApplicationDraft extends AdditionalDataHolder, Parsable {
|
|
|
12474
12550
|
*/
|
|
12475
12551
|
complianceWarnings?: string[] | null;
|
|
12476
12552
|
/**
|
|
12477
|
-
*
|
|
12553
|
+
* Contact email for this 10DLC application draft.
|
|
12478
12554
|
*/
|
|
12479
12555
|
contactEmail?: string | null;
|
|
12480
12556
|
/**
|
|
12481
|
-
*
|
|
12557
|
+
* Contact name for this 10DLC application draft.
|
|
12482
12558
|
*/
|
|
12483
12559
|
contactName?: string | null;
|
|
12484
12560
|
/**
|
|
12485
|
-
*
|
|
12561
|
+
* Contact phone for this 10DLC application draft.
|
|
12486
12562
|
*/
|
|
12487
12563
|
contactPhone?: string | null;
|
|
12488
12564
|
/**
|
|
12489
|
-
*
|
|
12565
|
+
* EIN for this 10DLC application draft.
|
|
12490
12566
|
*/
|
|
12491
12567
|
ein?: string | null;
|
|
12492
12568
|
/**
|
|
12493
|
-
*
|
|
12569
|
+
* Expected monthly volume for this 10DLC application draft.
|
|
12494
12570
|
*/
|
|
12495
12571
|
expectedMonthlyVolume?: number | null;
|
|
12496
12572
|
/**
|
|
@@ -12498,13 +12574,9 @@ export interface TenDlcApplicationDraft extends AdditionalDataHolder, Parsable {
|
|
|
12498
12574
|
*/
|
|
12499
12575
|
industry?: string | null;
|
|
12500
12576
|
/**
|
|
12501
|
-
*
|
|
12577
|
+
* UTC timestamp for last submitted at on this 10DLC application draft.
|
|
12502
12578
|
*/
|
|
12503
12579
|
lastSubmittedAt?: Date | null;
|
|
12504
|
-
/**
|
|
12505
|
-
* The lead source value for this 10DLC application draft.
|
|
12506
|
-
*/
|
|
12507
|
-
leadSource?: string | null;
|
|
12508
12580
|
/**
|
|
12509
12581
|
* The message examples included with this 10DLC application draft.
|
|
12510
12582
|
*/
|
|
@@ -12514,11 +12586,11 @@ export interface TenDlcApplicationDraft extends AdditionalDataHolder, Parsable {
|
|
|
12514
12586
|
*/
|
|
12515
12587
|
missingFields?: string[] | null;
|
|
12516
12588
|
/**
|
|
12517
|
-
*
|
|
12589
|
+
* Opt in language for this 10DLC application draft.
|
|
12518
12590
|
*/
|
|
12519
12591
|
optInLanguage?: string | null;
|
|
12520
12592
|
/**
|
|
12521
|
-
*
|
|
12593
|
+
* Public privacy-policy URL that explains how messaging recipient data is handled.
|
|
12522
12594
|
*/
|
|
12523
12595
|
privacyPolicyUrl?: string | null;
|
|
12524
12596
|
/**
|
|
@@ -12526,7 +12598,7 @@ export interface TenDlcApplicationDraft extends AdditionalDataHolder, Parsable {
|
|
|
12526
12598
|
*/
|
|
12527
12599
|
rejectionReason?: string | null;
|
|
12528
12600
|
/**
|
|
12529
|
-
*
|
|
12601
|
+
* Public terms-of-service URL governing the messaging program.
|
|
12530
12602
|
*/
|
|
12531
12603
|
termsUrl?: string | null;
|
|
12532
12604
|
/**
|
|
@@ -12534,23 +12606,23 @@ export interface TenDlcApplicationDraft extends AdditionalDataHolder, Parsable {
|
|
|
12534
12606
|
*/
|
|
12535
12607
|
trustedFormRequired?: boolean | null;
|
|
12536
12608
|
/**
|
|
12537
|
-
*
|
|
12609
|
+
* UTC timestamp for updated at on this 10DLC application draft.
|
|
12538
12610
|
*/
|
|
12539
12611
|
updatedAt?: Date | null;
|
|
12540
12612
|
/**
|
|
12541
|
-
*
|
|
12613
|
+
* Use case for this 10DLC application draft.
|
|
12542
12614
|
*/
|
|
12543
12615
|
useCase?: string | null;
|
|
12544
12616
|
/**
|
|
12545
|
-
*
|
|
12617
|
+
* Use case description for this 10DLC application draft.
|
|
12546
12618
|
*/
|
|
12547
12619
|
useCaseDescription?: string | null;
|
|
12548
12620
|
/**
|
|
12549
|
-
*
|
|
12621
|
+
* Version for this 10DLC application draft.
|
|
12550
12622
|
*/
|
|
12551
12623
|
version?: number | null;
|
|
12552
12624
|
/**
|
|
12553
|
-
*
|
|
12625
|
+
* Public business website URL submitted to carriers during brand review.
|
|
12554
12626
|
*/
|
|
12555
12627
|
websiteUrl?: string | null;
|
|
12556
12628
|
}
|
|
@@ -12566,7 +12638,7 @@ export interface TenDlcNotesRequest extends AdditionalDataHolder, Parsable {
|
|
|
12566
12638
|
}
|
|
12567
12639
|
export type TenDlcRegistrationStatus = (typeof TenDlcRegistrationStatusObject)[keyof typeof TenDlcRegistrationStatusObject];
|
|
12568
12640
|
/**
|
|
12569
|
-
*
|
|
12641
|
+
* Describes billing transaction data returned by Leadping.
|
|
12570
12642
|
*/
|
|
12571
12643
|
export interface TransactionResponse extends AdditionalDataHolder, Parsable {
|
|
12572
12644
|
/**
|
|
@@ -12578,7 +12650,7 @@ export interface TransactionResponse extends AdditionalDataHolder, Parsable {
|
|
|
12578
12650
|
*/
|
|
12579
12651
|
billableUnit?: TransactionResponse_billableUnit | null;
|
|
12580
12652
|
/**
|
|
12581
|
-
*
|
|
12653
|
+
* Customer-facing amount billed for the transaction.
|
|
12582
12654
|
*/
|
|
12583
12655
|
billedAmount?: number | null;
|
|
12584
12656
|
/**
|
|
@@ -12606,7 +12678,7 @@ export interface TransactionResponse extends AdditionalDataHolder, Parsable {
|
|
|
12606
12678
|
*/
|
|
12607
12679
|
id?: string | null;
|
|
12608
12680
|
/**
|
|
12609
|
-
*
|
|
12681
|
+
* Identifier and display name of the related lead.
|
|
12610
12682
|
*/
|
|
12611
12683
|
lead?: TransactionResponse_lead | null;
|
|
12612
12684
|
/**
|
|
@@ -12622,7 +12694,7 @@ export interface TransactionResponse extends AdditionalDataHolder, Parsable {
|
|
|
12622
12694
|
*/
|
|
12623
12695
|
notes?: string | null;
|
|
12624
12696
|
/**
|
|
12625
|
-
*
|
|
12697
|
+
* Identifier and display name of the related organization.
|
|
12626
12698
|
*/
|
|
12627
12699
|
organization?: TransactionResponse_organization | null;
|
|
12628
12700
|
/**
|
|
@@ -12645,18 +12717,18 @@ export interface TransactionResponse extends AdditionalDataHolder, Parsable {
|
|
|
12645
12717
|
export type TransactionResponse_billableUnit = (typeof TransactionResponse_billableUnitObject)[keyof typeof TransactionResponse_billableUnitObject];
|
|
12646
12718
|
export type TransactionResponse_billingChannel = (typeof TransactionResponse_billingChannelObject)[keyof typeof TransactionResponse_billingChannelObject];
|
|
12647
12719
|
/**
|
|
12648
|
-
*
|
|
12720
|
+
* Identifier and display name of the related lead.
|
|
12649
12721
|
*/
|
|
12650
12722
|
export interface TransactionResponse_lead extends IdNamePair, Parsable {
|
|
12651
12723
|
}
|
|
12652
12724
|
/**
|
|
12653
|
-
*
|
|
12725
|
+
* Identifier and display name of the related organization.
|
|
12654
12726
|
*/
|
|
12655
12727
|
export interface TransactionResponse_organization extends IdNamePair, Parsable {
|
|
12656
12728
|
}
|
|
12657
12729
|
export type TransactionStatus = (typeof TransactionStatusObject)[keyof typeof TransactionStatusObject];
|
|
12658
12730
|
/**
|
|
12659
|
-
*
|
|
12731
|
+
* Summarizes billing transaction data in paginated and searchable results.
|
|
12660
12732
|
*/
|
|
12661
12733
|
export interface TransactionTableRow extends AdditionalDataHolder, Parsable {
|
|
12662
12734
|
/**
|
|
@@ -12668,7 +12740,7 @@ export interface TransactionTableRow extends AdditionalDataHolder, Parsable {
|
|
|
12668
12740
|
*/
|
|
12669
12741
|
billableUnit?: TransactionTableRow_billableUnit | null;
|
|
12670
12742
|
/**
|
|
12671
|
-
*
|
|
12743
|
+
* Customer-facing amount billed for the metered usage or wallet transaction.
|
|
12672
12744
|
*/
|
|
12673
12745
|
billedAmount?: number | null;
|
|
12674
12746
|
/**
|
|
@@ -12688,7 +12760,7 @@ export interface TransactionTableRow extends AdditionalDataHolder, Parsable {
|
|
|
12688
12760
|
*/
|
|
12689
12761
|
id?: string | null;
|
|
12690
12762
|
/**
|
|
12691
|
-
*
|
|
12763
|
+
* Identifier and display name of the related lead.
|
|
12692
12764
|
*/
|
|
12693
12765
|
lead?: TransactionTableRow_lead | null;
|
|
12694
12766
|
/**
|
|
@@ -12696,7 +12768,7 @@ export interface TransactionTableRow extends AdditionalDataHolder, Parsable {
|
|
|
12696
12768
|
*/
|
|
12697
12769
|
netAmount?: number | null;
|
|
12698
12770
|
/**
|
|
12699
|
-
*
|
|
12771
|
+
* Identifier and display name of the related organization.
|
|
12700
12772
|
*/
|
|
12701
12773
|
organization?: TransactionTableRow_organization | null;
|
|
12702
12774
|
/**
|
|
@@ -12704,19 +12776,19 @@ export interface TransactionTableRow extends AdditionalDataHolder, Parsable {
|
|
|
12704
12776
|
*/
|
|
12705
12777
|
paymentMethodDisplay?: string | null;
|
|
12706
12778
|
/**
|
|
12707
|
-
*
|
|
12779
|
+
* Version of the pricing rules used to calculate the billed amount.
|
|
12708
12780
|
*/
|
|
12709
12781
|
pricingVersion?: string | null;
|
|
12710
12782
|
/**
|
|
12711
|
-
*
|
|
12783
|
+
* Number of billable units measured for this transaction, when usage-based pricing applies.
|
|
12712
12784
|
*/
|
|
12713
12785
|
quantity?: number | null;
|
|
12714
12786
|
/**
|
|
12715
|
-
*
|
|
12787
|
+
* Identifier of the event that created this billing transaction, when available.
|
|
12716
12788
|
*/
|
|
12717
12789
|
sourceEventId?: string | null;
|
|
12718
12790
|
/**
|
|
12719
|
-
*
|
|
12791
|
+
* Event type that created this billing transaction, when available.
|
|
12720
12792
|
*/
|
|
12721
12793
|
sourceEventType?: string | null;
|
|
12722
12794
|
/**
|
|
@@ -12728,37 +12800,37 @@ export interface TransactionTableRow extends AdditionalDataHolder, Parsable {
|
|
|
12728
12800
|
*/
|
|
12729
12801
|
transactionType?: TransactionType | null;
|
|
12730
12802
|
/**
|
|
12731
|
-
*
|
|
12803
|
+
* Price charged per billable unit when usage-based pricing applies.
|
|
12732
12804
|
*/
|
|
12733
12805
|
unitPrice?: number | null;
|
|
12734
12806
|
}
|
|
12735
12807
|
export type TransactionTableRow_billableUnit = (typeof TransactionTableRow_billableUnitObject)[keyof typeof TransactionTableRow_billableUnitObject];
|
|
12736
12808
|
export type TransactionTableRow_billingChannel = (typeof TransactionTableRow_billingChannelObject)[keyof typeof TransactionTableRow_billingChannelObject];
|
|
12737
12809
|
/**
|
|
12738
|
-
*
|
|
12810
|
+
* Identifier and display name of the related lead.
|
|
12739
12811
|
*/
|
|
12740
12812
|
export interface TransactionTableRow_lead extends IdNamePair, Parsable {
|
|
12741
12813
|
}
|
|
12742
12814
|
/**
|
|
12743
|
-
*
|
|
12815
|
+
* Identifier and display name of the related organization.
|
|
12744
12816
|
*/
|
|
12745
12817
|
export interface TransactionTableRow_organization extends IdNamePair, Parsable {
|
|
12746
12818
|
}
|
|
12747
12819
|
export type TransactionType = (typeof TransactionTypeObject)[keyof typeof TransactionTypeObject];
|
|
12748
12820
|
/**
|
|
12749
|
-
*
|
|
12821
|
+
* Describes trusted form certificate data used in Leadping API requests and responses.
|
|
12750
12822
|
*/
|
|
12751
12823
|
export interface TrustedFormCertificate extends AdditionalDataHolder, Parsable {
|
|
12752
12824
|
/**
|
|
12753
|
-
*
|
|
12825
|
+
* UTC timestamp for created at on this TrustedForm certificate.
|
|
12754
12826
|
*/
|
|
12755
12827
|
createdAt?: Date | null;
|
|
12756
12828
|
/**
|
|
12757
|
-
*
|
|
12829
|
+
* Unique Leadping identifier for this TrustedForm certificate.
|
|
12758
12830
|
*/
|
|
12759
12831
|
id?: string | null;
|
|
12760
12832
|
/**
|
|
12761
|
-
*
|
|
12833
|
+
* Source for this TrustedForm certificate.
|
|
12762
12834
|
*/
|
|
12763
12835
|
source?: string | null;
|
|
12764
12836
|
/**
|
|
@@ -12768,7 +12840,7 @@ export interface TrustedFormCertificate extends AdditionalDataHolder, Parsable {
|
|
|
12768
12840
|
}
|
|
12769
12841
|
export type UsageChannel = (typeof UsageChannelObject)[keyof typeof UsageChannelObject];
|
|
12770
12842
|
/**
|
|
12771
|
-
*
|
|
12843
|
+
* Describes one named usage total displayed in organization billing and activity summaries.
|
|
12772
12844
|
*/
|
|
12773
12845
|
export interface UsageCounterLine extends AdditionalDataHolder, Parsable {
|
|
12774
12846
|
/**
|
|
@@ -12788,28 +12860,28 @@ export interface UsageCounterLine extends AdditionalDataHolder, Parsable {
|
|
|
12788
12860
|
*/
|
|
12789
12861
|
unit?: string | null;
|
|
12790
12862
|
/**
|
|
12791
|
-
*
|
|
12863
|
+
* Numeric for this usage counter.
|
|
12792
12864
|
*/
|
|
12793
12865
|
value?: number | null;
|
|
12794
12866
|
}
|
|
12795
12867
|
/**
|
|
12796
|
-
*
|
|
12868
|
+
* Describes usage ledger data used in Leadping API requests and responses.
|
|
12797
12869
|
*/
|
|
12798
12870
|
export interface UsageLedgerTableRow extends AdditionalDataHolder, Parsable {
|
|
12799
12871
|
/**
|
|
12800
|
-
*
|
|
12872
|
+
* Billable seconds for this usage ledger.
|
|
12801
12873
|
*/
|
|
12802
12874
|
billableSeconds?: number | null;
|
|
12803
12875
|
/**
|
|
12804
|
-
*
|
|
12876
|
+
* Billable unit for this usage ledger.
|
|
12805
12877
|
*/
|
|
12806
12878
|
billableUnit?: BillableUnit | null;
|
|
12807
12879
|
/**
|
|
12808
|
-
*
|
|
12880
|
+
* Channel for this usage ledger.
|
|
12809
12881
|
*/
|
|
12810
12882
|
channel?: UsageChannel | null;
|
|
12811
12883
|
/**
|
|
12812
|
-
*
|
|
12884
|
+
* UTC timestamp for created at on this usage ledger.
|
|
12813
12885
|
*/
|
|
12814
12886
|
createdAt?: Date | null;
|
|
12815
12887
|
/**
|
|
@@ -12821,11 +12893,11 @@ export interface UsageLedgerTableRow extends AdditionalDataHolder, Parsable {
|
|
|
12821
12893
|
*/
|
|
12822
12894
|
description?: string | null;
|
|
12823
12895
|
/**
|
|
12824
|
-
*
|
|
12896
|
+
* Duration seconds for this usage ledger.
|
|
12825
12897
|
*/
|
|
12826
12898
|
durationSeconds?: number | null;
|
|
12827
12899
|
/**
|
|
12828
|
-
*
|
|
12900
|
+
* Unique Leadping identifier for this usage ledger.
|
|
12829
12901
|
*/
|
|
12830
12902
|
id?: string | null;
|
|
12831
12903
|
/**
|
|
@@ -12833,11 +12905,11 @@ export interface UsageLedgerTableRow extends AdditionalDataHolder, Parsable {
|
|
|
12833
12905
|
*/
|
|
12834
12906
|
isBillable?: boolean | null;
|
|
12835
12907
|
/**
|
|
12836
|
-
*
|
|
12908
|
+
* Identifier and display name of the related lead.
|
|
12837
12909
|
*/
|
|
12838
12910
|
lead?: UsageLedgerTableRow_lead | null;
|
|
12839
12911
|
/**
|
|
12840
|
-
*
|
|
12912
|
+
* Identifier and display name of the related organization.
|
|
12841
12913
|
*/
|
|
12842
12914
|
organization?: UsageLedgerTableRow_organization | null;
|
|
12843
12915
|
/**
|
|
@@ -12849,11 +12921,11 @@ export interface UsageLedgerTableRow extends AdditionalDataHolder, Parsable {
|
|
|
12849
12921
|
*/
|
|
12850
12922
|
phoneNumberId?: string | null;
|
|
12851
12923
|
/**
|
|
12852
|
-
*
|
|
12924
|
+
* Quantity for this usage ledger.
|
|
12853
12925
|
*/
|
|
12854
12926
|
quantity?: number | null;
|
|
12855
12927
|
/**
|
|
12856
|
-
*
|
|
12928
|
+
* SMS segments for this usage ledger.
|
|
12857
12929
|
*/
|
|
12858
12930
|
smsSegments?: number | null;
|
|
12859
12931
|
/**
|
|
@@ -12861,40 +12933,40 @@ export interface UsageLedgerTableRow extends AdditionalDataHolder, Parsable {
|
|
|
12861
12933
|
*/
|
|
12862
12934
|
status?: UsageStatus | null;
|
|
12863
12935
|
/**
|
|
12864
|
-
*
|
|
12936
|
+
* Unit price for this usage ledger.
|
|
12865
12937
|
*/
|
|
12866
12938
|
unitPrice?: number | null;
|
|
12867
12939
|
/**
|
|
12868
|
-
*
|
|
12940
|
+
* Identifier and display name of the related user.
|
|
12869
12941
|
*/
|
|
12870
12942
|
user?: UsageLedgerTableRow_user | null;
|
|
12871
12943
|
}
|
|
12872
12944
|
/**
|
|
12873
|
-
*
|
|
12945
|
+
* Identifier and display name of the related lead.
|
|
12874
12946
|
*/
|
|
12875
12947
|
export interface UsageLedgerTableRow_lead extends IdNamePair, Parsable {
|
|
12876
12948
|
}
|
|
12877
12949
|
/**
|
|
12878
|
-
*
|
|
12950
|
+
* Identifier and display name of the related organization.
|
|
12879
12951
|
*/
|
|
12880
12952
|
export interface UsageLedgerTableRow_organization extends IdNamePair, Parsable {
|
|
12881
12953
|
}
|
|
12882
12954
|
/**
|
|
12883
|
-
*
|
|
12955
|
+
* Identifier and display name of the related user.
|
|
12884
12956
|
*/
|
|
12885
12957
|
export interface UsageLedgerTableRow_user extends IdNamePair, Parsable {
|
|
12886
12958
|
}
|
|
12887
12959
|
export type UsageStatus = (typeof UsageStatusObject)[keyof typeof UsageStatusObject];
|
|
12888
12960
|
/**
|
|
12889
|
-
*
|
|
12961
|
+
* Describes usage summary line data used in Leadping API requests and responses.
|
|
12890
12962
|
*/
|
|
12891
12963
|
export interface UsageSummaryLine extends AdditionalDataHolder, Parsable {
|
|
12892
12964
|
/**
|
|
12893
|
-
*
|
|
12965
|
+
* Billable unit for this usage summary line.
|
|
12894
12966
|
*/
|
|
12895
12967
|
billableUnit?: BillableUnit | null;
|
|
12896
12968
|
/**
|
|
12897
|
-
*
|
|
12969
|
+
* Channel for this usage summary line.
|
|
12898
12970
|
*/
|
|
12899
12971
|
channel?: UsageChannel | null;
|
|
12900
12972
|
/**
|
|
@@ -12902,7 +12974,7 @@ export interface UsageSummaryLine extends AdditionalDataHolder, Parsable {
|
|
|
12902
12974
|
*/
|
|
12903
12975
|
customerChargeAmount?: number | null;
|
|
12904
12976
|
/**
|
|
12905
|
-
*
|
|
12977
|
+
* Quantity for this usage summary line.
|
|
12906
12978
|
*/
|
|
12907
12979
|
quantity?: number | null;
|
|
12908
12980
|
/**
|
|
@@ -12915,7 +12987,7 @@ export interface UsageSummaryLine extends AdditionalDataHolder, Parsable {
|
|
|
12915
12987
|
status?: UsageStatus | null;
|
|
12916
12988
|
}
|
|
12917
12989
|
/**
|
|
12918
|
-
*
|
|
12990
|
+
* Describes usage summary response data used by Leadping.
|
|
12919
12991
|
*/
|
|
12920
12992
|
export interface UsageSummaryResponse extends AdditionalDataHolder, Parsable {
|
|
12921
12993
|
/**
|
|
@@ -12943,11 +13015,11 @@ export interface UsageSummaryResponse extends AdditionalDataHolder, Parsable {
|
|
|
12943
13015
|
*/
|
|
12944
13016
|
pendingInvoiceCount?: number | null;
|
|
12945
13017
|
/**
|
|
12946
|
-
*
|
|
13018
|
+
* UTC timestamp for period end on this usage summary.
|
|
12947
13019
|
*/
|
|
12948
13020
|
periodEnd?: Date | null;
|
|
12949
13021
|
/**
|
|
12950
|
-
*
|
|
13022
|
+
* UTC timestamp for period start on this usage summary.
|
|
12951
13023
|
*/
|
|
12952
13024
|
periodStart?: Date | null;
|
|
12953
13025
|
/**
|
|
@@ -12956,7 +13028,7 @@ export interface UsageSummaryResponse extends AdditionalDataHolder, Parsable {
|
|
|
12956
13028
|
transactionCount?: number | null;
|
|
12957
13029
|
}
|
|
12958
13030
|
/**
|
|
12959
|
-
*
|
|
13031
|
+
* Describes user compliance data used in Leadping API requests and responses.
|
|
12960
13032
|
*/
|
|
12961
13033
|
export interface UserCompliance extends AdditionalDataHolder, Parsable {
|
|
12962
13034
|
/**
|
|
@@ -13058,7 +13130,7 @@ export interface UserDataExportResponse extends AdditionalDataHolder, Parsable {
|
|
|
13058
13130
|
*/
|
|
13059
13131
|
requestedAt?: Date | null;
|
|
13060
13132
|
/**
|
|
13061
|
-
*
|
|
13133
|
+
* Size of the generated export archive in bytes, when the export is ready.
|
|
13062
13134
|
*/
|
|
13063
13135
|
sizeBytes?: number | null;
|
|
13064
13136
|
/**
|
|
@@ -13076,20 +13148,20 @@ export type UserDataExportStatuses = (typeof UserDataExportStatusesObject)[keyof
|
|
|
13076
13148
|
*/
|
|
13077
13149
|
export interface UserIdentity extends AdditionalDataHolder, Parsable {
|
|
13078
13150
|
/**
|
|
13079
|
-
*
|
|
13151
|
+
* Identity provider or tenant that issued the user's sign-in identity.
|
|
13080
13152
|
*/
|
|
13081
13153
|
issuer?: string | null;
|
|
13082
13154
|
/**
|
|
13083
|
-
*
|
|
13155
|
+
* Unique user identifier assigned by the identity provider.
|
|
13084
13156
|
*/
|
|
13085
13157
|
issuerAssignedId?: string | null;
|
|
13086
13158
|
/**
|
|
13087
|
-
*
|
|
13159
|
+
* Sign-in method represented by the identity, such as email address, username, or federated login.
|
|
13088
13160
|
*/
|
|
13089
13161
|
signInType?: string | null;
|
|
13090
13162
|
}
|
|
13091
13163
|
/**
|
|
13092
|
-
*
|
|
13164
|
+
* Describes user notification preferences data used in Leadping API requests and responses.
|
|
13093
13165
|
*/
|
|
13094
13166
|
export interface UserNotificationPreferences extends AdditionalDataHolder, Parsable {
|
|
13095
13167
|
/**
|
|
@@ -13207,7 +13279,7 @@ export interface UserNotificationPreferences extends AdditionalDataHolder, Parsa
|
|
|
13207
13279
|
export interface UserNotificationPreferences_smsConsentTrustedFormCertificate extends Parsable, TrustedFormCertificate {
|
|
13208
13280
|
}
|
|
13209
13281
|
/**
|
|
13210
|
-
*
|
|
13282
|
+
* Defines the fields clients can send when working with user profile.
|
|
13211
13283
|
*/
|
|
13212
13284
|
export interface UserRequest extends AdditionalDataHolder, Parsable {
|
|
13213
13285
|
/**
|
|
@@ -13276,7 +13348,7 @@ export interface UserRequest_currentOrganization extends IdNamePair, Parsable {
|
|
|
13276
13348
|
export interface UserRequest_notificationPreferences extends Parsable, UserNotificationPreferences {
|
|
13277
13349
|
}
|
|
13278
13350
|
/**
|
|
13279
|
-
*
|
|
13351
|
+
* Describes user data returned by Leadping.
|
|
13280
13352
|
*/
|
|
13281
13353
|
export interface UserResponse extends AdditionalDataHolder, Parsable {
|
|
13282
13354
|
/**
|
|
@@ -13288,7 +13360,7 @@ export interface UserResponse extends AdditionalDataHolder, Parsable {
|
|
|
13288
13360
|
*/
|
|
13289
13361
|
billingState?: UserResponse_billingState | null;
|
|
13290
13362
|
/**
|
|
13291
|
-
*
|
|
13363
|
+
* Compliance for this user.
|
|
13292
13364
|
*/
|
|
13293
13365
|
compliance?: UserResponse_compliance | null;
|
|
13294
13366
|
/**
|
|
@@ -13296,7 +13368,7 @@ export interface UserResponse extends AdditionalDataHolder, Parsable {
|
|
|
13296
13368
|
*/
|
|
13297
13369
|
createdAt?: Date | null;
|
|
13298
13370
|
/**
|
|
13299
|
-
*
|
|
13371
|
+
* Current organization for this user.
|
|
13300
13372
|
*/
|
|
13301
13373
|
currentOrganization?: UserResponse_currentOrganization | null;
|
|
13302
13374
|
/**
|
|
@@ -13304,7 +13376,7 @@ export interface UserResponse extends AdditionalDataHolder, Parsable {
|
|
|
13304
13376
|
*/
|
|
13305
13377
|
email?: string | null;
|
|
13306
13378
|
/**
|
|
13307
|
-
*
|
|
13379
|
+
* First name for this user.
|
|
13308
13380
|
*/
|
|
13309
13381
|
firstName?: string | null;
|
|
13310
13382
|
/**
|
|
@@ -13320,7 +13392,7 @@ export interface UserResponse extends AdditionalDataHolder, Parsable {
|
|
|
13320
13392
|
*/
|
|
13321
13393
|
lastLoggedInAt?: Date | null;
|
|
13322
13394
|
/**
|
|
13323
|
-
*
|
|
13395
|
+
* UTC timestamp for last name on this user.
|
|
13324
13396
|
*/
|
|
13325
13397
|
lastName?: string | null;
|
|
13326
13398
|
/**
|
|
@@ -13336,11 +13408,11 @@ export interface UserResponse extends AdditionalDataHolder, Parsable {
|
|
|
13336
13408
|
*/
|
|
13337
13409
|
name?: string | null;
|
|
13338
13410
|
/**
|
|
13339
|
-
*
|
|
13411
|
+
* Notification preferences for this user.
|
|
13340
13412
|
*/
|
|
13341
13413
|
notificationPreferences?: UserResponse_notificationPreferences | null;
|
|
13342
13414
|
/**
|
|
13343
|
-
*
|
|
13415
|
+
* UTC timestamp for personal data deleted at on this user.
|
|
13344
13416
|
*/
|
|
13345
13417
|
personalDataDeletedAt?: Date | null;
|
|
13346
13418
|
/**
|
|
@@ -13348,7 +13420,7 @@ export interface UserResponse extends AdditionalDataHolder, Parsable {
|
|
|
13348
13420
|
*/
|
|
13349
13421
|
personalDataDeletionReason?: string | null;
|
|
13350
13422
|
/**
|
|
13351
|
-
*
|
|
13423
|
+
* UTC timestamp for personal data deletion requested at on this user.
|
|
13352
13424
|
*/
|
|
13353
13425
|
personalDataDeletionRequestedAt?: Date | null;
|
|
13354
13426
|
/**
|
|
@@ -13379,23 +13451,23 @@ export type UserResponse_billingPlan = (typeof UserResponse_billingPlanObject)[k
|
|
|
13379
13451
|
export interface UserResponse_billingState extends OrganizationBillingState, Parsable {
|
|
13380
13452
|
}
|
|
13381
13453
|
/**
|
|
13382
|
-
*
|
|
13454
|
+
* Compliance for this user.
|
|
13383
13455
|
*/
|
|
13384
13456
|
export interface UserResponse_compliance extends Parsable, UserCompliance {
|
|
13385
13457
|
}
|
|
13386
13458
|
/**
|
|
13387
|
-
*
|
|
13459
|
+
* Current organization for this user.
|
|
13388
13460
|
*/
|
|
13389
13461
|
export interface UserResponse_currentOrganization extends IdNamePair, Parsable {
|
|
13390
13462
|
}
|
|
13391
13463
|
/**
|
|
13392
|
-
*
|
|
13464
|
+
* Notification preferences for this user.
|
|
13393
13465
|
*/
|
|
13394
13466
|
export interface UserResponse_notificationPreferences extends Parsable, UserNotificationPreferences {
|
|
13395
13467
|
}
|
|
13396
13468
|
export type UserResponse_subscriptionStatus = (typeof UserResponse_subscriptionStatusObject)[keyof typeof UserResponse_subscriptionStatusObject];
|
|
13397
13469
|
/**
|
|
13398
|
-
*
|
|
13470
|
+
* Describes billing wallet data returned by Leadping.
|
|
13399
13471
|
*/
|
|
13400
13472
|
export interface WalletResponse extends AdditionalDataHolder, Parsable {
|
|
13401
13473
|
/**
|
|
@@ -14305,6 +14377,21 @@ export declare const PhoneCallStatusObject: {
|
|
|
14305
14377
|
readonly Blocked_permission: "blocked_permission";
|
|
14306
14378
|
readonly Configuration_required: "configuration_required";
|
|
14307
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
|
+
};
|
|
14308
14395
|
/**
|
|
14309
14396
|
* An enumerator describing phone line types
|
|
14310
14397
|
*/
|