kit-rb 0.2.0 → 0.3.0

data/lib/kit/webhooks/events.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Kit
+  module Webhooks
+    # Event types a webhook endpoint (/v4/webhook_endpoints) can subscribe to,
+    # as listed at developers.kit.com/webhooks/event-types (verified
+    # 2026-09-06). Use these instead of hand-typed strings:
+    #
+    #   client.webhook_endpoints.create(url: url, events: [Events::SUBSCRIBER_CREATED, Events::TAG_CREATED])
+    #
+    # DATA_KEYS names the keys each event's `data` carries. PLANNED events are
+    # documented but not yet delivered.
+    module Events
+      SUBSCRIBER_CREATED = "subscriber.created"
+      SUBSCRIBER_ACTIVATED = "subscriber.activated"
+      SUBSCRIBER_UNSUBSCRIBED = "subscriber.unsubscribed"
+      SUBSCRIBER_BOUNCED = "subscriber.bounced"
+      SUBSCRIBER_COMPLAINED = "subscriber.complained"
+      SUBSCRIBER_SUBSCRIBED_TO_FORM = "subscriber.subscribed_to_form"
+      SUBSCRIBER_ADDED_TO_SEQUENCE = "subscriber.added_to_sequence"
+      SUBSCRIBER_SEQUENCE_COMPLETED = "subscriber.sequence_completed"
+      SUBSCRIBER_TAG_ADDED = "subscriber.tag_added"
+      SUBSCRIBER_TAG_REMOVED = "subscriber.tag_removed"
+      SUBSCRIBER_CUSTOM_FIELD_VALUE_UPDATED = "subscriber.custom_field_value_updated"
+      SUBSCRIBER_PRODUCT_PURCHASED = "subscriber.product_purchased" # planned
+      SUBSCRIBER_LINK_CLICKED = "subscriber.link_clicked"           # planned
+      SUBSCRIBER_EMAIL_OPENED = "subscriber.email_opened"           # planned
+      TAG_CREATED = "tag.created"
+      TAG_DELETED = "tag.deleted"
+      CUSTOM_FIELD_CREATED = "custom_field.created"
+      CUSTOM_FIELD_DELETED = "custom_field.deleted"
+      SEQUENCE_CREATED = "sequence.created"
+      SEQUENCE_DELETED = "sequence.deleted"
+      SEQUENCE_PUBLISHED = "sequence.published"
+      SEQUENCE_DISABLED = "sequence.disabled"
+      BROADCAST_CREATED = "broadcast.created"
+      BROADCAST_SENT = "broadcast.sent"
+      BROADCAST_DELETED = "broadcast.deleted"
+      POST_PUBLISHED = "post.published"
+      LANDING_PAGE_CREATED = "landing_page.created" # planned
+      LANDING_PAGE_DELETED = "landing_page.deleted" # planned
+
+      DATA_KEYS = {
+        SUBSCRIBER_CREATED => %w[subscriber], SUBSCRIBER_ACTIVATED => %w[subscriber],
+        SUBSCRIBER_UNSUBSCRIBED => %w[subscriber], SUBSCRIBER_BOUNCED => %w[subscriber],
+        SUBSCRIBER_COMPLAINED => %w[subscriber], SUBSCRIBER_SUBSCRIBED_TO_FORM => %w[subscriber form],
+        SUBSCRIBER_ADDED_TO_SEQUENCE => %w[subscriber sequence],
+        SUBSCRIBER_SEQUENCE_COMPLETED => %w[subscriber sequence],
+        SUBSCRIBER_TAG_ADDED => %w[subscriber tag], SUBSCRIBER_TAG_REMOVED => %w[subscriber tag],
+        SUBSCRIBER_CUSTOM_FIELD_VALUE_UPDATED => %w[subscriber custom_field],
+        SUBSCRIBER_PRODUCT_PURCHASED => %w[subscriber], SUBSCRIBER_LINK_CLICKED => %w[subscriber],
+        SUBSCRIBER_EMAIL_OPENED => %w[subscriber],
+        TAG_CREATED => %w[tag], TAG_DELETED => %w[tag],
+        CUSTOM_FIELD_CREATED => %w[custom_field], CUSTOM_FIELD_DELETED => %w[custom_field],
+        SEQUENCE_CREATED => %w[sequence], SEQUENCE_DELETED => %w[sequence],
+        SEQUENCE_PUBLISHED => %w[sequence], SEQUENCE_DISABLED => %w[sequence],
+        BROADCAST_CREATED => %w[broadcast], BROADCAST_SENT => %w[broadcast], BROADCAST_DELETED => %w[broadcast],
+        POST_PUBLISHED => %w[post],
+        LANDING_PAGE_CREATED => [], LANDING_PAGE_DELETED => []
+      }.freeze
+
+      PLANNED = [
+        SUBSCRIBER_PRODUCT_PURCHASED, SUBSCRIBER_LINK_CLICKED, SUBSCRIBER_EMAIL_OPENED,
+        LANDING_PAGE_CREATED, LANDING_PAGE_DELETED
+      ].freeze
+
+      ALL = DATA_KEYS.keys.freeze
+      AVAILABLE = (ALL - PLANNED).freeze
+    end
+
+    # Event names for the previous-generation /v4/webhooks (one event per
+    # webhook, unsigned). Kept for existing integrations; new ones should use
+    # webhook endpoints. REQUIRED_PARAM names the extra key the `event` hash
+    # must carry for the events that are scoped to a resource:
+    #
+    #   client.webhooks.create(target_url: url,
+    #                          event: { name: LegacyEvents::TAG_ADD, tag_id: 12 })
+    module LegacyEvents
+      SUBSCRIBER_ACTIVATE = "subscriber.subscriber_activate"
+      SUBSCRIBER_UNSUBSCRIBE = "subscriber.subscriber_unsubscribe"
+      SUBSCRIBER_BOUNCE = "subscriber.subscriber_bounce"
+      SUBSCRIBER_COMPLAIN = "subscriber.subscriber_complain"
+      FORM_SUBSCRIBE = "subscriber.form_subscribe"
+      COURSE_SUBSCRIBE = "subscriber.course_subscribe"
+      COURSE_COMPLETE = "subscriber.course_complete"
+      LINK_CLICK = "subscriber.link_click"
+      PRODUCT_PURCHASE = "subscriber.product_purchase"
+      TAG_ADD = "subscriber.tag_add"
+      TAG_REMOVE = "subscriber.tag_remove"
+      PURCHASE_CREATE = "purchase.purchase_create"
+      FIELD_CREATED = "custom_field.field_created"
+      FIELD_DELETED = "custom_field.field_deleted"
+      FIELD_VALUE_UPDATED = "custom_field.field_value_updated"
+
+      REQUIRED_PARAM = {
+        FORM_SUBSCRIBE => :form_id,
+        COURSE_SUBSCRIBE => :sequence_id,
+        COURSE_COMPLETE => :sequence_id,
+        LINK_CLICK => :initiator_value,
+        PRODUCT_PURCHASE => :product_id,
+        TAG_ADD => :tag_id,
+        TAG_REMOVE => :tag_id,
+        FIELD_VALUE_UPDATED => :custom_field_id
+      }.freeze
+
+      ALL = [
+        SUBSCRIBER_ACTIVATE, SUBSCRIBER_UNSUBSCRIBE, SUBSCRIBER_BOUNCE, SUBSCRIBER_COMPLAIN,
+        FORM_SUBSCRIBE, COURSE_SUBSCRIBE, COURSE_COMPLETE, LINK_CLICK, PRODUCT_PURCHASE,
+        TAG_ADD, TAG_REMOVE, PURCHASE_CREATE, FIELD_CREATED, FIELD_DELETED, FIELD_VALUE_UPDATED
+      ].freeze
+    end
+  end
+end

