kit-rb 0.0.0 → 0.2.0

data/sig/kit-rb.rbs

@@ -32,6 +32,45 @@ module Kit
   end
   class ServerError < APIError
   end
+  class OAuthError < APIError
+    attr_reader oauth_error: String?
+    attr_reader error_description: String?
+    def initialize: (status: Integer, ?body: untyped, ?response: untyped) -> void
+  end
+
+  module OAuth
+    class Challenge
+      attr_reader code_verifier: String
+      attr_reader code_challenge: String
+      attr_reader code_challenge_method: String
+    end
+    module PKCE
+      METHOD: String
+      def self.generate: () -> Challenge
+      def self.challenge_for: (String verifier) -> String
+    end
+    class Token
+      attr_reader access_token: String?
+      attr_reader refresh_token: String?
+      attr_reader token_type: String?
+      attr_reader expires_in: Integer?
+      attr_reader scope: String?
+      attr_reader created_at: Integer?
+      def self.from: (Hash[String, untyped] hash) -> Token
+      def expires_at: () -> Integer?
+      def expired?: (?now: Integer, ?leeway: Integer) -> bool
+    end
+    class Client
+      AUTHORIZE_PATH: String
+      TOKEN_PATH: String
+      def initialize: (client_id: String, ?client_secret: String?, ?redirect_uri: String?, ?base_url: String) -> void
+      def authorization_url: (?scope: String, ?state: String?, ?code_challenge: String?, ?code_challenge_method: String?, ?tenant_name: String?, ?redirect_uri: String?) -> String
+      def exchange_code: (String code, ?code_verifier: String?, ?redirect_uri: String?) -> Token
+      def client_credentials: (?scope: String?) -> Token
+      def refresh: (String refresh_token) -> Token
+      def revoke: (String token, ?token_type_hint: String?) -> bool
+    end
+  end
 
   module Auth
     class ApiKey
@@ -53,15 +92,39 @@ module Kit
     attr_reader base_url: String
     attr_reader open_timeout: Integer
     attr_reader read_timeout: Integer
-    def initialize: (?api_key: String?, ?access_token: String?, ?base_url: String, ?open_timeout: Integer, ?read_timeout: Integer) -> void
+    attr_reader max_retries: Integer
+    attr_reader retry_backoff: Float
+    attr_reader max_backoff: Numeric
+    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
   end
 
   class Connection
     JSON_TYPE: String
+    RETRYABLE: Array[singleton(APIError)]
     def initialize: (Configuration config) -> void
     def request: (Symbol method, String path, ?params: Hash[untyped, untyped], ?body: Hash[untyped, untyped]?) -> untyped
   end
 
+  class Pagination
+    attr_reader has_previous_page: bool
+    attr_reader has_next_page: bool
+    attr_reader start_cursor: String?
+    attr_reader end_cursor: String?
+    attr_reader per_page: Integer?
+    def self.from: (Hash[String, untyped] hash) -> Pagination
+  end
+
+  class Collection[T]
+    include Enumerable[T]
+    attr_reader data: Array[T]
+    attr_reader pagination: Pagination
+    def initialize: (data: Array[T], pagination: Pagination) { (String end_cursor) -> Collection[T] } -> void
+    def each: () { (T) -> void } -> void
+    def next_page: () -> Collection[T]?
+    def auto_paging_each: () { (T) -> void } -> void
+                        | () -> Enumerator[T, void]
+  end
+
   module Objects
     class User
       attr_reader email: String?
@@ -81,6 +144,249 @@ module Kit
       attr_reader account: Account
       def self.from: (Hash[String, untyped] hash) -> AccountInfo
     end
