@zernio/node 0.2.145 → 0.2.146

package/dist/index.d.mts

@@ -14129,6 +14129,10 @@ type GetAdsTimelineError = ({
 } | unknown);
 type GetAdData = {
     path: {
+        /**
+         * Zernio `_id` (hex), Meta `platformAdId` (numeric), or one of the creative's effective story/media IDs. See description for details.
+         *
+         */
         adId: string;
     };
 };

package/dist/index.d.ts

@@ -14129,6 +14129,10 @@ type GetAdsTimelineError = ({
 } | unknown);
 type GetAdData = {
     path: {
+        /**
+         * Zernio `_id` (hex), Meta `platformAdId` (numeric), or one of the creative's effective story/media IDs. See description for details.
+         *
+         */
         adId: string;
     };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zernio/node",
-  "version": "0.2.145",
+  "version": "0.2.146",
   "description": "The official Node.js library for the Zernio API",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

package/src/generated/sdk.gen.ts

@@ -3493,6 +3493,15 @@ export const getAdsTimeline = <ThrowOnError extends boolean = false>(options: Op
 /**
  * Get ad details
  * Returns an ad with its creative, targeting, status, and performance metrics.
+ *
+ * The `{adId}` path segment accepts any identifier dialect Zernio indexes for the ad:
+ * - the Zernio internal `_id` (24-char hex)
+ * - Meta's numeric `platformAdId` (the value shipped in `comment.received` webhooks as `comment.ad.id`)
+ * - the creative's `effective_object_story_id` (`{pageId}_{postId}` shape, Facebook side)
+ * - the creative's `effective_instagram_media_id` (Instagram side)
+ *
+ * Any of the four resolve to the same ad. Caller doesn't need a translation step.
+ *
  */
 export const getAd = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetAdData, ThrowOnError>) => {
     return (options?.client ?? client).get<GetAdResponse, GetAdError, ThrowOnError>({
@@ -3570,6 +3579,12 @@ export const getAdAnalytics = <ThrowOnError extends boolean = false>(options: Op
  *
  * Requires the Ads add-on. Response shape matches GET /v1/inbox/comments/{postId}.
  *
+ * The `{adId}` path segment accepts any identifier dialect Zernio indexes for the ad:
+ * Zernio internal `_id` (24-char hex), Meta's numeric `platformAdId` (the value shipped in
+ * `comment.received` webhooks as `comment.ad.id`), or the creative's
+ * `effective_object_story_id` / `effective_instagram_media_id`. Caller doesn't need a
+ * translation step.
+ *
  */
 export const getAdComments = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetAdCommentsData, ThrowOnError>) => {
     return (options?.client ?? client).get<GetAdCommentsResponse, GetAdCommentsError, ThrowOnError>({

package/src/generated/types.gen.ts

@@ -14457,6 +14457,10 @@ export type GetAdsTimelineError = ({
 
 export type GetAdData = {
     path: {
+        /**
+         * Zernio `_id` (hex), Meta `platformAdId` (numeric), or one of the creative's effective story/media IDs. See description for details.
+         *
+         */
         adId: string;
     };
 };