data/lib/kit/webhooks/signature.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require "openssl"
+
+module Kit
+  module Webhooks
+    # Raised when a delivery's X-Kit-Signature is missing, malformed, stale, or
+    # does not match the body under any supplied secret.
+    class SignatureError < Error; end
+
+    # Verifies the `X-Kit-Signature` header Kit sends with every webhook-endpoint
+    # delivery (verified against developers.kit.com/webhooks/verifying-signatures,
+    # 2026-09-06):
+    #
+    #   X-Kit-Signature: t=1753797130,v1=<hex>[,v1=<hex>]
+    #
+    # Each v1 is hex(HMAC-SHA256(secret, "#{t}.#{raw_body}")). During a secret
+    # rotation the header carries two v1 entries (new and previous secret), so
+    # a delivery is valid when any v1 matches any of the secrets you hold.
+    #
+    #   Kit::Webhooks::Signature.verify!(request.raw_post, request.headers["X-Kit-Signature"],
+    #                                    secret: ENV["KIT_WEBHOOK_SECRET"])
+    module Signature
+      HEADER = "X-Kit-Signature"
+      SCHEME = "v1"
+      DEFAULT_TOLERANCE = 300 # seconds; Kit's recommended replay window
+
+      Parsed = Data.define(:timestamp, :signatures)
+
+      # hex(HMAC-SHA256(secret, "t.payload")) — what Kit puts in v1.
+      def self.compute(secret, timestamp, payload)
+        OpenSSL::HMAC.hexdigest("SHA256", secret, "#{timestamp}.#{payload}")
+      end
+
+      # Splits the header into its timestamp and v1 signatures. Pairs are kept
+      # as a list, not a Hash: a rotation sends two v1 entries.
+      def self.parse(header)
+        raise SignatureError, "missing #{HEADER} header" if header.nil? || header.strip.empty?
+
+        pairs = header.split(",").map { |pair| pair.strip.split("=", 2) }
+        signatures = pairs.filter_map { |key, value| value if key == SCHEME }
+        raise SignatureError, "malformed #{HEADER} header: #{header.inspect}" if signatures.empty?
+
+        Parsed.new(timestamp: parse_timestamp(pairs, header), signatures: signatures)
+      end
+
+      def self.parse_timestamp(pairs, header)
+        value = pairs.find { |key, _| key == "t" }&.last
+        raise SignatureError, "malformed #{HEADER} header: #{header.inspect}" if value.nil?
+        raise SignatureError, "malformed timestamp in #{HEADER}: #{value.inspect}" unless value.match?(/\A\d+\z/)
+
+        value.to_i
+      end
+      private_class_method :parse_timestamp
+
+      # True when the payload was signed by one of `secret` (a String, or an
+      # Array of Strings while you hold both sides of a rotation) within
+      # `tolerance` seconds of `now`. Constant-time comparison.
+      def self.verify?(payload, header, secret:, tolerance: DEFAULT_TOLERANCE, now: Time.now.to_i)
+        verify!(payload, header, secret: secret, tolerance: tolerance, now: now)
+        true
+      rescue SignatureError
+        false
+      end
+
+      # As #verify?, but raises SignatureError describing why the delivery was
+      # rejected. `payload` must be the raw request body, byte for byte.
+      def self.verify!(payload, header, secret:, tolerance: DEFAULT_TOLERANCE, now: Time.now.to_i)
+        secrets = secrets_from(secret)
+        parsed = parse(header)
+        check_freshness(parsed.timestamp, tolerance, now)
+        return true if secrets.any? { |value| matches?(value, parsed, payload) }
+
+        raise SignatureError, "no #{SCHEME} signature matched the payload"
+      end
+
+      def self.secrets_from(secret)
+        secrets = Array(secret).reject { |value| value.nil? || value.empty? }
+        raise ArgumentError, "at least one webhook secret is required" if secrets.empty?
+
+        secrets
+      end
+      private_class_method :secrets_from
+
+      def self.check_freshness(timestamp, tolerance, now)
+        return unless tolerance
+
+        age = (now - timestamp).abs
+        raise SignatureError, "timestamp outside tolerance (#{age}s > #{tolerance}s)" if age > tolerance
+      end
+      private_class_method :check_freshness
+
+      def self.matches?(secret, parsed, payload)
+        expected = compute(secret, parsed.timestamp, payload)
+        parsed.signatures.any? { |given| OpenSSL.secure_compare(expected, given) }
+      end
+      private_class_method :matches?
+    end
+  end
+end

