@leadping/sdk 1.0.12 → 1.0.13

package/dist/models/index.d.ts

@@ -1993,6 +1993,125 @@ export interface BusinessSwitchRequest extends AdditionalDataHolder, Parsable {
      */
     businessId?: string | null;
 }
+/**
+ * API DTO containing business data used by Leadping API contracts.
+ */
+export interface BusinessTableRow extends AdditionalDataHolder, Parsable {
+    /**
+     * The account balance value for this business.
+     */
+    accountBalance?: UntypedNode | null;
+    /**
+     * Defines the supported Customer Activation Status values.
+     */
+    activationStatus?: BusinessTableRow_activationStatus | null;
+    /**
+     * The admin force enablement override on this business.
+     */
+    adminEnablementOverride?: BusinessTableRow_adminEnablementOverride | null;
+    /**
+     * The date and time this business API key expires, or null when it has no expiration.
+     */
+    apiKeyExpiresAt?: Date | null;
+    /**
+     * The date and time this business API key was first used.
+     */
+    apiKeyFirstUsedAt?: Date | null;
+    /**
+     * The date and time this business API key was issued.
+     */
+    apiKeyIssuedAt?: Date | null;
+    /**
+     * The date and time this business API key was last used.
+     */
+    apiKeyLastUsedAt?: Date | null;
+    /**
+     * The masked API key preview owned by this business.
+     */
+    apiKeyPreview?: string | null;
+    /**
+     * The total number of tracked uses for this business API key.
+     */
+    apiKeyTotalUses?: number | null;
+    /**
+     * The business ID that owns this row when the row represents a child business resource.
+     */
+    businessId?: string | null;
+    /**
+     * The business name that owns this row when the row represents a child business resource.
+     */
+    businessName?: string | null;
+    /**
+     * Whether this business is enabled.
+     */
+    enabled?: boolean | null;
+    /**
+     * The unique ID for this business.
+     */
+    id?: string | null;
+    /**
+     * The industry value for this business.
+     */
+    industry?: string | null;
+    /**
+     * The date and time for the modified at value on this business.
+     */
+    modifiedAt?: Date | null;
+    /**
+     * The human-readable name shown for this business.
+     */
+    name?: string | null;
+    /**
+     * Whether needs admin review applies to this business.
+     */
+    needsAdminReview?: boolean | null;
+    /**
+     * The phone number associated with this business.
+     */
+    phone?: string | null;
+    /**
+     * Defines the supported Business Setup Step values.
+     */
+    setupStep?: BusinessTableRow_setupStep | null;
+    /**
+     * Defines the supported Business Status values.
+     */
+    status?: BusinessTableRow_status | null;
+    /**
+     * Defines the supported 10DLC Application Status values.
+     */
+    tenDlcStatus?: BusinessTableRow_tenDlcStatus | null;
+    /**
+     * The user count for this business.
+     */
+    userCount?: number | null;
+    /**
+     * The user ID value for this business.
+     */
+    userId?: string | null;
+    /**
+     * The user name value for this business.
+     */
+    userName?: string | null;
+    /**
+     * The website URL associated with this business.
+     */
+    website?: string | null;
+    /**
+     * Defines the supported Website Lifecycle Status values.
+     */
+    websiteStatus?: BusinessTableRow_websiteStatus | null;
+}
+export type BusinessTableRow_activationStatus = (typeof BusinessTableRow_activationStatusObject)[keyof typeof BusinessTableRow_activationStatusObject];
+/**
+ * The admin force enablement override on this business.
+ */
+export interface BusinessTableRow_adminEnablementOverride extends AdminEnablementOverride, Parsable {
+}
+export type BusinessTableRow_setupStep = (typeof BusinessTableRow_setupStepObject)[keyof typeof BusinessTableRow_setupStepObject];
+export type BusinessTableRow_status = (typeof BusinessTableRow_statusObject)[keyof typeof BusinessTableRow_statusObject];
+export type BusinessTableRow_tenDlcStatus = (typeof BusinessTableRow_tenDlcStatusObject)[keyof typeof BusinessTableRow_tenDlcStatusObject];
+export type BusinessTableRow_websiteStatus = (typeof BusinessTableRow_websiteStatusObject)[keyof typeof BusinessTableRow_websiteStatusObject];
 /**
  * Request schema for the Leadping API business user request, including the fields clients can send.
  */
