zelf-sdk 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d948897bb81022c440c848f71c2ce80b9584399ba05f71c116851872dd02da00
-  data.tar.gz: 527540f8d27cbf861e2f0ce5074ac3c0dac4e63df46066adcbcf6b001bdee478
+  metadata.gz: 1798e110726c0d5c4db798a7f722e2a16612b4ac8ebba151b9730a3d18dd50f1
+  data.tar.gz: 10f37bc7ba93a27619a04d02ce4b0d04f7da2337c58bba6269b54f53ae33ee9c
 SHA512:
-  metadata.gz: 24a574903b9793393e2d1bee281af5c79bd160204bbb1371e4daadaf81a13fbe0299e86cdd369be6bc2f85f59f83ff860db329a531795633bc964e759f7fa60f
-  data.tar.gz: 0ab78f10d9af08b4b357405fd2503a1a8d9dbefca7b93fdbca5c1f688c91b52d852fd8e1546d2dfc55cab6589d3a5fab047bcac4476097c935e5af90f1cc7c3f
+  metadata.gz: 7e975684d679027cdd19ab783be132ac664b0938c5c79e538d88814127a716f523e4f4ea3a28b9ba591e432ba698042b4780256011656a8b5a8b506e756ee02e
+  data.tar.gz: 11ab4d79a6a439d54b8950a434c18092574e4ab2223a98b485fa9e1c953fe755dcc7758164ce689aa74c01d06affc385d8b7ee4135f396778c911af8f00d4e90

data/lib/zelf/models.rb

@@ -108,6 +108,8 @@ module Zelf
     class BrandStatistics < Zelf::Model; end
     class Comment < Zelf::Model; end
     class CommentAuthor < Zelf::Model; end
+    class CommentCategory < Zelf::Model; end
+    class CommentStatistics < Zelf::Model; end
     class Content < Zelf::Model; end
     class ContentActionRequestRequest < Zelf::Model; end
     class ContentActionResponse < Zelf::Model; end
@@ -143,8 +145,6 @@ module Zelf
     class FollowerTimeseries < Zelf::Model; end
     class PatchedBrandUpdateRequest < Zelf::Model; end
     class PatchedWebhookSubscriptionUpdateRequest < Zelf::Model; end
-    class PostedCommentCategory < Zelf::Model; end
-    class PostedComments < Zelf::Model; end
     class ResultFile < Zelf::Model; end
     class SafetyCheckRequest < Zelf::Model; end
     class Usage < Zelf::Model; end
@@ -433,6 +433,26 @@ module Zelf
       field :profile_picture_url, "profile_picture_url"
     end
 
+    # Comments the brand posted on one category of content.
+    class CommentCategory
+      # brand, owned, competitors, themes or other
+      field :category, "category"
+      # Comments posted on this category
+      field :comments, "comments"
+      # Likes those comments received
+      field :likes, "likes"
+      # Replies those comments received
+      field :replies, "replies"
+    end
+
+    # Comments the brand posted, split by the content they were posted on.
+    class CommentStatistics
+      # Comments the brand posted in the window, across every category
+      field :total_comments_posted, "total_comments_posted"
+      # One entry per category
+      field :categories, "categories", cast: [CommentCategory]
+    end
+
     # A piece of content (a post, video, or image) and its metrics.
     class Content
       # Unique identifier for this piece of content
@@ -487,10 +507,10 @@ module Zelf
       field :transcript, "transcript"
       # Direct URL to the post on its platform
       field :platform_url, "platform_url"
-      # Short AI-generated summary of the content
-      field :ai_summary, "ai_summary"
       # The search term the content was most recently found by
       field :last_keyword, "last_keyword"
+      # Short AI-generated summary of the content
+      field :ai_summary, "ai_summary"
       # Hashtags used in the post, normalized to lowercase and without the leading #
       field :hashtags, "hashtags"
     end
@@ -1011,26 +1031,6 @@ module Zelf
       field :enabled, "enabled"
     end
 
-    # Comments the brand posted on one category of content.
-    class PostedCommentCategory
-      # brand, owned, competitors, themes or other
-      field :category, "category"
-      # Comments posted on this category
-      field :comments, "comments"
-      # Likes those comments received
-      field :likes, "likes"
-      # Replies those comments received
-      field :replies, "replies"
-    end
-
-    # Comments the brand posted, split by the content they were posted on.
-    class PostedComments
-      # Comments the brand posted in the window, across every category
-      field :total_comments_posted, "total_comments_posted"
-      # One entry per category
-      field :categories, "categories", cast: [PostedCommentCategory]
-    end
-
     # Signed, time-limited download of an analysis run's result payload.
     class ResultFile
       # Unix epoch seconds after which download_url expires

