late-sdk 0.0.681 → 0.0.682

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41c5dacaef01dfb7cff9a704d423e689678d13a09c7974e4c4645c7dec108bec
-  data.tar.gz: f0f7b99d63f4290cb5cd6a991091caa12c1162da411e93ff57f903cdcbc59422
+  metadata.gz: 476de2764b955cb602604845141be530e2aab850ad9bd0c915ca75b0e9efbe2e
+  data.tar.gz: 74cde0d1a14ca577510cb7bf6d4c4b461225344ef35e62a1858c6afbb7032063
 SHA512:
-  metadata.gz: 8a1bb79d897abd033a8222213053ad729188cb8fc930a16b88e658d00232aa0dc68d0b4ce5390a1eebcc03075ddaa577e295db5a7b2f79feee8ce597748e3ffa
-  data.tar.gz: 730ed362bed1290577e93ec9265012cb2a7317d2881e27033dac506d62ff360b5e0498c941c1c5d76fc88eff234d1c2e15a1e9f021d103119ed441363e30ad0a
+  metadata.gz: '08b9195fc96cf88dffe2b1aa174b79ea05837c1cebc4bd1780030e4f954a221c44355b97fb4ad2aa79727e3463bb001824cec92f28c92ad8acd3fa0c54acdc89'
+  data.tar.gz: b15379bd7f9ba352a9111b1cf0fd6879dae8977a94abd6fff5106999b8f3e995472df58d5380a7b3691acade63db3f107edef472ba2d1a0c55d3b37cb400cb07

data/README.md

@@ -624,6 +624,8 @@ Class | Method | HTTP request | Description
  - [Zernio::AdCampaignCampaignBudget](docs/AdCampaignCampaignBudget.md)
  - [Zernio::AdCreative](docs/AdCreative.md)
  - [Zernio::AdDailyMetrics](docs/AdDailyMetrics.md)
+ - [Zernio::AdEngagementCounts](docs/AdEngagementCounts.md)
+ - [Zernio::AdFunnelCounts](docs/AdFunnelCounts.md)
  - [Zernio::AdMetrics](docs/AdMetrics.md)
  - [Zernio::AdPromotedObject](docs/AdPromotedObject.md)
  - [Zernio::AdReviewStatus](docs/AdReviewStatus.md)

data/docs/Ad.md

@@ -11,6 +11,7 @@
 | **configured_status** | **String** | The ad's own on/off toggle as configured on the platform (Meta `configured_status`: ACTIVE / PAUSED), unaffected by ancestor (ad set / campaign) pauses. Distinct from `status`, which is the ancestor-cascaded delivery status. Only present for Meta ads synced after this field was added. | [optional] |
 | **review_status** | [**AdReviewStatus**](AdReviewStatus.md) | Platform review state of this ad, independent of delivery `status` / `configuredStatus`. Absent when the platform reports no review signal. | [optional] |
 | **ad_type** | **String** |  | [optional] |
+| **creative_type** | **String** | Creative format, classified from the media the creative carries. `null` when the creative carries no media to classify — an unsynced creative and a genuine text-only ad are indistinguishable, so neither is guessed at. Returned by `GET /v1/ads`, `GET /v1/ads/{adId}` and the ad nodes of `GET /v1/ads/tree`. | [optional] |
 | **goal** | **String** | Available goals vary by platform. Meta (Facebook/Instagram) supports all 9 (incl. `lead_conversion` = website pixel lead optimization and `catalog_sales` = Advantage+ catalog ads). TikTok supports the 7 non-`lead_conversion` goals. LinkedIn supports all except app_promotion / lead_conversion. Twitter/X supports engagement, traffic, awareness, video_views, app_promotion. Pinterest and Google Ads support only engagement, traffic, awareness, video_views. | [optional] |
 | **is_external** | **Boolean** | True for ads synced from platform ad managers | [optional] |
 | **budget** | [**AdBudget**](AdBudget.md) |  | [optional] |
