kit-rb 0.0.0 → 0.2.0

data/lib/kit/resources/custom_fields.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Kit
+  module Resources
+    # The /v4/custom_fields endpoints.
+    class CustomFields < Base
+      # GET /v4/custom_fields
+      def list(**params)
+        collection("/v4/custom_fields", "custom_fields", Objects::CustomField, params)
+      end
+
+      # POST /v4/custom_fields
+      def create(label:)
+        one(:post, "/v4/custom_fields", "custom_field", Objects::CustomField, body: { label: label })
+      end
+
+      # PUT /v4/custom_fields/:id
+      def update(id, label:)
+        one(:put, "/v4/custom_fields/#{id}", "custom_field", Objects::CustomField, body: { label: label })
+      end
+
+      # DELETE /v4/custom_fields/:id
+      def delete(id)
+        http_delete("/v4/custom_fields/#{id}")
+        nil
+      end
+    end
+  end
+end

data/lib/kit/resources/email_templates.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Kit
+  module Resources
+    # The /v4/email_templates endpoints.
+    class EmailTemplates < Base
+      # GET /v4/email_templates
+      def list(**params)
+        collection("/v4/email_templates", "email_templates", Objects::EmailTemplate, params)
+      end
+    end
+  end
+end

data/lib/kit/resources/forms.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Kit
+  module Resources
+    # The /v4/forms endpoints. Forms themselves are created in the Kit UI, so
+    # this resource lists them and manages their subscribers.
+    class Forms < Base
+      # GET /v4/forms
+      def list(**params)
+        collection("/v4/forms", "forms", Objects::Form, params)
+      end
+
+      # GET /v4/forms/:form_id/subscribers
+      def subscribers(form_id, **params)
+        collection("/v4/forms/#{form_id}/subscribers", "subscribers", Objects::Subscriber, params)
+      end
+
+      # POST /v4/forms/:form_id/subscribers/:subscriber_id
+      def add_subscriber(form_id, subscriber_id, referrer: nil)
+        one(:post, "/v4/forms/#{form_id}/subscribers/#{subscriber_id}", "subscriber",
+            Objects::Subscriber, body: { referrer: referrer }.compact)
+      end
+
+      # POST /v4/forms/:form_id/subscribers
+      def add_subscriber_by_email(form_id, email_address:, referrer: nil)
+        one(:post, "/v4/forms/#{form_id}/subscribers", "subscriber", Objects::Subscriber,
+            body: { email_address: email_address, referrer: referrer }.compact)
+      end
+    end
+  end
+end

data/lib/kit/resources/posts.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Kit
+  module Resources
+    # The /v4/posts endpoints — broadcasts published to the web.
+    class Posts < Base
+      # GET /v4/posts
+      def list(**params)
+        collection("/v4/posts", "posts", Objects::Post, params)
+      end
+
+      # GET /v4/posts/:id
+      def get(id)
+        one(:get, "/v4/posts/#{id}", "post", Objects::Post)
+      end
+    end
+  end
+end

data/lib/kit/resources/purchases.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Kit
+  module Resources
+    # The /v4/purchases endpoints. All three require OAuth (the API key is not
+    # accepted here); create records an external purchase.
+    class Purchases < Base
+      # GET /v4/purchases
+      def list(**params)
+        collection("/v4/purchases", "purchases", Objects::Purchase, params)
+      end
+
+      # GET /v4/purchases/:id
+      def get(id)
+        one(:get, "/v4/purchases/#{id}", "purchase", Objects::Purchase)
+      end
+
+      # POST /v4/purchases — the request wraps the fields under a "purchase" key.
+      # Pass email_address/transaction_id/status/currency/transaction_time,
+      # the monetary totals, and a products array.
+      def create(**attributes)
+        one(:post, "/v4/purchases", "purchase", Objects::Purchase, body: { purchase: attributes })
+      end
+    end
+  end
+end

data/lib/kit/resources/segments.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Kit
+  module Resources
+    # The /v4/segments endpoints.
+    class Segments < Base
+      # GET /v4/segments
+      def list(**params)
+        collection("/v4/segments", "segments", Objects::Segment, params)
+      end
+    end
+  end
+end

