knockapi 0.6.1 → 1.0.0

data/lib/knockapi.rb

@@ -0,0 +1,239 @@
+# frozen_string_literal: true
+
+# Standard libraries.
+require "English"
+require "cgi"
+require "date"
+require "erb"
+require "etc"
+require "json"
+require "net/http"
+require "pathname"
+require "rbconfig"
+require "securerandom"
+require "set"
+require "stringio"
+require "time"
+require "uri"
+
+# We already ship the preferred sorbet manifests in the package itself.
+# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
+if Object.const_defined?(:Tapioca) && caller.chain([$PROGRAM_NAME]).chain(ARGV).grep(/tapioca/)
+  return
+end
+
+# Gems.
+require "connection_pool"
+
+# Package files.
+require_relative "knockapi/version"
+require_relative "knockapi/internal/util"
+require_relative "knockapi/internal/type/converter"
+require_relative "knockapi/internal/type/unknown"
+require_relative "knockapi/internal/type/boolean"
+require_relative "knockapi/internal/type/file_input"
+require_relative "knockapi/internal/type/enum"
+require_relative "knockapi/internal/type/union"
+require_relative "knockapi/internal/type/array_of"
+require_relative "knockapi/internal/type/hash_of"
+require_relative "knockapi/internal/type/base_model"
+require_relative "knockapi/internal/type/base_page"
+require_relative "knockapi/internal/type/request_parameters"
+require_relative "knockapi/internal"
+require_relative "knockapi/request_options"
+require_relative "knockapi/file_part"
+require_relative "knockapi/errors"
+require_relative "knockapi/internal/transport/base_client"
+require_relative "knockapi/internal/transport/pooled_net_requester"
+require_relative "knockapi/client"
+require_relative "knockapi/internal/entries_cursor"
+require_relative "knockapi/internal/items_cursor"
+require_relative "knockapi/internal/ms_teams_pagination"
+require_relative "knockapi/internal/slack_channels_cursor"
+require_relative "knockapi/models/recipients/channel_data_request"
+require_relative "knockapi/models/recipients/preference_set_request"
+require_relative "knockapi/models/identify_user_request"
+require_relative "knockapi/models/activity"
+require_relative "knockapi/models/audience_add_members_params"
+require_relative "knockapi/models/audience_list_members_params"
+require_relative "knockapi/models/audience_list_members_response"
+require_relative "knockapi/models/audience_member"
+require_relative "knockapi/models/audience_remove_members_params"
+require_relative "knockapi/models/bulk_operation"
+require_relative "knockapi/models/bulk_operation_get_params"
+require_relative "knockapi/models/channels/bulk_update_message_status_params"
+require_relative "knockapi/models/condition"
+require_relative "knockapi/models/inline_identify_user_request"
+require_relative "knockapi/models/inline_object_request"
+require_relative "knockapi/models/inline_tenant_request"
+require_relative "knockapi/models/integrations/census_custom_destination_params"
+require_relative "knockapi/models/integrations/census_custom_destination_response"
+require_relative "knockapi/models/integrations/hightouch_embedded_destination_params"
+require_relative "knockapi/models/integrations/hightouch_embedded_destination_response"
+require_relative "knockapi/models/message"
+require_relative "knockapi/models/message_archive_params"
+require_relative "knockapi/models/message_delivery_log"
+require_relative "knockapi/models/message_event"
+require_relative "knockapi/models/message_get_content_params"
+require_relative "knockapi/models/message_get_content_response"
+require_relative "knockapi/models/message_get_params"
+require_relative "knockapi/models/message_list_activities_params"
+require_relative "knockapi/models/message_list_delivery_logs_params"
+require_relative "knockapi/models/message_list_events_params"
+require_relative "knockapi/models/message_list_params"
+require_relative "knockapi/models/message_mark_as_interacted_params"
+require_relative "knockapi/models/message_mark_as_read_params"
+require_relative "knockapi/models/message_mark_as_seen_params"
+require_relative "knockapi/models/message_mark_as_unread_params"
+require_relative "knockapi/models/message_mark_as_unseen_params"
+require_relative "knockapi/models/messages/activity_list_params"
+require_relative "knockapi/models/messages/batch_archive_params"
+require_relative "knockapi/models/messages/batch_archive_response"
+require_relative "knockapi/models/messages/batch_get_content_params"
+require_relative "knockapi/models/messages/batch_get_content_response"
+require_relative "knockapi/models/messages/batch_mark_as_interacted_params"
+require_relative "knockapi/models/messages/batch_mark_as_interacted_response"
+require_relative "knockapi/models/messages/batch_mark_as_read_params"
+require_relative "knockapi/models/messages/batch_mark_as_read_response"
+require_relative "knockapi/models/messages/batch_mark_as_seen_params"
+require_relative "knockapi/models/messages/batch_mark_as_seen_response"
+require_relative "knockapi/models/messages/batch_mark_as_unread_params"
+require_relative "knockapi/models/messages/batch_mark_as_unread_response"
+require_relative "knockapi/models/messages/batch_mark_as_unseen_params"
+require_relative "knockapi/models/messages/batch_mark_as_unseen_response"
+require_relative "knockapi/models/messages/batch_unarchive_params"
+require_relative "knockapi/models/messages/batch_unarchive_response"
+require_relative "knockapi/models/message_unarchive_params"
+require_relative "knockapi/models/object"
+require_relative "knockapi/models/object_add_subscriptions_params"
+require_relative "knockapi/models/object_add_subscriptions_response"
+require_relative "knockapi/models/object_delete_params"
+require_relative "knockapi/models/object_delete_subscriptions_params"
+require_relative "knockapi/models/object_delete_subscriptions_response"
+require_relative "knockapi/models/object_get_channel_data_params"
+require_relative "knockapi/models/object_get_params"
+require_relative "knockapi/models/object_get_preferences_params"
+require_relative "knockapi/models/object_list_messages_params"
+require_relative "knockapi/models/object_list_params"
+require_relative "knockapi/models/object_list_preferences_params"
+require_relative "knockapi/models/object_list_preferences_response"
+require_relative "knockapi/models/object_list_schedules_params"
+require_relative "knockapi/models/object_list_subscriptions_params"
+require_relative "knockapi/models/objects/bulk_add_subscriptions_params"
+require_relative "knockapi/models/objects/bulk_delete_params"
+require_relative "knockapi/models/objects/bulk_set_params"
+require_relative "knockapi/models/object_set_channel_data_params"
+require_relative "knockapi/models/object_set_params"
+require_relative "knockapi/models/object_set_preferences_params"
+require_relative "knockapi/models/object_unset_channel_data_params"
+require_relative "knockapi/models/page_info"
+require_relative "knockapi/models/providers/ms_team_check_auth_params"
+require_relative "knockapi/models/providers/ms_team_check_auth_response"
+require_relative "knockapi/models/providers/ms_team_list_channels_params"
+require_relative "knockapi/models/providers/ms_team_list_channels_response"
+require_relative "knockapi/models/providers/ms_team_list_teams_params"
+require_relative "knockapi/models/providers/ms_team_list_teams_response"
+require_relative "knockapi/models/providers/ms_team_revoke_access_params"
+require_relative "knockapi/models/providers/ms_team_revoke_access_response"
+require_relative "knockapi/models/providers/slack_check_auth_params"
+require_relative "knockapi/models/providers/slack_check_auth_response"
+require_relative "knockapi/models/providers/slack_list_channels_params"
+require_relative "knockapi/models/providers/slack_list_channels_response"
+require_relative "knockapi/models/providers/slack_revoke_access_params"
+require_relative "knockapi/models/providers/slack_revoke_access_response"
+require_relative "knockapi/models/recipient"
+require_relative "knockapi/models/recipient_reference"
+require_relative "knockapi/models/recipient_request"
+require_relative "knockapi/models/recipients/discord_channel_data"
+require_relative "knockapi/models/recipients/inline_channel_data_request"
+require_relative "knockapi/models/recipients/inline_preference_set_request"
+require_relative "knockapi/models/recipients/ms_teams_channel_data"
+require_relative "knockapi/models/recipients/one_signal_channel_data"
+require_relative "knockapi/models/recipients/preference_set"
+require_relative "knockapi/models/recipients/preference_set_channel_types"
+require_relative "knockapi/models/recipients/preference_set_channel_type_setting"
+require_relative "knockapi/models/recipients/push_channel_data"
+require_relative "knockapi/models/recipients/channel_data"
+require_relative "knockapi/models/recipients/slack_channel_data"
+require_relative "knockapi/models/recipients/subscription"
+require_relative "knockapi/models/schedule"
+require_relative "knockapi/models/schedule_create_params"
+require_relative "knockapi/models/schedule_create_response"
+require_relative "knockapi/models/schedule_delete_params"
+require_relative "knockapi/models/schedule_delete_response"
+require_relative "knockapi/models/schedule_list_params"
+require_relative "knockapi/models/schedule_repeat_rule"
+require_relative "knockapi/models/schedules/bulk_create_params"
+require_relative "knockapi/models/schedule_update_params"
+require_relative "knockapi/models/schedule_update_response"
+require_relative "knockapi/models/tenant"
+require_relative "knockapi/models/tenant_delete_params"
+require_relative "knockapi/models/tenant_get_params"
+require_relative "knockapi/models/tenant_list_params"
+require_relative "knockapi/models/tenant_request"
+require_relative "knockapi/models/tenants/bulk_delete_params"
+require_relative "knockapi/models/tenants/bulk_set_params"
+require_relative "knockapi/models/tenant_set_params"
+require_relative "knockapi/models/user"
+require_relative "knockapi/models/user_delete_params"
+require_relative "knockapi/models/user_get_channel_data_params"
+require_relative "knockapi/models/user_get_params"
+require_relative "knockapi/models/user_get_preferences_params"
+require_relative "knockapi/models/user_list_messages_params"
+require_relative "knockapi/models/user_list_params"
+require_relative "knockapi/models/user_list_preferences_params"
+require_relative "knockapi/models/user_list_preferences_response"
+require_relative "knockapi/models/user_list_schedules_params"
+require_relative "knockapi/models/user_list_subscriptions_params"
+require_relative "knockapi/models/user_merge_params"
+require_relative "knockapi/models/users/bulk_delete_params"
+require_relative "knockapi/models/users/bulk_identify_params"
+require_relative "knockapi/models/users/bulk_set_preferences_params"
+require_relative "knockapi/models/users/feed_get_settings_params"
+require_relative "knockapi/models/users/feed_get_settings_response"
+require_relative "knockapi/models/users/feed_list_items_params"
+require_relative "knockapi/models/users/feed_list_items_response"
+require_relative "knockapi/models/users/guide_get_channel_params"
+require_relative "knockapi/models/users/guide_get_channel_response"
+require_relative "knockapi/models/users/guide_mark_message_as_archived_params"
+require_relative "knockapi/models/users/guide_mark_message_as_archived_response"
+require_relative "knockapi/models/users/guide_mark_message_as_interacted_params"
+require_relative "knockapi/models/users/guide_mark_message_as_interacted_response"
+require_relative "knockapi/models/users/guide_mark_message_as_seen_params"
+require_relative "knockapi/models/users/guide_mark_message_as_seen_response"
+require_relative "knockapi/models/user_set_channel_data_params"
+require_relative "knockapi/models/user_set_preferences_params"
+require_relative "knockapi/models/user_unset_channel_data_params"
+require_relative "knockapi/models/user_update_params"
+require_relative "knockapi/models/workflow_cancel_params"
+require_relative "knockapi/models/workflow_trigger_params"
+require_relative "knockapi/models/workflow_trigger_response"
+require_relative "knockapi/resources/audiences"
+require_relative "knockapi/resources/bulk_operations"
+require_relative "knockapi/resources/channels"
+require_relative "knockapi/resources/channels/bulk"
+require_relative "knockapi/resources/integrations"
+require_relative "knockapi/resources/integrations/census"
+require_relative "knockapi/resources/integrations/hightouch"
+require_relative "knockapi/resources/messages"
+require_relative "knockapi/resources/messages/activities"
+require_relative "knockapi/resources/messages/batch"
+require_relative "knockapi/resources/objects"
+require_relative "knockapi/resources/objects/bulk"
+require_relative "knockapi/resources/providers"
+require_relative "knockapi/resources/providers/ms_teams"
+require_relative "knockapi/resources/providers/slack"
+require_relative "knockapi/resources/recipients"
+require_relative "knockapi/resources/recipients/channel_data"
+require_relative "knockapi/resources/recipients/preferences"
+require_relative "knockapi/resources/recipients/subscriptions"
+require_relative "knockapi/resources/schedules"
+require_relative "knockapi/resources/schedules/bulk"
+require_relative "knockapi/resources/shared"
+require_relative "knockapi/resources/tenants"
+require_relative "knockapi/resources/tenants/bulk"
+require_relative "knockapi/resources/users"
+require_relative "knockapi/resources/users/bulk"
+require_relative "knockapi/resources/users/feeds"
+require_relative "knockapi/resources/users/guides"
+require_relative "knockapi/resources/workflows"