@@ -51,6 +52,7 @@ instance = Zernio::Ad.new(
   configured_status: ACTIVE,
   review_status: null,
   ad_type: null,
+  creative_type: video,
   goal: null,
   is_external: null,
   budget: null,

data/docs/AdDailyMetrics.md

@@ -27,6 +27,9 @@
 | **video_p95_watched_actions** | **Integer** | Views reaching 95% of the video's length. Meta `video_p95_watched_actions`. | [optional] |
 | **video_p100_watched_actions** | **Integer** | Views reaching 100% of the video's length. Meta `video_p100_watched_actions`. | [optional] |
 | **video_avg_time_watched_actions** | **Float** | Average seconds watched per play (Meta `video_avg_time_watched_actions`). Aggregated over date ranges and across children as a play-weighted average (total watch time / total plays), never a plain average of averages. | [optional] |
+| **cost_per_thruplay** | **Float** | Derived `spend / videoThruplayWatchedActions`, in ad-account native currency. Rounded to 4 decimals rather than the usual 2 because a ThruPlay routinely costs well under a cent. 0 when the ad has no ThruPlays. | [optional] |
+| **funnel** | [**AdFunnelCounts**](AdFunnelCounts.md) |  | [optional] |
+| **engagement_breakdown** | [**AdEngagementCounts**](AdEngagementCounts.md) |  | [optional] |
 | **last_synced_at** | **Time** | Present on individual ads only, not on campaign aggregations | [optional] |
 | **date** | **Date** | Calendar day (YYYY-MM-DD) these metrics apply to. | [optional] |
 
@@ -59,6 +62,9 @@ instance = Zernio::AdDailyMetrics.new(
   video_p95_watched_actions: null,
   video_p100_watched_actions: null,
   video_avg_time_watched_actions: null,
+  cost_per_thruplay: null,
+  funnel: null,
+  engagement_breakdown: null,
   last_synced_at: null,
   date: null
 )

data/docs/AdEngagementCounts.md

@@ -0,0 +1,34 @@
+# Zernio::AdEngagementCounts
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **post_engagement** | **Integer** | Meta's own post-engagement total (`post_engagement`). | [optional] |
+| **page_engagement** | **Integer** | Meta's own page-engagement total (`page_engagement`). | [optional] |
+| **reactions** | **Integer** | Reactions on the ad's post (`post_reaction`). | [optional] |
+| **comments** | **Integer** | Comments on the ad's post. | [optional] |
+| **shares** | **Integer** | Shares of the ad's post. Meta reports these under the action type literally named `post`. | [optional] |
+| **saves** | **Integer** | Saves of the ad's post (`onsite_conversion.post_save`). | [optional] |
+| **page_likes** | **Integer** | New Page likes attributed to the ad (`like`). | [optional] |
+| **video_views** | **Integer** | 3-second video views (`video_view`). For completion-based counts use `videoThruplayWatchedActions`. | [optional] |
+| **link_clicks** | **Integer** | Attributed link clicks (`link_click`). This is the attribution-window count, which differs from the in-session `inline_link_clicks` reported by `GET /v1/ads/{adId}/analytics`. | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::AdEngagementCounts.new(
+  post_engagement: null,
+  page_engagement: null,
+  reactions: null,
+  comments: null,
+  shares: null,
+  saves: null,
+  page_likes: null,
+  video_views: null,
+  link_clicks: null
+)
+```
+

data/docs/AdFunnelCounts.md

@@ -0,0 +1,42 @@
+# Zernio::AdFunnelCounts
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **landing_page_views** | **Integer** | Landing page views — the visitor actually loaded the destination, unlike a link click. Meta `landing_page_view`. | [optional] |
+| **content_views** | **Integer** | Content views (Meta `ViewContent` pixel event). | [optional] |
+| **searches** | **Integer** | On-site searches (Meta `Search` pixel event). | [optional] |
+| **wishlist_adds** | **Integer** | Adds to wishlist (Meta `AddToWishlist` pixel event). | [optional] |
+| **cart_adds** | **Integer** | Adds to cart (Meta `AddToCart` pixel event). | [optional] |
+| **checkouts_initiated** | **Integer** | Checkouts started (Meta `InitiateCheckout` pixel event). | [optional] |
+| **payment_info_adds** | **Integer** | Payment details added at checkout (Meta `AddPaymentInfo` pixel event). | [optional] |
+| **purchases** | **Integer** | Purchases (Meta `Purchase` pixel event). Pair with `purchaseValue` for revenue. | [optional] |
+| **leads** | **Integer** | Leads, from either the website pixel or an instant form — whichever the ad uses. | [optional] |
+| **registrations_completed** | **Integer** | Completed registrations (Meta `CompleteRegistration` pixel event). | [optional] |
+| **app_installs** | **Integer** | Mobile app installs attributed to the ad. | [optional] |
+| **messaging_conversations_started** | **Integer** | Messaging conversations started within 7 days — the headline metric for click-to-WhatsApp and click-to-Messenger ads. | [optional] |
+| **messaging_first_replies** | **Integer** | Messaging threads where the person sent a first reply. | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::AdFunnelCounts.new(
+  landing_page_views: null,
+  content_views: null,
+  searches: null,
+  wishlist_adds: null,
+  cart_adds: null,
+  checkouts_initiated: null,
+  payment_info_adds: null,
+  purchases: null,
+  leads: null,
+  registrations_completed: null,
+  app_installs: null,
+  messaging_conversations_started: null,
+  messaging_first_replies: null
+)
+```
+

data/docs/AdMetrics.md

@@ -27,6 +27,9 @@
 | **video_p95_watched_actions** | **Integer** | Views reaching 95% of the video's length. Meta `video_p95_watched_actions`. | [optional] |
 | **video_p100_watched_actions** | **Integer** | Views reaching 100% of the video's length. Meta `video_p100_watched_actions`. | [optional] |
 | **video_avg_time_watched_actions** | **Float** | Average seconds watched per play (Meta `video_avg_time_watched_actions`). Aggregated over date ranges and across children as a play-weighted average (total watch time / total plays), never a plain average of averages. | [optional] |
+| **cost_per_thruplay** | **Float** | Derived `spend / videoThruplayWatchedActions`, in ad-account native currency. Rounded to 4 decimals rather than the usual 2 because a ThruPlay routinely costs well under a cent. 0 when the ad has no ThruPlays. | [optional] |
+| **funnel** | [**AdFunnelCounts**](AdFunnelCounts.md) |  | [optional] |
+| **engagement_breakdown** | [**AdEngagementCounts**](AdEngagementCounts.md) |  | [optional] |
 | **last_synced_at** | **Time** | Present on individual ads only, not on campaign aggregations | [optional] |
 
 ## Example
@@ -58,6 +61,9 @@ instance = Zernio::AdMetrics.new(
   video_p95_watched_actions: null,
   video_p100_watched_actions: null,
   video_avg_time_watched_actions: null,
+  cost_per_thruplay: null,
+  funnel: null,
+  engagement_breakdown: null,
   last_synced_at: null
 )
 ```

data/docs/GetCampaignAnalytics200ResponseAnalyticsDailyInner.md

@@ -27,6 +27,9 @@
 | **video_p95_watched_actions** | **Integer** | Views reaching 95% of the video's length. Meta `video_p95_watched_actions`. | [optional] |
 | **video_p100_watched_actions** | **Integer** | Views reaching 100% of the video's length. Meta `video_p100_watched_actions`. | [optional] |
 | **video_avg_time_watched_actions** | **Float** | Average seconds watched per play (Meta `video_avg_time_watched_actions`). Aggregated over date ranges and across children as a play-weighted average (total watch time / total plays), never a plain average of averages. | [optional] |
+| **cost_per_thruplay** | **Float** | Derived `spend / videoThruplayWatchedActions`, in ad-account native currency. Rounded to 4 decimals rather than the usual 2 because a ThruPlay routinely costs well under a cent. 0 when the ad has no ThruPlays. | [optional] |
+| **funnel** | [**AdFunnelCounts**](AdFunnelCounts.md) |  | [optional] |
+| **engagement_breakdown** | [**AdEngagementCounts**](AdEngagementCounts.md) |  | [optional] |
 | **last_synced_at** | **Time** | Present on individual ads only, not on campaign aggregations | [optional] |
 | **date** | **Date** |  | [optional] |
 
@@ -59,6 +62,9 @@ instance = Zernio::GetCampaignAnalytics200ResponseAnalyticsDailyInner.new(
   video_p95_watched_actions: null,
   video_p100_watched_actions: null,
   video_avg_time_watched_actions: null,
+  cost_per_thruplay: null,
+  funnel: null,
+  engagement_breakdown: null,
   last_synced_at: null,
   date: null
 )

data/docs/WebhookEventsApi.md

@@ -1963,7 +1963,7 @@ nil (empty response body)
 
 Post recycled event
 
-Fired when a post is recycled (cloned and re-scheduled for publishing).
+Fired when a post is recycled (cloned and re-scheduled for publishing). The new clone also fires a post.scheduled event.
 
 ### Examples
 
@@ -2031,7 +2031,7 @@ nil (empty response body)
 
 Post scheduled event
 
-Fired when a post is created and scheduled for publishing.
+Fired whenever a post enters the scheduled state: created with a schedule, added to a queue, a draft promoted to scheduled or queued, a failed or partial post retried, or a recycled clone created. Not fired when an already-scheduled post is edited or rescheduled.
 
 ### Examples
 

data/lib/zernio-sdk/api/webhook_events_api.rb

@@ -1868,7 +1868,7 @@ module Zernio
     end
 
     # Post recycled event
-    # Fired when a post is recycled (cloned and re-scheduled for publishing).
+    # Fired when a post is recycled (cloned and re-scheduled for publishing). The new clone also fires a post.scheduled event.
     # @param webhook_payload_post [WebhookPayloadPost] 
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -1878,7 +1878,7 @@ module Zernio
     end
 
     # Post recycled event
-    # Fired when a post is recycled (cloned and re-scheduled for publishing).
+    # Fired when a post is recycled (cloned and re-scheduled for publishing). The new clone also fires a post.scheduled event.
     # @param webhook_payload_post [WebhookPayloadPost] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -1934,7 +1934,7 @@ module Zernio
     end
 
     # Post scheduled event
-    # Fired when a post is created and scheduled for publishing.
+    # Fired whenever a post enters the scheduled state: created with a schedule, added to a queue, a draft promoted to scheduled or queued, a failed or partial post retried, or a recycled clone created. Not fired when an already-scheduled post is edited or rescheduled.
     # @param webhook_payload_post [WebhookPayloadPost] 
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -1944,7 +1944,7 @@ module Zernio
     end
 
     # Post scheduled event
-    # Fired when a post is created and scheduled for publishing.
+    # Fired whenever a post enters the scheduled state: created with a schedule, added to a queue, a draft promoted to scheduled or queued, a failed or partial post retried, or a recycled clone created. Not fired when an already-scheduled post is edited or rescheduled.
     # @param webhook_payload_post [WebhookPayloadPost] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

data/lib/zernio-sdk/models/ad.rb

@@ -32,6 +32,9 @@ module Zernio
 
     attr_accessor :ad_type
 
+    # Creative format, classified from the media the creative carries. `null` when the creative carries no media to classify — an unsynced creative and a genuine text-only ad are indistinguishable, so neither is guessed at. Returned by `GET /v1/ads`, `GET /v1/ads/{adId}` and the ad nodes of `GET /v1/ads/tree`.
+    attr_accessor :creative_type
+
     # Available goals vary by platform. Meta (Facebook/Instagram) supports all 9 (incl. `lead_conversion` = website pixel lead optimization and `catalog_sales` = Advantage+ catalog ads). TikTok supports the 7 non-`lead_conversion` goals. LinkedIn supports all except app_promotion / lead_conversion. Twitter/X supports engagement, traffic, awareness, video_views, app_promotion. Pinterest and Google Ads support only engagement, traffic, awareness, video_views.
     attr_accessor :goal
 
@@ -127,6 +130,7 @@ module Zernio
         :'configured_status' => :'configuredStatus',
         :'review_status' => :'reviewStatus',
         :'ad_type' => :'adType',
+        :'creative_type' => :'creativeType',
         :'goal' => :'goal',
         :'is_external' => :'isExternal',
         :'budget' => :'budget',
@@ -176,6 +180,7 @@ module Zernio
         :'configured_status' => :'String',
         :'review_status' => :'AdReviewStatus',
         :'ad_type' => :'String',
+        :'creative_type' => :'String',
         :'goal' => :'String',
         :'is_external' => :'Boolean',
         :'budget' => :'AdBudget',
@@ -209,6 +214,7 @@ module Zernio
     def self.openapi_nullable
       Set.new([
         :'configured_status',
+        :'creative_type',
         :'metrics',
         :'platform_objective',
         :'optimization_goal',
@@ -265,6 +271,10 @@ module Zernio
         self.ad_type = attributes[:'ad_type']
       end
 
+      if attributes.key?(:'creative_type')
+        self.creative_type = attributes[:'creative_type']
+      end
+
       if attributes.key?(:'goal')
         self.goal = attributes[:'goal']
       end
@@ -388,6 +398,8 @@ module Zernio
       return false unless platform_validator.valid?(@platform)
       ad_type_validator = EnumAttributeValidator.new('String', ["boost", "standalone"])
       return false unless ad_type_validator.valid?(@ad_type)
+      creative_type_validator = EnumAttributeValidator.new('String', ["carousel", "video", "document", "image"])
+      return false unless creative_type_validator.valid?(@creative_type)
       goal_validator = EnumAttributeValidator.new('String', ["engagement", "traffic", "awareness", "video_views", "lead_generation", "lead_conversion", "conversions", "app_promotion", "catalog_sales", "job_applicants"])
       return false unless goal_validator.valid?(@goal)
       true
@@ -413,6 +425,16 @@ module Zernio
       @ad_type = ad_type
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] creative_type Object to be assigned
+    def creative_type=(creative_type)
+      validator = EnumAttributeValidator.new('String', ["carousel", "video", "document", "image"])
+      unless validator.valid?(creative_type)
+        fail ArgumentError, "invalid value for \"creative_type\", must be one of #{validator.allowable_values}."
+      end
+      @creative_type = creative_type
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] goal Object to be assigned
     def goal=(goal)
@@ -435,6 +457,7 @@ module Zernio
           configured_status == o.configured_status &&
           review_status == o.review_status &&
           ad_type == o.ad_type &&
+          creative_type == o.creative_type &&
           goal == o.goal &&
           is_external == o.is_external &&
           budget == o.budget &&
@@ -472,7 +495,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [_id, name, platform, status, configured_status, review_status, ad_type, goal, is_external, budget, metrics, platform_ad_id, platform_ad_account_id, platform_campaign_id, platform_ad_set_id, campaign_name, ad_set_name, platform_objective, optimization_goal, cost_type, serving_statuses, platform_ad_account_name, platform_created_at, bid_strategy, bid_amount, roas_average_floor, promoted_object, creative, targeting, schedule, rejection_reason, created_at, updated_at].hash
+      [_id, name, platform, status, configured_status, review_status, ad_type, creative_type, goal, is_external, budget, metrics, platform_ad_id, platform_ad_account_id, platform_campaign_id, platform_ad_set_id, campaign_name, ad_set_name, platform_objective, optimization_goal, cost_type, serving_statuses, platform_ad_account_name, platform_created_at, bid_strategy, bid_amount, roas_average_floor, promoted_object, creative, targeting, schedule, rejection_reason, created_at, updated_at].hash
     end
 
     # Builds the object from hash

data/lib/zernio-sdk/models/ad_daily_metrics.rb

@@ -81,6 +81,13 @@ module Zernio
     # Average seconds watched per play (Meta `video_avg_time_watched_actions`). Aggregated over date ranges and across children as a play-weighted average (total watch time / total plays), never a plain average of averages.
     attr_accessor :video_avg_time_watched_actions
 
+    # Derived `spend / videoThruplayWatchedActions`, in ad-account native currency. Rounded to 4 decimals rather than the usual 2 because a ThruPlay routinely costs well under a cent. 0 when the ad has no ThruPlays.
+    attr_accessor :cost_per_thruplay
+
+    attr_accessor :funnel
+
+    attr_accessor :engagement_breakdown
+
     # Present on individual ads only, not on campaign aggregations
     attr_accessor :last_synced_at
 
@@ -113,6 +120,9 @@ module Zernio
         :'video_p95_watched_actions' => :'videoP95WatchedActions',
         :'video_p100_watched_actions' => :'videoP100WatchedActions',
         :'video_avg_time_watched_actions' => :'videoAvgTimeWatchedActions',
+        :'cost_per_thruplay' => :'costPerThruplay',
+        :'funnel' => :'funnel',
+        :'engagement_breakdown' => :'engagementBreakdown',
         :'last_synced_at' => :'lastSyncedAt',
         :'date' => :'date'
       }
@@ -154,6 +164,9 @@ module Zernio
         :'video_p95_watched_actions' => :'Integer',
         :'video_p100_watched_actions' => :'Integer',
         :'video_avg_time_watched_actions' => :'Float',
+        :'cost_per_thruplay' => :'Float',
+        :'funnel' => :'AdFunnelCounts',
+        :'engagement_breakdown' => :'AdEngagementCounts',
         :'last_synced_at' => :'Time',
         :'date' => :'Date'
       }
@@ -284,6 +297,18 @@ module Zernio
         self.video_avg_time_watched_actions = attributes[:'video_avg_time_watched_actions']
       end
 
+      if attributes.key?(:'cost_per_thruplay')
+        self.cost_per_thruplay = attributes[:'cost_per_thruplay']
+      end
+
+      if attributes.key?(:'funnel')
+        self.funnel = attributes[:'funnel']
+      end
+
+      if attributes.key?(:'engagement_breakdown')
+        self.engagement_breakdown = attributes[:'engagement_breakdown']
+      end
+
       if attributes.key?(:'last_synced_at')
         self.last_synced_at = attributes[:'last_synced_at']
       end
@@ -336,6 +361,9 @@ module Zernio
           video_p95_watched_actions == o.video_p95_watched_actions &&
           video_p100_watched_actions == o.video_p100_watched_actions &&
           video_avg_time_watched_actions == o.video_avg_time_watched_actions &&
+          cost_per_thruplay == o.cost_per_thruplay &&
+          funnel == o.funnel &&
+          engagement_breakdown == o.engagement_breakdown &&
           last_synced_at == o.last_synced_at &&
           date == o.date
     end
@@ -349,7 +377,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [spend, impressions, reach, clicks, ctr, cpc, cpm, engagement, conversions, cost_per_conversion, actions, action_values, purchase_value, roas, video_play_actions, video30_sec_watched_actions, video_thruplay_watched_actions, video_p25_watched_actions, video_p50_watched_actions, video_p75_watched_actions, video_p95_watched_actions, video_p100_watched_actions, video_avg_time_watched_actions, last_synced_at, date].hash
+      [spend, impressions, reach, clicks, ctr, cpc, cpm, engagement, conversions, cost_per_conversion, actions, action_values, purchase_value, roas, video_play_actions, video30_sec_watched_actions, video_thruplay_watched_actions, video_p25_watched_actions, video_p50_watched_actions, video_p75_watched_actions, video_p95_watched_actions, video_p100_watched_actions, video_avg_time_watched_actions, cost_per_thruplay, funnel, engagement_breakdown, last_synced_at, date].hash
     end
 
     # Builds the object from hash

data/lib/zernio-sdk/models/ad_engagement_counts.rb

@@ -0,0 +1,229 @@
+=begin
+#Zernio API
+
+#API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api 
+
+The version of the OpenAPI document: 1.0.4
+Contact: support@zernio.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Zernio
+  # The single `engagement` total split into the interactions behind it.  Note that `engagement` is not the sum of these: Meta's own `post_engagement` and `page_engagement` totals already contain the individual interactions, and all of them are counted into `engagement`. Use these fields when you need a specific interaction, and `engagement` only as the coarse total it has always been.  Meta-only; other platforms leave these at 0. 
+  class AdEngagementCounts < ApiModelBase
+    # Meta's own post-engagement total (`post_engagement`).
+    attr_accessor :post_engagement
+
+    # Meta's own page-engagement total (`page_engagement`).
+    attr_accessor :page_engagement
+
+    # Reactions on the ad's post (`post_reaction`).
+    attr_accessor :reactions
+
+    # Comments on the ad's post.
+    attr_accessor :comments
+
+    # Shares of the ad's post. Meta reports these under the action type literally named `post`.
+    attr_accessor :shares
+
+    # Saves of the ad's post (`onsite_conversion.post_save`).
+    attr_accessor :saves
+
+    # New Page likes attributed to the ad (`like`).
+    attr_accessor :page_likes
+
+    # 3-second video views (`video_view`). For completion-based counts use `videoThruplayWatchedActions`.
+    attr_accessor :video_views
+
+    # Attributed link clicks (`link_click`). This is the attribution-window count, which differs from the in-session `inline_link_clicks` reported by `GET /v1/ads/{adId}/analytics`.
+    attr_accessor :link_clicks
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'post_engagement' => :'postEngagement',
+        :'page_engagement' => :'pageEngagement',
+        :'reactions' => :'reactions',
+        :'comments' => :'comments',
+        :'shares' => :'shares',
+        :'saves' => :'saves',
+        :'page_likes' => :'pageLikes',
+        :'video_views' => :'videoViews',
+        :'link_clicks' => :'linkClicks'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'post_engagement' => :'Integer',
+        :'page_engagement' => :'Integer',
+        :'reactions' => :'Integer',
+        :'comments' => :'Integer',
+        :'shares' => :'Integer',
+        :'saves' => :'Integer',
+        :'page_likes' => :'Integer',
+        :'video_views' => :'Integer',
+        :'link_clicks' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::AdEngagementCounts` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::AdEngagementCounts`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'post_engagement')
+        self.post_engagement = attributes[:'post_engagement']
+      end
+
+      if attributes.key?(:'page_engagement')
+        self.page_engagement = attributes[:'page_engagement']
+      end
+
+      if attributes.key?(:'reactions')
+        self.reactions = attributes[:'reactions']
+      end
+
+      if attributes.key?(:'comments')
+        self.comments = attributes[:'comments']
+      end
+
+      if attributes.key?(:'shares')
+        self.shares = attributes[:'shares']
+      end
+
+      if attributes.key?(:'saves')
+        self.saves = attributes[:'saves']
+      end
+
+      if attributes.key?(:'page_likes')
+        self.page_likes = attributes[:'page_likes']
+      end
+
+      if attributes.key?(:'video_views')
+        self.video_views = attributes[:'video_views']
+      end
+
+      if attributes.key?(:'link_clicks')
+        self.link_clicks = attributes[:'link_clicks']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          post_engagement == o.post_engagement &&
+          page_engagement == o.page_engagement &&
+          reactions == o.reactions &&
+          comments == o.comments &&
+          shares == o.shares &&
+          saves == o.saves &&
+          page_likes == o.page_likes &&
+          video_views == o.video_views &&
+          link_clicks == o.link_clicks
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [post_engagement, page_engagement, reactions, comments, shares, saves, page_likes, video_views, link_clicks].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end