@leadping/sdk 1.0.22 → 1.0.24

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. package/dist/businesses/me/index.d.ts +21 -0
  2. package/dist/businesses/me/index.d.ts.map +1 -1
  3. package/dist/businesses/me/index.js +18 -0
  4. package/dist/businesses/me/index.js.map +1 -1
  5. package/dist/businesses/me/oneZerodlc/index.d.ts +20 -0
  6. package/dist/businesses/me/oneZerodlc/index.d.ts.map +1 -0
  7. package/dist/businesses/me/oneZerodlc/index.js +20 -0
  8. package/dist/businesses/me/oneZerodlc/index.js.map +1 -0
  9. package/dist/businesses/me/oneZerodlc/notes/index.d.ts +32 -0
  10. package/dist/businesses/me/oneZerodlc/notes/index.d.ts.map +1 -0
  11. package/dist/businesses/me/oneZerodlc/notes/index.js +30 -0
  12. package/dist/businesses/me/oneZerodlc/notes/index.js.map +1 -0
  13. package/dist/leadStatuses/index.d.ts +53 -0
  14. package/dist/leadStatuses/index.d.ts.map +1 -0
  15. package/dist/leadStatuses/index.js +43 -0
  16. package/dist/leadStatuses/index.js.map +1 -0
  17. package/dist/leadStatuses/item/index.d.ts +42 -0
  18. package/dist/leadStatuses/item/index.d.ts.map +1 -0
  19. package/dist/leadStatuses/item/index.js +32 -0
  20. package/dist/leadStatuses/item/index.js.map +1 -0
  21. package/dist/leadpingOpenApiClient.d.ts +5 -0
  22. package/dist/leadpingOpenApiClient.d.ts.map +1 -1
  23. package/dist/leadpingOpenApiClient.js +6 -0
  24. package/dist/leadpingOpenApiClient.js.map +1 -1
  25. package/dist/models/index.d.ts +383 -0
  26. package/dist/models/index.d.ts.map +1 -1
  27. package/dist/models/index.js +350 -0
  28. package/dist/models/index.js.map +1 -1
  29. package/dist/notifications/index.d.ts +1 -1
  30. package/dist/notifications/index.d.ts.map +1 -1
  31. package/dist/notifications/index.js +2 -1
  32. package/dist/notifications/index.js.map +1 -1
  33. package/dist/notifications/item/index.d.ts +20 -1
  34. package/dist/notifications/item/index.d.ts.map +1 -1
  35. package/dist/notifications/item/index.js +17 -0
  36. package/dist/notifications/item/index.js.map +1 -1
  37. package/dist/notifications/me/index.d.ts +16 -3
  38. package/dist/notifications/me/index.d.ts.map +1 -1
  39. package/dist/notifications/me/index.js +1 -1
  40. package/dist/notifications/me/index.js.map +1 -1
  41. package/dist/paymentMethods/index.d.ts +7 -2
  42. package/dist/paymentMethods/index.d.ts.map +1 -1
  43. package/dist/paymentMethods/index.js +6 -0
  44. package/dist/paymentMethods/index.js.map +1 -1
  45. package/dist/paymentMethods/invoices/index.d.ts +39 -0
  46. package/dist/paymentMethods/invoices/index.d.ts.map +1 -0
  47. package/dist/paymentMethods/invoices/index.js +34 -0
  48. package/dist/paymentMethods/invoices/index.js.map +1 -0
  49. package/dist/paymentMethods/invoices/item/index.d.ts +20 -0
  50. package/dist/paymentMethods/invoices/item/index.d.ts.map +1 -0
  51. package/dist/paymentMethods/invoices/item/index.js +20 -0
  52. package/dist/paymentMethods/invoices/item/index.js.map +1 -0
  53. package/dist/paymentMethods/invoices/item/pdfAccess/index.d.ts +35 -0
  54. package/dist/paymentMethods/invoices/item/pdfAccess/index.d.ts.map +1 -0
  55. package/dist/paymentMethods/invoices/item/pdfAccess/index.js +26 -0
  56. package/dist/paymentMethods/invoices/item/pdfAccess/index.js.map +1 -0
  57. package/dist/paymentMethods/item/defaultEscaped/index.d.ts +2 -2
  58. package/package.json +1 -1
@@ -1217,6 +1217,10 @@ export interface BusinessActivationState_tenDlcDraft extends Parsable, TenDlcApp
1217
1217
  * Customer-safe billing state for a Leadping business.
1218
1218
  */
