@getlatedev/node 0.2.331 → 0.2.333

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.mts CHANGED
@@ -13669,7 +13669,7 @@ type CreateInboxConversationData = {
13669
13669
  */
13670
13670
  templateLanguage?: string;
13671
13671
  /**
13672
- * WhatsApp only. Body variable values, in order. Works with positional placeholders ({{1}}, {{2}}, ...) and with named placeholders ({{name}}, {{company}} - how Meta Business Manager creates templates), where values fill the named slots in order of appearance.
13672
+ * WhatsApp only. Template variable values as one flat array, in the order the variables appear across the whole template: text-header variables first, then body variables, then one value per dynamic URL button (in button order). Works with positional placeholders ({{1}}, {{2}}, ...) and with named placeholders ({{name}}, {{company}} - how Meta Business Manager creates templates), where values fill the named slots in order of appearance. Example - a body with {{1}}, {{2}} plus a URL button https://example.com/{{1}} takes three values: [body1, body2, buttonSuffix]. Media headers (image, video, document) are filled automatically from the approved template and take no value here.
13673
13673
  */
13674
13674
  templateParams?: Array<(string)>;
13675
13675
  };
@@ -16683,26 +16683,37 @@ type StartSmsRegistrationData = {
16683
16683
  * Required for every entityType except SOLE_PROPRIETOR.
16684
16684
  */
16685
16685
  ein?: string;
16686
+ /**
16687
+ * Business contact phone. Required for every entityType except SOLE_PROPRIETOR.
16688
+ */
16686
16689
  phone?: string;
16687
16690
  /**
16688
16691
  * Required for SOLE_PROPRIETOR; the verification OTP is texted there (US/CA mobile).
16689
16692
  */
16690
16693
  mobilePhone?: string;
16691
- street?: string;
16692
- city?: string;
16693
- state?: string;
16694
- postalCode?: string;
16694
+ street: string;
16695
+ city: string;
16696
+ state: string;
16697
+ postalCode: string;
16695
16698
  country: 'US' | 'CA';
16696
16699
  /**
16697
16700
  * Brand contact email; defaults to your account email when omitted.
16698
16701
  */
16699
16702
  email?: string;
16700
- website?: string;
16703
+ /**
16704
+ * The brand's website (sole proprietors may use a social profile such as LinkedIn or a business Facebook page). Carriers verify the brand against it; a bare domain is normalized to https://.
16705
+ */
16706
+ website: string;
16701
16707
  vertical: 'AGRICULTURE' | 'COMMUNICATION' | 'CONSTRUCTION' | 'EDUCATION' | 'ENERGY' | 'ENTERTAINMENT' | 'FINANCIAL' | 'GAMBLING' | 'GOVERNMENT' | 'HEALTHCARE' | 'HOSPITALITY' | 'HUMAN_RESOURCES' | 'INSURANCE' | 'LEGAL' | 'MANUFACTURING' | 'NGO' | 'POLITICAL' | 'POSTAL' | 'PROFESSIONAL' | 'REAL_ESTATE' | 'RETAIL' | 'TECHNOLOGY' | 'TRANSPORTATION';
16702
16708
  stockSymbol?: string;
16703
16709
  };
16704
16710
  /**
16705
16711
  * Required for 10DLC. What you'll send and how recipients opt in/out.
16712
+ * Opt-in/opt-out/help auto-responses must name the registered brand and
16713
+ * carry the carrier-required disclosures; submissions that don't (or that
16714
+ * are blank) are automatically rewritten to a compliant, brand-named
16715
+ * template before the campaign is filed.
16716
+ *
16706
16717
  */
