@getlatedev/node 0.2.1406 → 0.2.1408

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
@@ -23469,7 +23469,7 @@ type ValidateSubredditError = (ErrorResponse | unknown);
23469
23469
  type GetAnalyticsData = {
23470
23470
  query?: {
23471
23471
  /**
23472
- * Filter by account ID
23472
+ * Filter by account ID. With a native postId, selects that account's copy of the post.
23473
23473
  */
23474
23474
  accountId?: string;
23475
23475
  /**
@@ -23493,11 +23493,11 @@ type GetAnalyticsData = {
23493
23493
  */
23494
23494
  platform?: string;
23495
23495
  /**
23496
- * Returns analytics for a single post. Accepts both Zernio Post IDs and External Post IDs. Zernio IDs are auto-resolved to External Post analytics.
23496
+ * Returns analytics for a single post. Accepts Zernio Post IDs, External Post IDs and the platform's native post ID. Zernio IDs are auto-resolved to External Post analytics.
23497
23497
  */
23498
23498
  postId?: string;
23499
23499
  /**
23500
- * Filter by profile ID (default "all")
23500
+ * Filter by profile ID (default "all"). With a native postId, selects that profile's copy of the post.
23501
23501
  */
23502
23502
  profileId?: string;
23503
23503
  /**
@@ -29139,6 +29139,10 @@ type ConnectAdsData = {
29139
29139
  *
29140
29140
  */
29141
29141
  adAccountIds?: Array<(string)>;
29142
+ /**
29143
+ * Welcome screen only: your product name in its heading. Same rules as on GET /v1/connect/{platform}.
29144
+ */
29145
+ brandName?: string;
29142
29146
  /**
29143
29147
  * Force a fresh OAuth even when an account already exists.
29144
29148
  *
@@ -29158,6 +29162,10 @@ type ConnectAdsData = {
29158
29162
  * Meta ads authorization mode. Business login is opt-in for Facebook and Instagram; classic preserves the posting-account flow.
29159
29163
  */
29160
29164
  loginMode?: 'classic' | 'business';
29165
+ /**
29166
+ * Welcome screen only: https URL of your square logo. Rejected with 400 `INVALID_FIELD_VALUE` when the welcome screen is not shown.
29167
+ */
29168
+ logoUrl?: string;
29161
29169
  /**
29162
29170
  * Business login only. Facebook Page ID to select from the token grants for ad creatives and lead forms.
29163
29171
  */
@@ -29172,6 +29180,10 @@ type ConnectAdsData = {
29172
29180
  *
29173
29181
  */
29174
29182
  permissionLevel?: 'full' | 'advertise';
29183
+ /**
29184
+ * Welcome screen only: hex colour (`#RRGGBB`) of its button.
29185
+ */
29186
+ primaryColor?: string;
29175
29187
  /**
29176
29188
  * Your Zernio profile ID
29177
29189
  */
@@ -29193,6 +29205,20 @@ type ConnectAdsData = {
29193
29205
  *
29194
29206
  */
29195
29207
  redirect_url?: string;
29208
+ /**
29209
+ * When `true`, `authUrl` opens on the Zernio-hosted welcome screen with your brand, as on GET /v1/connect/{platform}, naming the ads platform ("<brandName> wants to connect to your Meta Ads").
29210
+ *
29211
+ * - With no `redirect_url`, the flow ends on the branded result page instead of the Zernio dashboard.
29212
+ * - Shown only with `welcome=true`: the workspace's saved "on by default" (`PUT /v1/connect/welcome-screen`) applies to GET /v1/connect/{platform} only, so ads links behave as before unless you opt in. The saved brand still fills in what the call leaves out.
29213
+ * - Cannot be combined with `headless=true` (400 `INVALID_FIELD_VALUE`).
29214
+ * - Responses with `alreadyConnected: true` carry no `authUrl`, so they show no screen.
29215
+ *
29216
+ */
29217
+ welcome?: boolean;
29218
+ /**
29219
+ * Welcome screen only: a URL-encoded JSON object restyling and rewording the welcome screen and the result page, with the keys documented on GET /v1/connect/{platform}. Rejected when the welcome screen is not shown.
29220
+ */
29221
+ welcomeTheme?: string;
29196
29222
  };
29197
29223
  };
29198
29224
  type ConnectAdsResponse = (({
package/dist/index.d.ts CHANGED
@@ -23469,7 +23469,7 @@ type ValidateSubredditError = (ErrorResponse | unknown);
23469
23469
  type GetAnalyticsData = {
23470
23470
  query?: {
23471
23471
  /**
23472
- * Filter by account ID
23472
+ * Filter by account ID. With a native postId, selects that account's copy of the post.
23473
23473
  */
23474
23474
  accountId?: string;
23475
23475
  /**
@@ -23493,11 +23493,11 @@ type GetAnalyticsData = {
23493
23493
  */
23494
23494
  platform?: string;
23495
23495
  /**
23496
- * Returns analytics for a single post. Accepts both Zernio Post IDs and External Post IDs. Zernio IDs are auto-resolved to External Post analytics.
23496
+ * Returns analytics for a single post. Accepts Zernio Post IDs, External Post IDs and the platform's native post ID. Zernio IDs are auto-resolved to External Post analytics.
23497
23497
  */
23498
23498
  postId?: string;
23499
23499
  /**
23500
- * Filter by profile ID (default "all")
23500
+ * Filter by profile ID (default "all"). With a native postId, selects that profile's copy of the post.
23501
23501
  */
23502
23502
  profileId?: string;
23503
23503
  /**
@@ -29139,6 +29139,10 @@ type ConnectAdsData = {
29139
29139
  *
29140
29140
  */
29141
29141
  adAccountIds?: Array<(string)>;
29142
+ /**
29143
+ * Welcome screen only: your product name in its heading. Same rules as on GET /v1/connect/{platform}.
29144
+ */
29145
+ brandName?: string;
29142
29146
  /**
29143
29147
  * Force a fresh OAuth even when an account already exists.
29144
29148
  *
@@ -29158,6 +29162,10 @@ type ConnectAdsData = {
29158
29162
  * Meta ads authorization mode. Business login is opt-in for Facebook and Instagram; classic preserves the posting-account flow.
29159
29163
  */
29160
29164
  loginMode?: 'classic' | 'business';
29165
+ /**
29166
+ * Welcome screen only: https URL of your square logo. Rejected with 400 `INVALID_FIELD_VALUE` when the welcome screen is not shown.
29167
+ */
29168
+ logoUrl?: string;
29161
29169
  /**
29162
29170
  * Business login only. Facebook Page ID to select from the token grants for ad creatives and lead forms.
29163
29171
  */
@@ -29172,6 +29180,10 @@ type ConnectAdsData = {
29172
29180
  *
29173
29181
  */
29174
29182
  permissionLevel?: 'full' | 'advertise';
29183
+ /**
29184
+ * Welcome screen only: hex colour (`#RRGGBB`) of its button.
29185
+ */
29186
+ primaryColor?: string;
29175
29187
  /**
29176
29188
  * Your Zernio profile ID
29177
29189
  */
@@ -29193,6 +29205,20 @@ type ConnectAdsData = {
29193
29205
  *
29194
29206
  */
29195
29207
  redirect_url?: string;
29208
+ /**
29209
+ * When `true`, `authUrl` opens on the Zernio-hosted welcome screen with your brand, as on GET /v1/connect/{platform}, naming the ads platform ("<brandName> wants to connect to your Meta Ads").
29210
+ *
29211
+ * - With no `redirect_url`, the flow ends on the branded result page instead of the Zernio dashboard.
29212
+ * - Shown only with `welcome=true`: the workspace's saved "on by default" (`PUT /v1/connect/welcome-screen`) applies to GET /v1/connect/{platform} only, so ads links behave as before unless you opt in. The saved brand still fills in what the call leaves out.
29213
+ * - Cannot be combined with `headless=true` (400 `INVALID_FIELD_VALUE`).
29214
+ * - Responses with `alreadyConnected: true` carry no `authUrl`, so they show no screen.
29215
+ *
29216
+ */
29217
+ welcome?: boolean;
29218
+ /**
29219
+ * Welcome screen only: a URL-encoded JSON object restyling and rewording the welcome screen and the result page, with the keys documented on GET /v1/connect/{platform}. Rejected when the welcome screen is not shown.
29220
+ */
29221
+ welcomeTheme?: string;
29196
29222
  };
29197
29223
  };
29198
29224
  type ConnectAdsResponse = (({
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.1406",
39
+ version: "0.2.1408",
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.1406",
8
+ version: "0.2.1408",
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.1406",
3
+ "version": "0.2.1408",
4
4
  "description": "The official Node.js library for the Zernio API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -22161,7 +22161,7 @@ export type ValidateSubredditError = (ErrorResponse | unknown);
22161
22161
  export type GetAnalyticsData = {
22162
22162
  query?: {
22163
22163
  /**
22164
- * Filter by account ID
22164
+ * Filter by account ID. With a native postId, selects that account's copy of the post.
22165
22165
  */
22166
22166
  accountId?: string;
22167
22167
  /**
@@ -22185,11 +22185,11 @@ export type GetAnalyticsData = {
22185
22185
  */
22186
22186
  platform?: string;
22187
22187
  /**
22188
- * Returns analytics for a single post. Accepts both Zernio Post IDs and External Post IDs. Zernio IDs are auto-resolved to External Post analytics.
22188
+ * Returns analytics for a single post. Accepts Zernio Post IDs, External Post IDs and the platform's native post ID. Zernio IDs are auto-resolved to External Post analytics.
22189
22189
  */
22190
22190
  postId?: string;
22191
22191
  /**
22192
- * Filter by profile ID (default "all")
22192
+ * Filter by profile ID (default "all"). With a native postId, selects that profile's copy of the post.
22193
22193
  */
22194
22194
  profileId?: string;
22195
22195
  /**
@@ -28200,6 +28200,10 @@ export type ConnectAdsData = {
28200
28200
  *
28201
28201
  */
28202
28202
  adAccountIds?: Array<(string)>;
28203
+ /**
28204
+ * Welcome screen only: your product name in its heading. Same rules as on GET /v1/connect/{platform}.
28205
+ */
28206
+ brandName?: string;
28203
28207
  /**
28204
28208
  * Force a fresh OAuth even when an account already exists.
28205
28209
  *
@@ -28219,6 +28223,10 @@ export type ConnectAdsData = {
28219
28223
  * Meta ads authorization mode. Business login is opt-in for Facebook and Instagram; classic preserves the posting-account flow.
28220
28224
  */
28221
28225
  loginMode?: 'classic' | 'business';
28226
+ /**
28227
+ * Welcome screen only: https URL of your square logo. Rejected with 400 `INVALID_FIELD_VALUE` when the welcome screen is not shown.
28228
+ */
28229
+ logoUrl?: string;
28222
28230
  /**
28223
28231
  * Business login only. Facebook Page ID to select from the token grants for ad creatives and lead forms.
28224
28232
  */
@@ -28233,6 +28241,10 @@ export type ConnectAdsData = {
28233
28241
  *
28234
28242
  */
28235
28243
  permissionLevel?: 'full' | 'advertise';
28244
+ /**
28245
+ * Welcome screen only: hex colour (`#RRGGBB`) of its button.
28246
+ */
28247
+ primaryColor?: string;
28236
28248
  /**
28237
28249
  * Your Zernio profile ID
28238
28250
  */
@@ -28254,6 +28266,20 @@ export type ConnectAdsData = {
28254
28266
  *
28255
28267
  */
28256
28268
  redirect_url?: string;
28269
+ /**
28270
+ * When `true`, `authUrl` opens on the Zernio-hosted welcome screen with your brand, as on GET /v1/connect/{platform}, naming the ads platform ("<brandName> wants to connect to your Meta Ads").
28271
+ *
28272
+ * - With no `redirect_url`, the flow ends on the branded result page instead of the Zernio dashboard.
28273
+ * - Shown only with `welcome=true`: the workspace's saved "on by default" (`PUT /v1/connect/welcome-screen`) applies to GET /v1/connect/{platform} only, so ads links behave as before unless you opt in. The saved brand still fills in what the call leaves out.
28274
+ * - Cannot be combined with `headless=true` (400 `INVALID_FIELD_VALUE`).
28275
+ * - Responses with `alreadyConnected: true` carry no `authUrl`, so they show no screen.
28276
+ *
28277
+ */
28278
+ welcome?: boolean;
28279
+ /**
28280
+ * Welcome screen only: a URL-encoded JSON object restyling and rewording the welcome screen and the result page, with the keys documented on GET /v1/connect/{platform}. Rejected when the welcome screen is not shown.
28281
+ */
28282
+ welcomeTheme?: string;
28257
28283
  };
28258
28284
  };
28259
28285