data/manifest.yaml

@@ -0,0 +1,15 @@
+dependencies:
+  - English
+  - cgi
+  - date
+  - erb
+  - etc
+  - json
+  - net/http
+  - pathname
+  - rbconfig
+  - securerandom
+  - set
+  - stringio
+  - time
+  - uri

data/rbi/knockapi/client.rbi

@@ -0,0 +1,84 @@
+# typed: strong
+
+module Knockapi
+  class Client < Knockapi::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES = 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS = T.let(60.0, Float)
+
+    DEFAULT_INITIAL_RETRY_DELAY = T.let(0.5, Float)
+
+    DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
+
+    sig { returns(String) }
+    attr_reader :api_key
+
+    sig { returns(Knockapi::Resources::Shared) }
+    attr_reader :shared
+
+    sig { returns(Knockapi::Resources::Recipients) }
+    attr_reader :recipients
+
+    sig { returns(Knockapi::Resources::Users) }
+    attr_reader :users
+
+    sig { returns(Knockapi::Resources::Objects) }
+    attr_reader :objects
+
+    sig { returns(Knockapi::Resources::Tenants) }
+    attr_reader :tenants
+
+    sig { returns(Knockapi::Resources::BulkOperations) }
+    attr_reader :bulk_operations
+
+    sig { returns(Knockapi::Resources::Messages) }
+    attr_reader :messages
+
+    sig { returns(Knockapi::Resources::Providers) }
+    attr_reader :providers
+
+    sig { returns(Knockapi::Resources::Integrations) }
+    attr_reader :integrations
+
+    sig { returns(Knockapi::Resources::Workflows) }
+    attr_reader :workflows
+
+    sig { returns(Knockapi::Resources::Schedules) }
+    attr_reader :schedules
+
+    sig { returns(Knockapi::Resources::Channels) }
+    attr_reader :channels
+
+    sig { returns(Knockapi::Resources::Audiences) }
+    attr_reader :audiences
+
+    # @api private
+    sig { override.returns(T::Hash[String, String]) }
+    private def auth_headers; end
+
+    # Creates and returns a new client for interacting with the API.
+    sig do
+      params(
+        api_key: T.nilable(String),
+        base_url: T.nilable(String),
+        max_retries: Integer,
+        timeout: Float,
+        initial_retry_delay: Float,
+        max_retry_delay: Float
+      )
+        .returns(T.attached_class)
+    end
+    def self.new(
+      # Defaults to `ENV["KNOCK_API_KEY"]`
+      api_key: ENV["KNOCK_API_KEY"],
+      # Override the default base URL for the API, e.g.,
+      # `"https://api.example.com/v2/"`. Defaults to `ENV["KNOCK_BASE_URL"]`
+      base_url: ENV["KNOCK_BASE_URL"],
+      # Max number of retries to attempt after a failed retryable request.
+      max_retries: Knockapi::Client::DEFAULT_MAX_RETRIES,
+      timeout: Knockapi::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: Knockapi::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: Knockapi::Client::DEFAULT_MAX_RETRY_DELAY
+    ); end
+  end
+end