+    class CreatorProfile
+      attr_reader name: String?
+      attr_reader byline: String?
+      attr_reader bio: String?
+      attr_reader image_url: String?
+      attr_reader profile_url: String?
+      def self.from: (Hash[String, untyped] hash) -> CreatorProfile
+    end
+    class Tag
+      attr_reader id: Integer?
+      attr_reader name: String?
+      attr_reader created_at: String?
+      attr_reader subscriber_count: Integer?
+      def self.from: (Hash[String, untyped] hash) -> Tag
+    end
+    class CustomField
+      attr_reader id: Integer?
+      attr_reader name: String?
+      attr_reader key: String?
+      attr_reader label: String?
+      def self.from: (Hash[String, untyped] hash) -> CustomField
+    end
+    class Form
+      attr_reader id: Integer?
+      attr_reader name: String?
+      attr_reader created_at: String?
+      attr_reader type: String?
+      attr_reader format: untyped
+      attr_reader embed_js: String?
+      attr_reader embed_url: String?
+      attr_reader archived: bool?
+      attr_reader uid: String?
+      attr_reader subscriber_count: Integer?
+      def self.from: (Hash[String, untyped] hash) -> Form
+    end
+    class Sequence
+      attr_reader id: Integer?
+      attr_reader name: String?
+      attr_reader hold: bool?
+      attr_reader repeat: bool?
+      attr_reader created_at: String?
+      attr_reader updated_at: String?
+      attr_reader email_address: String?
+      attr_reader email_template_id: Integer?
+      attr_reader send_days: Array[untyped]?
+      attr_reader send_hour: Integer?
+      attr_reader time_zone: String?
+      attr_reader active: bool?
+      attr_reader exclude_subscriber_sources: Array[untyped]?
+      attr_reader email_count: Integer?
+      attr_reader subscriber_count: Integer?
+      attr_reader stats: Hash[String, untyped]?
+      def self.from: (Hash[String, untyped] hash) -> Sequence
+    end
+    class Broadcast
+      attr_reader id: Integer?
+      attr_reader publication_id: Integer?
+      attr_reader created_at: String?
+      attr_reader subject: String?
+      attr_reader preview_text: String?
+      attr_reader description: String?
+      attr_reader content: String?
+      attr_reader public: bool?
+      attr_reader published_at: String?
+      attr_reader send_at: String?
+      attr_reader thumbnail_alt: String?
+      attr_reader thumbnail_url: String?
+      attr_reader public_url: String?
+      attr_reader email_address: String?
+      attr_reader email_template: Hash[String, untyped]?
+      attr_reader subscriber_filter: Array[untyped]?
+      attr_reader status: String?
+      def self.from: (Hash[String, untyped] hash) -> Broadcast
+    end
+    class Webhook
+      attr_reader id: Integer?
+      attr_reader account_id: Integer?
+      attr_reader event: Hash[String, untyped]?
+      attr_reader target_url: String?
+      def self.from: (Hash[String, untyped] hash) -> Webhook
+    end
+    class WebhookEndpoint
+      attr_reader id: Integer?
+      attr_reader name: String?
+      attr_reader url: String?
+      attr_reader events: Array[untyped]?
+      attr_reader status: String?
+      attr_reader source: String?
+      attr_reader description: String?
+      attr_reader created_by_app: untyped
+      attr_reader created_at: String?
+      attr_reader previous_secret_expires_at: String?
+      def self.from: (Hash[String, untyped] hash) -> WebhookEndpoint
+    end
+    class EmailTemplate
+      attr_reader id: Integer?
+      attr_reader name: String?
+      attr_reader is_default: bool?
+      attr_reader category: String?
+      def self.from: (Hash[String, untyped] hash) -> EmailTemplate
+    end
+    class Segment
+      attr_reader id: Integer?
+      attr_reader name: String?
+      attr_reader created_at: String?
+      def self.from: (Hash[String, untyped] hash) -> Segment
+    end
+    class Post
+      attr_reader id: Integer?
+      attr_reader publication_id: Integer?
+      attr_reader created_at: String?
+      attr_reader title: String?
+      attr_reader slug: String?
+      attr_reader description: String?
+      attr_reader meta_description: String?
+      attr_reader status: String?
+      attr_reader published_at: String?
+      attr_reader sent_at: String?
+      attr_reader thumbnail_alt: String?
+      attr_reader thumbnail_url: String?
+      attr_reader is_paid: bool?
+      attr_reader public_url: String?
+      def self.from: (Hash[String, untyped] hash) -> Post
+    end
+    class Snippet
+      attr_reader id: Integer?
+      attr_reader name: String?
+      attr_reader snippet_type: String?
+      attr_reader archived: bool?
+      attr_reader key: String?
+      attr_reader created_at: String?
+      attr_reader updated_at: String?
+      attr_reader content: String?
+      attr_reader document: untyped
+      def self.from: (Hash[String, untyped] hash) -> Snippet
+    end
+    class Purchase
+      attr_reader id: Integer?
+      attr_reader transaction_id: String?
+      attr_reader subscriber_id: Integer?
+      attr_reader status: String?
+      attr_reader email_address: String?
+      attr_reader currency: String?
+      attr_reader transaction_time: String?
+      attr_reader subtotal: Numeric?
+      attr_reader discount: Numeric?
+      attr_reader tax: Numeric?
+      attr_reader total: Numeric?
+      attr_reader products: Array[untyped]?
+      attr_reader source: String?
+      def self.from: (Hash[String, untyped] hash) -> Purchase
+    end
+    class SequenceEmail
+      attr_reader id: Integer?
+      attr_reader sequence_id: Integer?
+      attr_reader subject: String?
+      attr_reader preview_text: String?
+      attr_reader email_address: String?
+      attr_reader email_template_id: Integer?
+      attr_reader published: bool?
+      attr_reader position: Integer?
+      attr_reader delay_value: Integer?
+      attr_reader delay_unit: String?
+      attr_reader send_days: Array[untyped]?
+      attr_reader stats: Hash[String, untyped]?
+      def self.from: (Hash[String, untyped] hash) -> SequenceEmail
+    end
+    class BroadcastStats
+      attr_reader id: Integer?
+      attr_reader subject: String?
+      attr_reader send_at: String?
+      attr_reader recipients: Integer?
+      attr_reader open_rate: Numeric?
+      attr_reader emails_opened: Integer?
+      attr_reader click_rate: Numeric?
+      attr_reader unsubscribe_rate: Numeric?
+      attr_reader unsubscribes: Integer?
+      attr_reader total_clicks: Integer?
+      attr_reader show_total_clicks: bool?
+      attr_reader status: String?
+      attr_reader progress: Numeric?
+      attr_reader open_tracking_disabled: bool?
+      attr_reader click_tracking_disabled: bool?
+      def self.from: (Hash[String, untyped] hash) -> BroadcastStats
+    end
+    class BroadcastClick
+      attr_reader id: Integer?
+      attr_reader url: String?
+      attr_reader unique_clicks: Integer?
+      attr_reader click_to_delivery_rate: Numeric?
+      attr_reader click_to_open_rate: Numeric?
+      def self.from: (Hash[String, untyped] hash) -> BroadcastClick
+    end
+    class SubscriberStats
+      attr_reader id: Integer?
+      attr_reader sent: Integer?
+      attr_reader opened: Integer?
+      attr_reader clicked: Integer?
+      attr_reader bounced: Integer?
+      attr_reader open_rate: Numeric?
+      attr_reader click_rate: Numeric?
+      attr_reader last_sent: String?
+      attr_reader last_opened: String?
+      attr_reader last_clicked: String?
+      attr_reader sends_since_last_open: Integer?
+      attr_reader sends_since_last_click: Integer?
+      def self.from: (Hash[String, untyped] hash) -> SubscriberStats
+    end
+    class EmailStats
+      attr_reader sent: Integer?
+      attr_reader clicked: Integer?
+      attr_reader opened: Integer?
+      attr_reader email_stats_mode: String?
+      attr_reader open_tracking_enabled: bool?
+      attr_reader click_tracking_enabled: bool?
+      attr_reader starting: String?
+      attr_reader ending: String?
+      attr_reader open_rate: Numeric?
+      attr_reader click_rate: Numeric?
+      attr_reader unsubscribe_rate: Numeric?
+      attr_reader bounce_rate: Numeric?
+      def self.from: (Hash[String, untyped] hash) -> EmailStats
+    end
+    class GrowthStats
+      attr_reader cancellations: Integer?
+      attr_reader net_new_subscribers: Integer?
+      attr_reader new_subscribers: Integer?
+      attr_reader subscribers: Integer?
+      attr_reader starting: String?
+      attr_reader ending: String?
+      def self.from: (Hash[String, untyped] hash) -> GrowthStats
+    end
+    class Subscriber
+      attr_reader id: Integer?
+      attr_reader first_name: String?
+      attr_reader email_address: String?
+      attr_reader state: String?
+      attr_reader created_at: String?
+      attr_reader canceled_at: String?
+      attr_reader location: Hash[String, untyped]?
+      attr_reader fields: Hash[String, untyped]?
+      def self.from: (Hash[String, untyped] hash) -> Subscriber
+    end
   end
 
   module Resources
