@getlatedev/node 0.2.1302 → 0.2.1304
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 +14 -6
- package/dist/index.d.ts +14 -6
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/sdk.gen.ts +8 -6
- package/src/generated/types.gen.ts +13 -5
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,
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
/**
|
|
@@ -43814,11 +43812,17 @@ type ListAdSetsData = {
|
|
|
43814
43812
|
* Platform campaign ID
|
|
43815
43813
|
*/
|
|
43816
43814
|
campaignId?: string;
|
|
43815
|
+
limit?: number;
|
|
43817
43816
|
/**
|
|
43818
43817
|
* Read the on/off switches live from the platform instead of returning the synced values. The fresh values are stored (so later reads return them too) and the response carries `statusReadAt`, the time of the read. At most 20 platform objects are read per request. Where a read fails (credentials, platform error, no reader on that platform), the stored values come back with `statusReadAt: null`. See "Status freshness" in the operation description. On X the budget is read live in the same read: on GET /v1/ads/{adId} `budget`, `adSetBudget`, `campaignBudget` and `budgetLevel` are the line item and campaign budgets X holds now (stored like the switches); on the ad set and campaign listings `budget` is the one that line item or campaign holds now (returned, not stored); a row whose budget the other level holds keeps its synced `budget`.
|
|
43819
43818
|
*/
|
|
43820
43819
|
live?: boolean;
|
|
43820
|
+
page?: number;
|
|
43821
43821
|
platform?: 'facebook' | 'instagram' | 'tiktok' | 'linkedin' | 'pinterest' | 'google' | 'twitter' | 'openai' | 'reddit';
|
|
43822
|
+
/**
|
|
43823
|
+
* Filter by the ad set's stored `status`, the value each row returns. A live read does not change it. Rows whose `status` is null match no filter.
|
|
43824
|
+
*/
|
|
43825
|
+
status?: AdStatus;
|
|
43822
43826
|
};
|
|
43823
43827
|
};
|
|
43824
43828
|
type ListAdSetsResponse = ({
|
|
@@ -43826,6 +43830,9 @@ type ListAdSetsResponse = ({
|
|
|
43826
43830
|
platformAdSetId?: string;
|
|
43827
43831
|
platform?: string;
|
|
43828
43832
|
adSetName?: (string) | null;
|
|
43833
|
+
/**
|
|
43834
|
+
* Stored ad set status (active, paused, pending_review, rejected, completed, cancelled, error), as last synced. The `status` filter matches it.
|
|
43835
|
+
*/
|
|
43829
43836
|
status?: (string) | null;
|
|
43830
43837
|
/**
|
|
43831
43838
|
* Raw platform ad set status. On TikTok the ad group's own switch `operation_status` (ENABLE / DISABLE), independent of its campaign. On Meta and Reddit the ad set's `effective_status` (e.g. CAMPAIGN_PAUSED).
|
|
@@ -43956,6 +43963,7 @@ type ListAdSetsResponse = ({
|
|
|
43956
43963
|
*/
|
|
43957
43964
|
configReadAt?: (string) | null;
|
|
43958
43965
|
}>;
|
|
43966
|
+
pagination?: Pagination;
|
|
43959
43967
|
});
|
|
43960
43968
|
type ListAdSetsError = (ErrorResponse | unknown);
|
|
43961
43969
|
type CreateAdSetData = {
|
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,
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
/**
|
|
@@ -43814,11 +43812,17 @@ type ListAdSetsData = {
|
|
|
43814
43812
|
* Platform campaign ID
|
|
43815
43813
|
*/
|
|
43816
43814
|
campaignId?: string;
|
|
43815
|
+
limit?: number;
|
|
43817
43816
|
/**
|
|
43818
43817
|
* Read the on/off switches live from the platform instead of returning the synced values. The fresh values are stored (so later reads return them too) and the response carries `statusReadAt`, the time of the read. At most 20 platform objects are read per request. Where a read fails (credentials, platform error, no reader on that platform), the stored values come back with `statusReadAt: null`. See "Status freshness" in the operation description. On X the budget is read live in the same read: on GET /v1/ads/{adId} `budget`, `adSetBudget`, `campaignBudget` and `budgetLevel` are the line item and campaign budgets X holds now (stored like the switches); on the ad set and campaign listings `budget` is the one that line item or campaign holds now (returned, not stored); a row whose budget the other level holds keeps its synced `budget`.
|
|
43819
43818
|
*/
|
|
43820
43819
|
live?: boolean;
|
|
43820
|
+
page?: number;
|
|
43821
43821
|
platform?: 'facebook' | 'instagram' | 'tiktok' | 'linkedin' | 'pinterest' | 'google' | 'twitter' | 'openai' | 'reddit';
|
|
43822
|
+
/**
|
|
43823
|
+
* Filter by the ad set's stored `status`, the value each row returns. A live read does not change it. Rows whose `status` is null match no filter.
|
|
43824
|
+
*/
|
|
43825
|
+
status?: AdStatus;
|
|
43822
43826
|
};
|
|
43823
43827
|
};
|
|
43824
43828
|
type ListAdSetsResponse = ({
|
|
@@ -43826,6 +43830,9 @@ type ListAdSetsResponse = ({
|
|
|
43826
43830
|
platformAdSetId?: string;
|
|
43827
43831
|
platform?: string;
|
|
43828
43832
|
adSetName?: (string) | null;
|
|
43833
|
+
/**
|
|
43834
|
+
* Stored ad set status (active, paused, pending_review, rejected, completed, cancelled, error), as last synced. The `status` filter matches it.
|
|
43835
|
+
*/
|
|
43829
43836
|
status?: (string) | null;
|
|
43830
43837
|
/**
|
|
43831
43838
|
* Raw platform ad set status. On TikTok the ad group's own switch `operation_status` (ENABLE / DISABLE), independent of its campaign. On Meta and Reddit the ad set's `effective_status` (e.g. CAMPAIGN_PAUSED).
|
|
@@ -43956,6 +43963,7 @@ type ListAdSetsResponse = ({
|
|
|
43956
43963
|
*/
|
|
43957
43964
|
configReadAt?: (string) | null;
|
|
43958
43965
|
}>;
|
|
43966
|
+
pagination?: Pagination;
|
|
43959
43967
|
});
|
|
43960
43968
|
type ListAdSetsError = (ErrorResponse | unknown);
|
|
43961
43969
|
type CreateAdSetData = {
|
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.
|
|
39
|
+
version: "0.2.1304",
|
|
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.
|
|
8
|
+
version: "0.2.1304",
|
|
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
package/src/generated/sdk.gen.ts
CHANGED
|
@@ -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
|
-
* -
|
|
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
|
-
* -
|
|
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
|
*/
|
|
@@ -10690,8 +10690,10 @@ export const updateCampaignTargeting = <ThrowOnError extends boolean = false>(op
|
|
|
10690
10690
|
* directly, independent of the `ads` rollup GET /v1/ads/tree uses, so a
|
|
10691
10691
|
* newly created standalone ad group with no ad yet (POST /v1/ads/ad-sets,
|
|
10692
10692
|
* Google only) is visible here even though it is invisible in the tree
|
|
10693
|
-
* until an ad joins it via `adSetId` on POST /v1/ads/create.
|
|
10694
|
-
*
|
|
10693
|
+
* until an ad joins it via `adSetId` on POST /v1/ads/create. Rows come newest first
|
|
10694
|
+
* (by platform creation time, then id, so pages never overlap), 500 per page unless `limit`
|
|
10695
|
+
* says otherwise; `pagination.total` counts every matching ad set and `page` reaches the
|
|
10696
|
+
* rest.
|
|
10695
10697
|
*
|
|
10696
10698
|
* **This list is SYNCED, not live** (refreshed by background sync, see below). Each row also
|
|
10697
10699
|
* carries the ad set's config (`targeting`, `bidStrategy`, `bidAmount`, `optimizationGoal`,
|
|
@@ -10710,8 +10712,8 @@ export const updateCampaignTargeting = <ThrowOnError extends boolean = false>(op
|
|
|
10710
10712
|
* which reads the switches from the platform now, stores them, and returns `statusReadAt`
|
|
10711
10713
|
* (null when the read failed and the stored values were returned).
|
|
10712
10714
|
* With `live=true` (which needs a `campaignId` or `adSetId` filter) each listed ad set's own
|
|
10713
|
-
* switch (`platformAdSetStatus`) is read live, for the first 20 rows; later rows keep their
|
|
10714
|
-
* synced value with `statusReadAt: null`. Live reads cover TikTok, Meta, Google, OpenAI and Reddit.
|
|
10715
|
+
* switch (`platformAdSetStatus`) is read live, for the first 20 rows of the page; later rows keep their
|
|
10716
|
+
* synced value with `statusReadAt: null`. To read more ad sets live, page with `limit=20`. Live reads cover TikTok, Meta, Google, OpenAI and Reddit.
|
|
10715
10717
|
* The rolled-up `status` is not re-derived by a live read. On TikTok the same live read also
|
|
10716
10718
|
* returns the ad group's applied `optimizationGoal` and `billingEvent`, as TikTok's adgroup/get
|
|
10717
10719
|
* reports them, so you can verify the goal TikTok applied rather than the one you requested.
|
|
@@ -27241,7 +27241,7 @@ export type GetLinkedInMentionsData = {
|
|
|
27241
27241
|
};
|
|
27242
27242
|
query: {
|
|
27243
27243
|
/**
|
|
27244
|
-
*
|
|
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
|
-
*
|
|
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: {
|
|
@@ -44338,11 +44336,17 @@ export type ListAdSetsData = {
|
|
|
44338
44336
|
* Platform campaign ID
|
|
44339
44337
|
*/
|
|
44340
44338
|
campaignId?: string;
|
|
44339
|
+
limit?: number;
|
|
44341
44340
|
/**
|
|
44342
44341
|
* Read the on/off switches live from the platform instead of returning the synced values. The fresh values are stored (so later reads return them too) and the response carries `statusReadAt`, the time of the read. At most 20 platform objects are read per request. Where a read fails (credentials, platform error, no reader on that platform), the stored values come back with `statusReadAt: null`. See "Status freshness" in the operation description. On X the budget is read live in the same read: on GET /v1/ads/{adId} `budget`, `adSetBudget`, `campaignBudget` and `budgetLevel` are the line item and campaign budgets X holds now (stored like the switches); on the ad set and campaign listings `budget` is the one that line item or campaign holds now (returned, not stored); a row whose budget the other level holds keeps its synced `budget`.
|
|
44343
44342
|
*/
|
|
44344
44343
|
live?: boolean;
|
|
44344
|
+
page?: number;
|
|
44345
44345
|
platform?: 'facebook' | 'instagram' | 'tiktok' | 'linkedin' | 'pinterest' | 'google' | 'twitter' | 'openai' | 'reddit';
|
|
44346
|
+
/**
|
|
44347
|
+
* Filter by the ad set's stored `status`, the value each row returns. A live read does not change it. Rows whose `status` is null match no filter.
|
|
44348
|
+
*/
|
|
44349
|
+
status?: AdStatus;
|
|
44346
44350
|
};
|
|
44347
44351
|
};
|
|
44348
44352
|
|
|
@@ -44351,6 +44355,9 @@ export type ListAdSetsResponse = ({
|
|
|
44351
44355
|
platformAdSetId?: string;
|
|
44352
44356
|
platform?: string;
|
|
44353
44357
|
adSetName?: (string) | null;
|
|
44358
|
+
/**
|
|
44359
|
+
* Stored ad set status (active, paused, pending_review, rejected, completed, cancelled, error), as last synced. The `status` filter matches it.
|
|
44360
|
+
*/
|
|
44354
44361
|
status?: (string) | null;
|
|
44355
44362
|
/**
|
|
44356
44363
|
* Raw platform ad set status. On TikTok the ad group's own switch `operation_status` (ENABLE / DISABLE), independent of its campaign. On Meta and Reddit the ad set's `effective_status` (e.g. CAMPAIGN_PAUSED).
|
|
@@ -44481,6 +44488,7 @@ export type ListAdSetsResponse = ({
|
|
|
44481
44488
|
*/
|
|
44482
44489
|
configReadAt?: (string) | null;
|
|
44483
44490
|
}>;
|
|
44491
|
+
pagination?: Pagination;
|
|
44484
44492
|
});
|
|
44485
44493
|
|
|
44486
44494
|
export type ListAdSetsError = (ErrorResponse | unknown);
|