data/rbi/knockapi/errors.rbi

@@ -0,0 +1,143 @@
+# typed: strong
+
+module Knockapi
+  module Errors
+    class Error < StandardError
+      sig { returns(T.nilable(StandardError)) }
+      attr_accessor :cause
+    end
+
+    class ConversionError < Knockapi::Errors::Error
+    end
+
+    class APIError < Knockapi::Errors::Error
+      sig { returns(URI::Generic) }
+      attr_accessor :url
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :status
+
+      sig { returns(T.nilable(T.anything)) }
+      attr_accessor :body
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: T.nilable(Integer),
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: nil); end
+    end
+
+    class APIConnectionError < Knockapi::Errors::APIError
+      sig { void }
+      attr_accessor :status
+
+      sig { void }
+      attr_accessor :body
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: NilClass,
+          body: NilClass,
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Connection error.")
+      end
+    end
+
+    class APITimeoutError < Knockapi::Errors::APIConnectionError
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: NilClass,
+          body: NilClass,
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Request timed out.")
+      end
+    end
+
+    class APIStatusError < Knockapi::Errors::APIError
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: Integer,
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        )
+          .returns(T.attached_class)
+      end
+      def self.for(url:, status:, body:, request:, response:, message: nil); end
+
+      sig { returns(Integer) }
+      attr_accessor :status
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: Integer,
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(url:, status:, body:, request:, response:, message: nil); end
+    end
+
+    class BadRequestError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS = 400
+    end
+
+    class AuthenticationError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS = 401
+    end
+
+    class PermissionDeniedError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS = 403
+    end
+
+    class NotFoundError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS = 404
+    end
+
+    class ConflictError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS = 409
+    end
+
+    class UnprocessableEntityError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS = 422
+    end
+
+    class RateLimitError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS = 429
+    end
+
+    class InternalServerError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS = T.let(500.., T::Range[Integer])
+    end
+  end
+end