@@ -2806,6 +2925,18 @@ export declare function createBusinessSwitchOptionFromDiscriminatorValue(parseNo
  * @returns {BusinessSwitchRequest}
  */
 export declare function createBusinessSwitchRequestFromDiscriminatorValue(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 {BusinessTableRow_adminEnablementOverride}
+ */
+export declare function createBusinessTableRow_adminEnablementOverrideFromDiscriminatorValue(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 {BusinessTableRow}
+ */
+export declare function createBusinessTableRowFromDiscriminatorValue(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
@@ -3247,6 +3378,12 @@ export declare function createOutgoingNumberSelectionResponseFromDiscriminatorVa
  * @returns {PagedResultOfAutomationTableRow}
  */
 export declare function createPagedResultOfAutomationTableRowFromDiscriminatorValue(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 {PagedResultOfBusinessTableRow}
+ */
+export declare function createPagedResultOfBusinessTableRowFromDiscriminatorValue(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
@@ -4703,6 +4840,18 @@ export declare function deserializeIntoBusinessSwitchOption(businessSwitchOption
  * @returns {Record<string, (node: ParseNode) => void>}
  */
 export declare function deserializeIntoBusinessSwitchRequest(businessSwitchRequest?: Partial<BusinessSwitchRequest> | undefined): Record<string, (node: ParseNode) => void>;
+/**
+ * The deserialization information for the current model
+ * @param BusinessTableRow The instance to deserialize into.
+ * @returns {Record<string, (node: ParseNode) => void>}
+ */
+export declare function deserializeIntoBusinessTableRow(businessTableRow?: Partial<BusinessTableRow> | undefined): Record<string, (node: ParseNode) => void>;
+/**
+ * The deserialization information for the current model
+ * @param BusinessTableRow_adminEnablementOverride The instance to deserialize into.
+ * @returns {Record<string, (node: ParseNode) => void>}
+ */
+export declare function deserializeIntoBusinessTableRow_adminEnablementOverride(businessTableRow_adminEnablementOverride?: Partial<BusinessTableRow_adminEnablementOverride> | undefined): Record<string, (node: ParseNode) => void>;
 /**
  * The deserialization information for the current model
  * @param BusinessUserRequest The instance to deserialize into.
@@ -5135,6 +5284,12 @@ export declare function deserializeIntoOutgoingNumberSelectionResponse(outgoingN
  * @returns {Record<string, (node: ParseNode) => void>}
  */
 export declare function deserializeIntoPagedResultOfAutomationTableRow(pagedResultOfAutomationTableRow?: Partial<PagedResultOfAutomationTableRow> | undefined): Record<string, (node: ParseNode) => void>;
+/**
+ * The deserialization information for the current model
+ * @param PagedResultOfBusinessTableRow The instance to deserialize into.
+ * @returns {Record<string, (node: ParseNode) => void>}
+ */
+export declare function deserializeIntoPagedResultOfBusinessTableRow(pagedResultOfBusinessTableRow?: Partial<PagedResultOfBusinessTableRow> | undefined): Record<string, (node: ParseNode) => void>;
 /**
  * The deserialization information for the current model
  * @param PagedResultOfCallEventTableRow The instance to deserialize into.
@@ -6329,6 +6484,14 @@ export interface EventDetailResponse_user extends IdNamePair, Parsable {
  * List item schema for Leadping API event timeline table row results shown in searchable tables.
  */
 export interface EventTableRow extends AdditionalDataHolder, Parsable {
+    /**
+     * Display name for the person or system that created this event timeline table row.
+     */
+    actorDisplayName?: string | null;
+    /**
+     * User ID for the person or system that created this event timeline table row.
+     */
+    actorUserId?: string | null;
     /**
      * Monetary amount billed for this Leadping communication or transaction.
      */
@@ -7348,6 +7511,10 @@ export interface LeadTableRow extends AdditionalDataHolder, Parsable {
      * Tags currently attached to this lead, source, or record.
      */
     tags?: TagSummary[] | null;
+    /**
+     * UTC timestamp when this lead table row was last updated.
+     */
+    updatedAt?: Date | null;
 }
 /**
  * Admin override that can enable or disable this record independently of normal status checks.
@@ -7744,6 +7911,27 @@ export interface PagedResultOfAutomationTableRow extends AdditionalDataHolder, P
      */
     totalCount?: UntypedNode | null;
 }
+/**
+ * A generic container for paginated results returned to the client.
+ */
+export interface PagedResultOfBusinessTableRow extends AdditionalDataHolder, Parsable {
+    /**
+     * Opaque storage continuation token. ‑ `null` → the current page was the last page.
+     */
+    continuationToken?: string | null;
+    /**
+     * The subset of items returned for the current page.
+     */
+    items?: BusinessTableRow[] | null;
+    /**
+     * The number of items returned per page in the response. This may reflect the client's requested page size, or a server-defined default or limit.
+     */
+    pageSize?: number | null;
+    /**
+     * The total number of items that match the query across all pages. May be null if the count is not computed or not applicable (e.g., in continuation-based pagination).
+     */
+    totalCount?: UntypedNode | null;
+}
 /**
  * A generic container for paginated results returned to the client.
  */
@@ -9762,6 +9950,20 @@ export declare function serializeBusinessSwitchOption(writer: SerializationWrite
  * @param writer Serialization writer to use to serialize this model
  */
 export declare function serializeBusinessSwitchRequest(writer: SerializationWriter, businessSwitchRequest?: Partial<BusinessSwitchRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
+/**
+ * Serializes information the current object
+ * @param BusinessTableRow 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 serializeBusinessTableRow(writer: SerializationWriter, businessTableRow?: Partial<BusinessTableRow> | undefined | null, isSerializingDerivedType?: boolean): void;
+/**
+ * Serializes information the current object
+ * @param BusinessTableRow_adminEnablementOverride 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 serializeBusinessTableRow_adminEnablementOverride(writer: SerializationWriter, businessTableRow_adminEnablementOverride?: Partial<BusinessTableRow_adminEnablementOverride> | undefined | null, isSerializingDerivedType?: boolean): void;
 /**
  * Serializes information the current object
  * @param BusinessUserRequest The instance to serialize from.
@@ -10266,6 +10468,13 @@ export declare function serializeOutgoingNumberSelectionResponse(writer: Seriali
  * @param writer Serialization writer to use to serialize this model
  */
 export declare function serializePagedResultOfAutomationTableRow(writer: SerializationWriter, pagedResultOfAutomationTableRow?: Partial<PagedResultOfAutomationTableRow> | undefined | null, isSerializingDerivedType?: boolean): void;
+/**
+ * Serializes information the current object
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
+ * @param PagedResultOfBusinessTableRow The instance to serialize from.
+ * @param writer Serialization writer to use to serialize this model
+ */
+export declare function serializePagedResultOfBusinessTableRow(writer: SerializationWriter, pagedResultOfBusinessTableRow?: Partial<PagedResultOfBusinessTableRow> | undefined | null, isSerializingDerivedType?: boolean): void;
 /**
  * Serializes information the current object
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -13432,6 +13641,88 @@ export declare const BusinessSwitchOption_businessStatusObject: {
     readonly SetupCompleted: "SetupCompleted";
     readonly Active: "Active";
 };
+/**
+ * Defines the supported Customer Activation Status values.
+ */
+export declare const BusinessTableRow_activationStatusObject: {
+    readonly DraftOnboarding: "DraftOnboarding";
+    readonly PaymentMethodPending: "PaymentMethodPending";
+    readonly PaymentMethodConfirmed: "PaymentMethodConfirmed";
+    readonly SubscriptionPending: "SubscriptionPending";
+    readonly SubscriptionReceived: "SubscriptionReceived";
+    readonly SubscriptionActive: "SubscriptionActive";
+    readonly LaunchReviewPending: "LaunchReviewPending";
+    readonly TelephonyProvisioningPending: "TelephonyProvisioningPending";
+    readonly TelephonyPartiallyProvisioned: "TelephonyPartiallyProvisioned";
+    readonly TelephonyReady: "TelephonyReady";
+    readonly AwaitingReview: "AwaitingReview";
+    readonly DomainSelection: "DomainSelection";
+    readonly WebsiteSetup: "WebsiteSetup";
+    readonly ComplianceRegistration: "ComplianceRegistration";
+    readonly ReadyForApproval: "ReadyForApproval";
+    readonly Active: "Active";
+    readonly Failed: "Failed";
+    readonly Blocked: "Blocked";
+    readonly BlockedRequiresOperatorAction: "BlockedRequiresOperatorAction";
+    readonly ManuallyBypassed: "ManuallyBypassed";
+};
+/**
+ * Defines the supported Business Setup Step values.
+ */
+export declare const BusinessTableRow_setupStepObject: {
+    readonly DomainFinding: "DomainFinding";
+    readonly DomainOptionsFound: "DomainOptionsFound";
+    readonly SiteGenerating: "SiteGenerating";
+    readonly SiteGenerated: "SiteGenerated";
+    readonly BrandSubmitted: "BrandSubmitted";
+    readonly BrandApproved: "BrandApproved";
+    readonly CampaignSubmitted: "CampaignSubmitted";
+    readonly CampaignApproved: "CampaignApproved";
+    readonly CarrierReviewing: "CarrierReviewing";
+    readonly TenDlcComplete: "TenDlcComplete";
+    readonly Complete: "Complete";
+};
+/**
+ * Defines the supported Business Status values.
+ */
+export declare const BusinessTableRow_statusObject: {
+    readonly SettingUp: "SettingUp";
+    readonly SetupCompleted: "SetupCompleted";
+    readonly Active: "Active";
+};
+/**
+ * Defines the supported 10DLC Application Status values.
+ */
+export declare const BusinessTableRow_tenDlcStatusObject: {
+    readonly NotStarted: "NotStarted";
+    readonly DraftGenerated: "DraftGenerated";
+    readonly DraftNeedsAdminReview: "DraftNeedsAdminReview";
+    readonly ReadyToSubmit: "ReadyToSubmit";
+    readonly Submitted: "Submitted";
+    readonly PendingTelnyxReview: "PendingTelnyxReview";
+    readonly Approved: "Approved";
+    readonly Rejected: "Rejected";
+    readonly NeedsChanges: "NeedsChanges";
+    readonly ResubmissionReady: "ResubmissionReady";
+    readonly Failed: "Failed";
+};
+/**
+ * Defines the supported Website Lifecycle Status values.
+ */
+export declare const BusinessTableRow_websiteStatusObject: {
+    readonly NotStarted: "NotStarted";
+    readonly DomainSuggestionsPending: "DomainSuggestionsPending";
+    readonly DomainSelectionPending: "DomainSelectionPending";
+    readonly DomainPurchasePending: "DomainPurchasePending";
+    readonly DomainPurchased: "DomainPurchased";
+    readonly WebsiteGenerationQueued: "WebsiteGenerationQueued";
+    readonly WebsiteGenerating: "WebsiteGenerating";
+    readonly WebsiteDeploymentQueued: "WebsiteDeploymentQueued";
+    readonly WebsiteDeploying: "WebsiteDeploying";
+    readonly WebsiteLive: "WebsiteLive";
+    readonly WebsiteFailed: "WebsiteFailed";
+    readonly ManuallyBypassed: "ManuallyBypassed";
+};
 /**
  * Defines the supported Business User Role values.
  */