data/lib/kit/resources/sequences.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Kit
+  module Resources
+    # The /v4/sequences endpoints. Sequences (formerly "courses"), their
+    # subscribers, and the emails that make up each sequence.
+    class Sequences < Base
+      # GET /v4/sequences
+      def list(**params)
+        collection("/v4/sequences", "sequences", Objects::Sequence, params)
+      end
+
+      # GET /v4/sequences/:id
+      def get(id)
+        one(:get, "/v4/sequences/#{id}", "sequence", Objects::Sequence)
+      end
+
+      # GET /v4/sequences/:sequence_id/subscribers
+      def subscribers(sequence_id, **params)
+        collection("/v4/sequences/#{sequence_id}/subscribers", "subscribers", Objects::Subscriber, params)
+      end
+
+      # POST /v4/sequences
+      def create(name:, **attributes)
+        one(:post, "/v4/sequences", "sequence", Objects::Sequence, body: { name: name }.merge(attributes))
+      end
+
+      # PUT /v4/sequences/:id
+      def update(id, **attributes)
+        one(:put, "/v4/sequences/#{id}", "sequence", Objects::Sequence, body: attributes)
+      end
+
+      # DELETE /v4/sequences/:id
+      def delete(id)
+        http_delete("/v4/sequences/#{id}")
+        nil
+      end
+
+      # POST /v4/sequences/:sequence_id/subscribers/:subscriber_id
+      def add_subscriber(sequence_id, subscriber_id)
+        one(:post, "/v4/sequences/#{sequence_id}/subscribers/#{subscriber_id}", "subscriber", Objects::Subscriber)
+      end
+
+      # POST /v4/sequences/:sequence_id/subscribers
+      def add_subscriber_by_email(sequence_id, email_address:)
+        one(:post, "/v4/sequences/#{sequence_id}/subscribers", "subscriber", Objects::Subscriber,
+            body: { email_address: email_address })
+      end
+
+      # GET /v4/sequences/:sequence_id/emails
+      def emails(sequence_id, **params)
+        collection("/v4/sequences/#{sequence_id}/emails", "emails", Objects::SequenceEmail, params)
+      end
+
+      # GET /v4/sequences/:sequence_id/emails/:id
+      def email(sequence_id, id)
+        one(:get, "/v4/sequences/#{sequence_id}/emails/#{id}", "email", Objects::SequenceEmail)
+      end
+
+      # POST /v4/sequences/:sequence_id/emails — subject/delay_value/delay_unit
+      # are required; content/position/send_days and the rest are optional.
+      def create_email(sequence_id, **attributes)
+        one(:post, "/v4/sequences/#{sequence_id}/emails", "email", Objects::SequenceEmail, body: attributes)
+      end
+
+      # PUT /v4/sequences/:sequence_id/emails/:id
+      def update_email(sequence_id, id, **attributes)
+        one(:put, "/v4/sequences/#{sequence_id}/emails/#{id}", "email", Objects::SequenceEmail, body: attributes)
+      end
+
+      # DELETE /v4/sequences/:sequence_id/emails/:id
+      def delete_email(sequence_id, id)
+        http_delete("/v4/sequences/#{sequence_id}/emails/#{id}")
+        nil
+      end
+    end
+  end
+end

data/lib/kit/resources/snippets.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Kit
+  module Resources
+    # The /v4/snippets endpoints — reusable inline/document content.
+    class Snippets < Base
+      # GET /v4/snippets
+      def list(**params)
+        collection("/v4/snippets", "snippets", Objects::Snippet, params)
+      end
+
+      # GET /v4/snippets/:id
+      def get(id)
+        one(:get, "/v4/snippets/#{id}", "snippet", Objects::Snippet)
+      end
+
+      # POST /v4/snippets — pass name/snippet_type and content (inline) or
+      # document (document); the API validates the combination.
+      def create(**attributes)
+        one(:post, "/v4/snippets", "snippet", Objects::Snippet, body: attributes)
+      end
+
+      # PUT /v4/snippets/:id
+      def update(id, **attributes)
+        one(:put, "/v4/snippets/#{id}", "snippet", Objects::Snippet, body: attributes)
+      end
+    end
+  end
+end