data/rbi/knockapi/file_part.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module Knockapi
+  class FilePart
+    sig { returns(T.any(Pathname, StringIO, IO, String)) }
+    attr_reader :content
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :content_type
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :filename
+
+    # @api private
+    sig { returns(String) }
+    private def read; end
+
+    sig { params(a: T.anything).returns(String) }
+    def to_json(*a); end
+
+    sig { params(a: T.anything).returns(String) }
+    def to_yaml(*a); end
+
+    sig do
+      params(
+        content: T.any(Pathname, StringIO, IO, String),
+        filename: T.nilable(String),
+        content_type: T.nilable(String)
+      )
+        .returns(T.attached_class)
+    end
+    def self.new(content, filename: nil, content_type: nil); end
+  end
+end

data/rbi/knockapi/internal/entries_cursor.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Knockapi
+  module Internal
+    class EntriesCursor
+      include Knockapi::Internal::Type::BasePage
+
+      Elem = type_member
+
+      sig { returns(T.nilable(T::Array[Elem])) }
+      attr_accessor :entries
+
+      sig { returns(PageInfo) }
+      attr_accessor :page_info
+
+      # @api private
+      sig { returns(String) }
+      def inspect; end
+
+      class PageInfo < Knockapi::Internal::Type::BaseModel
+        sig { returns(T.nilable(String)) }
+        attr_reader :after
+
+        sig { params(after: String).void }
+        attr_writer :after
+
+        sig { params(after: String).returns(T.attached_class) }
+        def self.new(after: nil); end
+
+        sig { override.returns({after: String}) }
+        def to_hash; end
+      end
+    end
+  end
+end