data/lib/kit-rb.rb

@@ -15,6 +15,7 @@ end
 require "kit/version"
 require "kit/errors"
 require "kit/configuration"
+require "kit/auth/credential"
 require "kit/auth/api_key"
 require "kit/auth/oauth"
 require "kit/connection"
@@ -43,6 +44,10 @@ require "kit/objects/segment"
 require "kit/objects/post"
 require "kit/objects/snippet"
 require "kit/objects/purchase"
+require "kit/objects/bulk_result"
+require "kit/webhooks/signature"
+require "kit/webhooks/delivery"
+require "kit/webhooks/events"
 require "kit/resources/base"
 require "kit/resources/account"
 require "kit/resources/subscribers"

data/sig/kit-rb.rbs

@@ -1,22 +1,35 @@
-# RBS type signatures for the public surface of kit-rb (P0: account slice).
-# Expanded per-resource as coverage grows in P1/P2.
+# RBS type signatures for the public surface of kit-rb, checked by Steep
+# (`bundle exec rake steep`). Keep in step with lib/.
 
 module Kit
   VERSION: String
   DEFAULT_BASE_URL: String
 
   class Error < StandardError
+    STATUS_CLASSES: Hash[Integer, singleton(APIError)]
     def self.class_for: (Integer status) -> singleton(APIError)
   end
   class ConfigurationError < Error
   end