16707
16718
  campaign?: {
16708
16719
  usecase: string;
@@ -16712,7 +16723,10 @@ type StartSmsRegistrationData = {
16712
16723
  */
16713
16724
  messageFlow: string;
16714
16725
  sample1: string;
16715
- sample2?: string;
16726
+ /**
16727
+ * Second example message; carriers require two distinct samples
16728
+ */
16729
+ sample2: string;
16716
16730
  helpMessage: string;
16717
16731
  optinKeywords: string;
16718
16732
  optinMessage: string;
package/dist/index.d.ts CHANGED
@@ -13669,7 +13669,7 @@ type CreateInboxConversationData = {
13669
13669
  */
13670
13670
  templateLanguage?: string;
13671
13671
  /**
13672
- * WhatsApp only. Body variable values, in order. Works with positional placeholders ({{1}}, {{2}}, ...) and with named placeholders ({{name}}, {{company}} - how Meta Business Manager creates templates), where values fill the named slots in order of appearance.
13672
+ * WhatsApp only. Template variable values as one flat array, in the order the variables appear across the whole template: text-header variables first, then body variables, then one value per dynamic URL button (in button order). Works with positional placeholders ({{1}}, {{2}}, ...) and with named placeholders ({{name}}, {{company}} - how Meta Business Manager creates templates), where values fill the named slots in order of appearance. Example - a body with {{1}}, {{2}} plus a URL button https://example.com/{{1}} takes three values: [body1, body2, buttonSuffix]. Media headers (image, video, document) are filled automatically from the approved template and take no value here.
13673
13673
  */
13674
13674
  templateParams?: Array<(string)>;
13675
13675
  };
@@ -16683,26 +16683,37 @@ type StartSmsRegistrationData = {
16683
16683
  * Required for every entityType except SOLE_PROPRIETOR.
16684
16684
  */
16685
16685
  ein?: string;
16686
+ /**
16687
+ * Business contact phone. Required for every entityType except SOLE_PROPRIETOR.
16688
+ */
16686
16689
  phone?: string;
16687
16690
  /**
16688
16691
  * Required for SOLE_PROPRIETOR; the verification OTP is texted there (US/CA mobile).
16689
16692
  */
16690
16693
  mobilePhone?: string;
16691
- street?: string;
16692
- city?: string;
16693
- state?: string;
16694
- postalCode?: string;
16694
+ street: string;
16695
+ city: string;
16696
+ state: string;
16697
+ postalCode: string;
16695
16698
  country: 'US' | 'CA';
16696
16699
  /**
16697
16700
  * Brand contact email; defaults to your account email when omitted.
16698
16701
  */
16699
16702
  email?: string;
16700
- website?: string;
16703
+ /**
16704
+ * The brand's website (sole proprietors may use a social profile such as LinkedIn or a business Facebook page). Carriers verify the brand against it; a bare domain is normalized to https://.
16705
+ */
16706
+ website: string;
16701
16707
  vertical: 'AGRICULTURE' | 'COMMUNICATION' | 'CONSTRUCTION' | 'EDUCATION' | 'ENERGY' | 'ENTERTAINMENT' | 'FINANCIAL' | 'GAMBLING' | 'GOVERNMENT' | 'HEALTHCARE' | 'HOSPITALITY' | 'HUMAN_RESOURCES' | 'INSURANCE' | 'LEGAL' | 'MANUFACTURING' | 'NGO' | 'POLITICAL' | 'POSTAL' | 'PROFESSIONAL' | 'REAL_ESTATE' | 'RETAIL' | 'TECHNOLOGY' | 'TRANSPORTATION';
16702
16708
  stockSymbol?: string;
16703
16709
  };
16704
16710
  /**
16705
16711
  * Required for 10DLC. What you'll send and how recipients opt in/out.
16712
+ * Opt-in/opt-out/help auto-responses must name the registered brand and
16713
+ * carry the carrier-required disclosures; submissions that don't (or that
16714
+ * are blank) are automatically rewritten to a compliant, brand-named
16715
+ * template before the campaign is filed.
16716
+ *
16706
16717
  */
16707
16718
  campaign?: {
16708
16719
  usecase: string;
@@ -16712,7 +16723,10 @@ type StartSmsRegistrationData = {
16712
16723
  */
16713
16724
  messageFlow: string;
16714
16725
  sample1: string;
16715
- sample2?: string;
16726
+ /**
16727
+ * Second example message; carriers require two distinct samples
16728
+ */
16729
+ sample2: string;
16716
16730
  helpMessage: string;
16717
16731
  optinKeywords: string;
16718
16732
  optinMessage: string;
package/dist/index.js CHANGED
@@ -36,7 +36,7 @@ module.exports = __toCommonJS(index_exports);
36
36
  // package.json
37
37
  var package_default = {
38
38
  name: "@getlatedev/node",
39
- version: "0.2.331",
39
+ version: "0.2.333",
40
40
  description: "The official Node.js library for the Zernio API",
41
41
  main: "dist/index.js",
42
42
  module: "dist/index.mjs",
package/dist/index.mjs CHANGED
@@ -5,7 +5,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
5
5
  // package.json
6
6
  var package_default = {
7
7
  name: "@getlatedev/node",
8
- version: "0.2.331",
8
+ version: "0.2.333",
9
9
  description: "The official Node.js library for the Zernio API",
10
10
  main: "dist/index.js",
11
11
  module: "dist/index.mjs",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@getlatedev/node",
3
- "version": "0.2.331",
3
+ "version": "0.2.333",
4
4
  "description": "The official Node.js library for the Zernio API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -2675,7 +2675,7 @@ export const listInboxConversations = <ThrowOnError extends boolean = false>(opt
2675
2675
  *
2676
2676
  * Supported platforms: X/Twitter, Bluesky, Reddit, and WhatsApp. Other platforms return PLATFORM_NOT_SUPPORTED.
2677
2677
  *
2678
- * WhatsApp: this is the endpoint for sending an approved template message to a phone number. Provide templateName, templateLanguage, and templateParams (body variable values), with the recipient phone in participantId. A template is required because WhatsApp does not permit freeform messages to open a conversation; a missing template returns TEMPLATE_REQUIRED. Templates with media headers (image, video, document) are handled automatically: Zernio reads the approved template definition and fills the header at send time. Calling this for a number you already have a thread with simply sends the template into that thread, which also makes it the way to re-engage a contact after the 24-hour customer-service window has closed. Once the recipient replies (opening the 24h window), send freeform messages with the send-message endpoint (POST /v1/inbox/conversations/{conversationId}/messages). Template fields are accepted on the JSON body only, not on multipart requests.
2678
+ * WhatsApp: this is the endpoint for sending an approved template message to a phone number. Provide templateName, templateLanguage, and templateParams (variable values for the text header, body and dynamic URL buttons, in that order), with the recipient phone in participantId. A template is required because WhatsApp does not permit freeform messages to open a conversation; a missing template returns TEMPLATE_REQUIRED. Templates with media headers (image, video, document) are handled automatically: Zernio reads the approved template definition and fills the header at send time. Calling this for a number you already have a thread with simply sends the template into that thread, which also makes it the way to re-engage a contact after the 24-hour customer-service window has closed. Once the recipient replies (opening the 24h window), send freeform messages with the send-message endpoint (POST /v1/inbox/conversations/{conversationId}/messages). Template fields are accepted on the JSON body only, not on multipart requests.
2679
2679
  *
2680
2680
  * DM eligibility (X/Twitter): Before sending, the endpoint checks if the recipient accepts DMs from your account (via the receives_your_dm field). If not, a 422 error with code DM_NOT_ALLOWED is returned. You can skip this check with skipDmCheck: true if you have already verified eligibility.
2681
2681
  *
@@ -13584,7 +13584,7 @@ export type CreateInboxConversationData = {
13584
13584
  */
13585
13585
  templateLanguage?: string;
13586
13586
  /**
13587
- * WhatsApp only. Body variable values, in order. Works with positional placeholders ({{1}}, {{2}}, ...) and with named placeholders ({{name}}, {{company}} - how Meta Business Manager creates templates), where values fill the named slots in order of appearance.
13587
+ * WhatsApp only. Template variable values as one flat array, in the order the variables appear across the whole template: text-header variables first, then body variables, then one value per dynamic URL button (in button order). Works with positional placeholders ({{1}}, {{2}}, ...) and with named placeholders ({{name}}, {{company}} - how Meta Business Manager creates templates), where values fill the named slots in order of appearance. Example - a body with {{1}}, {{2}} plus a URL button https://example.com/{{1}} takes three values: [body1, body2, buttonSuffix]. Media headers (image, video, document) are filled automatically from the approved template and take no value here.
13588
13588
  */
13589
13589
  templateParams?: Array<(string)>;
13590
13590
  };
@@ -16819,26 +16819,37 @@ export type StartSmsRegistrationData = {
16819
16819
  * Required for every entityType except SOLE_PROPRIETOR.
16820
16820
  */
16821
16821
  ein?: string;
16822
+ /**
16823
+ * Business contact phone. Required for every entityType except SOLE_PROPRIETOR.
16824
+ */
16822
16825
  phone?: string;
16823
16826
  /**
16824
16827
  * Required for SOLE_PROPRIETOR; the verification OTP is texted there (US/CA mobile).
16825
16828
  */
16826
16829
  mobilePhone?: string;
16827
- street?: string;
16828
- city?: string;
16829
- state?: string;
16830
- postalCode?: string;
16830
+ street: string;
16831
+ city: string;
16832
+ state: string;
16833
+ postalCode: string;
16831
16834
  country: 'US' | 'CA';
16832
16835
  /**
16833
16836
  * Brand contact email; defaults to your account email when omitted.
16834
16837
  */
16835
16838
  email?: string;
16836
- website?: string;
16839
+ /**
16840
+ * The brand's website (sole proprietors may use a social profile such as LinkedIn or a business Facebook page). Carriers verify the brand against it; a bare domain is normalized to https://.
16841
+ */
16842
+ website: string;
16837
16843
  vertical: 'AGRICULTURE' | 'COMMUNICATION' | 'CONSTRUCTION' | 'EDUCATION' | 'ENERGY' | 'ENTERTAINMENT' | 'FINANCIAL' | 'GAMBLING' | 'GOVERNMENT' | 'HEALTHCARE' | 'HOSPITALITY' | 'HUMAN_RESOURCES' | 'INSURANCE' | 'LEGAL' | 'MANUFACTURING' | 'NGO' | 'POLITICAL' | 'POSTAL' | 'PROFESSIONAL' | 'REAL_ESTATE' | 'RETAIL' | 'TECHNOLOGY' | 'TRANSPORTATION';
16838
16844
  stockSymbol?: string;
16839
16845
  };
16840
16846
  /**
16841
16847
  * Required for 10DLC. What you'll send and how recipients opt in/out.
16848
+ * Opt-in/opt-out/help auto-responses must name the registered brand and
16849
+ * carry the carrier-required disclosures; submissions that don't (or that
16850
+ * are blank) are automatically rewritten to a compliant, brand-named
16851
+ * template before the campaign is filed.
16852
+ *
16842
16853
  */
16843
16854
  campaign?: {
16844
16855
  usecase: string;
@@ -16848,7 +16859,10 @@ export type StartSmsRegistrationData = {
16848
16859
  */
16849
16860
  messageFlow: string;
16850
16861
  sample1: string;
16851
- sample2?: string;
16862
+ /**
16863
+ * Second example message; carriers require two distinct samples
16864
+ */
16865
+ sample2: string;
16852
16866
  helpMessage: string;
16853
16867
  optinKeywords: string;
16854
16868
  optinMessage: string;