@uptiqai/integrations-sdk 1.35.0 → 1.36.0

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.
@@ -10397,23 +10397,297 @@ export type HeyreachSetUserCredentialsBody = {
10397
10397
  export type HeyreachSetUserCredentials200 = {
10398
10398
  userId: string;
10399
10399
  };
10400
+ export type HeyreachCreateCampaignBodySchedule = {
10401
+ /** Daily send-window start, e.g. "09:00:00". */
10402
+ dailyStartTime: string;
10403
+ /** Daily send-window end, e.g. "17:00:00". */
10404
+ dailyEndTime: string;
10405
+ timeZoneId?: string;
10406
+ enabledMonday?: boolean;
10407
+ enabledTuesday?: boolean;
10408
+ enabledWednesday?: boolean;
10409
+ enabledThursday?: boolean;
10410
+ enabledFriday?: boolean;
10411
+ enabledSaturday?: boolean;
10412
+ enabledSunday?: boolean;
10413
+ /** Date-only, e.g. "2025-06-01". */
10414
+ startDate?: string;
10415
+ endDate?: string;
10416
+ [key: string]: unknown;
10417
+ };
10418
+ export type HeyreachCreateCampaignBodySequenceNodeType = typeof HeyreachCreateCampaignBodySequenceNodeType[keyof typeof HeyreachCreateCampaignBodySequenceNodeType];
10419
+ export declare const HeyreachCreateCampaignBodySequenceNodeType: {
10420
+ readonly CONNECTION_REQUEST: "CONNECTION_REQUEST";
10421
+ readonly MESSAGE: "MESSAGE";
10422
+ readonly INMAIL: "INMAIL";
10423
+ readonly VIEW_PROFILE: "VIEW_PROFILE";
10424
+ readonly FOLLOW: "FOLLOW";
10425
+ readonly LIKE_POST: "LIKE_POST";
10426
+ readonly FIND_EMAIL: "FIND_EMAIL";
10427
+ readonly CHECK_IS_CONNECTION: "CHECK_IS_CONNECTION";
10428
+ readonly CHECK_IS_OPEN_PROFILE: "CHECK_IS_OPEN_PROFILE";
10429
+ readonly SEND_LEAD_TO_INSTANTLY: "SEND_LEAD_TO_INSTANTLY";
10430
+ readonly SEND_LEAD_TO_SMARTLEAD: "SEND_LEAD_TO_SMARTLEAD";
10431
+ readonly END: "END";
10432
+ };
10433
+ export type HeyreachCreateCampaignBodySequenceUnconditionalNodeNodeType = typeof HeyreachCreateCampaignBodySequenceUnconditionalNodeNodeType[keyof typeof HeyreachCreateCampaignBodySequenceUnconditionalNodeNodeType];
10434
+ export declare const HeyreachCreateCampaignBodySequenceUnconditionalNodeNodeType: {
10435
+ readonly CONNECTION_REQUEST: "CONNECTION_REQUEST";
10436
+ readonly MESSAGE: "MESSAGE";
10437
+ readonly INMAIL: "INMAIL";
10438
+ readonly VIEW_PROFILE: "VIEW_PROFILE";
10439
+ readonly FOLLOW: "FOLLOW";
10440
+ readonly LIKE_POST: "LIKE_POST";
10441
+ readonly FIND_EMAIL: "FIND_EMAIL";
10442
+ readonly CHECK_IS_CONNECTION: "CHECK_IS_CONNECTION";
10443
+ readonly CHECK_IS_OPEN_PROFILE: "CHECK_IS_OPEN_PROFILE";
10444
+ readonly SEND_LEAD_TO_INSTANTLY: "SEND_LEAD_TO_INSTANTLY";
10445
+ readonly SEND_LEAD_TO_SMARTLEAD: "SEND_LEAD_TO_SMARTLEAD";
10446
+ readonly END: "END";
10447
+ };
10448
+ export type HeyreachCreateCampaignBodySequenceUnconditionalNodeActionDelayUnit = typeof HeyreachCreateCampaignBodySequenceUnconditionalNodeActionDelayUnit[keyof typeof HeyreachCreateCampaignBodySequenceUnconditionalNodeActionDelayUnit];
10449
+ export declare const HeyreachCreateCampaignBodySequenceUnconditionalNodeActionDelayUnit: {
10450
+ readonly HOUR: "HOUR";
10451
+ readonly DAY: "DAY";
10452
+ };
10453
+ export type HeyreachCreateCampaignBodySequenceUnconditionalNodePayload = {
10454
+ [key: string]: unknown | null;
10455
+ };
10456
+ /**
10457
+ * Next step for a non-branching node type.
10458
+ */
10459
+ export type HeyreachCreateCampaignBodySequenceUnconditionalNode = {
10460
+ nodeType: HeyreachCreateCampaignBodySequenceUnconditionalNodeNodeType;
10461
+ /**
10462
+ * @minimum 0
10463
+ * @maximum 100
10464
+ */
10465
+ actionDelay?: number;
10466
+ actionDelayUnit?: HeyreachCreateCampaignBodySequenceUnconditionalNodeActionDelayUnit;
10467
+ payload?: HeyreachCreateCampaignBodySequenceUnconditionalNodePayload;
10468
+ /** @maxLength 100 */
10469
+ externalReference?: string;
10470
+ [key: string]: unknown;
10471
+ };
10472
+ export type HeyreachCreateCampaignBodySequenceConditionalNodeNodeType = typeof HeyreachCreateCampaignBodySequenceConditionalNodeNodeType[keyof typeof HeyreachCreateCampaignBodySequenceConditionalNodeNodeType];
10473
+ export declare const HeyreachCreateCampaignBodySequenceConditionalNodeNodeType: {
10474
+ readonly CONNECTION_REQUEST: "CONNECTION_REQUEST";
10475
+ readonly MESSAGE: "MESSAGE";
10476
+ readonly INMAIL: "INMAIL";
10477
+ readonly VIEW_PROFILE: "VIEW_PROFILE";
10478
+ readonly FOLLOW: "FOLLOW";
10479
+ readonly LIKE_POST: "LIKE_POST";
10480
+ readonly FIND_EMAIL: "FIND_EMAIL";
10481
+ readonly CHECK_IS_CONNECTION: "CHECK_IS_CONNECTION";
10482
+ readonly CHECK_IS_OPEN_PROFILE: "CHECK_IS_OPEN_PROFILE";
10483
+ readonly SEND_LEAD_TO_INSTANTLY: "SEND_LEAD_TO_INSTANTLY";
10484
+ readonly SEND_LEAD_TO_SMARTLEAD: "SEND_LEAD_TO_SMARTLEAD";
10485
+ readonly END: "END";
10486
+ };
10487
+ export type HeyreachCreateCampaignBodySequenceConditionalNodeActionDelayUnit = typeof HeyreachCreateCampaignBodySequenceConditionalNodeActionDelayUnit[keyof typeof HeyreachCreateCampaignBodySequenceConditionalNodeActionDelayUnit];
10488
+ export declare const HeyreachCreateCampaignBodySequenceConditionalNodeActionDelayUnit: {
10489
+ readonly HOUR: "HOUR";
10490
+ readonly DAY: "DAY";
10491
+ };
10492
+ export type HeyreachCreateCampaignBodySequenceConditionalNodePayload = {
10493
+ [key: string]: unknown | null;
10494
+ };
10495
+ /**
10496
+ * Branch taken for a branching node type (e.g. CONNECTION_REQUEST, FIND_EMAIL).
10497
+ */
10498
+ export type HeyreachCreateCampaignBodySequenceConditionalNode = {
10499
+ nodeType: HeyreachCreateCampaignBodySequenceConditionalNodeNodeType;
10500
+ /**
10501
+ * @minimum 0
10502
+ * @maximum 100
10503
+ */
10504
+ actionDelay?: number;
10505
+ actionDelayUnit?: HeyreachCreateCampaignBodySequenceConditionalNodeActionDelayUnit;
10506
+ payload?: HeyreachCreateCampaignBodySequenceConditionalNodePayload;
10507
+ /** @maxLength 100 */
10508
+ externalReference?: string;
10509
+ [key: string]: unknown;
10510
+ };
10511
+ export type HeyreachCreateCampaignBodySequenceActionDelayUnit = typeof HeyreachCreateCampaignBodySequenceActionDelayUnit[keyof typeof HeyreachCreateCampaignBodySequenceActionDelayUnit];
10512
+ export declare const HeyreachCreateCampaignBodySequenceActionDelayUnit: {
10513
+ readonly HOUR: "HOUR";
10514
+ readonly DAY: "DAY";
10515
+ };
10516
+ export type HeyreachCreateCampaignBodySequencePayload = {
10517
+ [key: string]: unknown | null;
10518
+ };
10519
+ export type HeyreachCreateCampaignBodySequence = {
10520
+ nodeType: HeyreachCreateCampaignBodySequenceNodeType;
10521
+ /** Next step for a non-branching node type. */
10522
+ unconditionalNode?: HeyreachCreateCampaignBodySequenceUnconditionalNode;
10523
+ /** Branch taken for a branching node type (e.g. CONNECTION_REQUEST, FIND_EMAIL). */
10524
+ conditionalNode?: HeyreachCreateCampaignBodySequenceConditionalNode;
10525
+ /**
10526
+ * @minimum 0
10527
+ * @maximum 100
10528
+ */
10529
+ actionDelay?: number;
10530
+ actionDelayUnit?: HeyreachCreateCampaignBodySequenceActionDelayUnit;
10531
+ payload?: HeyreachCreateCampaignBodySequencePayload;
10532
+ /** @maxLength 100 */
10533
+ externalReference?: string;
10534
+ [key: string]: unknown;
10535
+ };
10400
10536
  export type HeyreachCreateCampaignBody = {
10401
10537
  userId?: string;
10538
+ /**
10539
+ * Campaign name.
10540
+ * @minLength 1
10541
+ * @maxLength 50
10542
+ */
10543
+ name: string;
10402
10544
  /**
10403
10545
  * LinkedIn sender account ids to assign to the campaign. Required by HeyReach. Must be numeric — HeyReach expects integer account ids, not UUIDs.
10404
10546
  * @minItems 1
10547
+ * @maxItems 100
10405
10548
  */
10406
10549
  linkedInAccountIds: string[];
10407
10550
  /**
10408
- * Lead list id to run the campaign against. Required by HeyReach. Must be numeric — HeyReach expects an integer list id, not a UUID.
10551
+ * Lead list id (type USER_LIST) to run the campaign against. Required by HeyReach. Must be numeric — HeyReach expects an integer list id, not a UUID.
10409
10552
  * @minLength 1
10410
10553
  */
10411
10554
  linkedInUserListId: string;
10555
+ /** Skip leads already contacted by other campaigns. HeyReach defaults this to false. */
10556
+ excludeContactedFromOtherCampaigns?: boolean;
10557
+ /** Skip leads with existing conversations on other sender accounts. HeyReach defaults this to false. */
10558
+ excludeHasOtherAccConversations?: boolean;
10559
+ /** Skip leads already contacted by this sender in another campaign. HeyReach defaults this to false. */
10560
+ excludeContactedFromSenderInOtherCampaign?: boolean;
10561
+ /** List id whose leads should be excluded. */
10562
+ excludeListId?: string;
10563
+ schedule?: HeyreachCreateCampaignBodySchedule;
10564
+ sequence?: HeyreachCreateCampaignBodySequence;
10412
10565
  [key: string]: unknown;
10413
10566
  };
10414
10567
  export type HeyreachCreateCampaign200 = {
10415
10568
  [key: string]: unknown | null;
10416
10569
  };
10570
+ export type HeyreachUpdateSequenceBodySequenceNodeType = typeof HeyreachUpdateSequenceBodySequenceNodeType[keyof typeof HeyreachUpdateSequenceBodySequenceNodeType];
10571
+ export declare const HeyreachUpdateSequenceBodySequenceNodeType: {
10572
+ readonly CONNECTION_REQUEST: "CONNECTION_REQUEST";
10573
+ readonly MESSAGE: "MESSAGE";
10574
+ readonly INMAIL: "INMAIL";
10575
+ readonly VIEW_PROFILE: "VIEW_PROFILE";
10576
+ readonly FOLLOW: "FOLLOW";
10577
+ readonly LIKE_POST: "LIKE_POST";
10578
+ readonly FIND_EMAIL: "FIND_EMAIL";
10579
+ readonly CHECK_IS_CONNECTION: "CHECK_IS_CONNECTION";
10580
+ readonly CHECK_IS_OPEN_PROFILE: "CHECK_IS_OPEN_PROFILE";
10581
+ readonly SEND_LEAD_TO_INSTANTLY: "SEND_LEAD_TO_INSTANTLY";
10582
+ readonly SEND_LEAD_TO_SMARTLEAD: "SEND_LEAD_TO_SMARTLEAD";
10583
+ readonly END: "END";
10584
+ };
10585
+ export type HeyreachUpdateSequenceBodySequenceUnconditionalNodeNodeType = typeof HeyreachUpdateSequenceBodySequenceUnconditionalNodeNodeType[keyof typeof HeyreachUpdateSequenceBodySequenceUnconditionalNodeNodeType];
10586
+ export declare const HeyreachUpdateSequenceBodySequenceUnconditionalNodeNodeType: {
10587
+ readonly CONNECTION_REQUEST: "CONNECTION_REQUEST";
10588
+ readonly MESSAGE: "MESSAGE";
10589
+ readonly INMAIL: "INMAIL";
10590
+ readonly VIEW_PROFILE: "VIEW_PROFILE";
10591
+ readonly FOLLOW: "FOLLOW";
10592
+ readonly LIKE_POST: "LIKE_POST";
10593
+ readonly FIND_EMAIL: "FIND_EMAIL";
10594
+ readonly CHECK_IS_CONNECTION: "CHECK_IS_CONNECTION";
10595
+ readonly CHECK_IS_OPEN_PROFILE: "CHECK_IS_OPEN_PROFILE";
10596
+ readonly SEND_LEAD_TO_INSTANTLY: "SEND_LEAD_TO_INSTANTLY";
10597
+ readonly SEND_LEAD_TO_SMARTLEAD: "SEND_LEAD_TO_SMARTLEAD";
10598
+ readonly END: "END";
10599
+ };
10600
+ export type HeyreachUpdateSequenceBodySequenceUnconditionalNodeActionDelayUnit = typeof HeyreachUpdateSequenceBodySequenceUnconditionalNodeActionDelayUnit[keyof typeof HeyreachUpdateSequenceBodySequenceUnconditionalNodeActionDelayUnit];
10601
+ export declare const HeyreachUpdateSequenceBodySequenceUnconditionalNodeActionDelayUnit: {
10602
+ readonly HOUR: "HOUR";
10603
+ readonly DAY: "DAY";
10604
+ };
10605
+ export type HeyreachUpdateSequenceBodySequenceUnconditionalNodePayload = {
10606
+ [key: string]: unknown | null;
10607
+ };
10608
+ /**
10609
+ * Next step for a non-branching node type.
10610
+ */
10611
+ export type HeyreachUpdateSequenceBodySequenceUnconditionalNode = {
10612
+ nodeType: HeyreachUpdateSequenceBodySequenceUnconditionalNodeNodeType;
10613
+ /**
10614
+ * @minimum 0
10615
+ * @maximum 100
10616
+ */
10617
+ actionDelay?: number;
10618
+ actionDelayUnit?: HeyreachUpdateSequenceBodySequenceUnconditionalNodeActionDelayUnit;
10619
+ payload?: HeyreachUpdateSequenceBodySequenceUnconditionalNodePayload;
10620
+ /** @maxLength 100 */
10621
+ externalReference?: string;
10622
+ [key: string]: unknown;
10623
+ };
10624
+ export type HeyreachUpdateSequenceBodySequenceConditionalNodeNodeType = typeof HeyreachUpdateSequenceBodySequenceConditionalNodeNodeType[keyof typeof HeyreachUpdateSequenceBodySequenceConditionalNodeNodeType];
10625
+ export declare const HeyreachUpdateSequenceBodySequenceConditionalNodeNodeType: {
10626
+ readonly CONNECTION_REQUEST: "CONNECTION_REQUEST";
10627
+ readonly MESSAGE: "MESSAGE";
10628
+ readonly INMAIL: "INMAIL";
10629
+ readonly VIEW_PROFILE: "VIEW_PROFILE";
10630
+ readonly FOLLOW: "FOLLOW";
10631
+ readonly LIKE_POST: "LIKE_POST";
10632
+ readonly FIND_EMAIL: "FIND_EMAIL";
10633
+ readonly CHECK_IS_CONNECTION: "CHECK_IS_CONNECTION";
10634
+ readonly CHECK_IS_OPEN_PROFILE: "CHECK_IS_OPEN_PROFILE";
10635
+ readonly SEND_LEAD_TO_INSTANTLY: "SEND_LEAD_TO_INSTANTLY";
10636
+ readonly SEND_LEAD_TO_SMARTLEAD: "SEND_LEAD_TO_SMARTLEAD";
10637
+ readonly END: "END";
10638
+ };
10639
+ export type HeyreachUpdateSequenceBodySequenceConditionalNodeActionDelayUnit = typeof HeyreachUpdateSequenceBodySequenceConditionalNodeActionDelayUnit[keyof typeof HeyreachUpdateSequenceBodySequenceConditionalNodeActionDelayUnit];
10640
+ export declare const HeyreachUpdateSequenceBodySequenceConditionalNodeActionDelayUnit: {
10641
+ readonly HOUR: "HOUR";
10642
+ readonly DAY: "DAY";
10643
+ };
10644
+ export type HeyreachUpdateSequenceBodySequenceConditionalNodePayload = {
10645
+ [key: string]: unknown | null;
10646
+ };
10647
+ /**
10648
+ * Branch taken for a branching node type (e.g. CONNECTION_REQUEST, FIND_EMAIL).
10649
+ */
10650
+ export type HeyreachUpdateSequenceBodySequenceConditionalNode = {
10651
+ nodeType: HeyreachUpdateSequenceBodySequenceConditionalNodeNodeType;
10652
+ /**
10653
+ * @minimum 0
10654
+ * @maximum 100
10655
+ */
10656
+ actionDelay?: number;
10657
+ actionDelayUnit?: HeyreachUpdateSequenceBodySequenceConditionalNodeActionDelayUnit;
10658
+ payload?: HeyreachUpdateSequenceBodySequenceConditionalNodePayload;
10659
+ /** @maxLength 100 */
10660
+ externalReference?: string;
10661
+ [key: string]: unknown;
10662
+ };
10663
+ export type HeyreachUpdateSequenceBodySequenceActionDelayUnit = typeof HeyreachUpdateSequenceBodySequenceActionDelayUnit[keyof typeof HeyreachUpdateSequenceBodySequenceActionDelayUnit];
10664
+ export declare const HeyreachUpdateSequenceBodySequenceActionDelayUnit: {
10665
+ readonly HOUR: "HOUR";
10666
+ readonly DAY: "DAY";
10667
+ };
10668
+ export type HeyreachUpdateSequenceBodySequencePayload = {
10669
+ [key: string]: unknown | null;
10670
+ };
10671
+ /**
10672
+ * Automation-step tree that fully replaces the campaign sequence. Required by HeyReach.
10673
+ */
10674
+ export type HeyreachUpdateSequenceBodySequence = {
10675
+ nodeType: HeyreachUpdateSequenceBodySequenceNodeType;
10676
+ /** Next step for a non-branching node type. */
10677
+ unconditionalNode?: HeyreachUpdateSequenceBodySequenceUnconditionalNode;
10678
+ /** Branch taken for a branching node type (e.g. CONNECTION_REQUEST, FIND_EMAIL). */
10679
+ conditionalNode?: HeyreachUpdateSequenceBodySequenceConditionalNode;
10680
+ /**
10681
+ * @minimum 0
10682
+ * @maximum 100
10683
+ */
10684
+ actionDelay?: number;
10685
+ actionDelayUnit?: HeyreachUpdateSequenceBodySequenceActionDelayUnit;
10686
+ payload?: HeyreachUpdateSequenceBodySequencePayload;
10687
+ /** @maxLength 100 */
10688
+ externalReference?: string;
10689
+ [key: string]: unknown;
10690
+ };
10417
10691
  export type HeyreachUpdateSequenceBody = {
10418
10692
  userId?: string;
10419
10693
  /**
@@ -10421,11 +10695,34 @@ export type HeyreachUpdateSequenceBody = {
10421
10695
  * @minLength 1
10422
10696
  */
10423
10697
  campaignId: string;
10698
+ /** Automation-step tree that fully replaces the campaign sequence. Required by HeyReach. */
10699
+ sequence: HeyreachUpdateSequenceBodySequence;
10424
10700
  [key: string]: unknown;
10425
10701
  };
10426
10702
  export type HeyreachUpdateSequence200 = {
10427
10703
  [key: string]: unknown | null;
10428
10704
  };
10705
+ /**
10706
+ * Campaign send schedule that fully replaces the campaign's current schedule. Required by HeyReach.
10707
+ */
10708
+ export type HeyreachUpdateCampaignScheduleBodySchedule = {
10709
+ /** Daily send-window start, e.g. "09:00:00". */
10710
+ dailyStartTime: string;
10711
+ /** Daily send-window end, e.g. "17:00:00". */
10712
+ dailyEndTime: string;
10713
+ timeZoneId?: string;
10714
+ enabledMonday?: boolean;
10715
+ enabledTuesday?: boolean;
10716
+ enabledWednesday?: boolean;
10717
+ enabledThursday?: boolean;
10718
+ enabledFriday?: boolean;
10719
+ enabledSaturday?: boolean;
10720
+ enabledSunday?: boolean;
10721
+ /** Date-only, e.g. "2025-06-01". */
10722
+ startDate?: string;
10723
+ endDate?: string;
10724
+ [key: string]: unknown;
10725
+ };
10429
10726
  export type HeyreachUpdateCampaignScheduleBody = {
10430
10727
  userId?: string;
10431
10728
  /**
@@ -10433,6 +10730,8 @@ export type HeyreachUpdateCampaignScheduleBody = {
10433
10730
  * @minLength 1
10434
10731
  */
10435
10732
  campaignId: string;
10733
+ /** Campaign send schedule that fully replaces the campaign's current schedule. Required by HeyReach. */
10734
+ schedule: HeyreachUpdateCampaignScheduleBodySchedule;
10436
10735
  [key: string]: unknown;
10437
10736
  };
10438
10737
  export type HeyreachUpdateCampaignSchedule200 = {
@@ -10481,25 +10780,88 @@ export type HeyreachGetCampaignsBody = {
10481
10780
  export type HeyreachGetCampaigns200 = {
10482
10781
  [key: string]: unknown | null;
10483
10782
  };
10783
+ /**
10784
+ * List type. Defaults to a lead list (USER_LIST) when omitted.
10785
+ */
10786
+ export type HeyreachCreateEmptyListBodyType = typeof HeyreachCreateEmptyListBodyType[keyof typeof HeyreachCreateEmptyListBodyType];
10787
+ export declare const HeyreachCreateEmptyListBodyType: {
10788
+ readonly USER_LIST: "USER_LIST";
10789
+ readonly COMPANY_LIST: "COMPANY_LIST";
10790
+ };
10484
10791
  export type HeyreachCreateEmptyListBody = {
10485
10792
  userId?: string;
10793
+ /**
10794
+ * List name.
10795
+ * @minLength 1
10796
+ */
10797
+ name: string;
10798
+ /** List type. Defaults to a lead list (USER_LIST) when omitted. */
10799
+ type?: HeyreachCreateEmptyListBodyType;
10486
10800
  [key: string]: unknown;
10487
10801
  };
10488
10802
  export type HeyreachCreateEmptyList200 = {
10489
10803
  [key: string]: unknown | null;
10490
10804
  };
10805
+ export type HeyreachAddLeadsToListBodyLeadsItemCustomUserFieldsItem = {
10806
+ name: string;
10807
+ value: string;
10808
+ };
10809
+ export type HeyreachAddLeadsToListBodyLeadsItem = {
10810
+ firstName?: string;
10811
+ lastName?: string;
10812
+ /** Lead's LinkedIn profile URL. */
10813
+ profileUrl?: string;
10814
+ location?: string;
10815
+ summary?: string;
10816
+ companyName?: string;
10817
+ position?: string;
10818
+ about?: string;
10819
+ emailAddress?: string;
10820
+ /** Custom field name/value pairs. `name` must be alphanumeric or underscore-only — HeyReach rejects other characters. */
10821
+ customUserFields?: HeyreachAddLeadsToListBodyLeadsItemCustomUserFieldsItem[];
10822
+ [key: string]: unknown;
10823
+ };
10491
10824
  export type HeyreachAddLeadsToListBody = {
10492
10825
  userId?: string;
10493
10826
  /**
10494
- * List id to add the leads to.
10827
+ * List id to add the leads to. Must be numeric — HeyReach expects an integer list id.
10495
10828
  * @minLength 1
10496
10829
  */
10497
10830
  listId: string;
10831
+ /**
10832
+ * Leads to import. Up to 100 per request.
10833
+ * @maxItems 100
10834
+ */
10835
+ leads: HeyreachAddLeadsToListBodyLeadsItem[];
10498
10836
  [key: string]: unknown;
10499
10837
  };
10500
10838
  export type HeyreachAddLeadsToList200 = {
10501
10839
  [key: string]: unknown | null;
10502
10840
  };
10841
+ export type HeyreachAddLeadsToCampaignBodyAccountLeadPairsItemLeadCustomUserFieldsItem = {
10842
+ name: string;
10843
+ value: string;
10844
+ };
10845
+ export type HeyreachAddLeadsToCampaignBodyAccountLeadPairsItemLead = {
10846
+ firstName?: string;
10847
+ lastName?: string;
10848
+ /** Lead's LinkedIn profile URL. */
10849
+ profileUrl?: string;
10850
+ location?: string;
10851
+ summary?: string;
10852
+ companyName?: string;
10853
+ position?: string;
10854
+ about?: string;
10855
+ emailAddress?: string;
10856
+ /** Custom field name/value pairs. `name` must be alphanumeric or underscore-only — HeyReach rejects other characters. */
10857
+ customUserFields?: HeyreachAddLeadsToCampaignBodyAccountLeadPairsItemLeadCustomUserFieldsItem[];
10858
+ [key: string]: unknown;
10859
+ };
10860
+ export type HeyreachAddLeadsToCampaignBodyAccountLeadPairsItem = {
10861
+ /** LinkedIn sender account id to map this lead to. Must be numeric if provided. */
10862
+ linkedInAccountId?: string;
10863
+ lead: HeyreachAddLeadsToCampaignBodyAccountLeadPairsItemLead;
10864
+ };
10503
10865
  export type HeyreachAddLeadsToCampaignBody = {
10504
10866
  userId?: string;
10505
10867
  /**
@@ -10507,6 +10869,15 @@ export type HeyreachAddLeadsToCampaignBody = {
10507
10869
  * @minLength 1
10508
10870
  */
10509
10871
  campaignId: string;
10872
+ /**
10873
+ * Leads (optionally paired with a sender account) to add. Up to 100 per request.
10874
+ * @maxItems 100
10875
+ */
10876
+ accountLeadPairs: HeyreachAddLeadsToCampaignBodyAccountLeadPairsItem[];
10877
+ /** Resume the campaign if it had already finished. */
10878
+ resumeFinishedCampaign?: boolean;
10879
+ /** Resume the campaign if it is currently paused. */
10880
+ resumePausedCampaign?: boolean;
10510
10881
  [key: string]: unknown;
10511
10882
  };
10512
10883
  export type HeyreachAddLeadsToCampaign200 = {
@@ -10519,6 +10890,10 @@ export type HeyreachStopLeadInCampaignBody = {
10519
10890
  * @minLength 1
10520
10891
  */
10521
10892
  campaignId: string;
10893
+ /** Lead's member id (HeyReach's `linkedin_id`, from GetLeadsFromCampaign/GetLeadsFromList). */
10894
+ leadMemberId?: string;
10895
+ /** Lead's LinkedIn profile URL. */
10896
+ leadUrl?: string;
10522
10897
  [key: string]: unknown;
10523
10898
  };
10524
10899
  export type HeyreachStopLeadInCampaign200 = {
@@ -10536,13 +10911,48 @@ export type HeyreachAddLeadTagsBody = {
10536
10911
  * @minLength 1
10537
10912
  */
10538
10913
  leadProfileUrl?: string;
10914
+ /**
10915
+ * Tags to add to the lead.
10916
+ * @minItems 1
10917
+ */
10918
+ tags: string[];
10919
+ /** If true, creates tags that don't already exist. If false and a tag doesn't exist, HeyReach returns a 400. */
10920
+ createTagIfNotExisting?: boolean;
10539
10921
  [key: string]: unknown;
10540
10922
  };
10541
10923
  export type HeyreachAddLeadTags200 = {
10542
10924
  [key: string]: unknown | null;
10543
10925
  };
10926
+ export type HeyreachGetConversationsBodyFilters = {
10927
+ /** LinkedIn sender account ids to filter by. Numeric. */
10928
+ linkedInAccountIds?: string[];
10929
+ /** Campaign ids to filter by. Numeric. */
10930
+ campaignIds?: string[];
10931
+ searchString?: string;
10932
+ /** Lead's LinkedIn id. Cannot be combined with leadProfileUrl. */
10933
+ leadLinkedInId?: string;
10934
+ /** Lead's LinkedIn profile URL. Cannot be combined with leadLinkedInId. */
10935
+ leadProfileUrl?: string;
10936
+ /** Case-insensitive lead tags — conversations of leads with at least one matching tag are returned. */
10937
+ tags?: string[];
10938
+ /**
10939
+ * true = read only, false = unread only, omit/null = both.
10940
+ * @nullable
10941
+ */
10942
+ seen?: boolean | null;
10943
+ [key: string]: unknown;
10944
+ };
10544
10945
  export type HeyreachGetConversationsBody = {
10545
10946
  userId?: string;
10947
+ filters?: HeyreachGetConversationsBodyFilters;
10948
+ /** @minimum 0 */
10949
+ offset?: number;
10950
+ /**
10951
+ * Page size, up to 100.
10952
+ * @minimum 1
10953
+ * @maximum 100
10954
+ */
10955
+ limit?: number;
10546
10956
  [key: string]: unknown;
10547
10957
  };
10548
10958
  export type HeyreachGetConversations200 = {
@@ -10563,7 +10973,19 @@ export type HeyreachGetConversation200 = {
10563
10973
  export type HeyreachSendInboxMessageBody = {
10564
10974
  userId?: string;
10565
10975
  /**
10566
- * LinkedIn sender account id to send the message from.
10976
+ * Conversation id to send the message to.
10977
+ * @minLength 1
10978
+ */
10979
+ conversationId: string;
10980
+ /**
10981
+ * Message body.
10982
+ * @minLength 1
10983
+ */
10984
+ message: string;
10985
+ /** Subject line (used for InMail messages). */
10986
+ subject?: string;
10987
+ /**
10988
+ * LinkedIn sender account id to send the message from. Numeric.
10567
10989
  * @minLength 1
10568
10990
  */
10569
10991
  linkedInAccountId?: string;
@@ -10574,16 +10996,14 @@ export type HeyreachSendInboxMessage200 = {
10574
10996
  };
10575
10997
  export type HeyreachGetOverallStatsBody = {
10576
10998
  userId?: string;
10577
- /**
10578
- * LinkedIn sender account ids. Required by HeyReach.
10579
- * @minItems 1
10580
- */
10999
+ /** LinkedIn sender account ids. Empty or omitted means all senders are included. */
10581
11000
  accountIds: string[];
10582
- /**
10583
- * Campaign ids. Required by HeyReach.
10584
- * @minItems 1
10585
- */
11001
+ /** Campaign ids. Empty or omitted means all campaigns are included. */
10586
11002
  campaignIds: string[];
11003
+ /** ISO 8601 datetime lower bound, e.g. "2024-12-17T00:00:00.000Z". */
11004
+ startDate?: string;
11005
+ /** ISO 8601 datetime upper bound, e.g. "2024-12-19T23:59:59.999Z". */
11006
+ endDate?: string;
10587
11007
  [key: string]: unknown;
10588
11008
  };
10589
11009
  export type HeyreachGetOverallStats200 = {