@smartlyqofficial/node 0.1.64 → 0.1.65

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.
package/dist/index.d.cts CHANGED
@@ -6565,6 +6565,22 @@ type ListContactsResponses = {
6565
6565
  website?: string | null;
6566
6566
  created_at?: string;
6567
6567
  updated_at?: string;
6568
+ /**
6569
+ * Where the contact's list came from, as given on import or with `list_source`. Null when it was never given.
6570
+ */
6571
+ list_source?: 'own_customers' | 'events' | 'bought' | 'found_online' | 'lead_finder';
6572
+ /**
6573
+ * The importer confirmed consent (own customers or events). Null when no source was given.
6574
+ */
6575
+ list_consent?: boolean;
6576
+ /**
6577
+ * Result of the free email check. `risky` = a role address such as info@. Null when not checked.
6578
+ */
6579
+ email_check?: 'ok' | 'risky' | 'invalid';
6580
+ /**
6581
+ * `outreach_only`: never emailed through the built-in email service (campaigns and automation emails skip it), only through your own mail server. `invalid`: never emailed. Null: sent as normal.
6582
+ */
6583
+ email_send_block?: 'outreach_only' | 'invalid';
6568
6584
  }>;
6569
6585
  pagination?: PaginationMeta;
6570
6586
  meta?: RequestMeta;
@@ -6619,6 +6635,14 @@ type CreateContactData = {
6619
6635
  attributes?: {
6620
6636
  [key: string]: unknown;
6621
6637
  };
6638
+ /**
6639
+ * Optional. Where these contacts came from. Leave it out and the contact is not marked (as before). `bought`, `found_online` and `lead_finder` make the contact outreach only: it is never emailed through the built-in email service, only through your own mail server. `own_customers` and `events` need `list_consent: true`. Every email also gets a free check (format, throwaway domains, domains that accept no mail, your suppression list); an invalid address is never emailed.
6640
+ */
6641
+ list_source?: 'own_customers' | 'events' | 'bought' | 'found_online' | 'lead_finder';
6642
+ /**
6643
+ * Required as `true` when `list_source` is `own_customers` or `events`: these people agreed to receive email from you. Ignored for the other sources.
6644
+ */
6645
+ list_consent?: boolean;
6622
6646
  };
6623
6647
  path?: never;
6624
6648
  query?: never;
@@ -6672,6 +6696,22 @@ type CreateContactResponses = {
6672
6696
  website?: string | null;
6673
6697
  created_at?: string;
6674
6698
  updated_at?: string;
6699
+ /**
6700
+ * Where the contact's list came from, as given on import or with `list_source`. Null when it was never given.
6701
+ */
6702
+ list_source?: 'own_customers' | 'events' | 'bought' | 'found_online' | 'lead_finder';
6703
+ /**
6704
+ * The importer confirmed consent (own customers or events). Null when no source was given.
6705
+ */
6706
+ list_consent?: boolean;
6707
+ /**
6708
+ * Result of the free email check. `risky` = a role address such as info@. Null when not checked.
6709
+ */
6710
+ email_check?: 'ok' | 'risky' | 'invalid';
6711
+ /**
6712
+ * `outreach_only`: never emailed through the built-in email service (campaigns and automation emails skip it), only through your own mail server. `invalid`: never emailed. Null: sent as normal.
6713
+ */
6714
+ email_send_block?: 'outreach_only' | 'invalid';
6675
6715
  };
6676
6716
  meta?: RequestMeta;
6677
6717
  };
@@ -6710,6 +6750,22 @@ type CreateContactResponses = {
6710
6750
  website?: string | null;
6711
6751
  created_at?: string;
6712
6752
  updated_at?: string;
6753
+ /**
6754
+ * Where the contact's list came from, as given on import or with `list_source`. Null when it was never given.
6755
+ */
6756
+ list_source?: 'own_customers' | 'events' | 'bought' | 'found_online' | 'lead_finder';
6757
+ /**
6758
+ * The importer confirmed consent (own customers or events). Null when no source was given.
6759
+ */
6760
+ list_consent?: boolean;
6761
+ /**
6762
+ * Result of the free email check. `risky` = a role address such as info@. Null when not checked.
6763
+ */
6764
+ email_check?: 'ok' | 'risky' | 'invalid';
6765
+ /**
6766
+ * `outreach_only`: never emailed through the built-in email service (campaigns and automation emails skip it), only through your own mail server. `invalid`: never emailed. Null: sent as normal.
6767
+ */
6768
+ email_send_block?: 'outreach_only' | 'invalid';
6713
6769
  };
6714
6770
  meta?: RequestMeta;
6715
6771
  };
