zelf-sdk 1.0.0

data/lib/zelf/resources/creator_sync.rb

@@ -0,0 +1,57 @@
+# Generated by codegen. Do not edit by hand.
+module Zelf
+  module Resources
+    # The creator_sync endpoints.
+    class CreatorSync
+      def initialize(transport)
+        @transport = transport
+      end
+
+      # Create Creator Sync. Add a creator's profile and posts to Zelf so their videos can
+      # be analyzed. Send the creator's `profile_url`. Zelf reads and stores the profile and
+      # the creator's own posts, which then appear in `creators.list` and `content.list`.
+      # Syncing is asynchronous. This method returns immediately with the sync at `status:
+      # SYNCING`. Poll `creator_sync.get` until `status` is `SUCCESS` or `FAILED`. Only the
+      # creator's own posts are synced. Reposts and posts they are tagged in are not. Synced
+      # content is not attached to your brand, so it does not appear in brand-scoped totals.
+      #
+      # Calls POST /api/v1/creator_sync/ (creator_sync.create).
+      def create(profile_url:)
+        body = {
+          "profile_url" => profile_url,
+        }.reject { |_, value| value.nil? }
+        envelope = @transport.request(:post, "/api/v1/creator_sync/", body: body)
+        Zelf.one(envelope, Models::CreatorSync, "CreatorSync")
+      end
+
+      # Get Creator Sync. Returns a single creator sync job identified by `id`, the value
+      # returned by `creator_sync.create` or reported by a vetting as `sync_job_id`. Poll it
+      # until `status` reports `SUCCESS` or `FAILED`.
+      #
+      # Calls GET /api/v1/creator_sync/{id}/ (creator_sync.get).
+      def get(id)
+        path_params = { "id" => id }
+        envelope = @transport.request(:get, "/api/v1/creator_sync/{id}/", path_params: path_params)
+        Zelf.one(envelope, Models::CreatorSync, "CreatorSync")
+      end
+
+      # List Creator Syncs. Returns creator sync jobs ordered newest first, each with its
+      # current `status`. Use it to monitor progress after `creator_sync.create`. Possible
+      # statuses are `SCHEDULED`, `SYNCING`, `SUCCESS` and `FAILED`. A job's `creator_id` is
+      # `null` until the creator has been resolved, and then corresponds to the `id` filter
+      # on `creators.list`. Syncs started by `creator_vetting` are listed here too; a
+      # vetting reports its own sync as `sync_job_id`.
+      #
+      # Calls GET /api/v1/creator_sync/ (creator_sync.list).
+      def list(page: nil, page_size: nil)
+        query = {
+          "page" => page,
+          "page_size" => page_size,
+        }.reject { |_, value| value.nil? }
+        envelope = @transport.request(:get, "/api/v1/creator_sync/", query: query)
+        path = @transport.resolve_path("/api/v1/creator_sync/".dup, {})
+        Zelf::Page.new(envelope, Models::CreatorSync, @transport, path, query)
+      end
+    end
+  end
+end

data/lib/zelf/resources/creator_vetting.rb

