RubyGems - trycourier - Versions diffs - 3.1.4 → 3.4.0.pre.alpha0 - Mend

trycourier 3.1.4 → 3.4.0.pre.alpha0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (969) hide show

data/lib/trycourier.rb CHANGED Viewed

@@ -1,127 +1,255 @@
 # frozen_string_literal: true
-require_relative "environment"
-require_relative "types_export"
-require_relative "requests"
-require_relative "trycourier/audiences/client"
-require_relative "trycourier/audit_events/client"
-require_relative "trycourier/auth_tokens/client"
-require_relative "trycourier/automations/client"
-require_relative "trycourier/brands/client"
-require_relative "trycourier/bulk/client"
-require_relative "trycourier/lists/client"
-require_relative "trycourier/messages/client"
-require_relative "trycourier/notifications/client"
-require_relative "trycourier/profiles/client"
-require_relative "trycourier/templates/client"
-require_relative "trycourier/tenants/client"
-require_relative "trycourier/translations/client"
-require_relative "trycourier/users/client"
-require_relative "trycourier/send/types/message"
-require_relative "trycourier/types/send_message_response"
+# Standard libraries.
+# rubocop:disable Lint/RedundantRequireStatement
+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"
+# rubocop:enable Lint/RedundantRequireStatement
-module Courier
-  class Client
-    attr_reader :audiences, :audit_events, :auth_tokens, :automations, :brands, :bulk, :lists, :messages,
-                :notifications, :profiles, :templates, :tenants, :translations, :users
-    # @param environment [Environment]
-    # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
-    # @param timeout_in_seconds [Long]
-    # @param authorization_token [String]
-    # @return [Client]
-    def initialize(authorization_token:, environment: Environment::PRODUCTION, max_retries: nil,
-                   timeout_in_seconds: nil)
-      @request_client = RequestClient.new(environment: environment, max_retries: max_retries,
-                                          timeout_in_seconds: timeout_in_seconds, authorization_token: authorization_token)
-      @audiences = AudiencesClient.new(request_client: @request_client)
-      @audit_events = AuditEventsClient.new(request_client: @request_client)
-      @auth_tokens = AuthTokensClient.new(request_client: @request_client)
-      @automations = AutomationsClient.new(request_client: @request_client)
-      @brands = BrandsClient.new(request_client: @request_client)
-      @bulk = BulkClient.new(request_client: @request_client)
-      @lists = ListsClient.new(request_client: @request_client)
-      @messages = MessagesClient.new(request_client: @request_client)
-      @notifications = NotificationsClient.new(request_client: @request_client)
-      @profiles = ProfilesClient.new(request_client: @request_client)
-      @templates = TemplatesClient.new(request_client: @request_client)
-      @tenants = TenantsClient.new(request_client: @request_client)
-      @translations = TranslationsClient.new(request_client: @request_client)
-      @users = Users::Client.new(request_client: @request_client)
-    end
-    # Use the send API to send a message to one or more recipients.
-    #
-    # @param message [Send::ContentMessage, Send::TemplateMessage] Defines the message to be delivered
-    # @param request_options [IdempotencyRequestOptions]
-    # @return [SendMessageResponse]
-    def send(message:, request_options: nil)
-      response = @request_client.conn.post("/send") do |req|
-        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-        unless request_options&.authorization_token.nil?
-          req.headers["Authorization"] =
-            request_options.authorization_token
-        end
-        req.headers["Idempotency-Key"] = request_options.idempotency_key unless request_options&.idempotency_key.nil?
-        unless request_options&.idempotency_expiry.nil?
-          req.headers["X-Idempotency-Expiration"] = request_options.idempotency_expiry
-        end
-        req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
-        req.body = { **(request_options&.additional_body_parameters || {}), message: message }.compact
-      end
-      SendMessageResponse.from_json(json_object: response.body)
-    end
-  end
-  class AsyncClient
-    attr_reader :audiences, :audit_events, :auth_tokens, :automations, :brands, :bulk, :lists, :messages,
-                :notifications, :profiles, :templates, :tenants, :translations, :users
+# 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
-    # @param environment [Environment]
-    # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
-    # @param timeout_in_seconds [Long]
-    # @param authorization_token [String]
-    # @return [AsyncClient]
-    def initialize(authorization_token:, environment: Environment::PRODUCTION, max_retries: nil,
-                   timeout_in_seconds: nil)
-      @async_request_client = AsyncRequestClient.new(environment: environment, max_retries: max_retries,
-                                                     timeout_in_seconds: timeout_in_seconds, authorization_token: authorization_token)
-      @audiences = AsyncAudiencesClient.new(request_client: @async_request_client)
-      @audit_events = AsyncAuditEventsClient.new(request_client: @async_request_client)
-      @auth_tokens = AsyncAuthTokensClient.new(request_client: @async_request_client)
-      @automations = AsyncAutomationsClient.new(request_client: @async_request_client)
-      @brands = AsyncBrandsClient.new(request_client: @async_request_client)
-      @bulk = AsyncBulkClient.new(request_client: @async_request_client)
-      @lists = AsyncListsClient.new(request_client: @async_request_client)
-      @messages = AsyncMessagesClient.new(request_client: @async_request_client)
-      @notifications = AsyncNotificationsClient.new(request_client: @async_request_client)
-      @profiles = AsyncProfilesClient.new(request_client: @async_request_client)
-      @templates = AsyncTemplatesClient.new(request_client: @async_request_client)
-      @tenants = AsyncTenantsClient.new(request_client: @async_request_client)
-      @translations = AsyncTranslationsClient.new(request_client: @async_request_client)
-      @users = Users::AsyncClient.new(request_client: @async_request_client)
-    end
+# Gems.
+require "connection_pool"
-    # Use the send API to send a message to one or more recipients.
-    #
-    # @param message [Send::ContentMessage, Send::TemplateMessage] Defines the message to be delivered
-    # @param request_options [IdempotencyRequestOptions]
-    # @return [SendMessageResponse]
-    def send(message:, request_options: nil)
-      response = @async_request_client.conn.post("/send") do |req|
-        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-        unless request_options&.authorization_token.nil?
-          req.headers["Authorization"] =
-            request_options.authorization_token
-        end
-        req.headers["Idempotency-Key"] = request_options.idempotency_key unless request_options&.idempotency_key.nil?
-        unless request_options&.idempotency_expiry.nil?
-          req.headers["X-Idempotency-Expiration"] = request_options.idempotency_expiry
-        end
-        req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
-        req.body = { **(request_options&.additional_body_parameters || {}), message: message }.compact
-      end
-      SendMessageResponse.from_json(json_object: response.body)
-    end
-  end
-end
+# 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/user_token"
+require_relative "trycourier/models/alignment"
+require_relative "trycourier/models/audience"
+require_relative "trycourier/models/audience_delete_params"
+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_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/automations/invoke_invoke_ad_hoc_params"
+require_relative "trycourier/models/automations/invoke_invoke_by_template_params"
+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/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/filter"
+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/list_delete_params"
+require_relative "trycourier/models/list_list_params"
+require_relative "trycourier/models/list_list_response"
+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/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/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"
+require_relative "trycourier/models/recipient_preferences"
+require_relative "trycourier/models/request_archive_params"
+require_relative "trycourier/models/rule"
+require_relative "trycourier/models/send_message_params"
+require_relative "trycourier/models/send_message_response"
+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/default_preferences/item_delete_params"
+require_relative "trycourier/models/tenants/default_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/topic_preference"
+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_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/utm"
+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/default_preferences"
+require_relative "trycourier/resources/tenants/default_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/manifest.yaml ADDED Viewed

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

data/rbi/trycourier/client.rbi ADDED Viewed

@@ -0,0 +1,94 @@
+# 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