@@ -6795,6 +6851,22 @@ type GetContactResponses = {
6795
6851
  website?: string | null;
6796
6852
  created_at?: string;
6797
6853
  updated_at?: string;
6854
+ /**
6855
+ * Where the contact's list came from, as given on import or with `list_source`. Null when it was never given.
6856
+ */
6857
+ list_source?: 'own_customers' | 'events' | 'bought' | 'found_online' | 'lead_finder';
6858
+ /**
6859
+ * The importer confirmed consent (own customers or events). Null when no source was given.
6860
+ */
6861
+ list_consent?: boolean;
6862
+ /**
6863
+ * Result of the free email check. `risky` = a role address such as info@. Null when not checked.
6864
+ */
6865
+ email_check?: 'ok' | 'risky' | 'invalid';
6866
+ /**
6867
+ * `outreach_only`: never emailed through the built-in email service (campaigns and automation emails skip it), only through your own mail server. `invalid`: never emailed. Null: sent as normal.
6868
+ */
6869
+ email_send_block?: 'outreach_only' | 'invalid';
6798
6870
  };
6799
6871
  meta?: RequestMeta;
6800
6872
  };
@@ -6893,6 +6965,22 @@ type UpdateContactResponses = {
6893
6965
  website?: string | null;
6894
6966
  created_at?: string;
6895
6967
  updated_at?: string;
6968
+ /**
6969
+ * Where the contact's list came from, as given on import or with `list_source`. Null when it was never given.
6970
+ */
6971
+ list_source?: 'own_customers' | 'events' | 'bought' | 'found_online' | 'lead_finder';
6972
+ /**
6973
+ * The importer confirmed consent (own customers or events). Null when no source was given.
6974
+ */
6975
+ list_consent?: boolean;
6976
+ /**
6977
+ * Result of the free email check. `risky` = a role address such as info@. Null when not checked.
6978
+ */
6979
+ email_check?: 'ok' | 'risky' | 'invalid';
6980
+ /**
6981
+ * `outreach_only`: never emailed through the built-in email service (campaigns and automation emails skip it), only through your own mail server. `invalid`: never emailed. Null: sent as normal.
6982
+ */
6983
+ email_send_block?: 'outreach_only' | 'invalid';
6896
6984
  };
6897
6985
  meta?: RequestMeta;
6898
6986
  };
@@ -11220,6 +11308,14 @@ type BulkImportContactsData = {
11220
11308
  contacts: Array<{
11221
11309
  [key: string]: unknown;
11222
11310
  }>;
11311
+ /**
11312
+ * Optional. One answer for every row in the call; the batch is checked as one list. Where these contacts came from. Leave it out and the contact is not marked (as before). `bought`, `found_online` and `lead_finder` make the contact outreach only: it is never emailed through the built-in email service, only through your own mail server. `own_customers` and `events` need `list_consent: true`. Every email also gets a free check (format, throwaway domains, domains that accept no mail, your suppression list); an invalid address is never emailed.
11313
+ */
11314
+ list_source?: 'own_customers' | 'events' | 'bought' | 'found_online' | 'lead_finder';
11315
+ /**
11316
+ * Required as `true` when `list_source` is `own_customers` or `events`: these people agreed to receive email from you. Ignored for the other sources.
11317
+ */
11318
+ list_consent?: boolean;
11223
11319
  };
11224
11320
  path?: never;
11225
11321
  query?: never;
@@ -11253,6 +11349,24 @@ type BulkImportContactsResponses = {
11253
11349
  matched_by?: string;
11254
11350
  error?: string;
11255
11351
  }>;
11352
+ /**
11353
+ * Present when `list_source` was sent: the free check over this call's emails and the decision for the batch.
11354
+ */
11355
+ list_check?: {
11356
+ source?: 'own_customers' | 'events' | 'bought' | 'found_online' | 'lead_finder';
11357
+ /**
11358
+ * `outreach_only` when the source is bought, found online or Lead Finder, or when at least 20 emails were checked and risky + invalid ones are more than `risky_pct` percent of them.
11359
+ */
11360
+ decision?: 'campaign_ready' | 'outreach_only';
11361
+ ok?: number;
11362
+ risky?: number;
11363
+ invalid?: number;
11364
+ /**
11365
+ * Most domain lookups failed, so no address was marked invalid for its domain.
11366
+ */
11367
+ dns_unreliable?: boolean;
11368
+ risky_pct?: number;
11369
+ };
11256
11370
  };
11257
11371
  meta?: RequestMeta;
11258
11372
  };