@@ -0,0 +1,124 @@
+# Generated by codegen. Do not edit by hand.
+module Zelf
+  module Resources
+    # The creator_vetting endpoints.
+    class CreatorVetting
+      def initialize(transport)
+        @transport = transport
+      end
+
+      # Get Creator Vetting Content Statistics. Returns aggregate totals (post count, views,
+      # engagement, earned media value, and unique creators) over the content tied to a
+      # creator vetting. Requires `vetting_id` (a vetting `id` from `creator_vetting.list`)
+      # and returns the same totals shape as `content.statistics`.
+      #
+      # Calls GET /api/v1/creator/vetting/contents/statistics/ (creator_vetting.content_statistics).
+      def content_statistics(vetting_id:)
+        query = {
+          "vetting_id" => vetting_id,
+        }.reject { |_, value| value.nil? }
+        envelope = @transport.request(:get, "/api/v1/creator/vetting/contents/statistics/", query: query)
+        Zelf.one(envelope, Models::ContentStatistics, "ContentStatistics")
+      end
+
+      # List Creator Vetting Content. Returns the content tied to a creator vetting, in the
+      # standard content shape. Use it to inspect the specific posts behind a vetting.
+      # Requires `vetting_id` (a vetting `id` from `creator_vetting.list`). Brand-scoped
+      # fields (`is_owned`, `is_tagged`, `net_promoter_score`, ...) are `null` in this
+      # response.
+      #
+      # Calls GET /api/v1/creator/vetting/contents/ (creator_vetting.contents).
+      def contents(vetting_id:, page: nil, page_size: nil)
+        query = {
+          "page" => page,
+          "page_size" => page_size,
+          "vetting_id" => vetting_id,
+        }.reject { |_, value| value.nil? }
+        envelope = @transport.request(:get, "/api/v1/creator/vetting/contents/", query: query)
+        path = @transport.resolve_path("/api/v1/creator/vetting/contents/".dup, {})
+        Zelf::Page.new(envelope, Models::Content, @transport, path, query)
+      end
+
+      # Create Creator Vetting. Vets a creator identified by `profile_url`, running or
+      # reusing the profile scrape and the AI safety and brand-fit analysis. Runs complete
+      # asynchronously, so this method returns immediately with the created vetting. The
+      # vetting analyzes up to 150 of the creator's posts per connection type, or the limit
+      # configured for your workspace. The created vetting is returned as the single item in
+      # `results`. Take its `id` and poll `creator_vetting.list` until a run reports
+      # `COMPLETED`. A vetting can take an hour or more to complete, so prefer the
+      # `creator_vetting.completed` webhook over frequent polling, which can trigger
+      # `RATE_LIMIT_EXCEEDED`. Once a run is complete, retrieve the payload from
+      # `creator_vetting.results`, passing `vetting_id=<id>`.
+      #
+      # Calls POST /api/v1/creator/vetting/ (creator_vetting.create).
+      def create(profile_url:, resync_profile: nil, content_scope: nil, safety_checks: nil)
+        body = {
+          "profile_url" => profile_url,
+          "resync_profile" => resync_profile,
+          "content_scope" => content_scope,
+          "safety_checks" => safety_checks,
+        }.reject { |_, value| value.nil? }
+        envelope = @transport.request(:post, "/api/v1/creator/vetting/", body: body)
+        Zelf.one(envelope, Models::CreatorVetting, "CreatorVetting")
+      end
+
+      # List Creator Vettings. Returns creator vettings ordered newest first, each with its
+      # analysis runs and their current `status`. Use it to discover vettings and monitor
+      # run progress without retrieving the full result payload. A vetting `id` corresponds
+      # to the `vetting_id` parameter on `creator_vetting.results` and
+      # `creator_vetting.contents`, and each run's `id` corresponds to the `id` parameter on
+      # `creator_vetting.results`. The run `result` download is not included in this
+      # response; retrieve it from `creator_vetting.results` once a run reports `COMPLETED`.
+      # Possible statuses are `IN_PROGRESS`, `COMPLETED`, `EMPTY_RESULT`, and `FAILED`.
+      # Supply `creator_id` to filter to a single creator, or `id` to return a single
+      # vetting.
+      #
+      # Calls GET /api/v1/creator/vetting/ (creator_vetting.list).
+      def list(creator_id: nil, id: nil, page: nil, page_size: nil)
+        query = {
+          "creator_id" => creator_id,
+          "id" => id,
+          "page" => page,
+          "page_size" => page_size,
+        }.reject { |_, value| value.nil? }
+        envelope = @transport.request(:get, "/api/v1/creator/vetting/", query: query)
+        path = @transport.resolve_path("/api/v1/creator/vetting/".dup, {})
+        Zelf::Page.new(envelope, Models::CreatorVetting, @transport, path, query)
+      end
+
+      # Get Creator Vetting Results. Returns the `result` for each run: a signed, time-
+      # limited download of the vetting analysis payload. Call this method after a run
+      # reaches `COMPLETED`; for earlier statuses the row is returned with a `null`
+      # `result`. Supply `vetting_id` (the vetting `id` from `creator_vetting.list`) to
+      # return every run of that vetting, or `id` (a single run's `id`) to return one run.
+      # One of the two is required. A malformed identifier returns `INVALID_ID`; omitting
+      # both returns `VALIDATION_ERROR`. **Disclosures.*; When the vetting requested
+      # `DISCLOSURE`, the payload's `insight_json.disclosures` holds one entry per analyzed
+      # video: its `content_id` and a `result`. The `result` lists `evidence` items, each
+      # with the `source` it was found in (`frame` for on-screen text, `audio` for the
+      # speech transcription, `title`, `caption` or `metadata`), a `kind` (`sponsorship`,
+      # `affiliate`, `gifted` or `relationship` for a commercial relationship; `terms` or
+      # `risk` for offer conditions and warnings), the quoted `text` and, where known,
+      # `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
+      # 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.
+      #
+      # Calls GET /api/v1/creator/vetting/results/ (creator_vetting.results).
+      def results(id: nil, page: nil, page_size: nil, vetting_id: nil)
+        query = {
+          "id" => id,
+          "page" => page,
+          "page_size" => page_size,
+          "vetting_id" => vetting_id,
+        }.reject { |_, value| value.nil? }
+        envelope = @transport.request(:get, "/api/v1/creator/vetting/results/", query: query)
+        path = @transport.resolve_path("/api/v1/creator/vetting/results/".dup, {})
+        Zelf::Page.new(envelope, Models::CreatorVettingResult, @transport, path, query)
+      end
+    end
+  end
+end

