trycourier 4.6.2 → 4.6.3

data/lib/trycourier.rb

@@ -1,300 +0,0 @@
-# frozen_string_literal: true
-
-# Standard libraries.
-# rubocop:disable Lint/RedundantRequireStatement
-require "English"
-require "base64"
-require "cgi"
-require "date"
-require "erb"
-require "etc"
-require "json"
-require "net/http"
-require "openssl"
-require "pathname"
-require "rbconfig"
-require "securerandom"
-require "set"
-require "stringio"
-require "time"
-require "uri"
-# rubocop:enable Lint/RedundantRequireStatement
-
-# 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).any?(/tapioca/) &&
-   ARGV.none?(/dsl/)
-  return
-end
-
-# Gems.
-require "connection_pool"
-
-# Package files.
-require_relative "trycourier/version"
-require_relative "trycourier/internal/util"
-require_relative "trycourier/internal/type/converter"
-require_relative "trycourier/internal/type/unknown"
-require_relative "trycourier/internal/type/boolean"
-require_relative "trycourier/internal/type/file_input"
-require_relative "trycourier/internal/type/enum"
-require_relative "trycourier/internal/type/union"
-require_relative "trycourier/internal/type/array_of"
-require_relative "trycourier/internal/type/hash_of"
-require_relative "trycourier/internal/type/base_model"
-require_relative "trycourier/internal/type/base_page"
-require_relative "trycourier/internal/type/request_parameters"
-require_relative "trycourier/internal"
-require_relative "trycourier/request_options"
-require_relative "trycourier/file_part"
-require_relative "trycourier/errors"
-require_relative "trycourier/internal/transport/base_client"
-require_relative "trycourier/internal/transport/pooled_net_requester"
-require_relative "trycourier/client"
-require_relative "trycourier/models/elemental_base_node"
-require_relative "trycourier/models/brand_template"
-require_relative "trycourier/models/inbound_bulk_message_user"
-require_relative "trycourier/models/base_check"
-require_relative "trycourier/models/subscription_topic_new"
-require_relative "trycourier/models/elemental_channel_node"
-require_relative "trycourier/models/message_details"
-require_relative "trycourier/models/base_template_tenant_association"
-require_relative "trycourier/models/users/user_token"
-require_relative "trycourier/models/airship_profile"
-require_relative "trycourier/models/airship_profile_audience"
-require_relative "trycourier/models/alignment"
-require_relative "trycourier/models/audience"
-require_relative "trycourier/models/audience_delete_params"
-require_relative "trycourier/models/audience_filter"
-require_relative "trycourier/models/audience_filter_config"
-require_relative "trycourier/models/audience_list_members_params"
-require_relative "trycourier/models/audience_list_members_response"
-require_relative "trycourier/models/audience_list_params"
-require_relative "trycourier/models/audience_list_response"
-require_relative "trycourier/models/audience_recipient"
-require_relative "trycourier/models/audience_retrieve_params"
-require_relative "trycourier/models/audience_update_params"
-require_relative "trycourier/models/audience_update_response"
-require_relative "trycourier/models/audit_event"
-require_relative "trycourier/models/audit_event_list_params"
-require_relative "trycourier/models/audit_event_list_response"
-require_relative "trycourier/models/audit_event_retrieve_params"
-require_relative "trycourier/models/auth_issue_token_params"
-require_relative "trycourier/models/auth_issue_token_response"
-require_relative "trycourier/models/automation_invoke_response"
-require_relative "trycourier/models/automation_list_params"
-require_relative "trycourier/models/automations/invoke_invoke_ad_hoc_params"
-require_relative "trycourier/models/automations/invoke_invoke_by_template_params"
-require_relative "trycourier/models/automation_template"
-require_relative "trycourier/models/automation_template_list_response"
-require_relative "trycourier/models/brand"
-require_relative "trycourier/models/brand_colors"
-require_relative "trycourier/models/brand_create_params"
-require_relative "trycourier/models/brand_delete_params"
-require_relative "trycourier/models/brand_list_params"
-require_relative "trycourier/models/brand_list_response"
-require_relative "trycourier/models/brand_retrieve_params"
-require_relative "trycourier/models/brand_settings"
-require_relative "trycourier/models/brand_settings_email"
-require_relative "trycourier/models/brand_settings_in_app"
-require_relative "trycourier/models/brand_snippet"
-require_relative "trycourier/models/brand_snippets"
-require_relative "trycourier/models/brand_update_params"
-require_relative "trycourier/models/bulk_add_users_params"
-require_relative "trycourier/models/bulk_create_job_params"
-require_relative "trycourier/models/bulk_create_job_response"
-require_relative "trycourier/models/bulk_list_users_params"
-require_relative "trycourier/models/bulk_list_users_response"
-require_relative "trycourier/models/bulk_retrieve_job_params"
-require_relative "trycourier/models/bulk_retrieve_job_response"
-require_relative "trycourier/models/bulk_run_job_params"
-require_relative "trycourier/models/channel_classification"
-require_relative "trycourier/models/channel_preference"
-require_relative "trycourier/models/check"
-require_relative "trycourier/models/default_preferences"
-require_relative "trycourier/models/device_type"
-require_relative "trycourier/models/discord"
-require_relative "trycourier/models/elemental_action_node_with_type"
-require_relative "trycourier/models/elemental_channel_node_with_type"
-require_relative "trycourier/models/elemental_content"
-require_relative "trycourier/models/elemental_content_sugar"
-require_relative "trycourier/models/elemental_divider_node_with_type"
-require_relative "trycourier/models/elemental_image_node_with_type"
-require_relative "trycourier/models/elemental_meta_node_with_type"
-require_relative "trycourier/models/elemental_node"
-require_relative "trycourier/models/elemental_quote_node_with_type"
-require_relative "trycourier/models/elemental_text_node_with_type"
-require_relative "trycourier/models/email_footer"
-require_relative "trycourier/models/email_head"
-require_relative "trycourier/models/email_header"
-require_relative "trycourier/models/expo"
-require_relative "trycourier/models/filter_config"
-require_relative "trycourier/models/icons"
-require_relative "trycourier/models/inbound_bulk_message"
-require_relative "trycourier/models/inbound_track_event_params"
-require_relative "trycourier/models/inbound_track_event_response"
-require_relative "trycourier/models/intercom"
-require_relative "trycourier/models/intercom_recipient"
-require_relative "trycourier/models/list_delete_params"
-require_relative "trycourier/models/list_filter"
-require_relative "trycourier/models/list_list_params"
-require_relative "trycourier/models/list_list_response"
-require_relative "trycourier/models/list_pattern_recipient"
-require_relative "trycourier/models/list_recipient"
-require_relative "trycourier/models/list_restore_params"
-require_relative "trycourier/models/list_retrieve_params"
-require_relative "trycourier/models/lists/subscription_add_params"
-require_relative "trycourier/models/lists/subscription_list_params"
-require_relative "trycourier/models/lists/subscription_list_response"
-require_relative "trycourier/models/lists/subscription_subscribe_params"
-require_relative "trycourier/models/lists/subscription_subscribe_user_params"
-require_relative "trycourier/models/lists/subscription_unsubscribe_user_params"
-require_relative "trycourier/models/list_update_params"
-require_relative "trycourier/models/logo"
-require_relative "trycourier/models/message_cancel_params"
-require_relative "trycourier/models/message_content_params"
-require_relative "trycourier/models/message_content_response"
-require_relative "trycourier/models/message_context"
-require_relative "trycourier/models/message_history_params"
-require_relative "trycourier/models/message_history_response"
-require_relative "trycourier/models/message_list_params"
-require_relative "trycourier/models/message_list_response"
-require_relative "trycourier/models/message_retrieve_params"
-require_relative "trycourier/models/message_retrieve_response"
-require_relative "trycourier/models/message_routing"
-require_relative "trycourier/models/message_routing_channel"
-require_relative "trycourier/models/ms_teams"
-require_relative "trycourier/models/ms_teams_base_properties"
-require_relative "trycourier/models/ms_teams_recipient"
-require_relative "trycourier/models/multiple_tokens"
-require_relative "trycourier/models/notification_get_content"
-require_relative "trycourier/models/notification_list_params"
-require_relative "trycourier/models/notification_list_response"
-require_relative "trycourier/models/notification_preference_details"
-require_relative "trycourier/models/notification_retrieve_content_params"
-require_relative "trycourier/models/notifications/check_delete_params"
-require_relative "trycourier/models/notifications/check_list_params"
-require_relative "trycourier/models/notifications/check_list_response"
-require_relative "trycourier/models/notifications/check_update_params"
-require_relative "trycourier/models/notifications/check_update_response"
-require_relative "trycourier/models/notifications/draft_retrieve_content_params"
-require_relative "trycourier/models/pagerduty"
-require_relative "trycourier/models/pagerduty_recipient"
-require_relative "trycourier/models/paging"
-require_relative "trycourier/models/preference"
-require_relative "trycourier/models/preference_status"
-require_relative "trycourier/models/profile_create_params"
-require_relative "trycourier/models/profile_create_response"
-require_relative "trycourier/models/profile_delete_params"
-require_relative "trycourier/models/profile_replace_params"
-require_relative "trycourier/models/profile_replace_response"
-require_relative "trycourier/models/profile_retrieve_params"
-require_relative "trycourier/models/profile_retrieve_response"
-require_relative "trycourier/models/profiles/list_delete_params"
-require_relative "trycourier/models/profiles/list_delete_response"
-require_relative "trycourier/models/profiles/list_retrieve_params"
-require_relative "trycourier/models/profiles/list_retrieve_response"
-require_relative "trycourier/models/profiles/list_subscribe_params"
-require_relative "trycourier/models/profiles/list_subscribe_response"
-require_relative "trycourier/models/profile_update_params"
-require_relative "trycourier/models/put_subscriptions_recipient"
-require_relative "trycourier/models/recipient_preferences"
-require_relative "trycourier/models/request_archive_params"
-require_relative "trycourier/models/rule"
-require_relative "trycourier/models/send_direct_message"
-require_relative "trycourier/models/send_message_params"
-require_relative "trycourier/models/send_message_response"
-require_relative "trycourier/models/send_to_channel"
-require_relative "trycourier/models/send_to_ms_teams_channel_id"
-require_relative "trycourier/models/send_to_ms_teams_channel_name"
-require_relative "trycourier/models/send_to_ms_teams_conversation_id"
-require_relative "trycourier/models/send_to_ms_teams_email"
-require_relative "trycourier/models/send_to_ms_teams_user_id"
-require_relative "trycourier/models/send_to_slack_channel"
-require_relative "trycourier/models/send_to_slack_email"
-require_relative "trycourier/models/send_to_slack_user_id"
-require_relative "trycourier/models/slack"
-require_relative "trycourier/models/slack_base_properties"
-require_relative "trycourier/models/slack_recipient"
-require_relative "trycourier/models/subscribe_to_lists_request_item"
-require_relative "trycourier/models/subscription_list"
-require_relative "trycourier/models/tenant"
-require_relative "trycourier/models/tenant_association"
-require_relative "trycourier/models/tenant_delete_params"
-require_relative "trycourier/models/tenant_list_params"
-require_relative "trycourier/models/tenant_list_response"
-require_relative "trycourier/models/tenant_list_users_params"
-require_relative "trycourier/models/tenant_list_users_response"
-require_relative "trycourier/models/tenant_retrieve_params"
-require_relative "trycourier/models/tenants/preferences/item_delete_params"
-require_relative "trycourier/models/tenants/preferences/item_update_params"
-require_relative "trycourier/models/tenants/template_list_params"
-require_relative "trycourier/models/tenants/template_list_response"
-require_relative "trycourier/models/tenants/template_retrieve_params"
-require_relative "trycourier/models/tenant_update_params"
-require_relative "trycourier/models/text_style"
-require_relative "trycourier/models/token"
-require_relative "trycourier/models/translation_retrieve_params"
-require_relative "trycourier/models/translation_retrieve_response"
-require_relative "trycourier/models/translation_update_params"
-require_relative "trycourier/models/user_profile"
-require_relative "trycourier/models/user_profile_firebase_token"
-require_relative "trycourier/models/user_recipient"
-require_relative "trycourier/models/users/preference_retrieve_params"
-require_relative "trycourier/models/users/preference_retrieve_response"
-require_relative "trycourier/models/users/preference_retrieve_topic_params"
-require_relative "trycourier/models/users/preference_retrieve_topic_response"
-require_relative "trycourier/models/users/preference_update_or_create_topic_params"
-require_relative "trycourier/models/users/preference_update_or_create_topic_response"
-require_relative "trycourier/models/users/tenant_add_multiple_params"
-require_relative "trycourier/models/users/tenant_add_single_params"
-require_relative "trycourier/models/users/tenant_list_params"
-require_relative "trycourier/models/users/tenant_list_response"
-require_relative "trycourier/models/users/tenant_remove_all_params"
-require_relative "trycourier/models/users/tenant_remove_single_params"
-require_relative "trycourier/models/users/token_add_multiple_params"
-require_relative "trycourier/models/users/token_add_single_params"
-require_relative "trycourier/models/users/token_delete_params"
-require_relative "trycourier/models/users/token_list_params"
-require_relative "trycourier/models/users/token_list_response"
-require_relative "trycourier/models/users/token_retrieve_params"
-require_relative "trycourier/models/users/token_retrieve_response"
-require_relative "trycourier/models/users/token_update_params"
-require_relative "trycourier/models/users/topic_preference"
-require_relative "trycourier/models/utm"
-require_relative "trycourier/models/webhook_authentication"
-require_relative "trycourier/models/webhook_auth_mode"
-require_relative "trycourier/models/webhook_method"
-require_relative "trycourier/models/webhook_profile"
-require_relative "trycourier/models/webhook_profile_type"
-require_relative "trycourier/models/webhook_recipient"
-require_relative "trycourier/models/widget_background"
-require_relative "trycourier/models"
-require_relative "trycourier/resources/audiences"
-require_relative "trycourier/resources/audit_events"
-require_relative "trycourier/resources/auth"
-require_relative "trycourier/resources/automations"
-require_relative "trycourier/resources/automations/invoke"
-require_relative "trycourier/resources/brands"
-require_relative "trycourier/resources/bulk"
-require_relative "trycourier/resources/inbound"
-require_relative "trycourier/resources/lists"
-require_relative "trycourier/resources/lists/subscriptions"
-require_relative "trycourier/resources/messages"
-require_relative "trycourier/resources/notifications"
-require_relative "trycourier/resources/notifications/checks"
-require_relative "trycourier/resources/notifications/draft"
-require_relative "trycourier/resources/profiles"
-require_relative "trycourier/resources/profiles/lists"
-require_relative "trycourier/resources/requests"
-require_relative "trycourier/resources/send"
-require_relative "trycourier/resources/tenants"
-require_relative "trycourier/resources/tenants/preferences"
-require_relative "trycourier/resources/tenants/preferences/items"
-require_relative "trycourier/resources/tenants/templates"
-require_relative "trycourier/resources/translations"
-require_relative "trycourier/resources/users"
-require_relative "trycourier/resources/users/preferences"
-require_relative "trycourier/resources/users/tenants"
-require_relative "trycourier/resources/users/tokens"