data/lib/zelf/resources/analytics.rb

@@ -8,10 +8,10 @@ module Zelf
       end
 
       # Compare Brand Performance. Returns one row of totals per brand: the top-level brand
-      # named by `brand_id`, followed by each of its competitor sub-brands. The statistics
-      # block matches `content.statistics`, so the same parsing works for both. `brand_id`
-      # must name a top-level brand. A sub-brand is refused with the id of the parent to use
-      # instead.
+      # named by `brand_id` first, then each of its competitor sub-brands by title. Theme
+      # sub-brands are not competitors and are left out. The statistics block matches
+      # `content.statistics`, so the same parsing works for both. `brand_id` must name a
+      # top-level brand. A sub-brand is refused with the id of the parent to use instead.
       #
       # Calls GET /api/v1/analytics/brand_comparison/ (analytics.brand_comparison).
       def brand_comparison(brand_id:, platform: nil, posted_after: nil, posted_before: nil, posted_within_days: nil, posted_within_hours: nil)
@@ -24,14 +24,14 @@ module Zelf
           "posted_within_hours" => posted_within_hours,
         }.reject { |_, value| value.nil? }
         envelope = @transport.request(:get, "/api/v1/analytics/brand_comparison/", query: query)
-        Zelf.one(envelope, Models::BrandComparison, "BrandComparison")
+        Zelf.rows(envelope, Models::BrandComparison)
       end
 
       # Get Brand Follower Time Series. Returns follower history for the top-level brand
-      # named by `brand_id` and each of its competitor sub-brands, bucketed by `period`. A
-      # brand appears only for the periods in which one of its owned handles was measured.
-      # Follower counts carry forward: a handle with no reading in a period keeps the last
-      # one recorded before it.
+      # named by `brand_id` first, then each of its competitor sub-brands by title, bucketed
+      # by `period`. A brand appears only for the periods in which one of its owned handles
+      # was measured. Follower counts carry forward: a handle with no reading in a period
+      # keeps the last one recorded before it.
       #
       # Calls GET /api/v1/analytics/follower_timeseries/ (analytics.follower_timeseries).
       def follower_timeseries(brand_id:, period: nil, platform: nil, posted_after: nil, posted_before: nil, posted_within_days: nil, posted_within_hours: nil)
@@ -45,27 +45,7 @@ module Zelf
           "posted_within_hours" => posted_within_hours,
         }.reject { |_, value| value.nil? }
         envelope = @transport.request(:get, "/api/v1/analytics/follower_timeseries/", query: query)
-        Zelf.one(envelope, Models::FollowerTimeseries, "FollowerTimeseries")
-      end
-
-      # Get Posted Comment Analytics. Returns the comments the brand posted in the window,
-      # grouped by the kind of content they were posted on, together with the likes and
-      # replies those comments received. These are comments the brand wrote, not comments
-      # left on its content; `comments.list` returns the latter. The five categories add up
-      # to `total_comments_posted`.
-      #
-      # Calls GET /api/v1/analytics/posted_comments/ (analytics.posted_comments).
-      def posted_comments(brand_id:, platform: nil, posted_after: nil, posted_before: nil, posted_within_days: nil, posted_within_hours: nil)
-        query = {
-          "brand_id" => brand_id,
-          "platform" => platform,
-          "posted_after" => posted_after,
-          "posted_before" => posted_before,
-          "posted_within_days" => posted_within_days,
-          "posted_within_hours" => posted_within_hours,
-        }.reject { |_, value| value.nil? }
-        envelope = @transport.request(:get, "/api/v1/analytics/posted_comments/", query: query)
-        Zelf.one(envelope, Models::PostedComments, "PostedComments")
+        Zelf.rows(envelope, Models::FollowerTimeseries)
       end
     end
   end

data/lib/zelf/resources/brand_accounts.rb

@@ -23,7 +23,7 @@ module Zelf
           "brand_id" => brand_id,
         }.reject { |_, value| value.nil? }
         envelope = @transport.request(:post, "/api/v1/brands/accounts/", body: body)
-        Zelf.rows(envelope, Models::BrandAccountGroups)
+        Zelf.one(envelope, Models::BrandAccountGroups, "BrandAccountGroups")
       end
 
       # List Brand Accounts. Returns a brand's tracked and influencer creator accounts, plus
@@ -39,7 +39,7 @@ module Zelf
           "brand_id" => brand_id,
         }.reject { |_, value| value.nil? }
         envelope = @transport.request(:get, "/api/v1/brands/accounts/", query: query)