data/lib/zelf/resources/creators.rb

@@ -0,0 +1,33 @@
+# Generated by codegen. Do not edit by hand.
+module Zelf
+  module Resources
+    # The creators endpoints.
+    class Creators
+      def initialize(transport)
+        @transport = transport
+      end
+
+      # List Creators. Returns creators across the platforms Zelf supports. At least one of
+      # `id`, `username`, or `email` must be supplied to scope the search. Results can be
+      # ordered with `order_by` (`follower_count`, `id`). The `id` of each creator
+      # corresponds to the `creator_id` filter on `creator_vetting.list`. Requests that
+      # supply none of the required filters return `INVALID_ID`.
+      #
+      # Calls GET /api/v1/creator/ (creators.list).
+      def list(email: nil, id: nil, order_by: nil, page: nil, page_size: nil, platform: nil, username: nil)
+        query = {
+          "email" => email,
+          "id" => id,
+          "order_by" => order_by,
+          "page" => page,
+          "page_size" => page_size,
+          "platform" => platform,
+          "username" => username,
+        }.reject { |_, value| value.nil? }
+        envelope = @transport.request(:get, "/api/v1/creator/", query: query)
+        path = @transport.resolve_path("/api/v1/creator/".dup, {})
+        Zelf::Page.new(envelope, Models::Creator, @transport, path, query)
+      end
+    end
+  end
+end

data/lib/zelf/resources/detection.rb

