@leadping/sdk 1.0.20 → 1.0.22

package/dist/models/index.d.ts

@@ -101,7 +101,7 @@ export interface ActivationTimelineEvent extends AdditionalDataHolder, Parsable
 export interface ActivationTimelineEvent_actor extends IdNamePair, Parsable {
 }
 /**
- * Date and time when this Leadping customer analytics summary was leads comparison.
+ * Represents analytics comparison data exposed by Leadping analytics.
  */
 export interface AnalyticsComparison extends AdditionalDataHolder, Parsable {
     /**
@@ -122,7 +122,7 @@ export interface AnalyticsComparison extends AdditionalDataHolder, Parsable {
     previous?: number | null;
 }
 /**
- * Range associated with this Leadping customer analytics.
+ * Represents analytics date range data exposed by Leadping analytics.
  */
 export interface AnalyticsDateRange extends AdditionalDataHolder, Parsable {
     /**
@@ -138,6 +138,9 @@ export interface AnalyticsDateRange extends AdditionalDataHolder, Parsable {
      */
     startAt?: Date | null;
 }
+/**
+ * Represents analytics trend point data exposed by Leadping analytics.
+ */
 export interface AnalyticsTrendPointOfdecimal extends AdditionalDataHolder, Parsable {
     /**
      * Date and time when this Leadping analytics trend point was end.
@@ -156,6 +159,9 @@ export interface AnalyticsTrendPointOfdecimal extends AdditionalDataHolder, Pars
      */
     value?: number | null;
 }
+/**
+ * Represents analytics trend point data exposed by Leadping analytics.
+ */
 export interface AnalyticsTrendPointOfint extends AdditionalDataHolder, Parsable {
     /**
      * Date and time when this Leadping analytics trend point was end.
@@ -1207,6 +1213,52 @@ export interface BusinessActivationState extends AdditionalDataHolder, Parsable
  */
 export interface BusinessActivationState_tenDlcDraft extends Parsable, TenDlcApplicationDraft {
 }
+/**
+ * Customer-safe billing state for a Leadping business.
+ */
+export interface BusinessBillingState extends AdditionalDataHolder, Parsable {
+    /**
+     * Gets or sets the number of user licenses currently assigned by the business.
+     */
+    businessUserAssignedQuantity?: UntypedNode | null;
+    /**
+     * Gets or sets the number of user licenses included in the business subscription.
+     */
+    businessUserQuantity?: UntypedNode | null;
+    /**
+     * Gets or sets when the active subscription is scheduled to cancel.
+     */
+    cancelAt?: Date | null;
+    /**
+     * Gets or sets the customer-safe payment recovery state for the business.
+     */
+    dunning?: BusinessBillingState_dunning | null;
+    /**
+     * Indicates whether the business has a saved default payment method.
+     */
+    hasPaymentMethod?: boolean | null;
+    /**
+     * Indicates whether the business has a Stripe customer account.
+     */
+    hasStripeCustomer?: boolean | null;
+    /**
+     * Gets or sets when Leadping last processed a payment-method event for the business.
+     */
+    lastPaymentMethodEventAt?: Date | null;
+    /**
+     * Gets or sets when Leadping last processed a subscription event for the business.
+     */
+    lastSubscriptionEventAt?: Date | null;
+    /**
+     * Gets or sets the number of phone numbers included in the business subscription.
+     */
+    phoneNumberQuantity?: UntypedNode | null;
+}
+/**
+ * Gets or sets the customer-safe payment recovery state for the business.
+ */
+export interface BusinessBillingState_dunning extends BusinessDunningInfo, Parsable {
+}
 /**
  * API DTO containing business compliance policy data used by Leadping API contracts.
  */
@@ -1244,6 +1296,51 @@ export interface BusinessCompliancePolicy extends AdditionalDataHolder, Parsable
      */
     requireTrustedFormForAutomations?: boolean | null;
 }
+/**
+ * Dunning state recorded after a failed recurring payment.
+ */
+export interface BusinessDunningInfo extends AdditionalDataHolder, Parsable {
+    /**
+     * Date and time when this Leadping business dunning info was final cancellation.
+     */
+    finalCancellationAt?: Date | null;
+    /**
+     * Date and time when this Leadping business dunning info was grace period ends.
+     */
+    gracePeriodEndsAt?: Date | null;
+    /**
+     * Current last failed invoice status for this Leadping business dunning info.
+     */
+    lastFailedInvoiceStatus?: string | null;
+    /**
+     * Date and time when this Leadping business dunning info was last updated.
+     */
+    lastUpdatedAt?: Date | null;
+    /**
+     * Date and time when the next retry is scheduled.
+     */
+    nextRetryAt?: Date | null;
+    /**
+     * Date and time when this Leadping business dunning info was outbound restricted.
+     */
+    outboundRestrictedAt?: Date | null;
+    /**
+     * Date and time when this Leadping business dunning info was outbound suspended.
+     */
+    outboundSuspendedAt?: Date | null;
+    /**
+     * Date and time when this Leadping business dunning info was payment failed.
+     */
+    paymentFailedAt?: Date | null;
+    /**
+     * Total number of retry attempt records represented by this Leadping business dunning info.
+     */
+    retryAttemptCount?: number | null;
+    /**
+     * Current stage for this Leadping business dunning info.
+     */
+    stage?: string | null;
+}
 /**
  * Request payload for business invitation.
  */
@@ -1554,6 +1651,10 @@ export interface BusinessResponse extends AdditionalDataHolder, Parsable {
      * Defines the supported Billing Plan values.
      */
     billingPlan?: BusinessResponse_billingPlan | null;
+    /**
+     * Customer-safe billing state for this business.
+     */
+    billingState?: BusinessResponse_billingState | null;
     /**
      * Compliance policy configuration for the business.
      */
@@ -1606,6 +1707,10 @@ export interface BusinessResponse extends AdditionalDataHolder, Parsable {
      * Alternate business name or DBA shown in Leadping.
      */
     secondaryName?: string | null;
+    /**
+     * Defines the supported User Setup Status values.
+     */
+    setupStatus?: BusinessResponse_setupStatus | null;
     /**
      * Defines the supported Business Setup Step values.
      */
@@ -1651,6 +1756,11 @@ export interface BusinessResponse_address extends Parsable, StreetAddress {
 export interface BusinessResponse_billingAddress extends Parsable, StreetAddress {
 }
 export type BusinessResponse_billingPlan = (typeof BusinessResponse_billingPlanObject)[keyof typeof BusinessResponse_billingPlanObject];
+/**
+ * Customer-safe billing state for this business.
+ */
+export interface BusinessResponse_billingState extends BusinessBillingState, Parsable {
+}
 /**
  * Compliance policy configuration for the business.
  */
@@ -1661,6 +1771,7 @@ export interface BusinessResponse_compliancePolicy extends BusinessCompliancePol
  */
 export interface BusinessResponse_einDocument extends IdNameValue, Parsable {
 }
+export type BusinessResponse_setupStatus = (typeof BusinessResponse_setupStatusObject)[keyof typeof BusinessResponse_setupStatusObject];
 export type BusinessResponse_setupStep = (typeof BusinessResponse_setupStepObject)[keyof typeof BusinessResponse_setupStepObject];
 /**
  * Leadping website record connected to this business.
@@ -2465,12 +2576,30 @@ export declare function createBusinessActivationState_tenDlcDraftFromDiscriminat
  * @returns {BusinessActivationState}
  */
 export declare function createBusinessActivationStateFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
+/**
+ * Creates a new instance of the appropriate class based on discriminator value
+ * @param parseNode The parse node to use to read the discriminator value and create the object
+ * @returns {BusinessBillingState_dunning}
+ */
+export declare function createBusinessBillingState_dunningFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
+/**
+ * Creates a new instance of the appropriate class based on discriminator value
+ * @param parseNode The parse node to use to read the discriminator value and create the object
+ * @returns {BusinessBillingState}
+ */
+export declare function createBusinessBillingStateFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
 /**
  * Creates a new instance of the appropriate class based on discriminator value
  * @param parseNode The parse node to use to read the discriminator value and create the object
  * @returns {BusinessCompliancePolicy}
  */
 export declare function createBusinessCompliancePolicyFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
+/**
+ * Creates a new instance of the appropriate class based on discriminator value
+ * @param parseNode The parse node to use to read the discriminator value and create the object
+ * @returns {BusinessDunningInfo}
+ */
+export declare function createBusinessDunningInfoFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
 /**
  * Creates a new instance of the appropriate class based on discriminator value
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -2537,6 +2666,12 @@ export declare function createBusinessResponse_addressFromDiscriminatorValue(par
  * @returns {BusinessResponse_billingAddress}
  */
 export declare function createBusinessResponse_billingAddressFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
+/**
+ * Creates a new instance of the appropriate class based on discriminator value
+ * @param parseNode The parse node to use to read the discriminator value and create the object
+ * @returns {BusinessResponse_billingState}
+ */
+export declare function createBusinessResponse_billingStateFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
 /**
  * Creates a new instance of the appropriate class based on discriminator value
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -3578,6 +3713,12 @@ export declare function createUserRequest_notificationPreferencesFromDiscriminat
  * @returns {UserRequest}
  */
 export declare function createUserRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
+/**
+ * Creates a new instance of the appropriate class based on discriminator value
+ * @param parseNode The parse node to use to read the discriminator value and create the object
+ * @returns {UserResponse_billingState}
+ */
+export declare function createUserResponse_billingStateFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
 /**
  * Creates a new instance of the appropriate class based on discriminator value
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -3648,7 +3789,7 @@ export interface CurrentDispositionSummary extends AdditionalDataHolder, Parsabl
 export type CurrentDispositionSummary_category = (typeof CurrentDispositionSummary_categoryObject)[keyof typeof CurrentDispositionSummary_categoryObject];
 export type CurrentDispositionSummary_source = (typeof CurrentDispositionSummary_sourceObject)[keyof typeof CurrentDispositionSummary_sourceObject];
 /**
- * Activation health associated with this Leadping customer analytics.
+ * Represents customer activation health data exposed by Leadping analytics.
  */
 export interface CustomerActivationHealth extends AdditionalDataHolder, Parsable {
     /**
@@ -3660,6 +3801,9 @@ export interface CustomerActivationHealth extends AdditionalDataHolder, Parsable
      */
     overallStatus?: string | null;
 }
+/**
+ * Represents customer activation health item data exposed by Leadping analytics.
+ */
 export interface CustomerActivationHealthItem extends AdditionalDataHolder, Parsable {
     /**
      * Relative URL for the recommended follow-up action.
@@ -3683,6 +3827,9 @@ export interface CustomerActivationHealthItem extends AdditionalDataHolder, Pars
     status?: string | null;
 }
 export type CustomerActivationStatus = (typeof CustomerActivationStatusObject)[keyof typeof CustomerActivationStatusObject];
+/**
+ * Response model containing customer analytics data returned by the Leadping API.
+ */
 export interface CustomerAnalyticsResponse extends AdditionalDataHolder, Parsable {
     /**
      * Activation health associated with this Leadping customer analytics.
@@ -3726,7 +3873,7 @@ export interface CustomerAnalyticsResponse extends AdditionalDataHolder, Parsabl
     summary?: CustomerAnalyticsSummary | null;
 }
 /**
- * Human-readable summary for this Leadping customer analytics.
+ * Represents customer analytics summary data exposed by Leadping analytics.
  */
 export interface CustomerAnalyticsSummary extends AdditionalDataHolder, Parsable {
     /**
@@ -3799,7 +3946,7 @@ export interface CustomerAnalyticsSummary extends AdditionalDataHolder, Parsable
     walletStatus?: string | null;
 }
 /**
- * Automation health associated with this Leadping customer analytics.
+ * Represents customer automation health data exposed by Leadping analytics.
  */
 export interface CustomerAutomationHealth extends AdditionalDataHolder, Parsable {
     /**
@@ -3837,7 +3984,7 @@ export interface CustomerAutomationHealth extends AdditionalDataHolder, Parsable
 export interface CustomerAutomationHealth_lastFailure extends CustomerFailingAutomation, Parsable {
 }
 /**
- * Communication usage associated with this Leadping customer analytics.
+ * Represents customer communication usage data exposed by Leadping analytics.
  */
 export interface CustomerCommunicationUsage extends AdditionalDataHolder, Parsable {
     /**
@@ -3881,6 +4028,9 @@ export interface CustomerCommunicationUsage extends AdditionalDataHolder, Parsab
      */
     usageSpend?: number | null;
 }
+/**
+ * Represents customer communication usage point data exposed by Leadping analytics.
+ */
 export interface CustomerCommunicationUsagePoint extends AdditionalDataHolder, Parsable {
     /**
      * Total connected call duration, in minutes, during the reporting period.
@@ -3916,7 +4066,7 @@ export interface CustomerCommunicationUsagePoint extends AdditionalDataHolder, P
     startAt?: Date | null;
 }
 /**
- * Last failure associated with this Leadping customer automation health.
+ * Represents customer failing automation data exposed by Leadping analytics.
  */
 export interface CustomerFailingAutomation extends AdditionalDataHolder, Parsable {
     /**
@@ -3936,6 +4086,9 @@ export interface CustomerFailingAutomation extends AdditionalDataHolder, Parsabl
      */
     name?: string | null;
 }
+/**
+ * Represents customer lead source breakdown data exposed by Leadping analytics.
+ */
 export interface CustomerLeadSourceBreakdown extends AdditionalDataHolder, Parsable {
     /**
      * Number of leads represented by this Leadping customer lead source breakdown.
@@ -3951,7 +4104,7 @@ export interface CustomerLeadSourceBreakdown extends AdditionalDataHolder, Parsa
     source?: string | null;
 }
 /**
- * Lead trend associated with this Leadping customer analytics.
+ * Represents customer lead trend data exposed by Leadping analytics.
  */
 export interface CustomerLeadTrend extends AdditionalDataHolder, Parsable {
     /**
@@ -3967,6 +4120,9 @@ export interface CustomerLeadTrend extends AdditionalDataHolder, Parsable {
      */
     total?: number | null;
 }
+/**
+ * Represents customer needs attention item data exposed by Leadping analytics.
+ */
 export interface CustomerNeedsAttentionItem extends AdditionalDataHolder, Parsable {
     /**
      * Relative URL for the recommended follow-up action.
@@ -3990,7 +4146,7 @@ export interface CustomerNeedsAttentionItem extends AdditionalDataHolder, Parsab
     title?: string | null;
 }
 /**
- * Response metrics associated with this Leadping customer analytics.
+ * Represents customer response metrics data exposed by Leadping analytics.
  */
 export interface CustomerResponseMetrics extends AdditionalDataHolder, Parsable {
     /**
@@ -4260,12 +4416,30 @@ export declare function deserializeIntoBusinessActivationState(businessActivatio
  * @returns {Record<string, (node: ParseNode) => void>}
  */
 export declare function deserializeIntoBusinessActivationState_tenDlcDraft(businessActivationState_tenDlcDraft?: Partial<BusinessActivationState_tenDlcDraft> | undefined): Record<string, (node: ParseNode) => void>;
+/**
+ * The deserialization information for the current model
+ * @param BusinessBillingState The instance to deserialize into.
+ * @returns {Record<string, (node: ParseNode) => void>}
+ */
+export declare function deserializeIntoBusinessBillingState(businessBillingState?: Partial<BusinessBillingState> | undefined): Record<string, (node: ParseNode) => void>;
+/**
+ * The deserialization information for the current model
+ * @param BusinessBillingState_dunning The instance to deserialize into.
+ * @returns {Record<string, (node: ParseNode) => void>}
+ */
+export declare function deserializeIntoBusinessBillingState_dunning(businessBillingState_dunning?: Partial<BusinessBillingState_dunning> | undefined): Record<string, (node: ParseNode) => void>;
 /**
  * The deserialization information for the current model
  * @param BusinessCompliancePolicy The instance to deserialize into.
  * @returns {Record<string, (node: ParseNode) => void>}
  */
 export declare function deserializeIntoBusinessCompliancePolicy(businessCompliancePolicy?: Partial<BusinessCompliancePolicy> | undefined): Record<string, (node: ParseNode) => void>;
+/**
+ * The deserialization information for the current model
+ * @param BusinessDunningInfo The instance to deserialize into.
+ * @returns {Record<string, (node: ParseNode) => void>}
+ */
+export declare function deserializeIntoBusinessDunningInfo(businessDunningInfo?: Partial<BusinessDunningInfo> | undefined): Record<string, (node: ParseNode) => void>;
 /**
  * The deserialization information for the current model
  * @param BusinessInvitationRequest The instance to deserialize into.
@@ -4338,6 +4512,12 @@ export declare function deserializeIntoBusinessResponse_address(businessResponse
  * @returns {Record<string, (node: ParseNode) => void>}
  */
 export declare function deserializeIntoBusinessResponse_billingAddress(businessResponse_billingAddress?: Partial<BusinessResponse_billingAddress> | undefined): Record<string, (node: ParseNode) => void>;
+/**
+ * The deserialization information for the current model
+ * @param BusinessResponse_billingState The instance to deserialize into.
+ * @returns {Record<string, (node: ParseNode) => void>}
+ */
+export declare function deserializeIntoBusinessResponse_billingState(businessResponse_billingState?: Partial<BusinessResponse_billingState> | undefined): Record<string, (node: ParseNode) => void>;
 /**
  * The deserialization information for the current model
  * @param BusinessResponse_compliancePolicy The instance to deserialize into.
@@ -5370,6 +5550,12 @@ export declare function deserializeIntoUserRequest_notificationPreferences(userR
  * @returns {Record<string, (node: ParseNode) => void>}
  */
 export declare function deserializeIntoUserResponse(userResponse?: Partial<UserResponse> | undefined): Record<string, (node: ParseNode) => void>;
+/**
+ * The deserialization information for the current model
+ * @param UserResponse_billingState The instance to deserialize into.
+ * @returns {Record<string, (node: ParseNode) => void>}
+ */
+export declare function deserializeIntoUserResponse_billingState(userResponse_billingState?: Partial<UserResponse_billingState> | undefined): Record<string, (node: ParseNode) => void>;
 /**
  * The deserialization information for the current model
  * @param UserResponse_compliance The instance to deserialize into.
@@ -6987,6 +7173,9 @@ export interface OrderByOption extends AdditionalDataHolder, Parsable {
     field?: string | null;
 }
 export type OrderByOption_direction = (typeof OrderByOption_directionObject)[keyof typeof OrderByOption_directionObject];
+/**
+ * Represents outbound capacity overview data used by Leadping.
+ */
 export interface OutboundCapacityOverview extends AdditionalDataHolder, Parsable {
     /**
      * Total number of blocked records represented by this Leadping outbound capacity overview.
@@ -7028,6 +7217,9 @@ export interface OutboundCapacityOverview extends AdditionalDataHolder, Parsable
 export type OutboundDeliveryChannel = (typeof OutboundDeliveryChannelObject)[keyof typeof OutboundDeliveryChannelObject];
 export type OutboundDeliverySource = (typeof OutboundDeliverySourceObject)[keyof typeof OutboundDeliverySourceObject];
 export type OutboundDeliveryStatus = (typeof OutboundDeliveryStatusObject)[keyof typeof OutboundDeliveryStatusObject];
+/**
+ * Represents outbound phone number capacity data used by Leadping.
+ */
 export interface OutboundPhoneNumberCapacity extends AdditionalDataHolder, Parsable {
     /**
      * Current health status for this Leadping outbound phone number capacity.
@@ -7090,6 +7282,9 @@ export interface OutboundPhoneNumberCapacity extends AdditionalDataHolder, Parsa
      */
     voiceUsedToday?: number | null;
 }
+/**
+ * Represents outbound queue item data used by Leadping.
+ */
 export interface OutboundQueueItem extends AdditionalDataHolder, Parsable {
     /**
      * Channel classification for this Leadping outbound queue item.
@@ -8492,6 +8687,20 @@ export declare function serializeBusinessActivationState(writer: SerializationWr
  * @param writer Serialization writer to use to serialize this model
  */
 export declare function serializeBusinessActivationState_tenDlcDraft(writer: SerializationWriter, businessActivationState_tenDlcDraft?: Partial<BusinessActivationState_tenDlcDraft> | undefined | null, isSerializingDerivedType?: boolean): void;
+/**
+ * Serializes information the current object
+ * @param BusinessBillingState The instance to serialize from.
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
+ * @param writer Serialization writer to use to serialize this model
+ */
+export declare function serializeBusinessBillingState(writer: SerializationWriter, businessBillingState?: Partial<BusinessBillingState> | undefined | null, isSerializingDerivedType?: boolean): void;
+/**
+ * Serializes information the current object
+ * @param BusinessBillingState_dunning The instance to serialize from.
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
+ * @param writer Serialization writer to use to serialize this model
+ */
+export declare function serializeBusinessBillingState_dunning(writer: SerializationWriter, businessBillingState_dunning?: Partial<BusinessBillingState_dunning> | undefined | null, isSerializingDerivedType?: boolean): void;
 /**
  * Serializes information the current object
  * @param BusinessCompliancePolicy The instance to serialize from.
@@ -8499,6 +8708,13 @@ export declare function serializeBusinessActivationState_tenDlcDraft(writer: Ser
  * @param writer Serialization writer to use to serialize this model
  */
 export declare function serializeBusinessCompliancePolicy(writer: SerializationWriter, businessCompliancePolicy?: Partial<BusinessCompliancePolicy> | undefined | null, isSerializingDerivedType?: boolean): void;
+/**
+ * Serializes information the current object
+ * @param BusinessDunningInfo The instance to serialize from.
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
+ * @param writer Serialization writer to use to serialize this model
+ */
+export declare function serializeBusinessDunningInfo(writer: SerializationWriter, businessDunningInfo?: Partial<BusinessDunningInfo> | undefined | null, isSerializingDerivedType?: boolean): void;
 /**
  * Serializes information the current object
  * @param BusinessInvitationRequest The instance to serialize from.
@@ -8583,6 +8799,13 @@ export declare function serializeBusinessResponse_address(writer: SerializationW
  * @param writer Serialization writer to use to serialize this model
  */
 export declare function serializeBusinessResponse_billingAddress(writer: SerializationWriter, businessResponse_billingAddress?: Partial<BusinessResponse_billingAddress> | undefined | null, isSerializingDerivedType?: boolean): void;
+/**
+ * Serializes information the current object
+ * @param BusinessResponse_billingState The instance to serialize from.
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
+ * @param writer Serialization writer to use to serialize this model
+ */
+export declare function serializeBusinessResponse_billingState(writer: SerializationWriter, businessResponse_billingState?: Partial<BusinessResponse_billingState> | undefined | null, isSerializingDerivedType?: boolean): void;
 /**
  * Serializes information the current object
  * @param BusinessResponse_compliancePolicy The instance to serialize from.
@@ -9787,6 +10010,13 @@ export declare function serializeUserRequest_notificationPreferences(writer: Ser
  * @param writer Serialization writer to use to serialize this model
  */
 export declare function serializeUserResponse(writer: SerializationWriter, userResponse?: Partial<UserResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
+/**
+ * Serializes information the current object
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
+ * @param UserResponse_billingState The instance to serialize from.
+ * @param writer Serialization writer to use to serialize this model
+ */
+export declare function serializeUserResponse_billingState(writer: SerializationWriter, userResponse_billingState?: Partial<UserResponse_billingState> | undefined | null, isSerializingDerivedType?: boolean): void;
 /**
  * Serializes information the current object
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -10178,6 +10408,9 @@ export interface SmsWarmupUiState extends AdditionalDataHolder, Parsable {
      */
     tone?: string | null;
 }
+/**
+ * Response model containing source metrics data returned by the Leadping API.
+ */
 export interface SourceMetricsResponse extends AdditionalDataHolder, Parsable {
     /**
      * Date and time when the source metrics was generated.
@@ -11297,6 +11530,9 @@ export interface UserCompliance extends AdditionalDataHolder, Parsable {
      */
     trustedFormCertificates?: TrustedFormCertificate[] | null;
 }
+/**
+ * Response model containing user data export file data returned by the Leadping API.
+ */
 export interface UserDataExportFile extends AdditionalDataHolder, Parsable {
     /**
      * Category classification for this Leadping user data export file.
@@ -11315,6 +11551,9 @@ export interface UserDataExportFile extends AdditionalDataHolder, Parsable {
      */
     rowCount?: number | null;
 }
+/**
+ * Response model containing user data export data returned by the Leadping API.
+ */
 export interface UserDataExportResponse extends AdditionalDataHolder, Parsable {
     /**
      * Date and time when the user data export completed.
@@ -11569,6 +11808,10 @@ export interface UserResponse extends AdditionalDataHolder, Parsable {
      * Defines the supported Billing Plan values.
      */
     billingPlan?: UserResponse_billingPlan | null;
+    /**
+     * Customer-safe billing state for the user's currently selected business.
+     */
+    billingState?: UserResponse_billingState | null;
     /**
      * The compliance value for this user.
      */
@@ -11651,6 +11894,11 @@ export interface UserResponse extends AdditionalDataHolder, Parsable {
     subscriptionStatus?: UserResponse_subscriptionStatus | null;
 }
 export type UserResponse_billingPlan = (typeof UserResponse_billingPlanObject)[keyof typeof UserResponse_billingPlanObject];
+/**
+ * Customer-safe billing state for the user's currently selected business.
+ */
+export interface UserResponse_billingState extends BusinessBillingState, Parsable {
+}
 /**
  * The compliance value for this user.
  */
@@ -11843,6 +12091,20 @@ export declare const BusinessResponse_billingPlanObject: {
     readonly Annual: "Annual";
     readonly Monthly: "Monthly";
 };
+/**
+ * Defines the supported User Setup Status values.
+ */
+export declare const BusinessResponse_setupStatusObject: {
+    readonly Personal: "Personal";
+    readonly Business: "Business";
+    readonly Details: "Details";
+    readonly Compliance: "Compliance";
+    readonly Phone: "Phone";
+    readonly Plan: "Plan";
+    readonly Billing: "Billing";
+    readonly Review: "Review";
+    readonly Complete: "Complete";
+};
 /**
  * Defines the supported Business Setup Step values.
  */