@@ -89,6 +395,114 @@ module Kit
     end
     class Account < Base
       def get: () -> Objects::AccountInfo
+      def colors: () -> Array[String]
+      def update_colors: (Array[String] colors) -> Array[String]
+      def creator_profile: () -> Objects::CreatorProfile
+      def email_stats: () -> Objects::EmailStats
+      def growth_stats: (**untyped params) -> Objects::GrowthStats
+    end
+    class Subscribers < Base
+      def list: (**untyped params) -> Collection[Objects::Subscriber]
+      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 filter: (**untyped params) -> Collection[Objects::Subscriber]
+      def tags: (Integer id, **untyped params) -> Collection[Objects::Tag]
+      def stats: (Integer id) -> Objects::SubscriberStats
+      def set_location: (Integer id, location: Hash[untyped, untyped]) -> Objects::Subscriber
+      def remove_location: (Integer id) -> void
+    end
+    class Tags < Base
+      def list: (**untyped params) -> Collection[Objects::Tag]
+      def create: (name: String) -> Objects::Tag
+      def update: (Integer id, name: String) -> Objects::Tag
+      def tag_subscriber: (Integer tag_id, Integer subscriber_id) -> Objects::Subscriber
+      def remove_subscriber: (Integer tag_id, Integer subscriber_id) -> untyped
+      def tag_subscriber_by_email: (Integer tag_id, email_address: String) -> Objects::Subscriber
+      def remove_subscriber_by_email: (Integer tag_id, email_address: String) -> void
+      def subscribers: (Integer tag_id, **untyped params) -> Collection[Objects::Subscriber]
+    end
+    class CustomFields < Base
+      def list: (**untyped params) -> Collection[Objects::CustomField]
+      def create: (label: String) -> Objects::CustomField
+      def update: (Integer id, label: String) -> Objects::CustomField
+      def delete: (Integer id) -> void
+    end
+    class Forms < Base
+      def list: (**untyped params) -> Collection[Objects::Form]
+      def subscribers: (Integer form_id, **untyped params) -> Collection[Objects::Subscriber]
+      def add_subscriber: (Integer form_id, Integer subscriber_id, ?referrer: String?) -> Objects::Subscriber
+      def add_subscriber_by_email: (Integer form_id, email_address: String, ?referrer: String?) -> Objects::Subscriber
+    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 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 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 delete: (Integer id) -> void
+      def stats_list: (**untyped params) -> Collection[Objects::BroadcastStats]
+      def stats: (Integer id) -> Objects::BroadcastStats
+      def clicks: (Integer id, **untyped params) -> Collection[Objects::BroadcastClick]
+    end
+    class EmailTemplates < Base
+      def list: (**untyped params) -> Collection[Objects::EmailTemplate]
+    end
+    class Posts < Base
+      def list: (**untyped params) -> Collection[Objects::Post]
+      def get: (Integer id) -> Objects::Post
+    end
+    class Purchases < Base
+      def list: (**untyped params) -> Collection[Objects::Purchase]
+      def get: (Integer id) -> Objects::Purchase
+      def create: (**untyped attributes) -> 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]
+    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
+    end
+    class Segments < Base
+      def list: (**untyped params) -> Collection[Objects::Segment]
+    end
+    class Webhooks < Base
+      def list: (**untyped params) -> Collection[Objects::Webhook]
+      def create: (target_url: String, event: Hash[untyped, untyped]) -> Objects::Webhook
+      def delete: (Integer id) -> void
+    end
+    class WebhookEndpoints < Base
+      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 delete: (Integer id) -> void
+      def rotate_secret: (Integer id, ?force: bool?) -> Objects::WebhookEndpoint
+      def revoke_previous_secret: (Integer id) -> Objects::WebhookEndpoint
     end
   end
 
