@leadping/sdk 1.0.40 → 1.0.41

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.
@@ -12168,7 +12168,7 @@ export function serializeWalletResponse(writer, walletResponse = {}, isSerializi
12168
12168
  writer.writeAdditionalData(walletResponse.additionalData);
12169
12169
  }
12170
12170
  /**
12171
- * Defines the supported Activation Launch Review Status values.
12171
+ * Describes the administrative review decision that determines whether an organization can launch Leadping workflows.
12172
12172
  */
12173
12173
  export const ActivationLaunchReviewStatusObject = {
12174
12174
  NotReady: "NotReady",
@@ -12178,7 +12178,7 @@ export const ActivationLaunchReviewStatusObject = {
12178
12178
  Blocked: "Blocked",
12179
12179
  };
12180
12180
  /**
12181
- * Defines the supported Activation Onboarding Status values.
12181
+ * Describes completion and blocking state for an organization's core Leadping onboarding requirements.
12182
12182
  */
12183
12183
  export const ActivationOnboardingStatusObject = {
12184
12184
  Draft: "Draft",
@@ -12186,7 +12186,7 @@ export const ActivationOnboardingStatusObject = {
12186
12186
  Failed: "Failed",
12187
12187
  };
12188
12188
  /**
12189
- * Defines the supported Activation Payment Status values.
12189
+ * Describes whether valid funding and payment prerequisites are satisfied during organization activation.
12190
12190
  */
12191
12191
  export const ActivationPaymentStatusObject = {
12192
12192
  PaymentMethodPending: "PaymentMethodPending",
@@ -12194,7 +12194,7 @@ export const ActivationPaymentStatusObject = {
12194
12194
  Failed: "Failed",
12195
12195
  };
12196
12196
  /**
12197
- * Defines the supported Activation Subscription Status values.
12197
+ * Describes whether an organization's subscription is ready, blocked, or still incomplete during activation.
12198
12198
  */
12199
12199
  export const ActivationSubscriptionStatusObject = {
12200
12200
  Pending: "Pending",
@@ -12203,7 +12203,7 @@ export const ActivationSubscriptionStatusObject = {
12203
12203
  Canceled: "Canceled",
12204
12204
  };
12205
12205
  /**
12206
- * Defines the supported Activation Telephony Status values.
12206
+ * Describes whether phone numbers, calling, messaging, and provider resources are ready for organization launch.
12207
12207
  */
12208
12208
  export const ActivationTelephonyStatusObject = {
12209
12209
  NotStarted: "NotStarted",
@@ -12214,7 +12214,7 @@ export const ActivationTelephonyStatusObject = {
12214
12214
  BlockedRequiresOperatorAction: "BlockedRequiresOperatorAction",
12215
12215
  };
12216
12216
  /**
12217
- * Defines the supported Billable Unit values.
12217
+ * Identifies the metered unit used to price Leadping usage, such as a message, call minute, lookup, or phone number.
12218
12218
  */
12219
12219
  export const BillableUnitObject = {
12220
12220
  Lead_received: "lead_received",
@@ -12236,14 +12236,14 @@ export const BillableUnitObject = {
12236
12236
  Automation_run: "automation_run",
12237
12237
  };
12238
12238
  /**
12239
- * Defines the supported Billing Plan values.
12239
+ * Identifies the Leadping subscription plan that determines organization features, allowances, and billing behavior.
12240
12240
  */
12241
12241
  export const BillingPlanObject = {
12242
12242
  Annual: "Annual",
12243
12243
  Monthly: "Monthly",
12244
12244
  };
12245
12245
  /**
12246
- * Defines the supported Phone Call Status values.
12246
+ * Describes the durable business outcome of a Leadping phone call after provider status normalization.
12247
12247
  */
12248
12248
  export const CallEventTableRow_statusObject = {
12249
12249
  Scheduled: "scheduled",
@@ -12298,7 +12298,7 @@ export const CurrentLeadStatusSummary_sourceObject = {
12298
12298
  API: "API",
12299
12299
  };
12300
12300
  /**
12301
- * Defines the supported Customer Activation Status values.
12301
+ * Summarizes an organization's overall progress from initial Leadping onboarding through launch readiness.
12302
12302
  */
12303
12303
  export const CustomerActivationStatusObject = {
12304
12304
  DraftOnboarding: "DraftOnboarding",
@@ -12323,7 +12323,7 @@ export const CustomerActivationStatusObject = {
12323
12323
  ManuallyBypassed: "ManuallyBypassed",
12324
12324
  };
12325
12325
  /**
12326
- * Defines the supported SMS readiness health assessments.
12326
+ * Summarizes the severity of conditions affecting an organization's ability to send compliant SMS or MMS traffic.
12327
12327
  */
12328
12328
  export const EligibleOutgoingNumberResponse_healthStatusObject = {
12329
12329
  NotEvaluated: "Not Evaluated",
@@ -12333,7 +12333,7 @@ export const EligibleOutgoingNumberResponse_healthStatusObject = {
12333
12333
  Blocked: "Blocked",
12334
12334
  };
12335
12335
  /**
12336
- * Defines the supported Event status values.
12336
+ * Describes whether a Leadping event is pending, processing, completed, failed, or otherwise resolved.
12337
12337
  */
12338
12338
  export const EventDetailResponse_statusObject = {
12339
12339
  Pending: "Pending",
@@ -12343,7 +12343,7 @@ export const EventDetailResponse_statusObject = {
12343
12343
  Cancelled: "Cancelled",
12344
12344
  };
12345
12345
  /**
12346
- * Defines the supported Event timeline type values.
12346
+ * Classifies the kind of activity displayed in a lead or conversation event timeline.
12347
12347
  */
12348
12348
  export const EventDetailResponse_timelineTypeObject = {
12349
12349
  Message: "Message",
@@ -12360,7 +12360,7 @@ export const EventDetailResponse_timelineTypeObject = {
12360
12360
  Warmup: "Warmup",
12361
12361
  };
12362
12362
  /**
12363
- * Defines the supported Outgoing Number Selection Reason values.
12363
+ * Explains why Leadping selected, rejected, or substituted an outgoing caller or messaging number.
12364
12364
  */
12365
12365
  export const EventTableRow_selectionReasonObject = {
12366
12366
  StickyConversation: "StickyConversation",
@@ -12373,7 +12373,7 @@ export const EventTableRow_selectionReasonObject = {
12373
12373
  ManualOverride: "ManualOverride",
12374
12374
  };
12375
12375
  /**
12376
- * Defines the supported Event timeline status values.
12376
+ * Provides the customer-facing outcome shown for an item in a lead or conversation timeline.
12377
12377
  */
12378
12378
  export const EventTableRow_statusObject = {
12379
12379
  Pending: "Pending",
@@ -12399,7 +12399,7 @@ export const EventTableRow_statusObject = {
12399
12399
  Canceled: "Canceled",
12400
12400
  };
12401
12401
  /**
12402
- * Defines the supported SMS Traffic Type values.
12402
+ * Classifies messaging traffic by conversational, informational, marketing, or other compliance-relevant purpose.
12403
12403
  */
12404
12404
  export const EventTableRow_trafficTypeObject = {
12405
12405
  RealLead: "RealLead",
@@ -12409,7 +12409,7 @@ export const EventTableRow_trafficTypeObject = {
12409
12409
  FailedAttempt: "FailedAttempt",
12410
12410
  };
12411
12411
  /**
12412
- * Defines the supported Event timeline type values.
12412
+ * Classifies the kind of activity displayed in a lead or conversation event timeline.
12413
12413
  */
12414
12414
  export const EventTimelineTypeObject = {
12415
12415
  Message: "Message",
@@ -12458,7 +12458,7 @@ export const FeedbackTypeObject = {
12458
12458
  Other: "other",
12459
12459
  };
12460
12460
  /**
12461
- * Defines the supported Employment Type values.
12461
+ * Classifies a lead's reported employment arrangement for qualification and demographic workflows.
12462
12462
  */
12463
12463
  export const LeadProfile_employmentTypeObject = {
12464
12464
  Employed: "Employed",
@@ -12474,7 +12474,7 @@ export const LeadProfile_employmentTypeObject = {
12474
12474
  Other: "Other",
12475
12475
  };
12476
12476
  /**
12477
- * Represents a gender classification used for demographic or identification purposes.
12477
+ * Classifies a lead's self-reported gender when required by a qualification, demographic, or integration workflow.
12478
12478
  */
12479
12479
  export const LeadProfile_genderObject = {
12480
12480
  M: "M",
@@ -12484,7 +12484,7 @@ export const LeadProfile_genderObject = {
12484
12484
  Other: "Other",
12485
12485
  };
12486
12486
  /**
12487
- * Defines the supported Marital Status Type values.
12487
+ * Classifies a lead's reported marital status when required by a qualification or integration workflow.
12488
12488
  */
12489
12489
  export const LeadProfile_maritalStatusObject = {
12490
12490
  Married: "Married",
@@ -12601,7 +12601,7 @@ export const LeadTableRow_processingStatusObject = {
12601
12601
  Failed: "Failed",
12602
12602
  };
12603
12603
  /**
12604
- * Defines the supported Notification Priority values.
12604
+ * Ranks the urgency and presentation importance of a Leadping user notification.
12605
12605
  */
12606
12606
  export const NotificationPriorityObject = {
12607
12607
  Low: "Low",
@@ -12610,7 +12610,7 @@ export const NotificationPriorityObject = {
12610
12610
  Critical: "Critical",
12611
12611
  };
12612
12612
  /**
12613
- * Defines the supported Notification Type values.
12613
+ * Identifies the Leadping workflow or account event communicated by a user notification.
12614
12614
  */
12615
12615
  export const NotificationTypeObject = {
12616
12616
  General: "General",
@@ -12645,14 +12645,14 @@ export const OrganizationActivationState_domainSearchStageObject = {
12645
12645
  Failed: "Failed",
12646
12646
  };
12647
12647
  /**
12648
- * Defines the supported Billing Plan values.
12648
+ * Identifies the Leadping subscription plan that determines organization features, allowances, and billing behavior.
12649
12649
  */
12650
12650
  export const OrganizationBillingState_pendingBillingPlanObject = {
12651
12651
  Annual: "Annual",
12652
12652
  Monthly: "Monthly",
12653
12653
  };
12654
12654
  /**
12655
- * Defines the supported Organization Invitation Status values.
12655
+ * Describes the lifecycle of an organization membership invitation from issuance through acceptance, expiration, or revocation.
12656
12656
  */
12657
12657
  export const OrganizationInvitationStatusObject = {
12658
12658
  Pending: "Pending",
@@ -12663,7 +12663,7 @@ export const OrganizationInvitationStatusObject = {
12663
12663
  FailedToSend: "Failed to send",
12664
12664
  };
12665
12665
  /**
12666
- * Defines the supported Organization User Role values.
12666
+ * Identifies an organization member's access level and permission scope within Leadping.
12667
12667
  */
12668
12668
  export const OrganizationMemberRoleObject = {
12669
12669
  Owner: "Owner",
@@ -12671,7 +12671,7 @@ export const OrganizationMemberRoleObject = {
12671
12671
  Agent: "Agent",
12672
12672
  };
12673
12673
  /**
12674
- * Defines the supported Organization Status values.
12674
+ * Describes an organization's account lifecycle and whether it can actively use Leadping services.
12675
12675
  */
12676
12676
  export const OrganizationRequest_statusObject = {
12677
12677
  SettingUp: "SettingUp",
@@ -12679,14 +12679,14 @@ export const OrganizationRequest_statusObject = {
12679
12679
  Active: "Active",
12680
12680
  };
12681
12681
  /**
12682
- * Defines the supported Billing Plan values.
12682
+ * Identifies the Leadping subscription plan that determines organization features, allowances, and billing behavior.
12683
12683
  */
12684
12684
  export const OrganizationResponse_billingPlanObject = {
12685
12685
  Annual: "Annual",
12686
12686
  Monthly: "Monthly",
12687
12687
  };
12688
12688
  /**
12689
- * Defines the supported User Setup Status values.
12689
+ * Describes a user's progress through required Leadping profile and account setup tasks.
12690
12690
  */
12691
12691
  export const OrganizationResponse_setupStatusObject = {
12692
12692
  Personal: "Personal",
@@ -12700,7 +12700,7 @@ export const OrganizationResponse_setupStatusObject = {
12700
12700
  Complete: "Complete",
12701
12701
  };
12702
12702
  /**
12703
- * Defines the supported Organization Setup Step values.
12703
+ * Identifies a discrete billing, telephony, compliance, or configuration stage in organization provisioning.
12704
12704
  */
12705
12705
  export const OrganizationResponse_setupStepObject = {
12706
12706
  DomainFinding: "DomainFinding",
@@ -12716,7 +12716,7 @@ export const OrganizationResponse_setupStepObject = {
12716
12716
  Complete: "Complete",
12717
12717
  };
12718
12718
  /**
12719
- * Defines the supported Organization Status values.
12719
+ * Describes an organization's account lifecycle and whether it can actively use Leadping services.
12720
12720
  */
12721
12721
  export const OrganizationResponse_statusObject = {
12722
12722
  SettingUp: "SettingUp",
@@ -12724,7 +12724,7 @@ export const OrganizationResponse_statusObject = {
12724
12724
  Active: "Active",
12725
12725
  };
12726
12726
  /**
12727
- * Defines the supported Subscription Status values.
12727
+ * Describes an organization's billing subscription lifecycle, including trial, active, delinquent, canceled, and expired states.
12728
12728
  */
12729
12729
  export const OrganizationResponse_subscriptionStatusObject = {
12730
12730
  Pending: "Pending",
@@ -12733,7 +12733,7 @@ export const OrganizationResponse_subscriptionStatusObject = {
12733
12733
  Canceled: "Canceled",
12734
12734
  };
12735
12735
  /**
12736
- * Defines the supported Customer Activation Status values.
12736
+ * Summarizes an organization's overall progress from initial Leadping onboarding through launch readiness.
12737
12737
  */
12738
12738
  export const OrganizationSwitchOption_activationStatusObject = {
12739
12739
  DraftOnboarding: "DraftOnboarding",
@@ -12758,7 +12758,7 @@ export const OrganizationSwitchOption_activationStatusObject = {
12758
12758
  ManuallyBypassed: "ManuallyBypassed",
12759
12759
  };
12760
12760
  /**
12761
- * Defines the supported Organization Status values.
12761
+ * Describes an organization's account lifecycle and whether it can actively use Leadping services.
12762
12762
  */
12763
12763
  export const OrganizationSwitchOption_organizationStatusObject = {
12764
12764
  SettingUp: "SettingUp",
@@ -12766,7 +12766,7 @@ export const OrganizationSwitchOption_organizationStatusObject = {
12766
12766
  Active: "Active",
12767
12767
  };
12768
12768
  /**
12769
- * Defines the supported 10DLC Application Status values.
12769
+ * Describes an organization's overall 10DLC registration lifecycle across brand and messaging campaign submission.
12770
12770
  */
12771
12771
  export const OrganizationSwitchOption_tenDlcStatusObject = {
12772
12772
  NotStarted: "NotStarted",
@@ -12782,7 +12782,7 @@ export const OrganizationSwitchOption_tenDlcStatusObject = {
12782
12782
  Failed: "Failed",
12783
12783
  };
12784
12784
  /**
12785
- * Defines the supported Customer Activation Status values.
12785
+ * Summarizes an organization's overall progress from initial Leadping onboarding through launch readiness.
12786
12786
  */
12787
12787
  export const OrganizationTableRow_activationStatusObject = {
12788
12788
  DraftOnboarding: "DraftOnboarding",
@@ -12807,14 +12807,14 @@ export const OrganizationTableRow_activationStatusObject = {
12807
12807
  ManuallyBypassed: "ManuallyBypassed",
12808
12808
  };
12809
12809
  /**
12810
- * Defines the supported Billing Plan values.
12810
+ * Identifies the Leadping subscription plan that determines organization features, allowances, and billing behavior.
12811
12811
  */
12812
12812
  export const OrganizationTableRow_billingPlanObject = {
12813
12813
  Annual: "Annual",
12814
12814
  Monthly: "Monthly",
12815
12815
  };
12816
12816
  /**
12817
- * Defines the supported Organization Setup Step values.
12817
+ * Identifies a discrete billing, telephony, compliance, or configuration stage in organization provisioning.
12818
12818
  */
12819
12819
  export const OrganizationTableRow_setupStepObject = {
12820
12820
  DomainFinding: "DomainFinding",
@@ -12830,7 +12830,7 @@ export const OrganizationTableRow_setupStepObject = {
12830
12830
  Complete: "Complete",
12831
12831
  };
12832
12832
  /**
12833
- * Defines the supported Organization Status values.
12833
+ * Describes an organization's account lifecycle and whether it can actively use Leadping services.
12834
12834
  */
12835
12835
  export const OrganizationTableRow_statusObject = {
12836
12836
  SettingUp: "SettingUp",
@@ -12838,7 +12838,7 @@ export const OrganizationTableRow_statusObject = {
12838
12838
  Active: "Active",
12839
12839
  };
12840
12840
  /**
12841
- * Defines the supported Subscription Status values.
12841
+ * Describes an organization's billing subscription lifecycle, including trial, active, delinquent, canceled, and expired states.
12842
12842
  */
12843
12843
  export const OrganizationTableRow_subscriptionStatusObject = {
12844
12844
  Pending: "Pending",
@@ -12847,7 +12847,7 @@ export const OrganizationTableRow_subscriptionStatusObject = {
12847
12847
  Canceled: "Canceled",
12848
12848
  };
12849
12849
  /**
12850
- * Defines the supported 10DLC Application Status values.
12850
+ * Describes an organization's overall 10DLC registration lifecycle across brand and messaging campaign submission.
12851
12851
  */
12852
12852
  export const OrganizationTableRow_tenDlcStatusObject = {
12853
12853
  NotStarted: "NotStarted",
@@ -12863,7 +12863,7 @@ export const OrganizationTableRow_tenDlcStatusObject = {
12863
12863
  Failed: "Failed",
12864
12864
  };
12865
12865
  /**
12866
- * Defines the supported Website Lifecycle Status values.
12866
+ * Describes an organization website's lifecycle from discovery and verification through activation, suspension, or removal.
12867
12867
  */
12868
12868
  export const OrganizationTableRow_websiteStatusObject = {
12869
12869
  NotStarted: "NotStarted",
@@ -12942,7 +12942,7 @@ export const OutboundQueueItem_reasonCodeObject = {
12942
12942
  Reservation_unavailable: "reservation_unavailable",
12943
12943
  };
12944
12944
  /**
12945
- * Defines the supported Outgoing Number Selection Reason values.
12945
+ * Explains why Leadping selected, rejected, or substituted an outgoing caller or messaging number.
12946
12946
  */
12947
12947
  export const OutgoingNumberSelectionReasonObject = {
12948
12948
  StickyConversation: "StickyConversation",
@@ -12955,14 +12955,14 @@ export const OutgoingNumberSelectionReasonObject = {
12955
12955
  ManualOverride: "ManualOverride",
12956
12956
  };
12957
12957
  /**
12958
- * Defines the supported Outgoing Number Channel values.
12958
+ * Identifies whether an outgoing phone number is eligible for voice, SMS, MMS, or another communication channel.
12959
12959
  */
12960
12960
  export const OutgoingNumberSelectionRequest_channelObject = {
12961
12961
  Sms: "sms",
12962
12962
  Call: "call",
12963
12963
  };
12964
12964
  /**
12965
- * Defines the supported SMS readiness health assessments.
12965
+ * Summarizes the severity of conditions affecting an organization's ability to send compliant SMS or MMS traffic.
12966
12966
  */
12967
12967
  export const OutgoingNumberSelectionResponse_healthStatusObject = {
12968
12968
  NotEvaluated: "Not Evaluated",
@@ -12972,7 +12972,7 @@ export const OutgoingNumberSelectionResponse_healthStatusObject = {
12972
12972
  Blocked: "Blocked",
12973
12973
  };
12974
12974
  /**
12975
- * Defines the supported Outgoing Number Selection Reason values.
12975
+ * Explains why Leadping selected, rejected, or substituted an outgoing caller or messaging number.
12976
12976
  */
12977
12977
  export const OutgoingNumberSelectionResponse_selectionReasonObject = {
12978
12978
  StickyConversation: "StickyConversation",
@@ -12985,7 +12985,7 @@ export const OutgoingNumberSelectionResponse_selectionReasonObject = {
12985
12985
  ManualOverride: "ManualOverride",
12986
12986
  };
12987
12987
  /**
12988
- * Defines the supported Outgoing Number Selection Reason values.
12988
+ * Explains why Leadping selected, rejected, or substituted an outgoing caller or messaging number.
12989
12989
  */
12990
12990
  export const PhoneCallResponse_selectionReasonObject = {
12991
12991
  StickyConversation: "StickyConversation",
@@ -12998,7 +12998,7 @@ export const PhoneCallResponse_selectionReasonObject = {
12998
12998
  ManualOverride: "ManualOverride",
12999
12999
  };
13000
13000
  /**
13001
- * Defines the supported Phone Call Status values.
13001
+ * Describes the durable business outcome of a Leadping phone call after provider status normalization.
13002
13002
  */
13003
13003
  export const PhoneCallStatusObject = {
13004
13004
  Scheduled: "scheduled",
@@ -13079,7 +13079,7 @@ export const PhoneNumberOutboundHealthStatusObject = {
13079
13079
  Disabled: "disabled",
13080
13080
  };
13081
13081
  /**
13082
- * Defines the supported voice call warmup stages for a Leadping-managed phone number.
13082
+ * Identifies the current traffic-ramp stage of controlled voice warmup for a Leadping-managed phone number.
13083
13083
  */
13084
13084
  export const PhoneNumberReadiness_callStageObject = {
13085
13085
  Stage0: "Stage 0",
@@ -13089,7 +13089,7 @@ export const PhoneNumberReadiness_callStageObject = {
13089
13089
  Stage4: "Stage 4",
13090
13090
  };
13091
13091
  /**
13092
- * Defines the supported SMS readiness health assessments.
13092
+ * Summarizes the severity of conditions affecting an organization's ability to send compliant SMS or MMS traffic.
13093
13093
  */
13094
13094
  export const PhoneNumberReadiness_healthStatusObject = {
13095
13095
  NotEvaluated: "Not Evaluated",
@@ -13099,7 +13099,7 @@ export const PhoneNumberReadiness_healthStatusObject = {
13099
13099
  Blocked: "Blocked",
13100
13100
  };
13101
13101
  /**
13102
- * Defines the supported SMS readiness states.
13102
+ * Describes whether an organization is configured and permitted to send SMS or MMS traffic through Leadping.
13103
13103
  */
13104
13104
  export const PhoneNumberReadiness_stateObject = {
13105
13105
  NotStarted: "Not Started",
@@ -13122,7 +13122,7 @@ export const SmsEventTableRow_outboundSourceObject = {
13122
13122
  Retry: "retry",
13123
13123
  };
13124
13124
  /**
13125
- * Defines the supported SMS Message Status values.
13125
+ * Describes the normalized lifecycle of an SMS or MMS message from scheduling through delivery or failure.
13126
13126
  */
13127
13127
  export const SmsEventTableRow_statusObject = {
13128
13128
  Draft: "draft",
@@ -13141,7 +13141,7 @@ export const SmsEventTableRow_statusObject = {
13141
13141
  Canceled: "canceled",
13142
13142
  };
13143
13143
  /**
13144
- * Defines the supported SMS Traffic Type values.
13144
+ * Classifies messaging traffic by conversational, informational, marketing, or other compliance-relevant purpose.
13145
13145
  */
13146
13146
  export const SmsEventTableRow_trafficTypeObject = {
13147
13147
  RealLead: "RealLead",
@@ -13151,7 +13151,7 @@ export const SmsEventTableRow_trafficTypeObject = {
13151
13151
  FailedAttempt: "FailedAttempt",
13152
13152
  };
13153
13153
  /**
13154
- * Defines the supported SMS readiness health assessments.
13154
+ * Summarizes the severity of conditions affecting an organization's ability to send compliant SMS or MMS traffic.
13155
13155
  */
13156
13156
  export const SmsReadinessHealthStatusObject = {
13157
13157
  NotEvaluated: "Not Evaluated",
@@ -13161,7 +13161,7 @@ export const SmsReadinessHealthStatusObject = {
13161
13161
  Blocked: "Blocked",
13162
13162
  };
13163
13163
  /**
13164
- * Defines the supported SMS readiness states.
13164
+ * Describes whether an organization is configured and permitted to send SMS or MMS traffic through Leadping.
13165
13165
  */
13166
13166
  export const SmsReadinessStateObject = {
13167
13167
  NotStarted: "Not Started",
@@ -13171,7 +13171,7 @@ export const SmsReadinessStateObject = {
13171
13171
  Ready: "Ready",
13172
13172
  };
13173
13173
  /**
13174
- * Defines the supported Outgoing Number Selection Reason values.
13174
+ * Explains why Leadping selected, rejected, or substituted an outgoing caller or messaging number.
13175
13175
  */
13176
13176
  export const SmsResponse_selectionReasonObject = {
13177
13177
  StickyConversation: "StickyConversation",
@@ -13184,7 +13184,7 @@ export const SmsResponse_selectionReasonObject = {
13184
13184
  ManualOverride: "ManualOverride",
13185
13185
  };
13186
13186
  /**
13187
- * Defines the supported SMS Message Status values.
13187
+ * Describes the normalized lifecycle of an SMS or MMS message from scheduling through delivery or failure.
13188
13188
  */
13189
13189
  export const SmsResponse_statusObject = {
13190
13190
  Draft: "draft",
@@ -13203,7 +13203,7 @@ export const SmsResponse_statusObject = {
13203
13203
  Canceled: "canceled",
13204
13204
  };
13205
13205
  /**
13206
- * Defines the supported SMS Traffic Type values.
13206
+ * Classifies messaging traffic by conversational, informational, marketing, or other compliance-relevant purpose.
13207
13207
  */
13208
13208
  export const SmsResponse_trafficTypeObject = {
13209
13209
  RealLead: "RealLead",
@@ -13213,7 +13213,7 @@ export const SmsResponse_trafficTypeObject = {
13213
13213
  FailedAttempt: "FailedAttempt",
13214
13214
  };
13215
13215
  /**
13216
- * Defines the supported 10DLC Application Status values.
13216
+ * Describes an organization's overall 10DLC registration lifecycle across brand and messaging campaign submission.
13217
13217
  */
13218
13218
  export const TenDlcApplicationStatusObject = {
13219
13219
  NotStarted: "NotStarted",
@@ -13239,7 +13239,7 @@ export const TenDlcRegistrationStatusObject = {
13239
13239
  Failed: "Failed",
13240
13240
  };
13241
13241
  /**
13242
- * Defines the supported Billable Unit values.
13242
+ * Identifies the metered unit used to price Leadping usage, such as a message, call minute, lookup, or phone number.
13243
13243
  */
13244
13244
  export const TransactionResponse_billableUnitObject = {
13245
13245
  Lead_received: "lead_received",
@@ -13261,7 +13261,7 @@ export const TransactionResponse_billableUnitObject = {
13261
13261
  Automation_run: "automation_run",
13262
13262
  };
13263
13263
  /**
13264
- * Defines the supported Usage Channel values.
13264
+ * Identifies the messaging, calling, phone-number, lookup, or platform channel that generated billable usage.
13265
13265
  */
13266
13266
  export const TransactionResponse_billingChannelObject = {
13267
13267
  Lead: "lead",
@@ -13280,7 +13280,7 @@ export const TransactionResponse_billingChannelObject = {
13280
13280
  Automation: "automation",
13281
13281
  };
13282
13282
  /**
13283
- * Defines the supported Transaction Status values.
13283
+ * Describes the processing and settlement lifecycle of a Leadping wallet or billing transaction.
13284
13284
  */
13285
13285
  export const TransactionStatusObject = {
13286
13286
  Pending: "Pending",
@@ -13288,7 +13288,7 @@ export const TransactionStatusObject = {
13288
13288
  Failed: "Failed",
13289
13289
  };
13290
13290
  /**
13291
- * Defines the supported Billable Unit values.
13291
+ * Identifies the metered unit used to price Leadping usage, such as a message, call minute, lookup, or phone number.
13292
13292
  */
13293
13293
  export const TransactionTableRow_billableUnitObject = {
13294
13294
  Lead_received: "lead_received",
@@ -13310,7 +13310,7 @@ export const TransactionTableRow_billableUnitObject = {
13310
13310
  Automation_run: "automation_run",
13311
13311
  };
13312
13312
  /**
13313
- * Defines the supported Usage Channel values.
13313
+ * Identifies the messaging, calling, phone-number, lookup, or platform channel that generated billable usage.
13314
13314
  */
13315
13315
  export const TransactionTableRow_billingChannelObject = {
13316
13316
  Lead: "lead",
@@ -13329,7 +13329,7 @@ export const TransactionTableRow_billingChannelObject = {
13329
13329
  Automation: "automation",
13330
13330
  };
13331
13331
  /**
13332
- * Defines the supported Transaction Type values.
13332
+ * Classifies a wallet transaction as a debit, credit, refund, adjustment, deposit, or other balance movement.
13333
13333
  */
13334
13334
  export const TransactionTypeObject = {
13335
13335
  Debit: "Debit",
@@ -13337,7 +13337,7 @@ export const TransactionTypeObject = {
13337
13337
  Deposit: "Deposit",
13338
13338
  };
13339
13339
  /**
13340
- * Defines the supported Usage Channel values.
13340
+ * Identifies the messaging, calling, phone-number, lookup, or platform channel that generated billable usage.
13341
13341
  */
13342
13342
  export const UsageChannelObject = {
13343
13343
  Lead: "lead",
@@ -13356,7 +13356,7 @@ export const UsageChannelObject = {
13356
13356
  Automation: "automation",
13357
13357
  };
13358
13358
  /**
13359
- * Defines the supported Usage Record Status values.
13359
+ * Describes whether a metered usage record is pending, rated, billed, reconciled, excluded, or failed.
13360
13360
  */
13361
13361
  export const UsageStatusObject = {
13362
13362
  Recorded: "recorded",
@@ -13370,7 +13370,7 @@ export const UsageStatusObject = {
13370
13370
  Blocked_due_to_billing: "blocked_due_to_billing",
13371
13371
  };
13372
13372
  /**
13373
- * Defines the supported user data export statuses values.
13373
+ * Identifies the preparation, availability, failure, expiration, or deletion stage of a Leadping user-data export.
13374
13374
  */
13375
13375
  export const UserDataExportStatusesObject = {
13376
13376
  Pending: "Pending",
@@ -13380,21 +13380,21 @@ export const UserDataExportStatusesObject = {
13380
13380
  Expired: "Expired",
13381
13381
  };
13382
13382
  /**
13383
- * Defines the supported Billing Plan values.
13383
+ * Identifies the Leadping subscription plan that determines organization features, allowances, and billing behavior.
13384
13384
  */
13385
13385
  export const UserRequest_billingPlanObject = {
13386
13386
  Annual: "Annual",
13387
13387
  Monthly: "Monthly",
13388
13388
  };
13389
13389
  /**
13390
- * Defines the supported Billing Plan values.
13390
+ * Identifies the Leadping subscription plan that determines organization features, allowances, and billing behavior.
13391
13391
  */
13392
13392
  export const UserResponse_billingPlanObject = {
13393
13393
  Annual: "Annual",
13394
13394
  Monthly: "Monthly",
13395
13395
  };
13396
13396
  /**
13397
- * Defines the supported Subscription Status values.
13397
+ * Describes an organization's billing subscription lifecycle, including trial, active, delinquent, canceled, and expired states.
13398
13398
  */
13399
13399
  export const UserResponse_subscriptionStatusObject = {
13400
13400
  Pending: "Pending",
@@ -13425,7 +13425,7 @@ export const WalletResponse_sourceTypeObject = {
13425
13425
  Compromise_restoration: "compromise_restoration",
13426
13426
  };
13427
13427
  /**
13428
- * Defines the supported Website Lifecycle Status values.
13428
+ * Describes an organization website's lifecycle from discovery and verification through activation, suspension, or removal.
13429
13429
  */
13430
13430
  export const WebsiteLifecycleStatusObject = {
13431
13431
  NotStarted: "NotStarted",
@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
6
6
  export interface LoginRequestBuilder extends BaseRequestBuilder<LoginRequestBuilder> {
7
7
  /**
8
8
  * Generates a Leadping WebRTC login token so authenticated agents can connect to telephony services and place or receive browser-based calls.
9
- * @param body Request model for telephony login token generation.
9
+ * @param body Identifies the Leadping user and calling context for which a short-lived telephony client token should be issued.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<TelephonyLoginResponse>}
12
12
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -17,7 +17,7 @@ export interface LoginRequestBuilder extends BaseRequestBuilder<LoginRequestBuil
17
17
  post(body: TelephonyLoginRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<TelephonyLoginResponse | undefined>;
18
18
  /**
19
19
  * Generates a Leadping WebRTC login token so authenticated agents can connect to telephony services and place or receive browser-based calls.
20
- * @param body Request model for telephony login token generation.
20
+ * @param body Identifies the Leadping user and calling context for which a short-lived telephony client token should be issued.
21
21
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
22
22
  * @returns {RequestInformation}
23
23
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@leadping/sdk",
3
- "version": "1.0.40",
3
+ "version": "1.0.41",
4
4
  "description": "Typed TypeScript client for the Leadping API, generated from the Leadping OpenAPI document with Microsoft Kiota.",
5
5
  "type": "module",
6
6
  "license": "MIT",