@leadping/sdk 1.0.21 → 1.0.23

package/dist/models/index.d.ts

@@ -1217,6 +1217,10 @@ export interface BusinessActivationState_tenDlcDraft extends Parsable, TenDlcApp
  * Customer-safe billing state for a Leadping business.
  */
 export interface BusinessBillingState extends AdditionalDataHolder, Parsable {
+    /**
+     * Date and time when the scheduled billing plan change takes effect.
+     */
+    billingPlanChangeEffectiveAt?: Date | null;
     /**
      * Gets or sets the number of user licenses currently assigned by the business.
      */
@@ -1249,16 +1253,25 @@ export interface BusinessBillingState extends AdditionalDataHolder, Parsable {
      * Gets or sets when Leadping last processed a subscription event for the business.
      */
     lastSubscriptionEventAt?: Date | null;
+    /**
+     * Defines the supported Billing Plan values.
+     */
+    pendingBillingPlan?: BusinessBillingState_pendingBillingPlan | null;
     /**
      * Gets or sets the number of phone numbers included in the business subscription.
      */
     phoneNumberQuantity?: UntypedNode | null;
+    /**
+     * Current plan renewal date.
+     */
+    planRenewalAt?: Date | null;
 }
 /**
  * Gets or sets the customer-safe payment recovery state for the business.
  */
 export interface BusinessBillingState_dunning extends BusinessDunningInfo, Parsable {
 }
+export type BusinessBillingState_pendingBillingPlan = (typeof BusinessBillingState_pendingBillingPlanObject)[keyof typeof BusinessBillingState_pendingBillingPlanObject];
 /**
  * API DTO containing business compliance policy data used by Leadping API contracts.
  */
@@ -1533,6 +1546,10 @@ export interface BusinessRequest extends AdditionalDataHolder, Parsable {
      * Name used for invoices, receipts, and payment processor billing records.
      */
     billingName?: string | null;
+    /**
+     * Tax identifier printed on billing documents. This may differ from the business verification EIN.
+     */
+    billingTaxId?: string | null;
     /**
      * Compliance policy configuration for the business.
      */
@@ -1655,6 +1672,10 @@ export interface BusinessResponse extends AdditionalDataHolder, Parsable {
      * Customer-safe billing state for this business.
      */
     billingState?: BusinessResponse_billingState | null;
+    /**
+     * Tax identifier printed on billing documents. This may differ from the business verification EIN.
+     */
+    billingTaxId?: string | null;
     /**
      * Compliance policy configuration for the business.
      */
@@ -1707,6 +1728,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.
      */
@@ -1767,6 +1792,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.
@@ -3051,6 +3077,18 @@ export declare function createLeadResponse_currentDispositionFromDiscriminatorVa
  * @returns {LeadResponse}
  */
 export declare function createLeadResponseFromDiscriminatorValue(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 {LeadStatusRequest}
+ */
+export declare function createLeadStatusRequestFromDiscriminatorValue(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 {LeadStatusResponse}
+ */
+export declare function createLeadStatusResponseFromDiscriminatorValue(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
@@ -3492,6 +3530,12 @@ export declare function createSourceTableRowFromDiscriminatorValue(parseNode: Pa
  * @returns {StreetAddress}
  */
 export declare function createStreetAddressFromDiscriminatorValue(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 {StripeInvoiceResponse}
+ */
+export declare function createStripeInvoiceResponseFromDiscriminatorValue(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
@@ -3678,6 +3722,12 @@ export declare function createUserDataExportResponseFromDiscriminatorValue(parse
  * @returns {UserIdentity}
  */
 export declare function createUserIdentityFromDiscriminatorValue(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 {UserNotificationPreferences_smsConsentTrustedFormCertificate}
+ */
+export declare function createUserNotificationPreferences_smsConsentTrustedFormCertificateFromDiscriminatorValue(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
@@ -4891,6 +4941,18 @@ export declare function deserializeIntoLeadResponse(leadResponse?: Partial<LeadR
  * @returns {Record<string, (node: ParseNode) => void>}
  */
 export declare function deserializeIntoLeadResponse_currentDisposition(leadResponse_currentDisposition?: Partial<LeadResponse_currentDisposition> | undefined): Record<string, (node: ParseNode) => void>;
+/**
+ * The deserialization information for the current model
+ * @param LeadStatusRequest The instance to deserialize into.
+ * @returns {Record<string, (node: ParseNode) => void>}
+ */
+export declare function deserializeIntoLeadStatusRequest(leadStatusRequest?: Partial<LeadStatusRequest> | undefined): Record<string, (node: ParseNode) => void>;
+/**
+ * The deserialization information for the current model
+ * @param LeadStatusResponse The instance to deserialize into.
+ * @returns {Record<string, (node: ParseNode) => void>}
+ */
+export declare function deserializeIntoLeadStatusResponse(leadStatusResponse?: Partial<LeadStatusResponse> | undefined): Record<string, (node: ParseNode) => void>;
 /**
  * The deserialization information for the current model
  * @param LeadTableRow The instance to deserialize into.
@@ -5323,6 +5385,12 @@ export declare function deserializeIntoSourceTableRow_user(sourceTableRow_user?:
  * @returns {Record<string, (node: ParseNode) => void>}
  */
 export declare function deserializeIntoStreetAddress(streetAddress?: Partial<StreetAddress> | undefined): Record<string, (node: ParseNode) => void>;
+/**
+ * The deserialization information for the current model
+ * @param StripeInvoiceResponse The instance to deserialize into.
+ * @returns {Record<string, (node: ParseNode) => void>}
+ */
+export declare function deserializeIntoStripeInvoiceResponse(stripeInvoiceResponse?: Partial<StripeInvoiceResponse> | undefined): Record<string, (node: ParseNode) => void>;
 /**
  * The deserialization information for the current model
  * @param StripePaymentMethodResponse The instance to deserialize into.
@@ -5515,6 +5583,12 @@ export declare function deserializeIntoUserIdentity(userIdentity?: Partial<UserI
  * @returns {Record<string, (node: ParseNode) => void>}
  */
 export declare function deserializeIntoUserNotificationPreferences(userNotificationPreferences?: Partial<UserNotificationPreferences> | undefined): Record<string, (node: ParseNode) => void>;
+/**
+ * The deserialization information for the current model
+ * @param UserNotificationPreferences_smsConsentTrustedFormCertificate The instance to deserialize into.
+ * @returns {Record<string, (node: ParseNode) => void>}
+ */
+export declare function deserializeIntoUserNotificationPreferences_smsConsentTrustedFormCertificate(userNotificationPreferences_smsConsentTrustedFormCertificate?: Partial<UserNotificationPreferences_smsConsentTrustedFormCertificate> | undefined): Record<string, (node: ParseNode) => void>;
 /**
  * The deserialization information for the current model
  * @param UserRequest The instance to deserialize into.
@@ -5575,6 +5649,7 @@ export declare function deserializeIntoUserResponse_notificationPreferences(user
  * @returns {Record<string, (node: ParseNode) => void>}
  */
 export declare function deserializeIntoWalletResponse(walletResponse?: Partial<WalletResponse> | undefined): Record<string, (node: ParseNode) => void>;
+export type DispositionCategory = (typeof DispositionCategoryObject)[keyof typeof DispositionCategoryObject];
 /**
  * API response containing disposition export data returned to callers.
  */
@@ -6961,6 +7036,59 @@ export interface LeadResponse extends AdditionalDataHolder, Parsable {
  */
 export interface LeadResponse_currentDisposition extends CurrentDispositionSummary, Parsable {
 }
+export interface LeadStatusRequest extends AdditionalDataHolder, Parsable {
+    /**
+     * Controlled disposition categories used for reporting, automation, and analytics.
+     */
+    category?: LeadStatusRequest_category | null;
+    /**
+     * The color property
+     */
+    color?: string | null;
+    /**
+     * The name property
+     */
+    name?: string | null;
+    /**
+     * The sortOrder property
+     */
+    sortOrder?: UntypedNode | null;
+}
+export type LeadStatusRequest_category = (typeof LeadStatusRequest_categoryObject)[keyof typeof LeadStatusRequest_categoryObject];
+export interface LeadStatusResponse extends AdditionalDataHolder, Parsable {
+    /**
+     * The businessId property
+     */
+    businessId?: string | null;
+    /**
+     * Controlled disposition categories used for reporting, automation, and analytics.
+     */
+    category?: DispositionCategory | null;
+    /**
+     * The color property
+     */
+    color?: string | null;
+    /**
+     * The id property
+     */
+    id?: string | null;
+    /**
+     * The isArchived property
+     */
+    isArchived?: boolean | null;
+    /**
+     * The modifiedAt property
+     */
+    modifiedAt?: Date | null;
+    /**
+     * The name property
+     */
+    name?: string | null;
+    /**
+     * The sortOrder property
+     */
+    sortOrder?: number | null;
+}
 /**
  * List item schema for Leadping API lead table row results shown in searchable tables.
  */
@@ -9242,6 +9370,20 @@ export declare function serializeLeadResponse(writer: SerializationWriter, leadR
  * @param writer Serialization writer to use to serialize this model
  */
 export declare function serializeLeadResponse_currentDisposition(writer: SerializationWriter, leadResponse_currentDisposition?: Partial<LeadResponse_currentDisposition> | undefined | null, isSerializingDerivedType?: boolean): void;
+/**
+ * Serializes information the current object
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
+ * @param LeadStatusRequest The instance to serialize from.
+ * @param writer Serialization writer to use to serialize this model
+ */
+export declare function serializeLeadStatusRequest(writer: SerializationWriter, leadStatusRequest?: Partial<LeadStatusRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
+/**
+ * Serializes information the current object
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
+ * @param LeadStatusResponse The instance to serialize from.
+ * @param writer Serialization writer to use to serialize this model
+ */
+export declare function serializeLeadStatusResponse(writer: SerializationWriter, leadStatusResponse?: Partial<LeadStatusResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
 /**
  * Serializes information the current object
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -9746,6 +9888,13 @@ export declare function serializeSourceTableRow_user(writer: SerializationWriter
  * @param writer Serialization writer to use to serialize this model
  */
 export declare function serializeStreetAddress(writer: SerializationWriter, streetAddress?: Partial<StreetAddress> | undefined | null, isSerializingDerivedType?: boolean): void;
+/**
+ * Serializes information the current object
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
+ * @param StripeInvoiceResponse The instance to serialize from.
+ * @param writer Serialization writer to use to serialize this model
+ */
+export declare function serializeStripeInvoiceResponse(writer: SerializationWriter, stripeInvoiceResponse?: Partial<StripeInvoiceResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
 /**
  * Serializes information the current object
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -9970,6 +10119,13 @@ export declare function serializeUserIdentity(writer: SerializationWriter, userI
  * @param writer Serialization writer to use to serialize this model
  */
 export declare function serializeUserNotificationPreferences(writer: SerializationWriter, userNotificationPreferences?: Partial<UserNotificationPreferences> | undefined | null, isSerializingDerivedType?: boolean): void;
+/**
+ * Serializes information the current object
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
+ * @param UserNotificationPreferences_smsConsentTrustedFormCertificate The instance to serialize from.
+ * @param writer Serialization writer to use to serialize this model
+ */
+export declare function serializeUserNotificationPreferences_smsConsentTrustedFormCertificate(writer: SerializationWriter, userNotificationPreferences_smsConsentTrustedFormCertificate?: Partial<UserNotificationPreferences_smsConsentTrustedFormCertificate> | undefined | null, isSerializingDerivedType?: boolean): void;
 /**
  * Serializes information the current object
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -10736,6 +10892,35 @@ export interface StreetAddress extends AdditionalDataHolder, Parsable {
      */
     state?: string | null;
 }
+/**
+ * Customer-safe Stripe invoice summary for billing history.
+ */
+export interface StripeInvoiceResponse extends AdditionalDataHolder, Parsable {
+    /**
+     * The amount property
+     */
+    amount?: number | null;
+    /**
+     * The createdAt property
+     */
+    createdAt?: Date | null;
+    /**
+     * The hostedInvoiceUrl property
+     */
+    hostedInvoiceUrl?: string | null;
+    /**
+     * The id property
+     */
+    id?: string | null;
+    /**
+     * The number property
+     */
+    number?: string | null;
+    /**
+     * The status property
+     */
+    status?: string | null;
+}
 /**
  * API DTO containing stripe payment method data used by Leadping API contracts.
  */
@@ -11697,6 +11882,18 @@ export interface UserNotificationPreferences extends AdditionalDataHolder, Parsa
      * Indicates whether payment failed SMS functionality is enabled for this Leadping user notification preferences.
      */
     paymentFailedSmsEnabled?: boolean | null;
+    /**
+     * Whether the user has consented to receive Leadping account notification SMS messages.
+     */
+    smsConsentOptedIn?: boolean | null;
+    /**
+     * The TrustedForm certificate captured for the user's most recent SMS opt-in.
+     */
+    smsConsentTrustedFormCertificate?: UserNotificationPreferences_smsConsentTrustedFormCertificate | null;
+    /**
+     * When the user's Leadping notification SMS consent was last changed.
+     */
+    smsConsentUpdatedAt?: Date | null;
     /**
      * Indicates whether subscription renewing email functionality is enabled for this Leadping user notification preferences.
      */
@@ -11730,6 +11927,11 @@ export interface UserNotificationPreferences extends AdditionalDataHolder, Parsa
      */
     usageLimitHitEnabled?: boolean | null;
 }
+/**
+ * The TrustedForm certificate captured for the user's most recent SMS opt-in.
+ */
+export interface UserNotificationPreferences_smsConsentTrustedFormCertificate extends Parsable, TrustedFormCertificate {
+}
 /**
  * Request schema for the Leadping API user profile request, including the fields clients can send.
  */
@@ -12060,6 +12262,13 @@ export declare const BillingPlanObject: {
     readonly Annual: "Annual";
     readonly Monthly: "Monthly";
 };
+/**
+ * Defines the supported Billing Plan values.
+ */
+export declare const BusinessBillingState_pendingBillingPlanObject: {
+    readonly Annual: "Annual";
+    readonly Monthly: "Monthly";
+};
 /**
  * Defines the supported Business Invitation Status values.
  */
@@ -12086,6 +12295,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.
  */
@@ -12338,6 +12561,17 @@ export declare const CustomerActivationStatusObject: {
     readonly BlockedRequiresOperatorAction: "BlockedRequiresOperatorAction";
     readonly ManuallyBypassed: "ManuallyBypassed";
 };
+/**
+ * Controlled disposition categories used for reporting, automation, and analytics.
+ */
+export declare const DispositionCategoryObject: {
+    readonly Open: "Open";
+    readonly Qualified: "Qualified";
+    readonly Converted: "Converted";
+    readonly Lost: "Lost";
+    readonly Invalid: "Invalid";
+    readonly Duplicate: "Duplicate";
+};
 /**
  * Controlled disposition categories used for reporting, automation, and analytics.
  */
@@ -12574,6 +12808,17 @@ export declare const LeadProfile_maritalStatusObject: {
     readonly Separated: "Separated";
     readonly Divorced: "Divorced";
 };
+/**
+ * Controlled disposition categories used for reporting, automation, and analytics.
+ */
+export declare const LeadStatusRequest_categoryObject: {
+    readonly Open: "Open";
+    readonly Qualified: "Qualified";
+    readonly Converted: "Converted";
+    readonly Lost: "Lost";
+    readonly Invalid: "Invalid";
+    readonly Duplicate: "Duplicate";
+};
 /**
  * Defines the supported Notification Priority values.
  */