@@ -96,5 +510,19 @@ module Kit
     attr_reader config: Configuration
     def initialize: (?api_key: String?, ?access_token: String?, **untyped options) -> void
     def account: () -> Resources::Account
+    def subscribers: () -> Resources::Subscribers
+    def tags: () -> Resources::Tags
+    def custom_fields: () -> Resources::CustomFields
+    def forms: () -> Resources::Forms
+    def sequences: () -> Resources::Sequences
+    def broadcasts: () -> Resources::Broadcasts
+    def webhooks: () -> Resources::Webhooks
+    def webhook_endpoints: () -> Resources::WebhookEndpoints
+    def email_templates: () -> Resources::EmailTemplates
+    def segments: () -> Resources::Segments
+    def posts: () -> Resources::Posts
+    def snippets: () -> Resources::Snippets
+    def purchases: () -> Resources::Purchases
+    def bulk: () -> Resources::Bulk
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kit-rb
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Lawrence Lin
@@ -44,18 +44,56 @@ files:
 - lib/kit/configuration.rb
 - lib/kit/connection.rb
 - lib/kit/errors.rb
+- lib/kit/oauth/client.rb
+- lib/kit/oauth/pkce.rb
+- lib/kit/oauth/token.rb
 - lib/kit/objects/account.rb