package/dist/index.d.ts CHANGED
@@ -6565,6 +6565,22 @@ type ListContactsResponses = {
6565
6565
  website?: string | null;
6566
6566
  created_at?: string;
6567
6567
  updated_at?: string;
6568
+ /**
6569
+ * Where the contact's list came from, as given on import or with `list_source`. Null when it was never given.
6570
+ */
6571
+ list_source?: 'own_customers' | 'events' | 'bought' | 'found_online' | 'lead_finder';
6572
+ /**
6573
+ * The importer confirmed consent (own customers or events). Null when no source was given.
6574
+ */
6575
+ list_consent?: boolean;
6576
+ /**
6577
+ * Result of the free email check. `risky` = a role address such as info@. Null when not checked.
6578
+ */
6579
+ email_check?: 'ok' | 'risky' | 'invalid';
6580
+ /**
6581
+ * `outreach_only`: never emailed through the built-in email service (campaigns and automation emails skip it), only through your own mail server. `invalid`: never emailed. Null: sent as normal.
6582
+ */
6583
+ email_send_block?: 'outreach_only' | 'invalid';
6568
6584
  }>;
6569
6585
  pagination?: PaginationMeta;
6570
6586
  meta?: RequestMeta;
@@ -6619,6 +6635,14 @@ type CreateContactData = {
6619
6635
  attributes?: {
6620
6636
  [key: string]: unknown;
6621
6637
  };
6638
+ /**
6639
+ * Optional. Where these contacts came from. Leave it out and the contact is not marked (as before). `bought`, `found_online` and `lead_finder` make the contact outreach only: it is never emailed through the built-in email service, only through your own mail server. `own_customers` and `events` need `list_consent: true`. Every email also gets a free check (format, throwaway domains, domains that accept no mail, your suppression list); an invalid address is never emailed.
6640
+ */
6641
+ list_source?: 'own_customers' | 'events' | 'bought' | 'found_online' | 'lead_finder';
6642
+ /**
6643
+ * Required as `true` when `list_source` is `own_customers` or `events`: these people agreed to receive email from you. Ignored for the other sources.
6644
+ */
6645
+ list_consent?: boolean;
6622
6646
  };
6623
6647
  path?: never;
6624
6648
  query?: never;
@@ -6672,6 +6696,22 @@ type CreateContactResponses = {
6672
6696
  website?: string | null;
6673
6697
  created_at?: string;
6674
6698
  updated_at?: string;
6699
+ /**
6700
+ * Where the contact's list came from, as given on import or with `list_source`. Null when it was never given.
6701
+ */
6702
+ list_source?: 'own_customers' | 'events' | 'bought' | 'found_online' | 'lead_finder';
6703
+ /**
6704
+ * The importer confirmed consent (own customers or events). Null when no source was given.
6705
+ */
6706
+ list_consent?: boolean;
6707
+ /**
6708
+ * Result of the free email check. `risky` = a role address such as info@. Null when not checked.
6709
+ */
6710
+ email_check?: 'ok' | 'risky' | 'invalid';
6711
+ /**
6712
+ * `outreach_only`: never emailed through the built-in email service (campaigns and automation emails skip it), only through your own mail server. `invalid`: never emailed. Null: sent as normal.
6713
+ */
6714
+ email_send_block?: 'outreach_only' | 'invalid';
6675
6715
  };
6676
6716
  meta?: RequestMeta;
6677
6717
  };
@@ -6710,6 +6750,22 @@ type CreateContactResponses = {
6710
6750
  website?: string | null;
6711
6751
  created_at?: string;
6712
6752
  updated_at?: string;
6753
+ /**
6754
+ * Where the contact's list came from, as given on import or with `list_source`. Null when it was never given.
6755
+ */
6756
+ list_source?: 'own_customers' | 'events' | 'bought' | 'found_online' | 'lead_finder';
6757
+ /**
6758
+ * The importer confirmed consent (own customers or events). Null when no source was given.
6759
+ */
6760
+ list_consent?: boolean;
6761
+ /**
6762
+ * Result of the free email check. `risky` = a role address such as info@. Null when not checked.
6763
+ */
6764
+ email_check?: 'ok' | 'risky' | 'invalid';
6765
+ /**
6766
+ * `outreach_only`: never emailed through the built-in email service (campaigns and automation emails skip it), only through your own mail server. `invalid`: never emailed. Null: sent as normal.
6767
+ */
6768
+ email_send_block?: 'outreach_only' | 'invalid';
6713
6769
  };
6714
6770
  meta?: RequestMeta;
6715
6771
  };