+  class TransportError < Error
+  end
+  class TimeoutError < TransportError
+  end
+  class ConnectionError < TransportError
+  end
+  class UnexpectedResponseError < Error
+    attr_reader body: untyped
+    def initialize: (String message, ?body: untyped) -> void
+  end
 
   class APIError < Error
     attr_reader status: Integer
     attr_reader body: untyped
     attr_reader errors: Array[untyped]
     attr_reader response: untyped
-    def initialize: (?String? message, status: Integer, ?body: untyped, ?response: untyped) -> void
+    attr_reader method: Symbol?
+    attr_reader path: String?
+    def initialize: (?String? message, status: Integer, ?body: untyped, ?response: untyped, ?method: Symbol?, ?path: String?) -> void
   end
   class AuthenticationError < APIError
   end
@@ -24,11 +37,15 @@ module Kit
   end
   class NotFoundError < APIError
   end
+  class ConflictError < APIError
+  end
+  class PayloadTooLargeError < APIError
+  end
   class UnprocessableEntityError < APIError
   end
   class RateLimitError < APIError
     attr_reader retry_after: Integer?
-    def initialize: (?String? message, status: Integer, ?body: untyped, ?response: untyped, ?retry_after: Integer?) -> void
+    def initialize: (?String? message, status: Integer, ?body: untyped, ?response: untyped, ?method: Symbol?, ?path: String?, ?retry_after: Integer?) -> void
   end
   class ServerError < APIError
   end
@@ -57,6 +74,8 @@ module Kit
       attr_reader scope: String?
       attr_reader created_at: Integer?
       def self.from: (Hash[String, untyped] hash) -> Token
+      def inspect: () -> String
+      def to_s: () -> String
       def expires_at: () -> Integer?
       def expired?: (?now: Integer, ?leeway: Integer) -> bool
     end
@@ -72,18 +91,70 @@ module Kit
     end
   end
 
+  module Webhooks
+    class SignatureError < Error
+    end
+    module Signature
+      HEADER: String
+      SCHEME: String
+      DEFAULT_TOLERANCE: Integer
+      class Parsed
+        attr_reader timestamp: Integer
+        attr_reader signatures: Array[String]
+      end
+      def self.compute: (String secret, Integer | String timestamp, String payload) -> String
+      def self.parse: (String? header) -> Parsed
+      def self.verify?: (String payload, String? header, secret: String | Array[String], ?tolerance: Integer?, ?now: Integer) -> bool
+      def self.verify!: (String payload, String? header, secret: String | Array[String], ?tolerance: Integer?, ?now: Integer) -> bool
+    end
+    class Event
+      attr_reader id: String?
+      attr_reader type: String?
+      attr_reader created: String?
+      attr_reader data: Hash[String, untyped]
+      def self.from: (Hash[String, untyped] hash) -> Event
+    end
+    module Events
+      DATA_KEYS: Hash[String, Array[String]]
+      PLANNED: Array[String]
+      ALL: Array[String]
+      AVAILABLE: Array[String]
+    end
+    module LegacyEvents
+      REQUIRED_PARAM: Hash[String, Symbol]
+      ALL: Array[String]
+    end
+    DELIVERY_HEADER: String
+    class Delivery
+      attr_reader delivery_id: Integer?
+      attr_reader events: Array[Event]
+      def self.from: (Hash[String, untyped] hash) -> Delivery
+      def self.parse: (String payload) -> Delivery
+      def self.from_request: (String payload, String? signature_header, secret: String | Array[String], ?tolerance: Integer?, ?now: Integer) -> Delivery
+      def type: () -> String?
+    end
+  end
+
   module Auth
+    module Credential
+      MASK: String
+      VISIBLE: Integer
+      def self.mask: (untyped secret) -> String
+    end
+
     class ApiKey
       HEADER: String
       def initialize: (String key) -> void
       def headers: () -> Hash[String, String]
+      def inspect: () -> String
+      def to_s: () -> String
     end
 
     class OAuth