1219
1219
  export interface BusinessBillingState extends AdditionalDataHolder, Parsable {
1220
+ /**
1221
+ * Date and time when the scheduled billing plan change takes effect.
1222
+ */
1223
+ billingPlanChangeEffectiveAt?: Date | null;
1220
1224
  /**
1221
1225
  * Gets or sets the number of user licenses currently assigned by the business.
1222
1226
  */
@@ -1249,16 +1253,25 @@ export interface BusinessBillingState extends AdditionalDataHolder, Parsable {
1249
1253
  * Gets or sets when Leadping last processed a subscription event for the business.
1250
1254
  */
1251
1255
  lastSubscriptionEventAt?: Date | null;
1256
+ /**
1257
+ * Defines the supported Billing Plan values.
1258
+ */
1259
+ pendingBillingPlan?: BusinessBillingState_pendingBillingPlan | null;
1252
1260
  /**
1253
1261
  * Gets or sets the number of phone numbers included in the business subscription.
1254
1262
  */
1255
1263
  phoneNumberQuantity?: UntypedNode | null;
1264
+ /**
1265
+ * Current plan renewal date.
1266
+ */
1267
+ planRenewalAt?: Date | null;
1256
1268
  }
1257
1269
  /**
1258
1270
  * Gets or sets the customer-safe payment recovery state for the business.
1259
1271
  */
1260
1272
  export interface BusinessBillingState_dunning extends BusinessDunningInfo, Parsable {
1261
1273
  }
1274
+ export type BusinessBillingState_pendingBillingPlan = (typeof BusinessBillingState_pendingBillingPlanObject)[keyof typeof BusinessBillingState_pendingBillingPlanObject];
1262
1275
  /**
1263
1276
  * API DTO containing business compliance policy data used by Leadping API contracts.
1264
1277
  */
@@ -1533,6 +1546,10 @@ export interface BusinessRequest extends AdditionalDataHolder, Parsable {
1533
1546
  * Name used for invoices, receipts, and payment processor billing records.
1534
1547
  */
1535
1548
  billingName?: string | null;
1549
+ /**
1550
+ * Tax identifier printed on billing documents. This may differ from the business verification EIN.
1551
+ */
1552
+ billingTaxId?: string | null;
1536
1553
  /**
1537
1554
  * Compliance policy configuration for the business.
1538
1555
  */
@@ -1655,6 +1672,10 @@ export interface BusinessResponse extends AdditionalDataHolder, Parsable {
1655
1672
  * Customer-safe billing state for this business.
1656
1673
  */
1657
1674
  billingState?: BusinessResponse_billingState | null;
1675
+ /**
1676
+ * Tax identifier printed on billing documents. This may differ from the business verification EIN.
1677
+ */
1678
+ billingTaxId?: string | null;
1658
1679
  /**
1659
1680
  * Compliance policy configuration for the business.
1660
1681
  */
@@ -2978,6 +2999,12 @@ export declare function createIdNameValueFromDiscriminatorValue(parseNode: Parse
2978
2999
  * @returns {InitiateCallRequest}
2979
3000
  */
2980
3001
  export declare function createInitiateCallRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3002
+ /**
3003
+ * Creates a new instance of the appropriate class based on discriminator value
3004
+ * @param parseNode The parse node to use to read the discriminator value and create the object
3005
+ * @returns {InvoicePdfAccessResponse}
3006
+ */
3007
+ export declare function createInvoicePdfAccessResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
2981
3008
  /**
2982
3009
  * Creates a new instance of the appropriate class based on discriminator value
2983
3010
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -3056,6 +3083,18 @@ export declare function createLeadResponse_currentDispositionFromDiscriminatorVa
3056
3083
  * @returns {LeadResponse}
3057
3084
  */
3058
3085
  export declare function createLeadResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3086
+ /**
3087
+ * Creates a new instance of the appropriate class based on discriminator value
3088
+ * @param parseNode The parse node to use to read the discriminator value and create the object
3089
+ * @returns {LeadStatusRequest}
3090
+ */
3091
+ export declare function createLeadStatusRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3092
+ /**
3093
+ * Creates a new instance of the appropriate class based on discriminator value
3094
+ * @param parseNode The parse node to use to read the discriminator value and create the object
3095
+ * @returns {LeadStatusResponse}
3096
+ */
3097
+ export declare function createLeadStatusResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3059
3098
  /**
3060
3099
  * Creates a new instance of the appropriate class based on discriminator value
3061
3100
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -3101,6 +3140,12 @@ export interface CreateNoteRequest extends AdditionalDataHolder, Parsable {
3101
3140
  */
3102
3141
  text?: string | null;
3103
3142
  }
3143
+ /**
3144
+ * Creates a new instance of the appropriate class based on discriminator value
3145
+ * @param parseNode The parse node to use to read the discriminator value and create the object
3146
+ * @returns {NotificationResponse}
3147
+ */
3148
+ export declare function createNotificationResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3104
3149
  /**
3105
3150
  * Creates a new instance of the appropriate class based on discriminator value
3106
3151
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -3497,6 +3542,12 @@ export declare function createSourceTableRowFromDiscriminatorValue(parseNode: Pa
3497
3542
  * @returns {StreetAddress}
3498
3543
  */
3499
3544
  export declare function createStreetAddressFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3545
+ /**
3546
+ * Creates a new instance of the appropriate class based on discriminator value
3547
+ * @param parseNode The parse node to use to read the discriminator value and create the object
3548
+ * @returns {StripeInvoiceResponse}
3549
+ */
3550
+ export declare function createStripeInvoiceResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3500
3551
  /**
3501
3552
  * Creates a new instance of the appropriate class based on discriminator value
3502
3553
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -3575,6 +3626,12 @@ export declare function createTelephonyLoginResponseFromDiscriminatorValue(parse
3575
3626
  * @returns {TenDlcApplicationDraft}
3576
3627
  */
3577
3628
  export declare function createTenDlcApplicationDraftFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3629
+ /**
3630
+ * Creates a new instance of the appropriate class based on discriminator value
3631
+ * @param parseNode The parse node to use to read the discriminator value and create the object
3632
+ * @returns {TenDlcNotesRequest}
3633
+ */
3634
+ export declare function createTenDlcNotesRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3578
3635
  /**
3579
3636
  * Creates a new instance of the appropriate class based on discriminator value
3580
3637
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -3683,6 +3740,12 @@ export declare function createUserDataExportResponseFromDiscriminatorValue(parse
3683
3740
  * @returns {UserIdentity}
3684
3741
  */
3685
3742
  export declare function createUserIdentityFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3743
+ /**
3744
+ * Creates a new instance of the appropriate class based on discriminator value
3745
+ * @param parseNode The parse node to use to read the discriminator value and create the object
3746
+ * @returns {UserNotificationPreferences_smsConsentTrustedFormCertificate}
3747
+ */
3748
+ export declare function createUserNotificationPreferences_smsConsentTrustedFormCertificateFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
3686
3749
  /**
3687
3750
  * Creates a new instance of the appropriate class based on discriminator value
3688
3751
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -4818,6 +4881,12 @@ export declare function deserializeIntoIdNameValue(idNameValue?: Partial<IdNameV
4818
4881
  * @returns {Record<string, (node: ParseNode) => void>}
4819
4882
  */
4820
4883
  export declare function deserializeIntoInitiateCallRequest(initiateCallRequest?: Partial<InitiateCallRequest> | undefined): Record<string, (node: ParseNode) => void>;
4884
+ /**
4885
+ * The deserialization information for the current model
4886
+ * @param InvoicePdfAccessResponse The instance to deserialize into.
4887
+ * @returns {Record<string, (node: ParseNode) => void>}
4888
+ */
4889
+ export declare function deserializeIntoInvoicePdfAccessResponse(invoicePdfAccessResponse?: Partial<InvoicePdfAccessResponse> | undefined): Record<string, (node: ParseNode) => void>;
4821
4890
  /**
4822
4891
  * The deserialization information for the current model
4823
4892
  * @param LeadArchiveRequest The instance to deserialize into.
@@ -4896,6 +4965,18 @@ export declare function deserializeIntoLeadResponse(leadResponse?: Partial<LeadR
4896
4965
  * @returns {Record<string, (node: ParseNode) => void>}
4897
4966
  */
4898
4967
  export declare function deserializeIntoLeadResponse_currentDisposition(leadResponse_currentDisposition?: Partial<LeadResponse_currentDisposition> | undefined): Record<string, (node: ParseNode) => void>;
4968
+ /**
4969
+ * The deserialization information for the current model
4970
+ * @param LeadStatusRequest The instance to deserialize into.
4971
+ * @returns {Record<string, (node: ParseNode) => void>}
4972
+ */
4973
+ export declare function deserializeIntoLeadStatusRequest(leadStatusRequest?: Partial<LeadStatusRequest> | undefined): Record<string, (node: ParseNode) => void>;
4974
+ /**
4975
+ * The deserialization information for the current model
4976
+ * @param LeadStatusResponse The instance to deserialize into.
4977
+ * @returns {Record<string, (node: ParseNode) => void>}
4978
+ */
4979
+ export declare function deserializeIntoLeadStatusResponse(leadStatusResponse?: Partial<LeadStatusResponse> | undefined): Record<string, (node: ParseNode) => void>;
4899
4980
  /**
4900
4981
  * The deserialization information for the current model
4901
4982
  * @param LeadTableRow The instance to deserialize into.
@@ -4932,6 +5013,12 @@ export declare function deserializeIntoLeadTagsRequest(leadTagsRequest?: Partial
4932
5013
  * @returns {Record<string, (node: ParseNode) => void>}
4933
5014
  */
4934
5015
  export declare function deserializeIntoMobileDevicePreferences(mobileDevicePreferences?: Partial<MobileDevicePreferences> | undefined): Record<string, (node: ParseNode) => void>;
5016
+ /**
5017
+ * The deserialization information for the current model
5018
+ * @param NotificationResponse The instance to deserialize into.
5019
+ * @returns {Record<string, (node: ParseNode) => void>}
5020
+ */
5021
+ export declare function deserializeIntoNotificationResponse(notificationResponse?: Partial<NotificationResponse> | undefined): Record<string, (node: ParseNode) => void>;
4935
5022
  /**
4936
5023
  * The deserialization information for the current model
4937
5024
  * @param NotificationTableRow The instance to deserialize into.
@@ -5328,6 +5415,12 @@ export declare function deserializeIntoSourceTableRow_user(sourceTableRow_user?:
5328
5415
  * @returns {Record<string, (node: ParseNode) => void>}
5329
5416
  */
5330
5417
  export declare function deserializeIntoStreetAddress(streetAddress?: Partial<StreetAddress> | undefined): Record<string, (node: ParseNode) => void>;
5418
+ /**
5419
+ * The deserialization information for the current model
5420
+ * @param StripeInvoiceResponse The instance to deserialize into.
5421
+ * @returns {Record<string, (node: ParseNode) => void>}
5422
+ */
5423
+ export declare function deserializeIntoStripeInvoiceResponse(stripeInvoiceResponse?: Partial<StripeInvoiceResponse> | undefined): Record<string, (node: ParseNode) => void>;
5331
5424
  /**
5332
5425
  * The deserialization information for the current model
5333
5426
  * @param StripePaymentMethodResponse The instance to deserialize into.
@@ -5406,6 +5499,12 @@ export declare function deserializeIntoTelephonyLoginResponse(telephonyLoginResp
5406
5499
  * @returns {Record<string, (node: ParseNode) => void>}
5407
5500
  */
5408
5501
  export declare function deserializeIntoTenDlcApplicationDraft(tenDlcApplicationDraft?: Partial<TenDlcApplicationDraft> | undefined): Record<string, (node: ParseNode) => void>;
5502
+ /**
5503
+ * The deserialization information for the current model
5504
+ * @param TenDlcNotesRequest The instance to deserialize into.
5505
+ * @returns {Record<string, (node: ParseNode) => void>}
5506
+ */
5507
+ export declare function deserializeIntoTenDlcNotesRequest(tenDlcNotesRequest?: Partial<TenDlcNotesRequest> | undefined): Record<string, (node: ParseNode) => void>;
5409
5508
  /**
5410
5509
  * The deserialization information for the current model
5411
5510
  * @param TransactionResponse The instance to deserialize into.
@@ -5520,6 +5619,12 @@ export declare function deserializeIntoUserIdentity(userIdentity?: Partial<UserI
5520
5619
  * @returns {Record<string, (node: ParseNode) => void>}
5521
5620
  */
5522
5621
  export declare function deserializeIntoUserNotificationPreferences(userNotificationPreferences?: Partial<UserNotificationPreferences> | undefined): Record<string, (node: ParseNode) => void>;
5622
+ /**
5623
+ * The deserialization information for the current model
5624
+ * @param UserNotificationPreferences_smsConsentTrustedFormCertificate The instance to deserialize into.
5625
+ * @returns {Record<string, (node: ParseNode) => void>}
5626
+ */
5627
+ export declare function deserializeIntoUserNotificationPreferences_smsConsentTrustedFormCertificate(userNotificationPreferences_smsConsentTrustedFormCertificate?: Partial<UserNotificationPreferences_smsConsentTrustedFormCertificate> | undefined): Record<string, (node: ParseNode) => void>;
5523
5628
  /**
5524
5629
  * The deserialization information for the current model
5525
5630
  * @param UserRequest The instance to deserialize into.
@@ -5580,6 +5685,7 @@ export declare function deserializeIntoUserResponse_notificationPreferences(user
5580
5685
  * @returns {Record<string, (node: ParseNode) => void>}
5581
5686
  */
5582
5687
  export declare function deserializeIntoWalletResponse(walletResponse?: Partial<WalletResponse> | undefined): Record<string, (node: ParseNode) => void>;
5688
+ export type DispositionCategory = (typeof DispositionCategoryObject)[keyof typeof DispositionCategoryObject];
5583
5689
  /**
5584
5690
  * API response containing disposition export data returned to callers.
5585
5691
  */
@@ -6458,6 +6564,19 @@ export interface InitiateCallRequest extends AdditionalDataHolder, Parsable {
6458
6564
  */
6459
6565
  wasManuallyOverridden?: boolean | null;
6460
6566
  }
6567
+ /**
6568
+ * Short-lived access details for a private Leadping invoice PDF.
6569
+ */
6570
+ export interface InvoicePdfAccessResponse extends AdditionalDataHolder, Parsable {
6571
+ /**
6572
+ * The expiresAt property
6573
+ */
6574
+ expiresAt?: Date | null;
6575
+ /**
6576
+ * The url property
6577
+ */
6578
+ url?: string | null;
6579
+ }
6461
6580
  /**
6462
6581
  * Request schema for the Leadping API lead archive request, including the fields clients can send.
6463
6582
  */
@@ -6966,6 +7085,59 @@ export interface LeadResponse extends AdditionalDataHolder, Parsable {
6966
7085
  */
6967
7086
  export interface LeadResponse_currentDisposition extends CurrentDispositionSummary, Parsable {
6968
7087
  }
7088
+ export interface LeadStatusRequest extends AdditionalDataHolder, Parsable {
7089
+ /**
7090
+ * Controlled disposition categories used for reporting, automation, and analytics.
7091
+ */
7092
+ category?: LeadStatusRequest_category | null;
7093
+ /**
7094
+ * The color property
7095
+ */
7096
+ color?: string | null;
7097
+ /**
7098
+ * The name property
7099
+ */
7100
+ name?: string | null;
7101
+ /**
7102
+ * The sortOrder property
7103
+ */
7104
+ sortOrder?: UntypedNode | null;
7105
+ }
7106
+ export type LeadStatusRequest_category = (typeof LeadStatusRequest_categoryObject)[keyof typeof LeadStatusRequest_categoryObject];
7107
+ export interface LeadStatusResponse extends AdditionalDataHolder, Parsable {
7108
+ /**
7109
+ * The businessId property
7110
+ */
7111
+ businessId?: string | null;
7112
+ /**
7113
+ * Controlled disposition categories used for reporting, automation, and analytics.
7114
+ */
7115
+ category?: DispositionCategory | null;
7116
+ /**
7117
+ * The color property
7118
+ */
7119
+ color?: string | null;
7120
+ /**
7121
+ * The id property
7122
+ */
7123
+ id?: string | null;
7124
+ /**
7125
+ * The isArchived property
7126
+ */
7127
+ isArchived?: boolean | null;
7128
+ /**
7129
+ * The modifiedAt property
7130
+ */
7131
+ modifiedAt?: Date | null;
7132
+ /**
7133
+ * The name property
7134
+ */
7135
+ name?: string | null;
7136
+ /**
7137
+ * The sortOrder property
7138
+ */
7139
+ sortOrder?: number | null;
7140
+ }
6969
7141
  /**
6970
7142
  * List item schema for Leadping API lead table row results shown in searchable tables.
6971
7143
  */
@@ -7097,6 +7269,71 @@ export interface MobileDevicePreferences extends AdditionalDataHolder, Parsable
7097
7269
  updatedAt?: Date | null;
7098
7270
  }
7099
7271
  export type NotificationPriority = (typeof NotificationPriorityObject)[keyof typeof NotificationPriorityObject];
7272
+ /**
7273
+ * API DTO containing notification data used by Leadping API contracts.
7274
+ */
7275
+ export interface NotificationResponse extends AdditionalDataHolder, Parsable {
7276
+ /**
7277
+ * The action button text value for this notification.
7278
+ */
7279
+ actionButtonText?: string | null;
7280
+ /**
7281
+ * The URL associated with this notification.
7282
+ */
7283
+ actionUrl?: string | null;
7284
+ /**
7285
+ * The date and time when the entity was created.
7286
+ */
7287
+ createdAt?: Date | null;
7288
+ /**
7289
+ * The details value for this notification.
7290
+ */
7291
+ details?: string | null;
7292
+ /**
7293
+ * The unique identifier for the entity.
7294
+ */
7295
+ id?: string | null;
7296
+ /**
7297
+ * Whether this notification is read.
7298
+ */
7299
+ isRead?: boolean | null;
7300
+ /**
7301
+ * The message value for this notification.
7302
+ */
7303
+ message?: string | null;
7304
+ /**
7305
+ * The date and time when the entity was last modified, if applicable.
7306
+ */
7307
+ modifiedAt?: Date | null;
7308
+ /**
7309
+ * The display name for the entity.
7310
+ */
7311
+ name?: string | null;
7312
+ /**
7313
+ * The priority value for this notification.
7314
+ */
7315
+ priority?: NotificationPriority | null;
7316
+ /**
7317
+ * The date and time for the read at value on this notification.
7318
+ */
7319
+ readAt?: Date | null;
7320
+ /**
7321
+ * The related entity ID associated with this notification.
7322
+ */
7323
+ relatedEntityId?: string | null;
7324
+ /**
7325
+ * The related entity type classification for this notification.
7326
+ */
7327
+ relatedEntityType?: string | null;
7328
+ /**
7329
+ * The type classification for this notification.
7330
+ */
7331
+ type?: NotificationType | null;
7332
+ /**
7333
+ * The user ID associated with this notification.
7334
+ */
7335
+ userId?: string | null;
7336
+ }
7100
7337
  /**
7101
7338
  * API response containing notification data returned to callers.
7102
7339
  */
@@ -7221,6 +7458,10 @@ export type OutboundDeliveryStatus = (typeof OutboundDeliveryStatusObject)[keyof
7221
7458
  * Represents outbound phone number capacity data used by Leadping.
7222
7459
  */
7223
7460
  export interface OutboundPhoneNumberCapacity extends AdditionalDataHolder, Parsable {
7461
+ /**
7462
+ * Indicates whether Leadping successfully calculated capacity for this phone number.
7463
+ */
7464
+ capacityAvailable?: boolean | null;
7224
7465
  /**
7225
7466
  * Current health status for this Leadping outbound phone number capacity.
7226
7467
  */
@@ -9156,6 +9397,13 @@ export declare function serializeIdNameValue(writer: SerializationWriter, idName
9156
9397
  * @param writer Serialization writer to use to serialize this model
9157
9398
  */
9158
9399
  export declare function serializeInitiateCallRequest(writer: SerializationWriter, initiateCallRequest?: Partial<InitiateCallRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
9400
+ /**
9401
+ * Serializes information the current object
9402
+ * @param InvoicePdfAccessResponse The instance to serialize from.
9403
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
9404
+ * @param writer Serialization writer to use to serialize this model
9405
+ */
9406
+ export declare function serializeInvoicePdfAccessResponse(writer: SerializationWriter, invoicePdfAccessResponse?: Partial<InvoicePdfAccessResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
9159
9407
  /**
9160
9408
  * Serializes information the current object
9161
9409
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -9247,6 +9495,20 @@ export declare function serializeLeadResponse(writer: SerializationWriter, leadR
9247
9495
  * @param writer Serialization writer to use to serialize this model
9248
9496
  */
9249
9497
  export declare function serializeLeadResponse_currentDisposition(writer: SerializationWriter, leadResponse_currentDisposition?: Partial<LeadResponse_currentDisposition> | undefined | null, isSerializingDerivedType?: boolean): void;
9498
+ /**
9499
+ * Serializes information the current object
9500
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
9501
+ * @param LeadStatusRequest The instance to serialize from.
9502
+ * @param writer Serialization writer to use to serialize this model
9503
+ */
9504
+ export declare function serializeLeadStatusRequest(writer: SerializationWriter, leadStatusRequest?: Partial<LeadStatusRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
9505
+ /**
9506
+ * Serializes information the current object
9507
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
9508
+ * @param LeadStatusResponse The instance to serialize from.
9509
+ * @param writer Serialization writer to use to serialize this model
9510
+ */
9511
+ export declare function serializeLeadStatusResponse(writer: SerializationWriter, leadStatusResponse?: Partial<LeadStatusResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
9250
9512
  /**
9251
9513
  * Serializes information the current object
9252
9514
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -9289,6 +9551,13 @@ export declare function serializeLeadTagsRequest(writer: SerializationWriter, le
9289
9551
  * @param writer Serialization writer to use to serialize this model
9290
9552
  */
9291
9553
  export declare function serializeMobileDevicePreferences(writer: SerializationWriter, mobileDevicePreferences?: Partial<MobileDevicePreferences> | undefined | null, isSerializingDerivedType?: boolean): void;
9554
+ /**
9555
+ * Serializes information the current object
9556
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
9557
+ * @param NotificationResponse The instance to serialize from.
9558
+ * @param writer Serialization writer to use to serialize this model
9559
+ */
9560
+ export declare function serializeNotificationResponse(writer: SerializationWriter, notificationResponse?: Partial<NotificationResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
9292
9561
  /**
9293
9562
  * Serializes information the current object
9294
9563
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -9751,6 +10020,13 @@ export declare function serializeSourceTableRow_user(writer: SerializationWriter
9751
10020
  * @param writer Serialization writer to use to serialize this model
9752
10021
  */
9753
10022
  export declare function serializeStreetAddress(writer: SerializationWriter, streetAddress?: Partial<StreetAddress> | undefined | null, isSerializingDerivedType?: boolean): void;
10023
+ /**
10024
+ * Serializes information the current object
10025
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
10026
+ * @param StripeInvoiceResponse The instance to serialize from.
10027
+ * @param writer Serialization writer to use to serialize this model
10028
+ */
10029
+ export declare function serializeStripeInvoiceResponse(writer: SerializationWriter, stripeInvoiceResponse?: Partial<StripeInvoiceResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
9754
10030
  /**
9755
10031
  * Serializes information the current object
9756
10032
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -9842,6 +10118,13 @@ export declare function serializeTelephonyLoginResponse(writer: SerializationWri
9842
10118
  * @param writer Serialization writer to use to serialize this model
9843
10119
  */
9844
10120
  export declare function serializeTenDlcApplicationDraft(writer: SerializationWriter, tenDlcApplicationDraft?: Partial<TenDlcApplicationDraft> | undefined | null, isSerializingDerivedType?: boolean): void;
10121
+ /**
10122
+ * Serializes information the current object
10123
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
10124
+ * @param TenDlcNotesRequest The instance to serialize from.
10125
+ * @param writer Serialization writer to use to serialize this model
10126
+ */
10127
+ export declare function serializeTenDlcNotesRequest(writer: SerializationWriter, tenDlcNotesRequest?: Partial<TenDlcNotesRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
9845
10128
  /**
9846
10129
  * Serializes information the current object
9847
10130
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -9975,6 +10258,13 @@ export declare function serializeUserIdentity(writer: SerializationWriter, userI
9975
10258
  * @param writer Serialization writer to use to serialize this model
9976
10259
  */
9977
10260
  export declare function serializeUserNotificationPreferences(writer: SerializationWriter, userNotificationPreferences?: Partial<UserNotificationPreferences> | undefined | null, isSerializingDerivedType?: boolean): void;
10261
+ /**
10262
+ * Serializes information the current object
10263
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
10264
+ * @param UserNotificationPreferences_smsConsentTrustedFormCertificate The instance to serialize from.
10265
+ * @param writer Serialization writer to use to serialize this model
10266
+ */
10267
+ export declare function serializeUserNotificationPreferences_smsConsentTrustedFormCertificate(writer: SerializationWriter, userNotificationPreferences_smsConsentTrustedFormCertificate?: Partial<UserNotificationPreferences_smsConsentTrustedFormCertificate> | undefined | null, isSerializingDerivedType?: boolean): void;
9978
10268
  /**
9979
10269
  * Serializes information the current object
9980
10270
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -10441,6 +10731,10 @@ export interface SourceRequest extends AdditionalDataHolder, Parsable {
10441
10731
  * State or region allowlist used to accept leads from this source.
10442
10732
  */
10443
10733
  allowedStates?: string[] | null;
10734
+ /**
10735
+ * Source API key used to authenticate inbound lead delivery to Leadping.
10736
+ */
10737
+ apiKey?: string | null;
10444
10738
  /**
10445
10739
  * Configured cost charged when this source creates a billable lead.
10446
10740
  */
@@ -10490,6 +10784,10 @@ export interface SourceResponse extends AdditionalDataHolder, Parsable {
10490
10784
  * State or region allowlist used to accept leads from this source.
10491
10785
  */
10492
10786
  allowedStates?: string[] | null;
10787
+ /**
10788
+ * Source API key used to authenticate inbound lead delivery to Leadping. Unlike a business API key, this value remains available to authorized source users.
10789
+ */
10790
+ apiKey?: string | null;
10493
10791
  /**
10494
10792
  * Masked preview of the source API key for compact display.
10495
10793
  */
@@ -10595,6 +10893,10 @@ export interface SourceTableRow extends AdditionalDataHolder, Parsable {
10595
10893
  * State or region allowlist used to accept leads from this source.
10596
10894
  */
10597
10895
  allowedStates?: string[] | null;
10896
+ /**
10897
+ * Source API key used to authenticate inbound lead delivery to Leadping. Unlike a business API key, this value remains available to authorized source users.
10898
+ */
10899
+ apiKey?: string | null;
10598
10900
  /**
10599
10901
  * UTC timestamp when the source API key was last used.
10600
10902
  */
@@ -10741,6 +11043,35 @@ export interface StreetAddress extends AdditionalDataHolder, Parsable {
10741
11043
  */
10742
11044
  state?: string | null;
10743
11045
  }
11046
+ /**
11047
+ * Customer-safe Leadping invoice summary for billing.
11048
+ */
11049
+ export interface StripeInvoiceResponse extends AdditionalDataHolder, Parsable {
11050
+ /**
11051
+ * The amount property
11052
+ */
11053
+ amount?: number | null;
11054
+ /**
11055
+ * The createdAt property
11056
+ */
11057
+ createdAt?: Date | null;
11058
+ /**
11059
+ * The hasPdf property
11060
+ */
11061
+ hasPdf?: boolean | null;
11062
+ /**
11063
+ * The id property
11064
+ */
11065
+ id?: string | null;
11066
+ /**
11067
+ * The number property
11068
+ */
11069
+ number?: string | null;
11070
+ /**
11071
+ * The status property
11072
+ */
11073
+ status?: string | null;
11074
+ }
10744
11075
  /**
10745
11076
  * API DTO containing stripe payment method data used by Leadping API contracts.
10746
11077
  */
@@ -11159,6 +11490,12 @@ export interface TenDlcApplicationDraft extends AdditionalDataHolder, Parsable {
11159
11490
  websiteUrl?: string | null;
11160
11491
  }
11161
11492
  export type TenDlcApplicationStatus = (typeof TenDlcApplicationStatusObject)[keyof typeof TenDlcApplicationStatusObject];
11493
+ export interface TenDlcNotesRequest extends AdditionalDataHolder, Parsable {
11494
+ /**
11495
+ * The notes property
11496
+ */
11497
+ notes?: string | null;
11498
+ }
11162
11499
  /**
11163
11500
  * Response schema for the Leadping API billing transaction response returned to authenticated clients.
11164
11501
  */
@@ -11702,6 +12039,18 @@ export interface UserNotificationPreferences extends AdditionalDataHolder, Parsa
11702
12039
  * Indicates whether payment failed SMS functionality is enabled for this Leadping user notification preferences.
11703
12040
  */
11704
12041
  paymentFailedSmsEnabled?: boolean | null;
12042
+ /**
12043
+ * Whether the user has consented to receive Leadping account notification SMS messages.
12044
+ */
12045
+ smsConsentOptedIn?: boolean | null;
12046
+ /**
12047
+ * The TrustedForm certificate captured for the user's most recent SMS opt-in.
12048
+ */
12049
+ smsConsentTrustedFormCertificate?: UserNotificationPreferences_smsConsentTrustedFormCertificate | null;
12050
+ /**
12051
+ * When the user's Leadping notification SMS consent was last changed.
12052
+ */
12053
+ smsConsentUpdatedAt?: Date | null;
11705
12054
  /**
11706
12055
  * Indicates whether subscription renewing email functionality is enabled for this Leadping user notification preferences.
11707
12056
  */
@@ -11735,6 +12084,11 @@ export interface UserNotificationPreferences extends AdditionalDataHolder, Parsa
11735
12084
  */
11736
12085
  usageLimitHitEnabled?: boolean | null;
11737
12086
  }
12087
+ /**
12088
+ * The TrustedForm certificate captured for the user's most recent SMS opt-in.
12089
+ */
12090
+ export interface UserNotificationPreferences_smsConsentTrustedFormCertificate extends Parsable, TrustedFormCertificate {
12091
+ }
11738
12092
  /**
11739
12093
  * Request schema for the Leadping API user profile request, including the fields clients can send.
11740
12094
  */
@@ -12065,6 +12419,13 @@ export declare const BillingPlanObject: {
12065
12419
  readonly Annual: "Annual";
12066
12420
  readonly Monthly: "Monthly";
12067
12421
  };
12422
+ /**
12423
+ * Defines the supported Billing Plan values.
12424
+ */
12425
+ export declare const BusinessBillingState_pendingBillingPlanObject: {
12426
+ readonly Annual: "Annual";
12427
+ readonly Monthly: "Monthly";
12428
+ };
12068
12429
  /**
12069
12430
  * Defines the supported Business Invitation Status values.
12070
12431
  */
@@ -12357,6 +12718,17 @@ export declare const CustomerActivationStatusObject: {
12357
12718
  readonly BlockedRequiresOperatorAction: "BlockedRequiresOperatorAction";
12358
12719
  readonly ManuallyBypassed: "ManuallyBypassed";
12359
12720
  };
12721
+ /**
12722
+ * Controlled disposition categories used for reporting, automation, and analytics.
12723
+ */
12724
+ export declare const DispositionCategoryObject: {
12725
+ readonly Open: "Open";
12726
+ readonly Qualified: "Qualified";
12727
+ readonly Converted: "Converted";
12728
+ readonly Lost: "Lost";
12729
+ readonly Invalid: "Invalid";
12730
+ readonly Duplicate: "Duplicate";
12731
+ };
12360
12732
  /**
12361
12733
  * Controlled disposition categories used for reporting, automation, and analytics.
12362
12734
  */
@@ -12593,6 +12965,17 @@ export declare const LeadProfile_maritalStatusObject: {
12593
12965
  readonly Separated: "Separated";
12594
12966
  readonly Divorced: "Divorced";
12595
12967
  };
12968
+ /**
12969
+ * Controlled disposition categories used for reporting, automation, and analytics.
12970
+ */
12971
+ export declare const LeadStatusRequest_categoryObject: {
12972
+ readonly Open: "Open";
12973
+ readonly Qualified: "Qualified";
12974
+ readonly Converted: "Converted";
12975
+ readonly Lost: "Lost";
12976
+ readonly Invalid: "Invalid";
12977
+ readonly Duplicate: "Duplicate";
12978
+ };
12596
12979
  /**
12597
12980
  * Defines the supported Notification Priority values.
12598
12981
  */