-        Zelf.rows(envelope, Models::BrandAccountGroups)
+        Zelf.one(envelope, Models::BrandAccountGroups, "BrandAccountGroups")
       end
 
       # Remove Brand Accounts. Removes profiles from a brand's `tracked`, `influencer` or
@@ -58,7 +58,7 @@ module Zelf
           "brand_id" => brand_id,
         }.reject { |_, value| value.nil? }
         envelope = @transport.request(:delete, "/api/v1/brands/accounts/", body: body)
-        Zelf.rows(envelope, Models::BrandAccountGroups)
+        Zelf.one(envelope, Models::BrandAccountGroups, "BrandAccountGroups")
       end
     end
   end

data/lib/zelf/resources/engage.rb

@@ -0,0 +1,31 @@
+# Generated by codegen. Do not edit by hand.
+module Zelf
+  module Resources
+    # The engage endpoints.
+    class Engage
+      def initialize(transport)
+        @transport = transport
+      end
+
+      # Get Comment Statistics. Returns the comments the brand posted in the window, grouped
+      # by the kind of content they were posted on, together with the likes and replies
+      # those comments received. These are comments the brand wrote, not comments left on
+      # its content; `comments.list` returns the latter. The five categories add up to
+      # `total_comments_posted`.
+      #
+      # Calls GET /api/v1/engage/comment_statistics/ (engage.comment_statistics).
+      def comment_statistics(brand_id:, platform: nil, posted_after: nil, posted_before: nil, posted_within_days: nil, posted_within_hours: nil)
+        query = {
+          "brand_id" => brand_id,
+          "platform" => platform,
+          "posted_after" => posted_after,
+          "posted_before" => posted_before,
+          "posted_within_days" => posted_within_days,
+          "posted_within_hours" => posted_within_hours,
+        }.reject { |_, value| value.nil? }
+        envelope = @transport.request(:get, "/api/v1/engage/comment_statistics/", query: query)
+        Zelf.one(envelope, Models::CommentStatistics, "CommentStatistics")
+      end
+    end
+  end
+end

data/lib/zelf/version.rb

@@ -1,5 +1,5 @@
 # Generated by codegen. Do not edit by hand.
 
 module Zelf
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.2.0'.freeze
 end

data/lib/zelf.rb

@@ -16,11 +16,12 @@ require_relative 'zelf/resources/creator_sync'
 require_relative 'zelf/resources/creator_vetting'
 require_relative 'zelf/resources/creators'
 require_relative 'zelf/resources/detection'
+require_relative 'zelf/resources/engage'
 require_relative 'zelf/resources/sub_brands'
 require_relative 'zelf/resources/usage'
 require_relative 'zelf/resources/webhooks'
 
-# Ruby client for the ZelfAI APIs (spec version 1.1.0).
+# Ruby client for the ZelfAI APIs (spec version 1.2.0).
 module Zelf
   # Client for the ZelfAI APIs.
   #
@@ -28,7 +29,7 @@ module Zelf
   # ZELF_API_KEY environment variable. It is sent as the x-api-key header
   # and is kept out of inspect output.
   class Client
-    attr_reader :ai_analysis, :analytics, :brand_accounts, :brands, :comments, :content, :creator_sync, :creator_vetting, :creators, :detection, :sub_brands, :usage, :webhooks
+    attr_reader :ai_analysis, :analytics, :brand_accounts, :brands, :comments, :content, :creator_sync, :creator_vetting, :creators, :detection, :engage, :sub_brands, :usage, :webhooks
 
     def initialize(api_key: nil, base_url: nil, timeout: 60,
                    max_retries: 2, retry_writes: false, headers: {})
@@ -45,6 +46,7 @@ module Zelf
       @creator_vetting = Resources::CreatorVetting.new(@transport)
       @creators = Resources::Creators.new(@transport)
       @detection = Resources::Detection.new(@transport)
+      @engage = Resources::Engage.new(@transport)
       @sub_brands = Resources::SubBrands.new(@transport)
       @usage = Resources::Usage.new(@transport)
       @webhooks = Resources::Webhooks.new(@transport)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zelf-sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Zelf
@@ -31,6 +31,7 @@ files:
 - lib/zelf/resources/creator_vetting.rb
 - lib/zelf/resources/creators.rb
 - lib/zelf/resources/detection.rb
+- lib/zelf/resources/engage.rb
 - lib/zelf/resources/sub_brands.rb
 - lib/zelf/resources/usage.rb
 - lib/zelf/resources/webhooks.rb