data/rbi/trycourier/client.rbi

@@ -1,94 +0,0 @@
-# typed: strong
-
-module Trycourier
-  class Client < Trycourier::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(Trycourier::Resources::Send) }
-    attr_reader :send_
-
-    sig { returns(Trycourier::Resources::Audiences) }
-    attr_reader :audiences
-
-    sig { returns(Trycourier::Resources::AuditEvents) }
-    attr_reader :audit_events
-
-    sig { returns(Trycourier::Resources::Auth) }
-    attr_reader :auth
-
-    sig { returns(Trycourier::Resources::Automations) }
-    attr_reader :automations
-
-    sig { returns(Trycourier::Resources::Brands) }
-    attr_reader :brands
-
-    sig { returns(Trycourier::Resources::Bulk) }
-    attr_reader :bulk
-
-    sig { returns(Trycourier::Resources::Inbound) }
-    attr_reader :inbound
-
-    sig { returns(Trycourier::Resources::Lists) }
-    attr_reader :lists
-
-    sig { returns(Trycourier::Resources::Messages) }
-    attr_reader :messages
-
-    sig { returns(Trycourier::Resources::Requests) }
-    attr_reader :requests
-
-    sig { returns(Trycourier::Resources::Notifications) }
-    attr_reader :notifications
-
-    sig { returns(Trycourier::Resources::Profiles) }
-    attr_reader :profiles
-
-    sig { returns(Trycourier::Resources::Tenants) }
-    attr_reader :tenants
-
-    sig { returns(Trycourier::Resources::Translations) }
-    attr_reader :translations
-
-    sig { returns(Trycourier::Resources::Users) }
-    attr_reader :users
-
-    # @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["COURIER_API_KEY"]`
-      api_key: ENV["COURIER_API_KEY"],
-      # Override the default base URL for the API, e.g.,
-      # `"https://api.example.com/v2/"`. Defaults to `ENV["COURIER_BASE_URL"]`
-      base_url: ENV["COURIER_BASE_URL"],
-      # Max number of retries to attempt after a failed retryable request.
-      max_retries: Trycourier::Client::DEFAULT_MAX_RETRIES,
-      timeout: Trycourier::Client::DEFAULT_TIMEOUT_IN_SECONDS,
-      initial_retry_delay: Trycourier::Client::DEFAULT_INITIAL_RETRY_DELAY,
-      max_retry_delay: Trycourier::Client::DEFAULT_MAX_RETRY_DELAY
-    )
-    end
-  end
-end

data/rbi/trycourier/errors.rbi

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

data/rbi/trycourier/file_part.rbi

@@ -1,37 +0,0 @@
-# typed: strong
-
-module Trycourier
-  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(T.any(Pathname, String)),
-        content_type: T.nilable(String)
-      ).returns(T.attached_class)
-    end
-    def self.new(content, filename: nil, content_type: nil)
-    end
-  end
-end