zelf-sdk 1.1.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7dc5aa63857c8d396bdcbfa9cd168c29835cfa5f5944e45d112a9421a508bb4f
-  data.tar.gz: 72f2a544049cf5fad0c50ba0c32a4644dfbc03e9b39c73285602e3a91bbb8ec5
+  metadata.gz: 8ea6c46cc2c031f6dc4406875f1db335c201654f45c9837cf459b90ed3cb6cc5
+  data.tar.gz: e57d1efc5e789ff92489d3f4b039c896ca297057520f0846135f3bd05150e9f3
 SHA512:
-  metadata.gz: 8ad309f547e96a6b246dd6916343330f8e320438384798a1989318f3348cae191e74297b07b94aa4be82fe4c61097c61b99e43e667c6d3408e87192a9f8093b9
-  data.tar.gz: 571827d98e57f10d16dc9db5f41573514e7f432c625dce9f9a5730efb6c5a95e01c40ddf7b0a5c026e1171357e50dfccbfe4f1d507cace85b2e387e9e7db5195
+  metadata.gz: b821ee8a254d4efdda139485c8edcabfb697748558471a2d1e87d56f62ec0629d1116b3ec23ecfe617b425ec18cc9959db078cf375aacbbff4fcaaa262a1162b
+  data.tar.gz: bec3bf4f30a3cbba532e38686405c4e7ca07bcdfec073497e9d0c56d8ac6acfb03de35c43ee872b15ede25e01c7257025f5330f84db12a88e189e03152f902a1

data/lib/zelf/errors.rb

@@ -93,7 +93,7 @@ module Zelf
       detail = body['error'].is_a?(Hash) ? body['error'] : {}
       status = response.code.to_i
       klass = STATUS_MAP.fetch(status, APIError)
-      klass.new(detail['message'] || "HTTP #{status} from the ZelfAI API",
+      klass.new(detail['message'] || "HTTP #{status} from the Zelf API",
                 status: status, code: detail['code'],
                 details: detail['details'], log_id: body['log_id'])
     end

data/lib/zelf/models.rb

@@ -24,7 +24,7 @@ module Zelf
     # Accepted values for ContentFormEnum.
     ContentFormEnum = [
       "VIDEO",
-      "IMAGE",
+      "PHOTO",
     ].freeze
 
     # Accepted values for KindEnum.
@@ -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
@@ -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
@@ -1203,7 +1203,7 @@ module Zelf
       field :download_url, "download_url"
     end
 
-    # The outer payload ZelfAI POSTs to receivers, uniform across all pushes. Top-level
+    # The outer payload Zelf POSTs to receivers, uniform across all pushes. Top-level
     # fields are delivery metadata and remain identical across modes. `data` carries the
     # content; which key inside it is populated (`files` or `items`) is determined by
     # `delivery_mode`. `manifest` deliveries use `data.files`, while `inline` event pushes
@@ -1215,7 +1215,7 @@ module Zelf
       field :type, "type"
       # Id of the subscription that produced this push
       field :subscription_id, "subscription_id"
-      # Unix epoch seconds at which ZelfAI sent this push
+      # Unix epoch seconds at which Zelf sent this push
       field :delivered_at, "delivered_at"
       # true for production data; false for test deliveries
       field :livemode, "livemode"

data/lib/zelf/resources/analytics.rb

@@ -47,26 +47,6 @@ module Zelf
         envelope = @transport.request(:get, "/api/v1/analytics/follower_timeseries/", query: query)
         Zelf.rows(envelope, Models::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")
-      end
     end
   end
 end

data/lib/zelf/resources/creator_vetting.rb

@@ -102,7 +102,7 @@ module Zelf
       # `time_seconds`. It also gives each source a `channels` status: `present`, `absent`
       # or `unknown` (not checked). Disclosures are not counted as violations. Limits: only
       # videos up to 10 minutes are checked; on-screen text is read from sampled frames, so
-      # text shown only briefly can be missed; videos ZelfAI analyzed before the request are
+      # text shown only briefly can be missed; videos Zelf analyzed before the request are
       # not re-analyzed for disclosures. An empty `evidence` list does not confirm that a
       # video has no disclosure. Detection reports what was stated; it does not assess legal
       # compliance.

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/transport.rb

@@ -4,7 +4,7 @@ require 'uri'
 require 'time'
 
 module Zelf
-  # The production ZelfAI API.
+  # The production Zelf API.
   DEFAULT_BASE_URL = 'https://api.hellozelf.com'.freeze
   # Read when no key is passed explicitly.
   API_KEY_ENV = 'ZELF_API_KEY'.freeze

data/lib/zelf/version.rb

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

data/lib/zelf/webhooks.rb

@@ -7,7 +7,7 @@ require 'openssl'
 require 'uri'
 
 module Zelf
-  # Verifies and routes the deliveries ZelfAI posts to a receiver.
+  # Verifies and routes the deliveries Zelf posts to a receiver.
   module Webhooks
     SIGNATURE_HEADER = 'Webhook-Signature'.freeze
     TIMESTAMP_HEADER = 'Webhook-Timestamp'.freeze

data/lib/zelf.rb

@@ -16,19 +16,20 @@ 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 Zelf APIs (spec version 1.3.0).
 module Zelf
-  # Client for the ZelfAI APIs.
+  # Client for the Zelf APIs.
   #
   # The key comes from the api_key: argument, falling back to the
   # 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.1
+  version: 1.3.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
@@ -61,5 +62,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: Ruby client for the ZelfAI APIs
+summary: Ruby client for the Zelf APIs
 test_files: []