@@ -0,0 +1,89 @@
+# Generated by codegen. Do not edit by hand.
+module Zelf
+  module Resources
+    # The detection endpoints.
+    class Detection
+      def initialize(transport)
+        @transport = transport
+      end
+
+      # Detect brands in a video. Detects a list of brands in one video. Zelf Detection
+      # reads the whole video and finds each scene where a brand is identifiable: its logo
+      # or name is visible (on a product, on packaging or in on-screen text) or the brand is
+      # named out loud. Every appearance (placement) comes back with its timestamp, what was
+      # detected and how confident the detection is. Send the brands in
+      # `context.hints.brands`. Identify the video with `content_id` (a video already in
+      # Zelf) or `content_url` (a link to any supported video). Sending both, or neither,
+      # returns `VALIDATION_ERROR`. A `content_url` that is not in Zelf yet is added first,
+      # which makes the detection take longer. **Limits*; ; One video per request, up to 90
+      # minutes. YouTube, TikTok and Instagram videos. Photo posts are not supported.; A
+      # product with no visible logo or name, and no spoken mention, is not detected.;
+      # `content_url`: the full video link, not a short link (`vm.tiktok.com`,
+      # `vt.tiktok.com`, `tiktok.com/t/`). Supported forms: `youtube.com/watch?v=<id>`,
+      # `youtu.be/<id>`, `youtube.com/shorts/<id>`, `tiktok.com/@<handle>/video/<id>`,
+      # `instagram.com/reel/<id>`, `/p/<id>`, `/tv/<id>`.; `context.hints.brands`: 1 to 200
+      # brands. No two names that differ only by punctuation or digits.;
+      # `context.hints.brands[].name`: up to 60 characters.;
+      # `context.hints.brands[].identifiers`: 2 to 10, each 2 to 200 characters, including
+      # the brand name.; `context.hints.brands[].negatives`: optional, up to 12, each up to
+      # 200 characters. A request that breaks a rule returns `VALIDATION_ERROR` for the
+      # first rule it breaks. `error.details.field` names the field, for example
+      # `context.hints.brands[3].identifiers`, and `error.details.code` is one of
+      # `INVALID_REQUEST`, `NO_BRANDS`, `TOO_MANY_BRANDS`, `INVALID_BRAND`,
+      # `IDENTIFIER_COUNT`, `IDENTIFIER_TOO_SHORT`, `UNSUPPORTED_URL`, `SHORT_LINK`,
+      # `PHOTO_POST` or `VIDEO_TOO_LONG`. Detection is asynchronous. This method returns
+      # immediately with the detection at `status: SCHEDULED`. Poll `detection.get` until
+      # `status` is `SUCCESS` or `FAILED`; both are final.
+      #
+      # Calls POST /api/v1/detection/ (detection.create).
+      def create(context:, content_id: nil, content_url: nil)
+        body = {
+          "context" => context,
+          "content_id" => content_id,
+          "content_url" => content_url,
+        }.reject { |_, value| value.nil? }
+        envelope = @transport.request(:post, "/api/v1/detection/", body: body)
+        Zelf.one(envelope, Models::Detection, "Detection")
+      end
+
+      # Retrieve a detection and its placements. Retrieve one detection by `id`, the value
+      # returned by `detection.create`. Poll it until `status` is `SUCCESS` or `FAILED`;
+      # both are final. `result` is `null` until then. On `FAILED`, `result` carries the
+      # counts and `brands: []`. **Reading `result`*; ; `brands`: one entry per requested
+      # brand, in request order. `found: false` means the brand was searched for and does
+      # not appear in the video.; `timestamp`: `mm:ss-mm:ss`, or `mm:ss` for a single
+      # moment. Past an hour the minutes keep counting (`69:23-69:25`).; `modality`:
+      # `Visual` (logo or product on screen), `Text` (brand name written on screen) or
+      # `Audio` (brand name spoken).; `confidence`: `confirmed` means the placement passed a
+      # final check against the video's frames; `review` means it was detected but did not
+      # pass that final frame check. `Audio` placements are always `review`, because a
+      # spoken mention has no frames to check. On `Visual` and `Text` placements, `review`
+      # means the final frame check did not confirm the placement.;
+      # `video_url_at_timestamp`: YouTube only, opens the video 5 seconds before the
+      # placement. `null` on TikTok and Instagram.
+      #
+      # Calls GET /api/v1/detection/{id}/ (detection.get).
+      def get(id)
+        path_params = { "id" => id }
+        envelope = @transport.request(:get, "/api/v1/detection/{id}/", path_params: path_params)
+        Zelf.one(envelope, Models::Detection, "Detection")
+      end
+
+      # List detections and their status. Lists detections, newest first. Each detection has
+      # its current `status` and, once finished, its placements in `result`. Possible
+      # statuses are `SCHEDULED`, `IN_PROGRESS`, `SUCCESS` and `FAILED`. `SUCCESS` and
+      # `FAILED` are final.
+      #
+      # Calls GET /api/v1/detection/ (detection.list).
+      def list(page: nil, page_size: nil)
+        query = {
+          "page" => page,
+          "page_size" => page_size,
+        }.reject { |_, value| value.nil? }
+        envelope = @transport.request(:get, "/api/v1/detection/", query: query)
+        path = @transport.resolve_path("/api/v1/detection/".dup, {})
+        Zelf::Page.new(envelope, Models::Detection, @transport, path, query)
+      end
+    end
+  end
+end

data/lib/zelf/resources/sub_brands.rb