data/lib/kit/resources/subscribers.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Kit
+  module Resources
+    # The /v4/subscribers endpoints.
+    class Subscribers < Base
+      # GET /v4/subscribers — a cursor-paginated Collection of Subscriber.
+      # Accepts filters as params: after, before, per_page, email_address,
+      # status, created_after, created_before, sort_field, sort_order.
+      def list(**params)
+        collection("/v4/subscribers", "subscribers", Objects::Subscriber, params)
+      end
+
+      # GET /v4/subscribers/:id
+      def get(id)
+        one(:get, "/v4/subscribers/#{id}", "subscriber", Objects::Subscriber)
+      end
+
+      # POST /v4/subscribers — email_address required; first_name, state, fields optional.
+      def create(email_address:, first_name: nil, state: nil, fields: nil)
+        body = { email_address: email_address, first_name: first_name,
+                 state: state, fields: fields }.compact
+        one(:post, "/v4/subscribers", "subscriber", Objects::Subscriber, body: body)
+      end
+
+      # PUT /v4/subscribers/:id
+      def update(id, first_name: nil, email_address: nil, fields: nil)
+        body = { first_name: first_name, email_address: email_address, fields: fields }.compact
+        one(:put, "/v4/subscribers/#{id}", "subscriber", Objects::Subscriber, body: body)
+      end
+
+      # POST /v4/subscribers/:id/unsubscribe
+      def unsubscribe(id)
+        one(:post, "/v4/subscribers/#{id}/unsubscribe", "subscriber", Objects::Subscriber)
+      end
+
+      # POST /v4/subscribers/filter — the same filters as #list, sent in the
+      # request rather than the query string; returns a cursor-paginated Collection.
+      def filter(**params)
+        collection("/v4/subscribers/filter", "subscribers", Objects::Subscriber, params, verb: :post)
+      end
+
+      # GET /v4/subscribers/:id/tags — the tags applied to a subscriber.
+      def tags(id, **params)
+        collection("/v4/subscribers/#{id}/tags", "tags", Objects::Tag, params)
+      end
+
+      # GET /v4/subscribers/:id/stats — the subscriber's engagement stats.
+      def stats(id)
+        one(:get, "/v4/subscribers/#{id}/stats", "subscriber", Objects::SubscriberStats)
+      end
+
+      # POST /v4/subscribers/:id/location — set the subscriber's location
+      # (a hash of city/state_province/country_code/latitude/longitude/timezone).
+      def set_location(id, location:)
+        one(:post, "/v4/subscribers/#{id}/location", "subscriber", Objects::Subscriber,
+            body: { location: location })
+      end
+
+      # DELETE /v4/subscribers/:id/location
+      def remove_location(id)
+        http_delete("/v4/subscribers/#{id}/location")
+        nil
+      end
+    end
+  end
+end

data/lib/kit/resources/tags.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Kit
+  module Resources
+    # The /v4/tags endpoints.
+    class Tags < Base
+      # GET /v4/tags
+      def list(**params)
+        collection("/v4/tags", "tags", Objects::Tag, params)
+      end
+
+      # POST /v4/tags
+      def create(name:)
+        one(:post, "/v4/tags", "tag", Objects::Tag, body: { name: name })
+      end
+
+      # PUT /v4/tags/:id
+      def update(id, name:)
+        one(:put, "/v4/tags/#{id}", "tag", Objects::Tag, body: { name: name })
+      end
+
+      # POST /v4/tags/:tag_id/subscribers/:id
+      def tag_subscriber(tag_id, subscriber_id)
+        one(:post, "/v4/tags/#{tag_id}/subscribers/#{subscriber_id}", "subscriber", Objects::Subscriber)
+      end
+
+      # DELETE /v4/tags/:tag_id/subscribers/:id
+      def remove_subscriber(tag_id, subscriber_id)
+        http_delete("/v4/tags/#{tag_id}/subscribers/#{subscriber_id}")
+        nil
+      end
+
+      # POST /v4/tags/:tag_id/subscribers — tag a subscriber by email address.
+      def tag_subscriber_by_email(tag_id, email_address:)
+        one(:post, "/v4/tags/#{tag_id}/subscribers", "subscriber", Objects::Subscriber,
+            body: { email_address: email_address })
+      end
+
+      # DELETE /v4/tags/:tag_id/subscribers — remove a tag from a subscriber by
+      # email address (passed as a query parameter).
+      def remove_subscriber_by_email(tag_id, email_address:)
+        http_delete("/v4/tags/#{tag_id}/subscribers", params: { email_address: email_address })
+        nil
+      end
+
+      # GET /v4/tags/:tag_id/subscribers
+      def subscribers(tag_id, **params)
+        collection("/v4/tags/#{tag_id}/subscribers", "subscribers", Objects::Subscriber, params)
+      end
+    end
+  end
+end

