@getlatedev/node 0.2.1301 → 0.2.1303

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
@@ -237,7 +237,7 @@ declare class Zernio {
237
237
  listBusinessPartners: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListBusinessPartnersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListBusinessPartnersResponse, unknown, ThrowOnError>;
238
238
  grantBusinessPartner: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GrantBusinessPartnerData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GrantBusinessPartnerResponse, unknown, ThrowOnError>;
239
239
  revokeBusinessPartner: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<RevokeBusinessPartnerData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RevokeBusinessPartnerResponse, unknown, ThrowOnError>;
240
- getLinkedInMentions: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetLinkedInMentionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetLinkedInMentionsResponse, GetLinkedInMentionsError, ThrowOnError>;
240
+ getLinkedInMentions: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetLinkedInMentionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetLinkedInMentionsResponse, ErrorResponse, ThrowOnError>;
241
241
  getHubSpotSettings: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetHubSpotSettingsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetHubSpotSettingsResponse, unknown, ThrowOnError>;
242
242
  updateHubSpotSettings: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateHubSpotSettingsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateHubSpotSettingsResponse, unknown, ThrowOnError>;
243
243
  getSlackSettings: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetSlackSettingsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetSlackSettingsResponse, unknown, ThrowOnError>;
@@ -28040,7 +28040,7 @@ type GetLinkedInMentionsData = {
28040
28040
  };
28041
28041
  query: {
28042
28042
  /**
28043
- * Exact display name as shown on LinkedIn. Required for person mentions to be clickable. Optional for org mentions.
28043
+ * Optional override for a person's mention text. When omitted, the real name is resolved from LinkedIn. Ignored for org mentions, which always use the organization's LinkedIn name.
28044
28044
  */
28045
28045
  displayName?: string;
28046
28046
  /**
@@ -28071,13 +28071,11 @@ type GetLinkedInMentionsResponse = ({
28071
28071
  */
28072
28072
  vanityName?: string;
28073
28073
  /**
28074
- * Warning about clickable mentions (only present for person mentions if displayName was not provided)
28074
+ * Only present for person mentions when displayName was not provided and the real name could not be resolved from LinkedIn
28075
28075
  */
28076
28076
  warning?: string;
28077
28077
  });