@@ -0,0 +1,33 @@
+# Generated by codegen. Do not edit by hand.
+module Zelf
+  module Resources
+    # The sub_brands endpoints.
+    class SubBrands
+      def initialize(transport)
+        @transport = transport
+      end
+
+      # Create Sub-brand. Creates a sub-brand under the workspace brand. A sub-brand tracks
+      # a competitor (`COMPETITIVE`) or a content theme (`THEME`) separately. A brand may
+      # have at most 64 sub-brands; requests beyond this limit are rejected. The new brand's
+      # `id` is the value to supply as `brand_id` elsewhere.
+      #
+      # Calls POST /api/v1/brands/ (sub_brands.create).
+      def create(title:, sub_brand_type:, search_terms: nil, inclusion_terms: nil, exclusion_terms: nil, compound_inclusion_terms: nil, influencer_terms: nil, allowed_languages: nil, boolean_query: nil)
+        body = {
+          "title" => title,
+          "sub_brand_type" => sub_brand_type,
+          "search_terms" => search_terms,
+          "inclusion_terms" => inclusion_terms,
+          "exclusion_terms" => exclusion_terms,
+          "compound_inclusion_terms" => compound_inclusion_terms,
+          "influencer_terms" => influencer_terms,
+          "allowed_languages" => allowed_languages,
+          "boolean_query" => boolean_query,
+        }.reject { |_, value| value.nil? }
+        envelope = @transport.request(:post, "/api/v1/brands/", body: body)
+        Zelf.one(envelope, Models::Brand, "Brand")
+      end
+    end
+  end
+end

data/lib/zelf/resources/usage.rb

@@ -0,0 +1,26 @@
+# Generated by codegen. Do not edit by hand.
+module Zelf
+  module Resources
+    # The usage endpoints.
+    class Usage
+      def initialize(transport)
+        @transport = transport
+      end
+
+      # Get Usage. Live consumption for your brand, per group and per window. Both sections
+      # come back however you call: `api` groups count requests made with an API key, `mcp`
+      # groups count the ones an AI client makes, and the two never share a counter.
+      # `authenticated_as` says which of them the current credentials spend. A window
+      # appears only when a limit is configured for it, so a brand with no monthly limit has
+      # no monthly row. Ask an administrator to set one and it appears here with no further
+      # work. `reset_in` counts down to the end of the current window, which starts on its
+      # first request rather than on the clock. Reading this consumes no quota.
+      #
+      # Calls GET /api/v1/usage/ (usage.retrieve).
+      def retrieve
+        envelope = @transport.request(:get, "/api/v1/usage/")
+        Zelf.one(envelope, Models::Usage, "Usage")
+      end
+    end
+  end
+end

data/lib/zelf/resources/webhooks.rb