data/lib/kit/resources/webhook_endpoints.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Kit
+  module Resources
+    # The /v4/webhook_endpoints endpoints — signed webhook delivery, with a
+    # rotatable secret.
+    #
+    # Note: although the OpenAPI spec lists API Key as accepted, the live API
+    # rejected an API key here with 401 while /v4/webhooks accepted the same key
+    # (verified 2026-09-04) — these endpoints appear to require OAuth in practice.
+    class WebhookEndpoints < Base
+      # GET /v4/webhook_endpoints
+      def list(**params)
+        collection("/v4/webhook_endpoints", "webhook_endpoints", Objects::WebhookEndpoint, params)
+      end
+
+      # GET /v4/webhook_endpoints/:id
+      def get(id)
+        one(:get, "/v4/webhook_endpoints/#{id}", "webhook_endpoint", Objects::WebhookEndpoint)
+      end
+
+      # POST /v4/webhook_endpoints
+      def create(url:, events:, name: nil, description: nil)
+        one(:post, "/v4/webhook_endpoints", "webhook_endpoint", Objects::WebhookEndpoint,
+            body: { url: url, events: events, name: name, description: description }.compact)
+      end
+
+      # DELETE /v4/webhook_endpoints/:id
+      def delete(id)
+        http_delete("/v4/webhook_endpoints/#{id}")
+        nil
+      end
+
+      # POST /v4/webhook_endpoints/:id/rotate_secret
+      def rotate_secret(id, force: nil)
+        one(:post, "/v4/webhook_endpoints/#{id}/rotate_secret", "webhook_endpoint", Objects::WebhookEndpoint,
+            body: { force: force }.compact)
+      end
+
+      # POST /v4/webhook_endpoints/:id/revoke_previous_secret
+      def revoke_previous_secret(id)
+        one(:post, "/v4/webhook_endpoints/#{id}/revoke_previous_secret", "webhook_endpoint", Objects::WebhookEndpoint)
+      end
+    end
+  end
+end

data/lib/kit/resources/webhooks.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Kit
+  module Resources
+    # The /v4/webhooks endpoints — automation rules that POST to a target URL.
+    class Webhooks < Base
+      # GET /v4/webhooks
+      def list(**params)
+        collection("/v4/webhooks", "webhooks", Objects::Webhook, params)
+      end
+
+      # POST /v4/webhooks
+      def create(target_url:, event:)
+        one(:post, "/v4/webhooks", "webhook", Objects::Webhook, body: { target_url: target_url, event: event })
+      end
+
+      # DELETE /v4/webhooks/:id
+      def delete(id)
+        http_delete("/v4/webhooks/#{id}")
+        nil
+      end
+    end
+  end
+end

data/lib/kit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kit
-  VERSION = "0.0.0"
+  VERSION = "0.2.0"
 end

data/lib/kit-rb.rb

@@ -18,7 +18,45 @@ require "kit/configuration"
 require "kit/auth/api_key"
 require "kit/auth/oauth"
 require "kit/connection"
+require "kit/pagination"
+require "kit/oauth/pkce"
+require "kit/oauth/token"
+require "kit/oauth/client"
 require "kit/objects/account"
+require "kit/objects/creator_profile"
+require "kit/objects/subscriber"
+require "kit/objects/tag"
+require "kit/objects/custom_field"
+require "kit/objects/form"
+require "kit/objects/sequence"
+require "kit/objects/sequence_email"
+require "kit/objects/broadcast"
+require "kit/objects/broadcast_stats"
+require "kit/objects/broadcast_click"
+require "kit/objects/subscriber_stats"
+require "kit/objects/email_stats"
+require "kit/objects/growth_stats"
+require "kit/objects/webhook"
+require "kit/objects/webhook_endpoint"
+require "kit/objects/email_template"
+require "kit/objects/segment"
+require "kit/objects/post"
+require "kit/objects/snippet"
+require "kit/objects/purchase"
 require "kit/resources/base"
 require "kit/resources/account"
+require "kit/resources/subscribers"
+require "kit/resources/tags"
+require "kit/resources/custom_fields"
+require "kit/resources/forms"
+require "kit/resources/sequences"
+require "kit/resources/broadcasts"
+require "kit/resources/webhooks"
+require "kit/resources/webhook_endpoints"
+require "kit/resources/email_templates"
+require "kit/resources/segments"
+require "kit/resources/posts"
+require "kit/resources/snippets"
+require "kit/resources/purchases"
+require "kit/resources/bulk"
 require "kit/client"