@zernio/node 0.2.1054 → 0.2.1056

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
@@ -20212,7 +20212,7 @@ type GetConnectUrlData = {
20212
20212
  */
20213
20213
  profileId: string;
20214
20214
  /**
20215
- * Refresh this existing account (a Zernio account id of the same platform on this profile; otherwise 400). The OAuth callback and the selection endpoints (select-page, select-organization, select-board, select-location, Instagram and Snapchat selection) refuse, with `reconnect_account_mismatch`, a login that would write to a different account of the platform on this profile instead of this one. While a profile holds one account per platform the login still replaces this account as before. In headless mode the marker travels in the redirect_url we hand you, so pass that URL back unchanged to the selection endpoint. On X it counts toward the OAuth state limit described under redirect_url.
20215
+ * Refresh this existing account (a Zernio account id of the same platform on this profile; otherwise 400). The OAuth callback and the selection endpoints (select-page, select-organization, select-board, select-location, Instagram and Snapchat selection) refuse, with `reconnect_account_mismatch`, a login that would write to a different account of the platform on this profile instead of this one. In headless mode the marker travels in the redirect_url we hand you, so pass that URL back unchanged to the selection endpoint. On X it counts toward the OAuth state limit described under redirect_url.
20216
20216
  */
20217
20217
  reconnectAccountId?: string;
20218
20218
  /**
@@ -20244,7 +20244,8 @@ type GetConnectUrlData = {
20244
20244
  * - `pages_permission_declined`: the user declined the pages_show_list permission.
20245
20245
  * - `no_pages_granted`: the permission was granted with no Page ticked. Meta reports a user who
20246
20246
  * manages no Page the same way, so this covers both.
20247
- * - `granted_pages_not_listed`: Pages were ticked but Meta listed none the user can manage.
20247
+ * - `granted_pages_not_listed`: Pages were ticked but Meta listed none the user can manage, and a
20248
+ * direct read of each ticked Page returned no access token.
20248
20249
  *
20249
20250
  * Headless Facebook success (`step=select_page`): `userProfile` is JSON that was
20250
20251
  * percent-encoded once before being set as a query param, so it is encoded twice on the wire.
@@ -21111,7 +21112,7 @@ type SelectFacebookPageData = {
21111
21112
  */
21112
21113
  pageId?: string;
21113
21114
  /**
21114
- * Several Page IDs to connect from one sign-in, each as its own account. With two or more distinct IDs the response lists `accounts` and `failed` instead of `account`, and the request is refused with 400 while a profile holds one Facebook account and on a reconnect or an ads connect, which pick exactly one Page. A single distinct ID behaves exactly like pageId.
21115
+ * Several Page IDs to connect from one sign-in, each as its own account. With two or more distinct IDs the response lists `accounts` and `failed` instead of `account`, and the request is refused with 400 on a reconnect or an ads connect, which pick exactly one Page. A single distinct ID behaves exactly like pageId.
21115
21116
  */
21116
21117
  pageIds?: Array<(string)>;
21117
21118
  /**
@@ -21237,7 +21238,7 @@ type SelectInstagramAccountData = {
21237
21238
  */
21238
21239
  pageId?: string;
21239
21240
  /**
21240
- * Several Page IDs whose linked Instagram accounts to connect from one sign-in, each as its own account. With two or more distinct IDs the response lists `accounts` and `failed` instead of `account`, and the request is refused with 400 while a profile holds one Instagram account and on a reconnect or an ads connect. A single distinct ID behaves exactly like pageId.
21241
+ * Several Page IDs whose linked Instagram accounts to connect from one sign-in, each as its own account. With two or more distinct IDs the response lists `accounts` and `failed` instead of `account`, and the request is refused with 400 on a reconnect or an ads connect. A single distinct ID behaves exactly like pageId.
21241
21242
  */
21242
21243
  pageIds?: Array<(string)>;
21243
21244
  /**
@@ -22793,7 +22794,7 @@ type SelectLinkedInOrganizationData = {
22793
22794
  */
22794
22795
  accountType?: 'personal' | 'organization';
22795
22796
  /**
22796
- * Several accounts to connect from one sign-in (yourself and/or organizations), each as its own account. With two or more entries the response lists `accounts` and `failed` instead of `account`, and the request is refused with 400 while a profile holds one LinkedIn account and on a reconnect or an ads connect. A single entry behaves exactly like accountType.
22797
+ * Several accounts to connect from one sign-in (yourself and/or organizations), each as its own account. With two or more entries the response lists `accounts` and `failed` instead of `account`, and the request is refused with 400 on a reconnect or an ads connect. A single entry behaves exactly like accountType.
22797
22798
  */
22798
22799
  selections?: Array<{
22799
22800
  accountType: 'personal' | 'organization';
@@ -33202,7 +33203,7 @@ type ReleasePhoneNumberError = (unknown | {
33202
33203
  type PurchasePhoneNumberData = {
33203
33204
  body: {
33204
33205
  /**
33205
- * Preferred profile for the number. One number = one profile, so when the requested profile already holds a number the API assigns the next free profile instead (or creates one) and returns the actual assignment in `profileId` on the response.
33206
+ * Profile for the number, which may already hold other numbers. Without it the number goes to the default profile. The response's `profileId` carries the assignment.
33206
33207
  *
33207
33208
  */
33208
33209
  profileId: string;
package/dist/index.d.ts CHANGED
@@ -20212,7 +20212,7 @@ type GetConnectUrlData = {
20212
20212
  */
20213
20213
  profileId: string;
20214
20214
  /**
20215
- * Refresh this existing account (a Zernio account id of the same platform on this profile; otherwise 400). The OAuth callback and the selection endpoints (select-page, select-organization, select-board, select-location, Instagram and Snapchat selection) refuse, with `reconnect_account_mismatch`, a login that would write to a different account of the platform on this profile instead of this one. While a profile holds one account per platform the login still replaces this account as before. In headless mode the marker travels in the redirect_url we hand you, so pass that URL back unchanged to the selection endpoint. On X it counts toward the OAuth state limit described under redirect_url.
20215
+ * Refresh this existing account (a Zernio account id of the same platform on this profile; otherwise 400). The OAuth callback and the selection endpoints (select-page, select-organization, select-board, select-location, Instagram and Snapchat selection) refuse, with `reconnect_account_mismatch`, a login that would write to a different account of the platform on this profile instead of this one. In headless mode the marker travels in the redirect_url we hand you, so pass that URL back unchanged to the selection endpoint. On X it counts toward the OAuth state limit described under redirect_url.
20216
20216
  */
20217
20217
  reconnectAccountId?: string;
20218
20218
  /**
@@ -20244,7 +20244,8 @@ type GetConnectUrlData = {
20244
20244
  * - `pages_permission_declined`: the user declined the pages_show_list permission.
20245
20245
  * - `no_pages_granted`: the permission was granted with no Page ticked. Meta reports a user who
20246
20246
  * manages no Page the same way, so this covers both.
20247
- * - `granted_pages_not_listed`: Pages were ticked but Meta listed none the user can manage.
20247
+ * - `granted_pages_not_listed`: Pages were ticked but Meta listed none the user can manage, and a
20248
+ * direct read of each ticked Page returned no access token.
20248
20249
  *
20249
20250
  * Headless Facebook success (`step=select_page`): `userProfile` is JSON that was
20250
20251
  * percent-encoded once before being set as a query param, so it is encoded twice on the wire.
@@ -21111,7 +21112,7 @@ type SelectFacebookPageData = {
21111
21112
  */
21112
21113
  pageId?: string;
21113
21114
  /**
21114
- * Several Page IDs to connect from one sign-in, each as its own account. With two or more distinct IDs the response lists `accounts` and `failed` instead of `account`, and the request is refused with 400 while a profile holds one Facebook account and on a reconnect or an ads connect, which pick exactly one Page. A single distinct ID behaves exactly like pageId.
21115
+ * Several Page IDs to connect from one sign-in, each as its own account. With two or more distinct IDs the response lists `accounts` and `failed` instead of `account`, and the request is refused with 400 on a reconnect or an ads connect, which pick exactly one Page. A single distinct ID behaves exactly like pageId.
21115
21116
  */
21116
21117
  pageIds?: Array<(string)>;
21117
21118
  /**
@@ -21237,7 +21238,7 @@ type SelectInstagramAccountData = {
21237
21238
  */
21238
21239
  pageId?: string;
21239
21240
  /**
21240
- * Several Page IDs whose linked Instagram accounts to connect from one sign-in, each as its own account. With two or more distinct IDs the response lists `accounts` and `failed` instead of `account`, and the request is refused with 400 while a profile holds one Instagram account and on a reconnect or an ads connect. A single distinct ID behaves exactly like pageId.
21241
+ * Several Page IDs whose linked Instagram accounts to connect from one sign-in, each as its own account. With two or more distinct IDs the response lists `accounts` and `failed` instead of `account`, and the request is refused with 400 on a reconnect or an ads connect. A single distinct ID behaves exactly like pageId.
21241
21242
  */
21242
21243
  pageIds?: Array<(string)>;
21243
21244
  /**
@@ -22793,7 +22794,7 @@ type SelectLinkedInOrganizationData = {
22793
22794
  */
22794
22795
  accountType?: 'personal' | 'organization';
22795
22796
  /**
22796
- * Several accounts to connect from one sign-in (yourself and/or organizations), each as its own account. With two or more entries the response lists `accounts` and `failed` instead of `account`, and the request is refused with 400 while a profile holds one LinkedIn account and on a reconnect or an ads connect. A single entry behaves exactly like accountType.
22797
+ * Several accounts to connect from one sign-in (yourself and/or organizations), each as its own account. With two or more entries the response lists `accounts` and `failed` instead of `account`, and the request is refused with 400 on a reconnect or an ads connect. A single entry behaves exactly like accountType.
22797
22798
  */
22798
22799
  selections?: Array<{
22799
22800
  accountType: 'personal' | 'organization';
@@ -33202,7 +33203,7 @@ type ReleasePhoneNumberError = (unknown | {
33202
33203
  type PurchasePhoneNumberData = {
33203
33204
  body: {
33204
33205
  /**
33205
- * Preferred profile for the number. One number = one profile, so when the requested profile already holds a number the API assigns the next free profile instead (or creates one) and returns the actual assignment in `profileId` on the response.
33206
+ * Profile for the number, which may already hold other numbers. Without it the number goes to the default profile. The response's `profileId` carries the assignment.
33206
33207
  *
33207
33208
  */
33208
33209
  profileId: 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: "@zernio/node",
39
- version: "0.2.1054",
39
+ version: "0.2.1056",
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: "@zernio/node",
8
- version: "0.2.1054",
8
+ version: "0.2.1056",
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": "@zernio/node",
3
- "version": "0.2.1054",
3
+ "version": "0.2.1056",
4
4
  "description": "The official Node.js library for the Zernio API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -1642,12 +1642,12 @@ export const createInviteToken = <ThrowOnError extends boolean = false>(options:
1642
1642
  * Initiate an OAuth connection flow. Returns an authUrl to redirect the user to.
1643
1643
  * Standard flow: Zernio hosts the selection UI, then redirects to your redirect_url. Headless mode (headless=true): user is redirected to your redirect_url with OAuth data for custom UI. Use the platform-specific selection endpoints to complete.
1644
1644
  *
1645
- * TikTok: every connection now goes through the TikTok for Business app. One TikTok account per
1646
- * profile, so connecting on a profile that already holds one replaces it. Reconnecting the SAME
1647
- * account keeps it and all of its history; authorizing a DIFFERENT TikTok account takes the slot
1648
- * over and permanently deletes the previous account's analytics, inbox and DM history. The two
1649
- * are told apart by the `@handle` stored at the last connect, so an account whose handle has
1650
- * been renamed on TikTok since then reads as a different account. An authorization that leaves
1645
+ * A profile can hold several accounts of the same platform: connecting a different account adds
1646
+ * it as a new account, and reconnecting the SAME account keeps it and all of its history. Ads
1647
+ * connections stay one per profile. On a legacy plan limited to N profiles, a new account is
1648
+ * refused with 403 `platform_account_limit` once N accounts of its platform are connected.
1649
+ *
1650
+ * TikTok: every connection now goes through the TikTok for Business app. An authorization that leaves
1651
1651
  * out a permission the connected account needs changes nothing at all and comes back as
1652
1652
  * `missing_tiktok_permissions`; connect again and accept every permission on TikTok's screen.
1653
1653
  *
@@ -1944,7 +1944,7 @@ export const listInstagramPages = <ThrowOnError extends boolean = false>(options
1944
1944
  * Select the Page whose Instagram account to connect
1945
1945
  * Saves the selected Page as an Instagram account connected via Facebook Login. The Page access token becomes the account's access token, so every Instagram call for it runs against the Facebook Graph host.
1946
1946
  *
1947
- * One Instagram account per profile: if the profile already has an Instagram account, this replaces it, and picking a different Instagram identity purges the previous account's conversations, external posts and stats.
1947
+ * A different Instagram account is added next to any already connected on the profile; picking one already connected refreshes it.
1948
1948
  *
1949
1949
  */
1950
1950
  export const selectInstagramAccount = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<SelectInstagramAccountData, ThrowOnError>) => {
@@ -3009,7 +3009,7 @@ export const updateGmbLocation = <ThrowOnError extends boolean = false>(options:
3009
3009
 
3010
3010
  /**
3011
3011
  * Assign Google Business Profile location to another profile
3012
- * Connect a Google Business Profile location onto a DIFFERENT profile by reusing the OAuth grant from an already-connected Google Business Profile account, with no browser and no re-authorization. Built for agencies whose single Google account has manager access to many client locations and who run one profile per client: connect one location the normal way (browser OAuth), then bulk-assign the rest onto each client's profile via this endpoint. The path `accountId` is a SOURCE connected Google Business Profile account (the token holder); the body `profileId` is the TARGET profile. Returns 409 if the target profile already has a Google Business Profile connection (switch its location with PUT gmb-locations instead).
3012
+ * Connect a Google Business Profile location onto a DIFFERENT profile by reusing the OAuth grant from an already-connected Google Business Profile account, with no browser and no re-authorization. Built for agencies whose single Google account has manager access to many client locations and who run one profile per client: connect one location the normal way (browser OAuth), then bulk-assign the rest onto each client's profile via this endpoint. The path `accountId` is a SOURCE connected Google Business Profile account (the token holder); the body `profileId` is the TARGET profile, which may already hold other locations; assigning a location it already holds refreshes that account.
3013
3013
  *
3014
3014
  */
3015
3015
  export const assignGoogleBusinessLocation = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<AssignGoogleBusinessLocationData, ThrowOnError>) => {
@@ -5504,9 +5504,9 @@ export const listImessageSenders = <ThrowOnError extends boolean = false>(option
5504
5504
  * conversation endpoints. To have Zernio order a new sender for you, use
5505
5505
  * POST /v1/imessage/senders/order instead. Registration attaches the
5506
5506
  * monthly sender fee (billed while active) and requires a payment method
5507
- * (402 without one). One sender per profile: re-registering the SAME
5508
- * handle refreshes it; a different handle returns 409 until the existing
5509
- * sender is canceled.
5507
+ * (402 without one). Re-registering the SAME handle refreshes its account;
5508
+ * a different handle is added as another sender, and a profile can hold
5509
+ * several.
5510
5510
  *
5511
5511
  */
5512
5512
  export const registerImessageSender = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<RegisterImessageSenderData, ThrowOnError>) => {
@@ -5817,7 +5817,7 @@ export const listRcsAgents = <ThrowOnError extends boolean = false>(options?: Op
5817
5817
  * Request an RCS agent
5818
5818
  * Requests a new agent for a profile, with a new company (`brand`) or an existing one
5819
5819
  * (`brandId`, skips vetting when it is already verified). The request lands in our review:
5820
- * nothing is filed with the carriers or billed until we submit it. One open agent per profile.
5820
+ * nothing is filed with the carriers or billed until we submit it. A profile can hold several agents.
5821
5821
  * Requires usage-based billing and a card on file. Send an `Idempotency-Key` header to make
5822
5822
  * retries safe.
5823
5823
  *
@@ -7643,8 +7643,7 @@ export const createWhatsAppNumberKycLink = <ThrowOnError extends boolean = false
7643
7643
  *
7644
7644
  * `id` is the number record id from `GET /v1/phone-numbers`, not an account id.
7645
7645
  *
7646
- * A profile holds at most one account per platform, so the destination must be
7647
- * free of every platform this number occupies.
7646
+ * The destination profile may already hold other numbers.
7648
7647
  *
7649
7648
  */
7650
7649
  export const moveWhatsAppNumberToProfile = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<MoveWhatsAppNumberToProfileData, ThrowOnError>) => {
@@ -19144,7 +19144,7 @@ export type GetConnectUrlData = {
19144
19144
  */
19145
19145
  profileId: string;
19146
19146
  /**
19147
- * Refresh this existing account (a Zernio account id of the same platform on this profile; otherwise 400). The OAuth callback and the selection endpoints (select-page, select-organization, select-board, select-location, Instagram and Snapchat selection) refuse, with `reconnect_account_mismatch`, a login that would write to a different account of the platform on this profile instead of this one. While a profile holds one account per platform the login still replaces this account as before. In headless mode the marker travels in the redirect_url we hand you, so pass that URL back unchanged to the selection endpoint. On X it counts toward the OAuth state limit described under redirect_url.
19147
+ * Refresh this existing account (a Zernio account id of the same platform on this profile; otherwise 400). The OAuth callback and the selection endpoints (select-page, select-organization, select-board, select-location, Instagram and Snapchat selection) refuse, with `reconnect_account_mismatch`, a login that would write to a different account of the platform on this profile instead of this one. In headless mode the marker travels in the redirect_url we hand you, so pass that URL back unchanged to the selection endpoint. On X it counts toward the OAuth state limit described under redirect_url.
19148
19148
  */
19149
19149
  reconnectAccountId?: string;
19150
19150
  /**
@@ -19176,7 +19176,8 @@ export type GetConnectUrlData = {
19176
19176
  * - `pages_permission_declined`: the user declined the pages_show_list permission.
19177
19177
  * - `no_pages_granted`: the permission was granted with no Page ticked. Meta reports a user who
19178
19178
  * manages no Page the same way, so this covers both.
19179
- * - `granted_pages_not_listed`: Pages were ticked but Meta listed none the user can manage.
19179
+ * - `granted_pages_not_listed`: Pages were ticked but Meta listed none the user can manage, and a
19180
+ * direct read of each ticked Page returned no access token.
19180
19181
  *
19181
19182
  * Headless Facebook success (`step=select_page`): `userProfile` is JSON that was
19182
19183
  * percent-encoded once before being set as a query param, so it is encoded twice on the wire.
@@ -20071,7 +20072,7 @@ export type SelectFacebookPageData = {
20071
20072
  */
20072
20073
  pageId?: string;
20073
20074
  /**
20074
- * Several Page IDs to connect from one sign-in, each as its own account. With two or more distinct IDs the response lists `accounts` and `failed` instead of `account`, and the request is refused with 400 while a profile holds one Facebook account and on a reconnect or an ads connect, which pick exactly one Page. A single distinct ID behaves exactly like pageId.
20075
+ * Several Page IDs to connect from one sign-in, each as its own account. With two or more distinct IDs the response lists `accounts` and `failed` instead of `account`, and the request is refused with 400 on a reconnect or an ads connect, which pick exactly one Page. A single distinct ID behaves exactly like pageId.
20075
20076
  */
20076
20077
  pageIds?: Array<(string)>;
20077
20078
  /**
@@ -20203,7 +20204,7 @@ export type SelectInstagramAccountData = {
20203
20204
  */
20204
20205
  pageId?: string;
20205
20206
  /**
20206
- * Several Page IDs whose linked Instagram accounts to connect from one sign-in, each as its own account. With two or more distinct IDs the response lists `accounts` and `failed` instead of `account`, and the request is refused with 400 while a profile holds one Instagram account and on a reconnect or an ads connect. A single distinct ID behaves exactly like pageId.
20207
+ * Several Page IDs whose linked Instagram accounts to connect from one sign-in, each as its own account. With two or more distinct IDs the response lists `accounts` and `failed` instead of `account`, and the request is refused with 400 on a reconnect or an ads connect. A single distinct ID behaves exactly like pageId.
20207
20208
  */
20208
20209
  pageIds?: Array<(string)>;
20209
20210
  /**
@@ -21849,7 +21850,7 @@ export type SelectLinkedInOrganizationData = {
21849
21850
  */
21850
21851
  accountType?: 'personal' | 'organization';
21851
21852
  /**
21852
- * Several accounts to connect from one sign-in (yourself and/or organizations), each as its own account. With two or more entries the response lists `accounts` and `failed` instead of `account`, and the request is refused with 400 while a profile holds one LinkedIn account and on a reconnect or an ads connect. A single entry behaves exactly like accountType.
21853
+ * Several accounts to connect from one sign-in (yourself and/or organizations), each as its own account. With two or more entries the response lists `accounts` and `failed` instead of `account`, and the request is refused with 400 on a reconnect or an ads connect. A single entry behaves exactly like accountType.
21853
21854
  */
21854
21855
  selections?: Array<{
21855
21856
  accountType: 'personal' | 'organization';
@@ -33086,7 +33087,7 @@ export type ReleasePhoneNumberError = (unknown | {
33086
33087
  export type PurchasePhoneNumberData = {
33087
33088
  body: {
33088
33089
  /**
33089
- * Preferred profile for the number. One number = one profile, so when the requested profile already holds a number the API assigns the next free profile instead (or creates one) and returns the actual assignment in `profileId` on the response.
33090
+ * Profile for the number, which may already hold other numbers. Without it the number goes to the default profile. The response's `profileId` carries the assignment.
33090
33091
  *
33091
33092
  */
33092
33093
  profileId: string;