-      AUTHORIZE_URL: String
-      TOKEN_URL: String
       def initialize: (String access_token) -> void
       def headers: () -> Hash[String, String]
+      def inspect: () -> String
+      def to_s: () -> String
     end
   end
 
@@ -100,9 +171,12 @@ module Kit
 
   class Connection
     JSON_TYPE: String
-    RETRYABLE: Array[singleton(APIError)]
+    RETRYABLE: Array[singleton(Error)]
+    IDEMPOTENT: Array[Symbol]
     def initialize: (Configuration config) -> void
     def request: (Symbol method, String path, ?params: Hash[untyped, untyped], ?body: Hash[untyped, untyped]?) -> untyped
+    def request_with_status: (Symbol method, String path, ?params: Hash[untyped, untyped], ?body: Hash[untyped, untyped]?) -> [Integer, untyped]
+    def inspect: () -> String
   end
 
   class Pagination
@@ -111,11 +185,20 @@ module Kit
     attr_reader start_cursor: String?
     attr_reader end_cursor: String?
     attr_reader per_page: Integer?
+    attr_reader total_count: Integer?
     def self.from: (Hash[String, untyped] hash) -> Pagination
   end
 
   class Collection[T]
     include Enumerable[T]
+    FIRST_PAGE_ONLY: Array[Symbol]
+    def self.next_page_params: (Hash[Symbol, untyped] params, String? after) -> Hash[Symbol, untyped]
+    def total_count: () -> Integer?
+    def size: () -> Integer
+    def length: () -> Integer
+    def empty?: () -> bool
+    def []: (Integer index) -> T?
+    def inspect: () -> String
     attr_reader data: Array[T]
     attr_reader pagination: Pagination
     def initialize: (data: Array[T], pagination: Pagination) { (String end_cursor) -> Collection[T] } -> void
@@ -131,12 +214,40 @@ module Kit
       attr_reader id: Integer?
       def self.from: (Hash[String, untyped] hash) -> User
     end
+    class Timezone
+      attr_reader name: String?
+      attr_reader friendly_name: String?
+      attr_reader utc_offset: String?
+      def self.from: (Hash[String, untyped] hash) -> Timezone
+    end
+    class Plan
+      attr_reader plan_type: String?
+      attr_reader interval: String?
+      attr_reader subscriber_limit: Integer?
+      attr_reader on_trial: bool?
+      attr_reader trial_lapse_date: String?
+      attr_reader renews_at: String?
+      attr_reader cancels_at: String?
+      def self.from: (Hash[String, untyped] hash) -> Plan
+    end
+    class SendingAddress
+      attr_reader email_address: String?
+      attr_reader from_name: String?
+      attr_reader status: String?
+      attr_reader is_default: bool?
+      attr_reader is_verified: bool?
+      attr_reader is_dmarc_configured: bool?
+      def self.from: (Hash[String, untyped] hash) -> SendingAddress
+    end
     class Account
       attr_reader id: Integer?
       attr_reader name: String?
       attr_reader plan_type: String?
       attr_reader primary_email_address: String?
       attr_reader created_at: String?
+      attr_reader timezone: Timezone?
+      attr_reader plan: Plan?
+      attr_reader sending_addresses: Array[SendingAddress]
       def self.from: (Hash[String, untyped] hash) -> Account
     end
     class AccountInfo
@@ -157,6 +268,7 @@ module Kit
       attr_reader name: String?
       attr_reader created_at: String?
       attr_reader subscriber_count: Integer?
+      attr_reader tagged_at: String?
       def self.from: (Hash[String, untyped] hash) -> Tag
     end
     class CustomField
@@ -164,6 +276,7 @@ module Kit
       attr_reader name: String?
       attr_reader key: String?
       attr_reader label: String?
+      attr_reader created_at: String?
       def self.from: (Hash[String, untyped] hash) -> CustomField
     end
     class Form
@@ -236,6 +349,7 @@ module Kit
       attr_reader created_by_app: untyped
       attr_reader created_at: String?
       attr_reader previous_secret_expires_at: String?
+      attr_reader secret: String?
       def self.from: (Hash[String, untyped] hash) -> WebhookEndpoint
     end
     class EmailTemplate
@@ -266,6 +380,7 @@ module Kit
       attr_reader thumbnail_url: String?
       attr_reader is_paid: bool?
       attr_reader public_url: String?