@@ -6795,6 +6851,22 @@ type GetContactResponses = {
6795
6851
  website?: string | null;
6796
6852
  created_at?: string;
6797
6853
  updated_at?: string;
6854
+ /**
6855
+ * Where the contact's list came from, as given on import or with `list_source`. Null when it was never given.
6856
+ */
6857
+ list_source?: 'own_customers' | 'events' | 'bought' | 'found_online' | 'lead_finder';
6858
+ /**
6859
+ * The importer confirmed consent (own customers or events). Null when no source was given.
6860
+ */
6861
+ list_consent?: boolean;
6862
+ /**
6863
+ * Result of the free email check. `risky` = a role address such as info@. Null when not checked.
6864
+ */
6865
+ email_check?: 'ok' | 'risky' | 'invalid';
6866
+ /**
6867
+ * `outreach_only`: never emailed through the built-in email service (campaigns and automation emails skip it), only through your own mail server. `invalid`: never emailed. Null: sent as normal.
6868
+ */
6869
+ email_send_block?: 'outreach_only' | 'invalid';
6798
6870
  };
6799
6871
  meta?: RequestMeta;
6800
6872
  };
@@ -6893,6 +6965,22 @@ type UpdateContactResponses = {
6893
6965
  website?: string | null;
6894
6966
  created_at?: string;
6895
6967
  updated_at?: string;
6968
+ /**
6969
+ * Where the contact's list came from, as given on import or with `list_source`. Null when it was never given.
6970
+ */
6971
+ list_source?: 'own_customers' | 'events' | 'bought' | 'found_online' | 'lead_finder';
6972
+ /**
6973
+ * The importer confirmed consent (own customers or events). Null when no source was given.
6974
+ */
6975
+ list_consent?: boolean;
6976
+ /**
6977
+ * Result of the free email check. `risky` = a role address such as info@. Null when not checked.
6978
+ */
6979
+ email_check?: 'ok' | 'risky' | 'invalid';
6980
+ /**
6981
+ * `outreach_only`: never emailed through the built-in email service (campaigns and automation emails skip it), only through your own mail server. `invalid`: never emailed. Null: sent as normal.
6982
+ */
6983
+ email_send_block?: 'outreach_only' | 'invalid';
6896
6984
  };
6897
6985
  meta?: RequestMeta;
6898
6986
  };
@@ -11220,6 +11308,14 @@ type BulkImportContactsData = {
11220
11308
  contacts: Array<{
11221
11309
  [key: string]: unknown;
11222
11310
  }>;
11311
+ /**
11312
+ * Optional. One answer for every row in the call; the batch is checked as one list. Where these contacts came from. Leave it out and the contact is not marked (as before). `bought`, `found_online` and `lead_finder` make the contact outreach only: it is never emailed through the built-in email service, only through your own mail server. `own_customers` and `events` need `list_consent: true`. Every email also gets a free check (format, throwaway domains, domains that accept no mail, your suppression list); an invalid address is never emailed.
11313
+ */
11314
+ list_source?: 'own_customers' | 'events' | 'bought' | 'found_online' | 'lead_finder';
11315
+ /**
11316
+ * Required as `true` when `list_source` is `own_customers` or `events`: these people agreed to receive email from you. Ignored for the other sources.
11317
+ */
11318
+ list_consent?: boolean;
11223
11319
  };
11224
11320
  path?: never;
11225
11321
  query?: never;
@@ -11253,6 +11349,24 @@ type BulkImportContactsResponses = {
11253
11349
  matched_by?: string;
11254
11350
  error?: string;
11255
11351
  }>;
11352
+ /**
11353
+ * Present when `list_source` was sent: the free check over this call's emails and the decision for the batch.
11354
+ */
11355
+ list_check?: {
11356
+ source?: 'own_customers' | 'events' | 'bought' | 'found_online' | 'lead_finder';
11357
+ /**
11358
+ * `outreach_only` when the source is bought, found online or Lead Finder, or when at least 20 emails were checked and risky + invalid ones are more than `risky_pct` percent of them.
11359
+ */
11360
+ decision?: 'campaign_ready' | 'outreach_only';
11361
+ ok?: number;
11362
+ risky?: number;
11363
+ invalid?: number;
11364
+ /**
11365
+ * Most domain lookups failed, so no address was marked invalid for its domain.
11366
+ */
11367
+ dns_unreliable?: boolean;
11368
+ risky_pct?: number;
11369
+ };
11256
11370
  };
11257
11371
  meta?: RequestMeta;
11258
11372
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@smartlyqofficial/node",
3
- "version": "0.1.64",
3
+ "version": "0.1.65",
4
4
  "description": "Official Node.js SDK for the SmartlyQ API - social posting, AI content generation, SEO, CRM, and more.",
5
5
  "keywords": [
6
6
  "smartlyq",