+- lib/kit/objects/broadcast.rb
+- lib/kit/objects/broadcast_click.rb
+- lib/kit/objects/broadcast_stats.rb
+- lib/kit/objects/creator_profile.rb
+- lib/kit/objects/custom_field.rb
+- lib/kit/objects/email_stats.rb
+- lib/kit/objects/email_template.rb
+- lib/kit/objects/form.rb
+- lib/kit/objects/growth_stats.rb
+- lib/kit/objects/post.rb
+- lib/kit/objects/purchase.rb
+- lib/kit/objects/segment.rb
+- lib/kit/objects/sequence.rb
+- lib/kit/objects/sequence_email.rb
+- lib/kit/objects/snippet.rb
+- lib/kit/objects/subscriber.rb
+- lib/kit/objects/subscriber_stats.rb
+- lib/kit/objects/tag.rb
+- lib/kit/objects/webhook.rb
+- lib/kit/objects/webhook_endpoint.rb
+- lib/kit/pagination.rb
 - lib/kit/resources/account.rb
 - lib/kit/resources/base.rb
+- lib/kit/resources/broadcasts.rb
+- lib/kit/resources/bulk.rb
+- lib/kit/resources/custom_fields.rb
+- lib/kit/resources/email_templates.rb
+- lib/kit/resources/forms.rb
+- lib/kit/resources/posts.rb
+- lib/kit/resources/purchases.rb
+- lib/kit/resources/segments.rb
+- lib/kit/resources/sequences.rb
+- lib/kit/resources/snippets.rb
+- lib/kit/resources/subscribers.rb
+- lib/kit/resources/tags.rb
+- lib/kit/resources/webhook_endpoints.rb
+- lib/kit/resources/webhooks.rb
 - lib/kit/version.rb
 - sig/kit-rb.rbs
-homepage: https://github.com/solcreek/kit-rb
+homepage: https://github.com/linyiru/kit-rb
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/solcreek/kit-rb
-  source_code_uri: https://github.com/solcreek/kit-rb
-  changelog_uri: https://github.com/solcreek/kit-rb/blob/main/CHANGELOG.md
+  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
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: