@uptiqai/integrations-sdk 1.38.0 → 1.39.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.
@@ -14809,14 +14809,196 @@ export type InstantlySetUserCredentialsBody = {
14809
14809
  export type InstantlySetUserCredentials200 = {
14810
14810
  userId: string;
14811
14811
  };
14812
+ export type InstantlyCreateCampaignBodyCampaignScheduleSchedulesItemTiming = {
14813
+ /** 24h start time, e.g. "09:00". */
14814
+ from: string;
14815
+ /** 24h end time, e.g. "17:00". */
14816
+ to: string;
14817
+ };
14818
+ /**
14819
+ * Send-day toggles keyed Sunday(0)–Saturday(6), e.g. { "1": true, ..., "5": true } for weekdays. An object, not an array of weekday numbers — omitted keys are treated as off.
14820
+ */
14821
+ export type InstantlyCreateCampaignBodyCampaignScheduleSchedulesItemDays = {
14822
+ '0'?: boolean;
14823
+ '1'?: boolean;
14824
+ '2'?: boolean;
14825
+ '3'?: boolean;
14826
+ '4'?: boolean;
14827
+ '5'?: boolean;
14828
+ '6'?: boolean;
14829
+ };
14830
+ /**
14831
+ * One of Instantly's fixed accepted zone names. Use "America/Detroit" for US Eastern — "America/New_York" is rejected.
14832
+ */
14833
+ export type InstantlyCreateCampaignBodyCampaignScheduleSchedulesItemTimezone = typeof InstantlyCreateCampaignBodyCampaignScheduleSchedulesItemTimezone[keyof typeof InstantlyCreateCampaignBodyCampaignScheduleSchedulesItemTimezone];
14834
+ export declare const InstantlyCreateCampaignBodyCampaignScheduleSchedulesItemTimezone: {
14835
+ readonly 'Etc/GMT+12': "Etc/GMT+12";
14836
+ readonly 'Etc/GMT+11': "Etc/GMT+11";
14837
+ readonly 'Etc/GMT+10': "Etc/GMT+10";
14838
+ readonly 'America/Anchorage': "America/Anchorage";
14839
+ readonly 'America/Dawson': "America/Dawson";
14840
+ readonly 'America/Creston': "America/Creston";
14841
+ readonly 'America/Chihuahua': "America/Chihuahua";
14842
+ readonly 'America/Boise': "America/Boise";
14843
+ readonly 'America/Belize': "America/Belize";
14844
+ readonly 'America/Chicago': "America/Chicago";
14845
+ readonly 'America/Bahia_Banderas': "America/Bahia_Banderas";
14846
+ readonly 'America/Regina': "America/Regina";
14847
+ readonly 'America/Bogota': "America/Bogota";
14848
+ readonly 'America/Detroit': "America/Detroit";
14849
+ readonly 'America/Indiana/Marengo': "America/Indiana/Marengo";
14850
+ readonly 'America/Caracas': "America/Caracas";
14851
+ readonly 'America/Asuncion': "America/Asuncion";
14852
+ readonly 'America/Glace_Bay': "America/Glace_Bay";
14853
+ readonly 'America/Campo_Grande': "America/Campo_Grande";
14854
+ readonly 'America/Anguilla': "America/Anguilla";
14855
+ readonly 'America/Santiago': "America/Santiago";
14856
+ readonly 'America/St_Johns': "America/St_Johns";
14857
+ readonly 'America/Sao_Paulo': "America/Sao_Paulo";
14858
+ readonly 'America/Argentina/La_Rioja': "America/Argentina/La_Rioja";
14859
+ readonly 'America/Araguaina': "America/Araguaina";
14860
+ readonly 'America/Godthab': "America/Godthab";
14861
+ readonly 'America/Montevideo': "America/Montevideo";
14862
+ readonly 'America/Bahia': "America/Bahia";
14863
+ readonly 'America/Noronha': "America/Noronha";
14864
+ readonly 'America/Scoresbysund': "America/Scoresbysund";
14865
+ readonly 'Atlantic/Cape_Verde': "Atlantic/Cape_Verde";
14866
+ readonly 'Africa/Casablanca': "Africa/Casablanca";
14867
+ readonly 'America/Danmarkshavn': "America/Danmarkshavn";
14868
+ readonly 'Europe/Isle_of_Man': "Europe/Isle_of_Man";
14869
+ readonly 'Atlantic/Canary': "Atlantic/Canary";
14870
+ readonly 'Africa/Abidjan': "Africa/Abidjan";
14871
+ readonly 'Arctic/Longyearbyen': "Arctic/Longyearbyen";
14872
+ readonly 'Europe/Belgrade': "Europe/Belgrade";
14873
+ readonly 'Africa/Ceuta': "Africa/Ceuta";
14874
+ readonly 'Europe/Sarajevo': "Europe/Sarajevo";
14875
+ readonly 'Africa/Algiers': "Africa/Algiers";
14876
+ readonly 'Africa/Windhoek': "Africa/Windhoek";
14877
+ readonly 'Asia/Nicosia': "Asia/Nicosia";
14878
+ readonly 'Asia/Beirut': "Asia/Beirut";
14879
+ readonly 'Africa/Cairo': "Africa/Cairo";
14880
+ readonly 'Asia/Damascus': "Asia/Damascus";
14881
+ readonly 'Europe/Bucharest': "Europe/Bucharest";
14882
+ readonly 'Africa/Blantyre': "Africa/Blantyre";
14883
+ readonly 'Europe/Helsinki': "Europe/Helsinki";
14884
+ readonly 'Europe/Istanbul': "Europe/Istanbul";
14885
+ readonly 'Asia/Jerusalem': "Asia/Jerusalem";
14886
+ readonly 'Africa/Tripoli': "Africa/Tripoli";
14887
+ readonly 'Asia/Amman': "Asia/Amman";
14888
+ readonly 'Asia/Baghdad': "Asia/Baghdad";
14889
+ readonly 'Europe/Kaliningrad': "Europe/Kaliningrad";
14890
+ readonly 'Asia/Aden': "Asia/Aden";
14891
+ readonly 'Africa/Addis_Ababa': "Africa/Addis_Ababa";
14892
+ readonly 'Europe/Kirov': "Europe/Kirov";
14893
+ readonly 'Europe/Astrakhan': "Europe/Astrakhan";
14894
+ readonly 'Asia/Tehran': "Asia/Tehran";
14895
+ readonly 'Asia/Dubai': "Asia/Dubai";
14896
+ readonly 'Asia/Baku': "Asia/Baku";
14897
+ readonly 'Indian/Mahe': "Indian/Mahe";
14898
+ readonly 'Asia/Tbilisi': "Asia/Tbilisi";
14899
+ readonly 'Asia/Yerevan': "Asia/Yerevan";
14900
+ readonly 'Asia/Kabul': "Asia/Kabul";
14901
+ readonly 'Antarctica/Mawson': "Antarctica/Mawson";
14902
+ readonly 'Asia/Yekaterinburg': "Asia/Yekaterinburg";
14903
+ readonly 'Asia/Karachi': "Asia/Karachi";
14904
+ readonly 'Asia/Kolkata': "Asia/Kolkata";
14905
+ readonly 'Asia/Colombo': "Asia/Colombo";
14906
+ readonly 'Asia/Kathmandu': "Asia/Kathmandu";
14907
+ readonly 'Antarctica/Vostok': "Antarctica/Vostok";
14908
+ readonly 'Asia/Dhaka': "Asia/Dhaka";
14909
+ readonly 'Asia/Rangoon': "Asia/Rangoon";
14910
+ readonly 'Antarctica/Davis': "Antarctica/Davis";
14911
+ readonly 'Asia/Novokuznetsk': "Asia/Novokuznetsk";
14912
+ readonly 'Asia/Hong_Kong': "Asia/Hong_Kong";
14913
+ readonly 'Asia/Krasnoyarsk': "Asia/Krasnoyarsk";
14914
+ readonly 'Asia/Brunei': "Asia/Brunei";
14915
+ readonly 'Australia/Perth': "Australia/Perth";
14916
+ readonly 'Asia/Taipei': "Asia/Taipei";
14917
+ readonly 'Asia/Choibalsan': "Asia/Choibalsan";
14918
+ readonly 'Asia/Irkutsk': "Asia/Irkutsk";
14919
+ readonly 'Asia/Dili': "Asia/Dili";
14920
+ readonly 'Asia/Pyongyang': "Asia/Pyongyang";
14921
+ readonly 'Australia/Adelaide': "Australia/Adelaide";
14922
+ readonly 'Australia/Darwin': "Australia/Darwin";
14923
+ readonly 'Australia/Brisbane': "Australia/Brisbane";
14924
+ readonly 'Australia/Melbourne': "Australia/Melbourne";
14925
+ readonly 'Antarctica/DumontDUrville': "Antarctica/DumontDUrville";
14926
+ readonly 'Australia/Currie': "Australia/Currie";
14927
+ readonly 'Asia/Chita': "Asia/Chita";
14928
+ readonly 'Antarctica/Macquarie': "Antarctica/Macquarie";
14929
+ readonly 'Asia/Sakhalin': "Asia/Sakhalin";
14930
+ readonly 'Pacific/Auckland': "Pacific/Auckland";
14931
+ readonly 'Etc/GMT-12': "Etc/GMT-12";
14932
+ readonly 'Pacific/Fiji': "Pacific/Fiji";
14933
+ readonly 'Asia/Anadyr': "Asia/Anadyr";
14934
+ readonly 'Asia/Kamchatka': "Asia/Kamchatka";
14935
+ readonly 'Etc/GMT-13': "Etc/GMT-13";
14936
+ readonly 'Pacific/Apia': "Pacific/Apia";
14937
+ };
14938
+ export type InstantlyCreateCampaignBodyCampaignScheduleSchedulesItem = {
14939
+ /**
14940
+ * Schedule name, e.g. "Business hours". Required by Instantly.
14941
+ * @minLength 1
14942
+ */
14943
+ name: string;
14944
+ timing: InstantlyCreateCampaignBodyCampaignScheduleSchedulesItemTiming;
14945
+ /** Send-day toggles keyed Sunday(0)–Saturday(6), e.g. { "1": true, ..., "5": true } for weekdays. An object, not an array of weekday numbers — omitted keys are treated as off. */
14946
+ days: InstantlyCreateCampaignBodyCampaignScheduleSchedulesItemDays;
14947
+ /** One of Instantly's fixed accepted zone names. Use "America/Detroit" for US Eastern — "America/New_York" is rejected. */
14948
+ timezone: InstantlyCreateCampaignBodyCampaignScheduleSchedulesItemTimezone;
14949
+ [key: string]: unknown;
14950
+ };
14812
14951
  /**
14813
- * Sending schedule configuration (required by Instantly — schedules[], each with name/timing/days/timezone).
14952
+ * Sending schedule configuration required by Instantly.
14814
14953
  */
14815
14954
  export type InstantlyCreateCampaignBodyCampaignSchedule = {
14816
- [key: string]: unknown | null;
14955
+ start_date?: string;
14956
+ end_date?: string;
14957
+ /** @minItems 1 */
14958
+ schedules: InstantlyCreateCampaignBodyCampaignScheduleSchedulesItem[];
14959
+ [key: string]: unknown;
14960
+ };
14961
+ /**
14962
+ * Always 'email' — the only step type Instantly supports.
14963
+ */
14964
+ export type InstantlyCreateCampaignBodySequencesItemStepsItemType = typeof InstantlyCreateCampaignBodySequencesItemStepsItemType[keyof typeof InstantlyCreateCampaignBodySequencesItemStepsItemType];
14965
+ export declare const InstantlyCreateCampaignBodySequencesItemStepsItemType: {
14966
+ readonly email: "email";
14967
+ };
14968
+ /**
14969
+ * Defaults to "days".
14970
+ */
14971
+ export type InstantlyCreateCampaignBodySequencesItemStepsItemDelayUnit = typeof InstantlyCreateCampaignBodySequencesItemStepsItemDelayUnit[keyof typeof InstantlyCreateCampaignBodySequencesItemStepsItemDelayUnit];
14972
+ export declare const InstantlyCreateCampaignBodySequencesItemStepsItemDelayUnit: {
14973
+ readonly minutes: "minutes";
14974
+ readonly hours: "hours";
14975
+ readonly days: "days";
14976
+ };
14977
+ export type InstantlyCreateCampaignBodySequencesItemStepsItemVariantsItem = {
14978
+ /** @minLength 1 */
14979
+ subject: string;
14980
+ /** @minLength 1 */
14981
+ body: string;
14982
+ [key: string]: unknown;
14983
+ };
14984
+ export type InstantlyCreateCampaignBodySequencesItemStepsItem = {
14985
+ /** Always 'email' — the only step type Instantly supports. */
14986
+ type: InstantlyCreateCampaignBodySequencesItemStepsItemType;
14987
+ /** @minimum 0 */
14988
+ delay: number;
14989
+ /** Defaults to "days". */
14990
+ delay_unit?: InstantlyCreateCampaignBodySequencesItemStepsItemDelayUnit;
14991
+ /**
14992
+ * subject/body live inside variants, not directly on the step.
14993
+ * @minItems 1
14994
+ */
14995
+ variants: InstantlyCreateCampaignBodySequencesItemStepsItemVariantsItem[];
14996
+ [key: string]: unknown;
14817
14997
  };
14818
14998
  export type InstantlyCreateCampaignBodySequencesItem = {
14819
- [key: string]: unknown | null;
14999
+ /** @minItems 1 */
15000
+ steps: InstantlyCreateCampaignBodySequencesItemStepsItem[];
15001
+ [key: string]: unknown;
14820
15002
  };
14821
15003
  export type InstantlyCreateCampaignBody = {
14822
15004
  userId?: string;
@@ -14825,7 +15007,7 @@ export type InstantlyCreateCampaignBody = {
14825
15007
  * @minLength 1
14826
15008
  */
14827
15009
  name: string;
14828
- /** Sending schedule configuration (required by Instantly — schedules[], each with name/timing/days/timezone). */
15010
+ /** Sending schedule configuration required by Instantly. */
14829
15011
  campaign_schedule: InstantlyCreateCampaignBodyCampaignSchedule;
14830
15012
  /** Sequence steps, including step variants for A/B testing. */
14831
15013
  sequences?: InstantlyCreateCampaignBodySequencesItem[];
@@ -14967,6 +15149,43 @@ export type InstantlyCreateAccountBody = {
14967
15149
  userId?: string;
14968
15150
  /** Sending mailbox email address to connect. */
14969
15151
  email: string;
15152
+ /** @minLength 1 */
15153
+ first_name: string;
15154
+ /** @minLength 1 */
15155
+ last_name: string;
15156
+ /**
15157
+ * 1=Custom IMAP/SMTP, 2=Google, 3=Microsoft, 4=AWS, 8=AirMail, 11=Airmail Instant.
15158
+ * @nullable
15159
+ */
15160
+ provider_code: number | null;
15161
+ /** @minLength 1 */
15162
+ imap_username: string;
15163
+ /** @minLength 1 */
15164
+ imap_password: string;
15165
+ /**
15166
+ * e.g. imap.gmail.com
15167
+ * @minLength 1
15168
+ */
15169
+ imap_host: string;
15170
+ /**
15171
+ * e.g. 993
15172
+ * @nullable
15173
+ */
15174
+ imap_port: number | null;
15175
+ /** @minLength 1 */
15176
+ smtp_username: string;
15177
+ /** @minLength 1 */
15178
+ smtp_password: string;
15179
+ /**
15180
+ * e.g. smtp.gmail.com
15181
+ * @minLength 1
15182
+ */
15183
+ smtp_host: string;
15184
+ /**
15185
+ * e.g. 587
15186
+ * @nullable
15187
+ */
15188
+ smtp_port: number | null;
14970
15189
  [key: string]: unknown;
14971
15190
  };
14972
15191
  export type InstantlyCreateAccount200 = {
@@ -14998,8 +15217,8 @@ export type InstantlyPauseAccount200 = {
14998
15217
  };
14999
15218
  export type InstantlyEnableWarmupBody = {
15000
15219
  userId?: string;
15001
- /** Sending account email addresses. */
15002
- emails: string[];
15220
+ /** Sending account email addresses. Omit and set include_all_emails=true to warm up every account instead. */
15221
+ emails?: string[];
15003
15222
  [key: string]: unknown;
15004
15223
  };
15005
15224
  export type InstantlyEnableWarmup200 = {
@@ -15049,10 +15268,10 @@ export type InstantlyGetCampaignAnalyticsDaily200 = ({
15049
15268
  export type InstantlyGetCampaignAnalyticsStepsBody = {
15050
15269
  userId?: string;
15051
15270
  /**
15052
- * Campaign id to scope the per-step metrics to.
15271
+ * Campaign id to scope the per-step metrics to. Omit for all campaigns.
15053
15272
  * @minLength 1
15054
15273
  */
15055
- campaign_id: string;
15274
+ campaign_id?: string;
15056
15275
  /** Start date, e.g. 2026-01-01. */
15057
15276
  start_date?: string;
15058
15277
  /** End date, e.g. 2026-01-31. */