+      attr_reader content: String?
       def self.from: (Hash[String, untyped] hash) -> Post
     end
     class Snippet
@@ -280,6 +395,19 @@ module Kit
       attr_reader document: untyped
       def self.from: (Hash[String, untyped] hash) -> Snippet
     end
+    class BulkFailure
+      attr_reader item: untyped
+      attr_reader errors: Array[String]
+      def self.from: (Hash[String, untyped] hash) -> BulkFailure
+    end
+    class BulkResult
+      attr_reader items: Array[Hash[String, untyped]]
+      attr_reader failures: Array[BulkFailure]
+      attr_reader async: bool
+      def self.from: (Integer status, untyped body, String? key) -> BulkResult
+      def async?: () -> bool
+      def success?: () -> bool
+    end
     class Purchase
       attr_reader id: Integer?
       attr_reader transaction_id: String?
@@ -309,6 +437,7 @@ module Kit
       attr_reader delay_unit: String?
       attr_reader send_days: Array[untyped]?
       attr_reader stats: Hash[String, untyped]?
+      attr_reader content: String?
       def self.from: (Hash[String, untyped] hash) -> SequenceEmail
     end
     class BroadcastStats
@@ -385,12 +514,22 @@ module Kit
       attr_reader canceled_at: String?
       attr_reader location: Hash[String, untyped]?
       attr_reader fields: Hash[String, untyped]?
+      attr_reader added_at: String?
+      attr_reader tagged_at: String?
+      attr_reader referrer: String?
+      attr_reader referrer_utm_parameters: Hash[String, untyped]?
+      attr_reader attribution: Hash[String, untyped]?
+      attr_reader tags: Array[Hash[String, untyped]]?
+      attr_reader tag_names: Array[String]?
+      attr_reader tag_ids: Array[Integer]?
+      attr_reader stats: Hash[String, untyped]?
       def self.from: (Hash[String, untyped] hash) -> Subscriber
     end
   end
 
   module Resources
     class Base
+      OMIT: Object
       def initialize: (Connection connection) -> void
     end
     class Account < Base
@@ -406,11 +545,12 @@ module Kit
       def get: (Integer id) -> Objects::Subscriber
       def create: (email_address: String, ?first_name: String?, ?state: String?, ?fields: Hash[untyped, untyped]?) -> Objects::Subscriber
       def update: (Integer id, ?first_name: String?, ?email_address: String?, ?fields: Hash[untyped, untyped]?) -> Objects::Subscriber
-      def unsubscribe: (Integer id) -> Objects::Subscriber
+      def unsubscribe: (Integer id) -> Objects::Subscriber?
       def filter: (**untyped params) -> Collection[Objects::Subscriber]
       def tags: (Integer id, **untyped params) -> Collection[Objects::Tag]
-      def stats: (Integer id) -> Objects::SubscriberStats
+      def stats: (Integer id, ?email_sent_after: String?, ?email_sent_before: String?) -> Objects::SubscriberStats
       def set_location: (Integer id, location: Hash[untyped, untyped]) -> Objects::Subscriber
+      def update_location: (Integer id, location: Hash[untyped, untyped]) -> Objects::Subscriber
       def remove_location: (Integer id) -> void
     end
     class Tags < Base
@@ -437,24 +577,24 @@ module Kit
     end
     class Sequences < Base
       def list: (**untyped params) -> Collection[Objects::Sequence]
-      def get: (Integer id) -> Objects::Sequence
-      def create: (name: String, **untyped attributes) -> Objects::Sequence
-      def update: (Integer id, **untyped attributes) -> Objects::Sequence
+      def get: (Integer id, ?include: String?) -> Objects::Sequence
+      def create: (name: String, ?email_address: String?, ?email_template_id: Integer?, ?send_days: Array[String]?, ?send_hour: Integer?, ?time_zone: String?, ?active: bool?, ?repeat: bool?, ?hold: bool?, ?exclude_subscriber_sources: Array[Hash[Symbol | String, untyped]]?) -> Objects::Sequence
+      def update: (Integer id, ?name: String?, ?email_address: String?, ?email_template_id: Integer?, ?send_days: Array[String]?, ?send_hour: Integer?, ?time_zone: String?, ?active: bool?, ?repeat: bool?, ?hold: bool?, ?exclude_subscriber_sources: Array[Hash[Symbol | String, untyped]]?) -> Objects::Sequence
       def delete: (Integer id) -> void
       def subscribers: (Integer sequence_id, **untyped params) -> Collection[Objects::Subscriber]
       def add_subscriber: (Integer sequence_id, Integer subscriber_id) -> Objects::Subscriber
       def add_subscriber_by_email: (Integer sequence_id, email_address: String) -> Objects::Subscriber
       def emails: (Integer sequence_id, **untyped params) -> Collection[Objects::SequenceEmail]