28078
- type GetLinkedInMentionsError = ({
28079
- error?: string;
28080
- } | ErrorResponse);
28078
+ type GetLinkedInMentionsError = (ErrorResponse);
28081
28079
  type ListInstagramStoriesData = {
28082
28080
  path: {
28083
28081
  /**
@@ -46431,6 +46429,10 @@ type GetTikTokSmartPlusMaterialReportResponse = ({
46431
46429
  pageSize?: number;
46432
46430
  totalRows?: number;
46433
46431
  totalPages?: number;
46432
+ /**
46433
+ * Rows TikTok declared that a read and its retry could not return. 0 when the result is complete.
46434
+ */
46435
+ missingRows?: number;
46434
46436
  rows?: Array<{
46435
46437
  /**
46436
46438
  * TikTok main material id
package/dist/index.d.ts CHANGED
@@ -237,7 +237,7 @@ declare class Zernio {
237
237
  listBusinessPartners: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListBusinessPartnersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListBusinessPartnersResponse, unknown, ThrowOnError>;
238
238
  grantBusinessPartner: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GrantBusinessPartnerData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GrantBusinessPartnerResponse, unknown, ThrowOnError>;
239
239
  revokeBusinessPartner: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<RevokeBusinessPartnerData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RevokeBusinessPartnerResponse, unknown, ThrowOnError>;
240
- getLinkedInMentions: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetLinkedInMentionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetLinkedInMentionsResponse, GetLinkedInMentionsError, ThrowOnError>;
240
+ getLinkedInMentions: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetLinkedInMentionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetLinkedInMentionsResponse, ErrorResponse, ThrowOnError>;
241
241
  getHubSpotSettings: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetHubSpotSettingsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetHubSpotSettingsResponse, unknown, ThrowOnError>;
242
242
  updateHubSpotSettings: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateHubSpotSettingsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateHubSpotSettingsResponse, unknown, ThrowOnError>;
243
243
  getSlackSettings: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetSlackSettingsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetSlackSettingsResponse, unknown, ThrowOnError>;
@@ -28040,7 +28040,7 @@ type GetLinkedInMentionsData = {
28040
28040
  };
28041
28041
  query: {
28042
28042
  /**
28043
- * Exact display name as shown on LinkedIn. Required for person mentions to be clickable. Optional for org mentions.
28043
+ * Optional override for a person's mention text. When omitted, the real name is resolved from LinkedIn. Ignored for org mentions, which always use the organization's LinkedIn name.
28044
28044
  */
28045
28045
  displayName?: string;
28046
28046
  /**
@@ -28071,13 +28071,11 @@ type GetLinkedInMentionsResponse = ({
28071
28071
  */
28072
28072
  vanityName?: string;
28073
28073
  /**
28074
- * Warning about clickable mentions (only present for person mentions if displayName was not provided)
28074
+ * Only present for person mentions when displayName was not provided and the real name could not be resolved from LinkedIn
28075
28075
  */
28076
28076
  warning?: string;
28077
28077
  });
28078
- type GetLinkedInMentionsError = ({
28079
- error?: string;
28080
- } | ErrorResponse);
28078
+ type GetLinkedInMentionsError = (ErrorResponse);
28081
28079
  type ListInstagramStoriesData = {
28082
28080
  path: {
28083
28081
  /**
@@ -46431,6 +46429,10 @@ type GetTikTokSmartPlusMaterialReportResponse = ({
46431
46429
  pageSize?: number;
46432
46430
  totalRows?: number;
46433
46431
  totalPages?: number;
46432
+ /**
46433
+ * Rows TikTok declared that a read and its retry could not return. 0 when the result is complete.
46434
+ */
46435
+ missingRows?: number;
46434
46436
  rows?: Array<{
46435
46437
  /**
46436
46438
  * TikTok main material id
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.1301",
39
+ version: "0.2.1303",
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.1301",
8
+ version: "0.2.1303",
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.1301",
3
+ "version": "0.2.1303",
4
4
  "description": "The official Node.js library for the Zernio API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -3055,9 +3055,9 @@ export const updateLinkedInOrganization = <ThrowOnError extends boolean = false>
3055
3055
  * Important: The mentions array field in POST /v1/posts is stored for reference only and does NOT trigger @mentions on LinkedIn. You must embed the mention format directly in the content text.
3056
3056
  *
3057
3057
  * Requirements:
3058
- * - Person mentions require the LinkedIn account to be admin of at least one organization: both endpoints that resolve a profile URL to a member URN take an organization you administer. Organization mentions (e.g. @Microsoft) have no such requirement.
3058
+ * - Resolving a profile URL to a person mention requires the LinkedIn account to be admin of at least one organization: both endpoints that resolve a profile URL to a member URN take an organization you administer. A resolved person mention publishes from any account. Organization mentions (e.g. @Microsoft) have no such requirement.
3059
3059
  * - The two are not scoped alike. peopleTypeahead?q=organizationFollowers only returns that organization's followers; vanityUrl?q=vanityUrlAsOrganization does not, and its resolvable set is opaque. A 404 here does not mean the person is unknown to you or unknown to LinkedIn: a live public profile can 404 with no reason given.
3060
- * - For person mentions to be clickable, the displayName parameter must exactly match the name shown on their LinkedIn profile.
3060
+ * - displayName is optional: the endpoint looks up the person's real name itself. LinkedIn renders a person mention as a link when the mention text is the person's first name, last name or full name (case-sensitive).
3061
3061
  * - Person mentions DO work when published from personal profiles (the URN only needs to be valid). The limitation is only in the resolution step (URL to URN), not in publishing.
3062
3062
  *
3063
3063
  */
@@ -11992,7 +11992,7 @@ export const listAdsTikTokIdentities = <ThrowOnError extends boolean = false>(op
11992
11992
 
11993
11993
  /**
11994
11994
  * Per-creative performance inside TikTok Smart+ ads
11995
- * Breaks a Smart+ ad (or ad group) down by creative material, one row per Spark post, video or image, from TikTok's Smart+ material report. For a Spark post `tiktokItemId` is the TikTok post id. Conversion metrics are TikTok web (pixel) events. `purchases`, `purchaseValue` and `roas` come from Complete Payment, or from Place an Order (legacy ON_WEB_ORDER pixels) when that reports more; the two are never summed. TikTok allows two dimensions per report, so rows are keyed by the Smart+ ad (`level=ad`) or by the ad group (`level=adGroup`), not both. A row is identified by `smartPlusAdId` + `materialId` at `level=ad` and by `adGroupId` + `materialId` at `level=adGroup`; each appears once across all pages. Rows are sorted by `spend` descending, then the Smart+ ad or ad group id, then `materialId`, and the full result is cached for 10 minutes per account, advertiser and query, so pages read within that window are consistent and `totalRows` counts distinct rows. The result can hold more rows than TikTok's unfiltered report declares, because the per-ad reads also return listed Smart+ ads that report leaves out. When the slices come back with fewer rows than TikTok declares on two reads, the call answers 502 instead of a short result. Metrics TikTok returns empty come back as null.
11995
+ * Breaks a Smart+ ad (or ad group) down by creative material, one row per Spark post, video or image, from TikTok's Smart+ material report. For a Spark post `tiktokItemId` is the TikTok post id. Conversion metrics are TikTok web (pixel) events. `purchases`, `purchaseValue` and `roas` come from Complete Payment, or from Place an Order (legacy ON_WEB_ORDER pixels) when that reports more; the two are never summed. TikTok allows two dimensions per report, so rows are keyed by the Smart+ ad (`level=ad`) or by the ad group (`level=adGroup`), not both. A row is identified by `smartPlusAdId` + `materialId` at `level=ad` and by `adGroupId` + `materialId` at `level=adGroup`; each appears once across all pages. Rows are sorted by `spend` descending, then the Smart+ ad or ad group id, then `materialId`, and the full result is cached for 10 minutes per account, advertiser and query, so pages read within that window are consistent and `totalRows` counts distinct rows. When the result spans more than one TikTok page it is read per Smart+ ad (or ad group) listed on the advertiser, every status included, and those reads can return more rows than TikTok's unfiltered report declares, so `totalRows` can be larger than that count; when the unfiltered report fits one page (100 rows or fewer) it is served as is. Each TikTok read is checked against the row count it declares itself, and a short read is retried once. A shortfall of at most 2 rows (or 1% of the rows, whichever is more) is served with `missingRows` set to that number; a larger one answers 502 instead of a short result. Metrics TikTok returns empty come back as null.
11996
11996
  */
11997
11997
  export const getTikTokSmartPlusMaterialReport = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetTikTokSmartPlusMaterialReportData, ThrowOnError>) => {
11998
11998
  return (options?.client ?? client).get<GetTikTokSmartPlusMaterialReportResponse, GetTikTokSmartPlusMaterialReportError, ThrowOnError>({
@@ -27241,7 +27241,7 @@ export type GetLinkedInMentionsData = {
27241
27241
  };
27242
27242
  query: {
27243
27243
  /**
27244
- * Exact display name as shown on LinkedIn. Required for person mentions to be clickable. Optional for org mentions.
27244
+ * Optional override for a person's mention text. When omitted, the real name is resolved from LinkedIn. Ignored for org mentions, which always use the organization's LinkedIn name.
27245
27245
  */
27246
27246
  displayName?: string;
27247
27247
  /**
@@ -27273,14 +27273,12 @@ export type GetLinkedInMentionsResponse = ({
27273
27273
  */
27274
27274
  vanityName?: string;
27275
27275
  /**
27276
- * Warning about clickable mentions (only present for person mentions if displayName was not provided)
27276
+ * Only present for person mentions when displayName was not provided and the real name could not be resolved from LinkedIn
27277
27277
  */
27278
27278
  warning?: string;
27279
27279
  });
27280
27280
 
27281
- export type GetLinkedInMentionsError = ({
27282
- error?: string;
27283
- } | ErrorResponse);
27281
+ export type GetLinkedInMentionsError = (ErrorResponse);
27284
27282
 
27285
27283
  export type ListInstagramStoriesData = {
27286
27284
  path: {
@@ -47100,6 +47098,10 @@ export type GetTikTokSmartPlusMaterialReportResponse = ({
47100
47098
  pageSize?: number;
47101
47099
  totalRows?: number;
47102
47100
  totalPages?: number;
47101
+ /**
47102
+ * Rows TikTok declared that a read and its retry could not return. 0 when the result is complete.
47103
+ */
47104
+ missingRows?: number;
47103
47105
  rows?: Array<{
47104
47106
  /**
47105
47107
  * TikTok main material id