@@ -0,0 +1,199 @@
+# Generated by codegen. Do not edit by hand.
+module Zelf
+  module Resources
+    # The webhooks endpoints.
+    class Webhooks
+      def initialize(transport)
+        @transport = transport
+      end
+
+      # Create Webhook Secret. Creates a signing secret for the brand. The full `secret` is
+      # returned only once.
+      #
+      # Calls POST /api/v1/webhooks/secrets/ (webhooks.create_secret).
+      def create_secret(kind: nil, make_default: nil)
+        body = {
+          "kind" => kind,
+          "make_default" => make_default,
+        }.reject { |_, value| value.nil? }
+        envelope = @transport.request(:post, "/api/v1/webhooks/secrets/", body: body)
+        Zelf.one(envelope, Models::WebhookSecretCreated, "WebhookSecretCreated")
+      end
+
+      # Create Webhook Subscription. Creates a webhook subscription for your brand. The full
+      # signing `secret` is returned only once, in this response. A brand may hold at most
+      # one `event` subscription.
+      #
+      # Calls POST /api/v1/webhooks/subscriptions/ (webhooks.create_subscription).
+      def create_subscription(url:, kind: nil, resource: nil, event_types: nil, resource_filters: nil, custom_headers: nil, interval_hours: nil, max_items: nil, secret_type: nil)
+        body = {
+          "url" => url,
+          "kind" => kind,
+          "resource" => resource,
+          "event_types" => event_types,
+          "resource_filters" => resource_filters,
+          "custom_headers" => custom_headers,
+          "interval_hours" => interval_hours,
+          "max_items" => max_items,
+          "secret_type" => secret_type,
+        }.reject { |_, value| value.nil? }
+        envelope = @transport.request(:post, "/api/v1/webhooks/subscriptions/", body: body)
+        Zelf.one(envelope, Models::WebhookSubscriptionCreated, "WebhookSubscriptionCreated")
+      end
+
+      # Delete Webhook Secret. Deactivates a secret. The default secret, or one still linked
+      # to a subscription, cannot be deleted.
+      #
+      # Calls DELETE /api/v1/webhooks/secrets/{secret_id}/ (webhooks.delete_secret).
+      def delete_secret(secret_id)
+        path_params = { "secret_id" => secret_id }
+        envelope = @transport.request(:delete, "/api/v1/webhooks/secrets/{secret_id}/", path_params: path_params)
+        Zelf.one(envelope, Models::WebhookDeleteAcknowledgement, "WebhookDeleteAcknowledgement")
+      end
+
+      # Delete Webhook Subscription. Deletes a subscription. This is destructive: the
+      # subscription stops receiving deliveries.
+      #
+      # Calls DELETE /api/v1/webhooks/subscriptions/{subscription_id}/ (webhooks.delete_subscription).
+      def delete_subscription(subscription_id)
+        path_params = { "subscription_id" => subscription_id }
+        envelope = @transport.request(:delete, "/api/v1/webhooks/subscriptions/{subscription_id}/", path_params: path_params)
+        Zelf.one(envelope, Models::WebhookDeleteAcknowledgement, "WebhookDeleteAcknowledgement")
+      end
+
+      # Get Webhook Delivery. Returns a single delivery attempt.
+      #
+      # Calls GET /api/v1/webhooks/deliveries/{delivery_id}/ (webhooks.get_delivery).
+      def get_delivery(delivery_id)
+        path_params = { "delivery_id" => delivery_id }
+        envelope = @transport.request(:get, "/api/v1/webhooks/deliveries/{delivery_id}/", path_params: path_params)
+        Zelf.one(envelope, Models::WebhookDelivery, "WebhookDelivery")
+      end
+
+      # Get Webhook Secret. Returns a single secret.
+      #
+      # Calls GET /api/v1/webhooks/secrets/{secret_id}/ (webhooks.get_secret).
+      def get_secret(secret_id)
+        path_params = { "secret_id" => secret_id }
+        envelope = @transport.request(:get, "/api/v1/webhooks/secrets/{secret_id}/", path_params: path_params)
+        Zelf.one(envelope, Models::WebhookSecret, "WebhookSecret")
+      end
+
+      # Get Webhook Subscription. Returns a single subscription.
+      #
+      # Calls GET /api/v1/webhooks/subscriptions/{subscription_id}/ (webhooks.get_subscription).
+      def get_subscription(subscription_id)
+        path_params = { "subscription_id" => subscription_id }
+        envelope = @transport.request(:get, "/api/v1/webhooks/subscriptions/{subscription_id}/", path_params: path_params)
+        Zelf.one(envelope, Models::WebhookSubscription, "WebhookSubscription")
+      end
+
+      # List Webhook Deliveries. Lists webhook delivery attempts for the brand, newest
+      # first. Filter by `subscription` (masked id), `state`, and a `created_after` /
+      # `created_before` window.
+      #
+      # Calls GET /api/v1/webhooks/deliveries/ (webhooks.list_deliveries).
+      def list_deliveries(created: nil, created_after: nil, created_before: nil, page: nil, page_size: nil, sort_by: nil, state: nil, state_not: nil, subscription: nil)
+        query = {
+          "created" => created,
+          "created_after" => created_after,
+          "created_before" => created_before,
+          "page" => page,
+          "page_size" => page_size,
+          "sort_by" => sort_by,
+          "state" => state,
+          "state!" => state_not,
+          "subscription" => subscription,
+        }.reject { |_, value| value.nil? }
+        envelope = @transport.request(:get, "/api/v1/webhooks/deliveries/", query: query)
+        path = @transport.resolve_path("/api/v1/webhooks/deliveries/".dup, {})
+        Zelf::Page.new(envelope, Models::WebhookDelivery, @transport, path, query)
+      end
+
+      # List Available Webhook Events. Lists the event types an event subscription can
+      # listen for.
+      #
+      # Calls GET /api/v1/webhooks/events/ (webhooks.list_events).
+      def list_events
+        envelope = @transport.request(:get, "/api/v1/webhooks/events/")
+        Zelf.rows(envelope, Models::WebhookAvailableEvent)
+      end
+
+      # List Webhook Secrets. Lists the brand's active secrets.
+      #
+      # Calls GET /api/v1/webhooks/secrets/ (webhooks.list_secrets).
+      def list_secrets(page: nil, page_size: nil)
+        query = {
+          "page" => page,
+          "page_size" => page_size,
+        }.reject { |_, value| value.nil? }
+        envelope = @transport.request(:get, "/api/v1/webhooks/secrets/", query: query)
+        path = @transport.resolve_path("/api/v1/webhooks/secrets/".dup, {})
+        Zelf::Page.new(envelope, Models::WebhookSecret, @transport, path, query)
+      end
+
+      # List Webhook Subscriptions. Returns the webhook subscriptions owned by your brand,
+      # newest first.
+      #
+      # Calls GET /api/v1/webhooks/subscriptions/ (webhooks.list_subscriptions).
+      def list_subscriptions(page: nil, page_size: nil)
+        query = {
+          "page" => page,
+          "page_size" => page_size,
+        }.reject { |_, value| value.nil? }
+        envelope = @transport.request(:get, "/api/v1/webhooks/subscriptions/", query: query)
+        path = @transport.resolve_path("/api/v1/webhooks/subscriptions/".dup, {})
+        Zelf::Page.new(envelope, Models::WebhookSubscription, @transport, path, query)
+      end
+
+      # Rotate Webhook Subscription Secret. Mints a new signing secret for the subscription
+      # and returns the full `secret` once. Deliveries after this use the new secret.
+      #
+      # Calls POST /api/v1/webhooks/subscriptions/{subscription_id}/rotate_secret/ (webhooks.rotate_subscription_secret).
+      def rotate_subscription_secret(subscription_id)
+        path_params = { "subscription_id" => subscription_id }
+        envelope = @transport.request(:post, "/api/v1/webhooks/subscriptions/{subscription_id}/rotate_secret/", path_params: path_params)
+        Zelf.one(envelope, Models::WebhookSubscriptionCreated, "WebhookSubscriptionCreated")
+      end
+
+      # Send Test Webhook. Queues a test event to the subscription's URL so you can verify
+      # signing and parsing. Rate limited to 12 per hour per subscription. A disabled
+      # subscription is rejected.
+      #
+      # Calls POST /api/v1/webhooks/subscriptions/{subscription_id}/send_test/ (webhooks.send_test).
+      def send_test(subscription_id)
+        path_params = { "subscription_id" => subscription_id }
+        envelope = @transport.request(:post, "/api/v1/webhooks/subscriptions/{subscription_id}/send_test/", path_params: path_params)
+        nil
+      end
+
+      # Set Default Webhook Secret. Marks a secret as the brand's default for its kind.
+      #
+      # Calls POST /api/v1/webhooks/secrets/{secret_id}/set_default/ (webhooks.set_default_secret).
+      def set_default_secret(secret_id)
+        path_params = { "secret_id" => secret_id }
+        envelope = @transport.request(:post, "/api/v1/webhooks/secrets/{secret_id}/set_default/", path_params: path_params)
+        Zelf.one(envelope, Models::WebhookSecret, "WebhookSecret")
+      end
+
+      # Update Webhook Subscription. Partially updates a subscription's `url`,
+      # `custom_headers`, `resource_filters`, `interval_hours`, `max_items`, or `enabled`.
+      # `kind`, `resource`, and `event_types` are immutable after create.
+      #
+      # Calls PATCH /api/v1/webhooks/subscriptions/{subscription_id}/ (webhooks.update_subscription).
+      def update_subscription(subscription_id, url: nil, resource_filters: nil, custom_headers: nil, interval_hours: nil, max_items: nil, enabled: nil)
+        path_params = { "subscription_id" => subscription_id }
+        body = {
+          "url" => url,
+          "resource_filters" => resource_filters,
+          "custom_headers" => custom_headers,
+          "interval_hours" => interval_hours,
+          "max_items" => max_items,
+          "enabled" => enabled,
+        }.reject { |_, value| value.nil? }
+        envelope = @transport.request(:patch, "/api/v1/webhooks/subscriptions/{subscription_id}/", path_params: path_params, body: body)
+        Zelf.one(envelope, Models::WebhookSubscription, "WebhookSubscription")
+      end
+    end
+  end
+end