-      def email: (Integer sequence_id, Integer id) -> Objects::SequenceEmail
-      def create_email: (Integer sequence_id, **untyped attributes) -> Objects::SequenceEmail
-      def update_email: (Integer sequence_id, Integer id, **untyped attributes) -> Objects::SequenceEmail
+      def email: (Integer sequence_id, Integer id, ?include: String?) -> Objects::SequenceEmail
+      def create_email: (Integer sequence_id, subject: String, delay_value: Integer, delay_unit: String, ?preview_text: String?, ?content: String?, ?email_template_id: Integer?, ?published: bool?, ?send_days: Array[String]?, ?position: Integer?) -> Objects::SequenceEmail
+      def update_email: (Integer sequence_id, Integer id, ?subject: String?, ?delay_value: Integer?, ?delay_unit: String?, ?preview_text: String?, ?content: String?, ?email_template_id: Integer?, ?published: bool?, ?send_days: Array[String]?, ?position: Integer?) -> Objects::SequenceEmail
       def delete_email: (Integer sequence_id, Integer id) -> void
     end
     class Broadcasts < Base
       def list: (**untyped params) -> Collection[Objects::Broadcast]
       def get: (Integer id) -> Objects::Broadcast
-      def create: (**untyped attributes) -> Objects::Broadcast
-      def update: (Integer id, **untyped attributes) -> Objects::Broadcast
+      def create: (?subject: String?, ?preview_text: String?, ?content: String?, ?description: String?, ?public: bool?, ?published_at: String?, ?send_at: String?, ?email_address: String?, ?email_template_id: Integer?, ?thumbnail_alt: String?, ?thumbnail_url: String?, ?subscriber_filter: Array[Hash[Symbol | String, untyped]]?) -> Objects::Broadcast
+      def update: (Integer id, ?subject: String?, ?preview_text: String?, ?content: String?, ?description: String?, ?public: bool?, ?published_at: String?, ?send_at: String?, ?email_address: String?, ?email_template_id: Integer?, ?thumbnail_alt: String?, ?thumbnail_url: String?, ?subscriber_filter: Array[Hash[Symbol | String, untyped]]?) -> Objects::Broadcast
       def delete: (Integer id) -> void
       def stats_list: (**untyped params) -> Collection[Objects::BroadcastStats]
       def stats: (Integer id) -> Objects::BroadcastStats
@@ -470,23 +610,23 @@ module Kit
     class Purchases < Base
       def list: (**untyped params) -> Collection[Objects::Purchase]
       def get: (Integer id) -> Objects::Purchase
-      def create: (**untyped attributes) -> Objects::Purchase
+      def create: (email_address: String, transaction_id: String, status: String, currency: String, ?transaction_time: String?, ?subtotal: Numeric?, ?tax: Numeric?, ?shipping: Numeric?, ?discount: Numeric?, ?total: Numeric?, ?products: Array[Hash[Symbol | String, untyped]]?) -> Objects::Purchase
     end
     class Bulk < Base
-      def create_subscribers: (Array[untyped] subscribers, ?callback_url: String?) -> Hash[String, untyped]
-      def create_custom_fields: (Array[untyped] custom_fields, ?callback_url: String?) -> Hash[String, untyped]
-      def update_custom_field_values: (Array[untyped] custom_field_values, ?callback_url: String?) -> Hash[String, untyped]
-      def add_subscribers_to_forms: (Array[untyped] additions, ?callback_url: String?) -> Hash[String, untyped]
-      def create_tags: (Array[untyped] tags, ?callback_url: String?) -> Hash[String, untyped]
-      def delete_tags: (Array[untyped] tags, ?callback_url: String?) -> Hash[String, untyped]
-      def tag_subscribers: (Array[untyped] taggings, ?callback_url: String?) -> Hash[String, untyped]
-      def remove_tag_subscribers: (Array[untyped] taggings, ?callback_url: String?) -> Hash[String, untyped]
+      def create_subscribers: (Array[untyped] subscribers, ?callback_url: String?) -> Objects::BulkResult
+      def create_custom_fields: (Array[untyped] custom_fields, ?callback_url: String?) -> Objects::BulkResult
+      def update_custom_field_values: (Array[untyped] custom_field_values, ?callback_url: String?) -> Objects::BulkResult
+      def add_subscribers_to_forms: (Array[untyped] additions, ?callback_url: String?) -> Objects::BulkResult
+      def create_tags: (Array[untyped] tags, ?callback_url: String?) -> Objects::BulkResult
+      def delete_tags: (Array[untyped] tags, ?callback_url: String?) -> Objects::BulkResult
+      def tag_subscribers: (Array[untyped] taggings, ?callback_url: String?) -> Objects::BulkResult
+      def remove_tag_subscribers: (Array[untyped] taggings, ?callback_url: String?) -> Objects::BulkResult
     end
     class Snippets < Base
       def list: (**untyped params) -> Collection[Objects::Snippet]
       def get: (Integer id) -> Objects::Snippet