data/rbi/knockapi/internal/items_cursor.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Knockapi
+  module Internal
+    class ItemsCursor
+      include Knockapi::Internal::Type::BasePage
+
+      Elem = type_member
+
+      sig { returns(T.nilable(T::Array[Elem])) }
+      attr_accessor :items
+
+      sig { returns(PageInfo) }
+      attr_accessor :page_info
+
+      # @api private
+      sig { returns(String) }
+      def inspect; end
+
+      class PageInfo < Knockapi::Internal::Type::BaseModel
+        sig { returns(T.nilable(String)) }
+        attr_reader :after
+
+        sig { params(after: String).void }
+        attr_writer :after
+
+        sig { params(after: String).returns(T.attached_class) }
+        def self.new(after: nil); end
+
+        sig { override.returns({after: String}) }
+        def to_hash; end
+      end
+    end
+  end
+end

data/rbi/knockapi/internal/ms_teams_pagination.rbi

@@ -0,0 +1,21 @@
+# typed: strong
+
+module Knockapi
+  module Internal
+    class MsTeamsPagination
+      include Knockapi::Internal::Type::BasePage
+
+      Elem = type_member
+
+      sig { returns(String) }
+      attr_accessor :skip_token
+
+      sig { returns(T.nilable(T::Array[Elem])) }
+      attr_accessor :ms_teams_teams
+
+      # @api private
+      sig { returns(String) }
+      def inspect; end
+    end
+  end
+end

data/rbi/knockapi/internal/slack_channels_cursor.rbi

@@ -0,0 +1,21 @@
+# typed: strong
+
+module Knockapi
+  module Internal
+    class SlackChannelsCursor
+      include Knockapi::Internal::Type::BasePage
+
+      Elem = type_member
+
+      sig { returns(String) }
+      attr_accessor :next_cursor
+
+      sig { returns(T.nilable(T::Array[Elem])) }
+      attr_accessor :slack_channels
+
+      # @api private
+      sig { returns(String) }
+      def inspect; end
+    end
+  end
+end