-      def create: (**untyped attributes) -> Objects::Snippet
-      def update: (Integer id, **untyped attributes) -> Objects::Snippet
+      def create: (name: String, snippet_type: String, ?content: String?, ?document_attributes: Hash[Symbol | String, untyped]?) -> Objects::Snippet
+      def update: (Integer id, ?name: String?, ?archived: bool?, ?content: String?, ?document_attributes: Hash[Symbol | String, untyped]?) -> Objects::Snippet
     end
     class Segments < Base
       def list: (**untyped params) -> Collection[Objects::Segment]
@@ -500,6 +640,7 @@ module Kit
       def list: (**untyped params) -> Collection[Objects::WebhookEndpoint]
       def get: (Integer id) -> Objects::WebhookEndpoint
       def create: (url: String, events: Array[untyped], ?name: String?, ?description: String?) -> Objects::WebhookEndpoint
+      def update: (Integer id, ?name: String?, ?url: String?, ?description: String?, ?status: String?, ?events: Array[String]?) -> Objects::WebhookEndpoint
       def delete: (Integer id) -> void
       def rotate_secret: (Integer id, ?force: bool?) -> Objects::WebhookEndpoint
       def revoke_previous_secret: (Integer id) -> Objects::WebhookEndpoint
@@ -508,7 +649,7 @@ module Kit
 
   class Client
     attr_reader config: Configuration
-    def initialize: (?api_key: String?, ?access_token: String?, **untyped options) -> void
+    def initialize: (?api_key: String?, ?access_token: String?, ?base_url: String, ?open_timeout: Integer, ?read_timeout: Integer, ?max_retries: Integer, ?retry_backoff: Float, ?max_backoff: Numeric) -> void
     def account: () -> Resources::Account
     def subscribers: () -> Resources::Subscribers
     def tags: () -> Resources::Tags

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kit-rb
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Lawrence Lin
@@ -31,14 +31,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".githooks/pre-commit"
+- ".githooks/pre-push"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
 - Rakefile
 - Steepfile
 - docs/DESIGN.md
+- docs/TASKS.md
 - lib/kit-rb.rb
 - lib/kit/auth/api_key.rb
+- lib/kit/auth/credential.rb
 - lib/kit/auth/oauth.rb
 - lib/kit/client.rb
 - lib/kit/configuration.rb
@@ -51,6 +55,7 @@ files:
 - lib/kit/objects/broadcast.rb
 - lib/kit/objects/broadcast_click.rb
 - lib/kit/objects/broadcast_stats.rb
+- lib/kit/objects/bulk_result.rb
 - lib/kit/objects/creator_profile.rb
 - lib/kit/objects/custom_field.rb
 - lib/kit/objects/email_stats.rb
@@ -86,6 +91,9 @@ files:
 - lib/kit/resources/webhook_endpoints.rb
 - lib/kit/resources/webhooks.rb
 - lib/kit/version.rb
+- lib/kit/webhooks/delivery.rb
+- lib/kit/webhooks/events.rb
+- lib/kit/webhooks/signature.rb
 - sig/kit-rb.rbs
 homepage: https://github.com/linyiru/kit-rb
 licenses:
@@ -94,6 +102,8 @@ metadata:
   homepage_uri: https://github.com/linyiru/kit-rb
   source_code_uri: https://github.com/linyiru/kit-rb
   changelog_uri: https://github.com/linyiru/kit-rb/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/linyiru/kit-rb/issues
+  documentation_uri: https://github.com/linyiru/kit-rb#readme
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: