trycourier 4.6.2 → 4.6.3

data/rbi/courier/models/webhook_authentication.rbi

@@ -0,0 +1,61 @@
+# typed: strong
+
+module Courier
+  module Models
+    class WebhookAuthentication < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::WebhookAuthentication, Courier::Internal::AnyHash)
+        end
+
+      # The authentication mode to use. Defaults to 'none' if not specified.
+      sig { returns(Courier::WebhookAuthMode::OrSymbol) }
+      attr_accessor :mode
+
+      # Token for bearer authentication.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :token
+
+      # Password for basic authentication.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :password
+
+      # Username for basic authentication.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :username
+
+      sig do
+        params(
+          mode: Courier::WebhookAuthMode::OrSymbol,
+          token: T.nilable(String),
+          password: T.nilable(String),
+          username: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The authentication mode to use. Defaults to 'none' if not specified.
+        mode:,
+        # Token for bearer authentication.
+        token: nil,
+        # Password for basic authentication.
+        password: nil,
+        # Username for basic authentication.
+        username: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            mode: Courier::WebhookAuthMode::OrSymbol,
+            token: T.nilable(String),
+            password: T.nilable(String),
+            username: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/webhook_method.rbi

@@ -0,0 +1,19 @@
+# typed: strong
+
+module Courier
+  module Models
+    module WebhookMethod
+      extend Courier::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, Courier::WebhookMethod) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      POST = T.let(:POST, Courier::WebhookMethod::TaggedSymbol)
+      PUT = T.let(:PUT, Courier::WebhookMethod::TaggedSymbol)
+
+      sig { override.returns(T::Array[Courier::WebhookMethod::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/courier/models/webhook_profile.rbi

@@ -0,0 +1,80 @@
+# typed: strong
+
+module Courier
+  module Models
+    class WebhookProfile < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::WebhookProfile, Courier::Internal::AnyHash)
+        end
+
+      # The URL to send the webhook request to.
+      sig { returns(String) }
+      attr_accessor :url
+
+      # Authentication configuration for the webhook request.
+      sig { returns(T.nilable(Courier::WebhookAuthentication)) }
+      attr_reader :authentication
+
+      sig do
+        params(
+          authentication: T.nilable(Courier::WebhookAuthentication::OrHash)
+        ).void
+      end
+      attr_writer :authentication
+
+      # Custom headers to include in the webhook request.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_accessor :headers
+
+      # The HTTP method to use for the webhook request. Defaults to POST if not
+      # specified.
+      sig { returns(T.nilable(Courier::WebhookMethod::OrSymbol)) }
+      attr_accessor :method_
+
+      # Specifies what profile information is included in the request payload. Defaults
+      # to 'limited' if not specified.
+      sig { returns(T.nilable(Courier::WebhookProfileType::OrSymbol)) }
+      attr_accessor :profile
+
+      sig do
+        params(
+          url: String,
+          authentication: T.nilable(Courier::WebhookAuthentication::OrHash),
+          headers: T.nilable(T::Hash[Symbol, String]),
+          method_: T.nilable(Courier::WebhookMethod::OrSymbol),
+          profile: T.nilable(Courier::WebhookProfileType::OrSymbol)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The URL to send the webhook request to.
+        url:,
+        # Authentication configuration for the webhook request.
+        authentication: nil,
+        # Custom headers to include in the webhook request.
+        headers: nil,
+        # The HTTP method to use for the webhook request. Defaults to POST if not
+        # specified.
+        method_: nil,
+        # Specifies what profile information is included in the request payload. Defaults
+        # to 'limited' if not specified.
+        profile: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            url: String,
+            authentication: T.nilable(Courier::WebhookAuthentication),
+            headers: T.nilable(T::Hash[Symbol, String]),
+            method_: T.nilable(Courier::WebhookMethod::OrSymbol),
+            profile: T.nilable(Courier::WebhookProfileType::OrSymbol)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/webhook_profile_type.rbi

@@ -0,0 +1,21 @@
+# typed: strong
+
+module Courier
+  module Models
+    module WebhookProfileType
+      extend Courier::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, Courier::WebhookProfileType) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      LIMITED = T.let(:limited, Courier::WebhookProfileType::TaggedSymbol)
+      EXPANDED = T.let(:expanded, Courier::WebhookProfileType::TaggedSymbol)
+
+      sig do
+        override.returns(T::Array[Courier::WebhookProfileType::TaggedSymbol])
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/courier/models/webhook_recipient.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module Courier
+  module Models
+    class WebhookRecipient < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::WebhookRecipient, Courier::Internal::AnyHash)
+        end
+
+      sig { returns(Courier::WebhookProfile) }
+      attr_reader :webhook
+
+      sig { params(webhook: Courier::WebhookProfile::OrHash).void }
+      attr_writer :webhook
+
+      # Send via webhook
+      sig do
+        params(webhook: Courier::WebhookProfile::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(webhook:)
+      end
+
+      sig { override.returns({ webhook: Courier::WebhookProfile }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/widget_background.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Courier
+  module Models
+    class WidgetBackground < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::WidgetBackground, Courier::Internal::AnyHash)
+        end
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :bottom_color
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :top_color
+
+      sig do
+        params(
+          bottom_color: T.nilable(String),
+          top_color: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(bottom_color: nil, top_color: nil)
+      end
+
+      sig do
+        override.returns(
+          { bottom_color: T.nilable(String), top_color: T.nilable(String) }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models.rbi

@@ -0,0 +1,313 @@
+# typed: strong
+
+module Courier
+  AirshipProfile = Courier::Models::AirshipProfile
+
+  AirshipProfileAudience = Courier::Models::AirshipProfileAudience
+
+  Alignment = Courier::Models::Alignment
+
+  Audience = Courier::Models::Audience
+
+  AudienceDeleteParams = Courier::Models::AudienceDeleteParams
+
+  AudienceFilter = Courier::Models::AudienceFilter
+
+  AudienceFilterConfig = Courier::Models::AudienceFilterConfig
+
+  AudienceListMembersParams = Courier::Models::AudienceListMembersParams
+
+  AudienceListParams = Courier::Models::AudienceListParams
+
+  AudienceRecipient = Courier::Models::AudienceRecipient
+
+  AudienceRetrieveParams = Courier::Models::AudienceRetrieveParams
+
+  AudienceUpdateParams = Courier::Models::AudienceUpdateParams
+
+  AuditEvent = Courier::Models::AuditEvent
+
+  AuditEventListParams = Courier::Models::AuditEventListParams
+
+  AuditEventRetrieveParams = Courier::Models::AuditEventRetrieveParams
+
+  AuthIssueTokenParams = Courier::Models::AuthIssueTokenParams
+
+  AutomationInvokeResponse = Courier::Models::AutomationInvokeResponse
+
+  AutomationListParams = Courier::Models::AutomationListParams
+
+  Automations = Courier::Models::Automations
+
+  AutomationTemplate = Courier::Models::AutomationTemplate
+
+  AutomationTemplateListResponse =
+    Courier::Models::AutomationTemplateListResponse
+
+  BaseCheck = Courier::Models::BaseCheck
+
+  BaseTemplateTenantAssociation = Courier::Models::BaseTemplateTenantAssociation
+
+  Brand = Courier::Models::Brand
+
+  BrandColors = Courier::Models::BrandColors
+
+  BrandCreateParams = Courier::Models::BrandCreateParams
+
+  BrandDeleteParams = Courier::Models::BrandDeleteParams
+
+  BrandListParams = Courier::Models::BrandListParams
+
+  BrandRetrieveParams = Courier::Models::BrandRetrieveParams
+
+  BrandSettings = Courier::Models::BrandSettings
+
+  BrandSettingsEmail = Courier::Models::BrandSettingsEmail
+
+  BrandSettingsInApp = Courier::Models::BrandSettingsInApp
+
+  BrandSnippet = Courier::Models::BrandSnippet
+
+  BrandSnippets = Courier::Models::BrandSnippets
+
+  BrandTemplate = Courier::Models::BrandTemplate
+
+  BrandUpdateParams = Courier::Models::BrandUpdateParams
+
+  BulkAddUsersParams = Courier::Models::BulkAddUsersParams
+
+  BulkCreateJobParams = Courier::Models::BulkCreateJobParams
+
+  BulkListUsersParams = Courier::Models::BulkListUsersParams
+
+  BulkRetrieveJobParams = Courier::Models::BulkRetrieveJobParams
+
+  BulkRunJobParams = Courier::Models::BulkRunJobParams
+
+  ChannelClassification = Courier::Models::ChannelClassification
+
+  ChannelPreference = Courier::Models::ChannelPreference
+
+  Check = Courier::Models::Check
+
+  DefaultPreferences = Courier::Models::DefaultPreferences
+
+  DeviceType = Courier::Models::DeviceType
+
+  Discord = Courier::Models::Discord
+
+  ElementalActionNodeWithType = Courier::Models::ElementalActionNodeWithType
+
+  ElementalBaseNode = Courier::Models::ElementalBaseNode
+
+  ElementalChannelNode = Courier::Models::ElementalChannelNode
+
+  ElementalChannelNodeWithType = Courier::Models::ElementalChannelNodeWithType
+
+  ElementalContent = Courier::Models::ElementalContent
+
+  ElementalContentSugar = Courier::Models::ElementalContentSugar
+
+  ElementalDividerNodeWithType = Courier::Models::ElementalDividerNodeWithType
+
+  ElementalImageNodeWithType = Courier::Models::ElementalImageNodeWithType
+
+  ElementalMetaNodeWithType = Courier::Models::ElementalMetaNodeWithType
+
+  ElementalNode = Courier::Models::ElementalNode
+
+  ElementalQuoteNodeWithType = Courier::Models::ElementalQuoteNodeWithType
+
+  ElementalTextNodeWithType = Courier::Models::ElementalTextNodeWithType
+
+  EmailFooter = Courier::Models::EmailFooter
+
+  EmailHead = Courier::Models::EmailHead
+
+  EmailHeader = Courier::Models::EmailHeader
+
+  Expo = Courier::Models::Expo
+
+  FilterConfig = Courier::Models::FilterConfig
+
+  Icons = Courier::Models::Icons
+
+  InboundBulkMessage = Courier::Models::InboundBulkMessage
+
+  InboundBulkMessageUser = Courier::Models::InboundBulkMessageUser
+
+  InboundTrackEventParams = Courier::Models::InboundTrackEventParams
+
+  Intercom = Courier::Models::Intercom
+
+  IntercomRecipient = Courier::Models::IntercomRecipient
+
+  ListDeleteParams = Courier::Models::ListDeleteParams
+
+  ListFilter = Courier::Models::ListFilter
+
+  ListListParams = Courier::Models::ListListParams
+
+  ListPatternRecipient = Courier::Models::ListPatternRecipient
+
+  ListRecipient = Courier::Models::ListRecipient
+
+  ListRestoreParams = Courier::Models::ListRestoreParams
+
+  ListRetrieveParams = Courier::Models::ListRetrieveParams
+
+  Lists = Courier::Models::Lists
+
+  ListUpdateParams = Courier::Models::ListUpdateParams
+
+  Logo = Courier::Models::Logo
+
+  MessageCancelParams = Courier::Models::MessageCancelParams
+
+  MessageContentParams = Courier::Models::MessageContentParams
+
+  MessageContext = Courier::Models::MessageContext
+
+  MessageDetails = Courier::Models::MessageDetails
+
+  MessageHistoryParams = Courier::Models::MessageHistoryParams
+
+  MessageListParams = Courier::Models::MessageListParams
+
+  MessageRetrieveParams = Courier::Models::MessageRetrieveParams
+
+  MessageRouting = Courier::Models::MessageRouting
+
+  MessageRoutingChannel = Courier::Models::MessageRoutingChannel
+
+  MsTeams = Courier::Models::MsTeams
+
+  MsTeamsBaseProperties = Courier::Models::MsTeamsBaseProperties
+
+  MsTeamsRecipient = Courier::Models::MsTeamsRecipient
+
+  MultipleTokens = Courier::Models::MultipleTokens
+
+  NotificationGetContent = Courier::Models::NotificationGetContent
+
+  NotificationListParams = Courier::Models::NotificationListParams
+
+  NotificationPreferenceDetails = Courier::Models::NotificationPreferenceDetails
+
+  NotificationRetrieveContentParams =
+    Courier::Models::NotificationRetrieveContentParams
+
+  Notifications = Courier::Models::Notifications
+
+  Pagerduty = Courier::Models::Pagerduty
+
+  PagerdutyRecipient = Courier::Models::PagerdutyRecipient
+
+  Paging = Courier::Models::Paging
+
+  Preference = Courier::Models::Preference
+
+  PreferenceStatus = Courier::Models::PreferenceStatus
+
+  ProfileCreateParams = Courier::Models::ProfileCreateParams
+
+  ProfileDeleteParams = Courier::Models::ProfileDeleteParams
+
+  ProfileReplaceParams = Courier::Models::ProfileReplaceParams
+
+  ProfileRetrieveParams = Courier::Models::ProfileRetrieveParams
+
+  Profiles = Courier::Models::Profiles
+
+  ProfileUpdateParams = Courier::Models::ProfileUpdateParams
+
+  PutSubscriptionsRecipient = Courier::Models::PutSubscriptionsRecipient
+
+  RecipientPreferences = Courier::Models::RecipientPreferences
+
+  RequestArchiveParams = Courier::Models::RequestArchiveParams
+
+  Rule = Courier::Models::Rule
+
+  SendDirectMessage = Courier::Models::SendDirectMessage
+
+  SendMessageParams = Courier::Models::SendMessageParams
+
+  SendToChannel = Courier::Models::SendToChannel
+
+  SendToMsTeamsChannelID = Courier::Models::SendToMsTeamsChannelID
+
+  SendToMsTeamsChannelName = Courier::Models::SendToMsTeamsChannelName
+
+  SendToMsTeamsConversationID = Courier::Models::SendToMsTeamsConversationID
+
+  SendToMsTeamsEmail = Courier::Models::SendToMsTeamsEmail
+
+  SendToMsTeamsUserID = Courier::Models::SendToMsTeamsUserID
+
+  SendToSlackChannel = Courier::Models::SendToSlackChannel
+
+  SendToSlackEmail = Courier::Models::SendToSlackEmail
+
+  SendToSlackUserID = Courier::Models::SendToSlackUserID
+
+  Slack = Courier::Models::Slack
+
+  SlackBaseProperties = Courier::Models::SlackBaseProperties
+
+  SlackRecipient = Courier::Models::SlackRecipient
+
+  SubscribeToListsRequestItem = Courier::Models::SubscribeToListsRequestItem
+
+  SubscriptionList = Courier::Models::SubscriptionList
+
+  SubscriptionTopicNew = Courier::Models::SubscriptionTopicNew
+
+  Tenant = Courier::Models::Tenant
+
+  TenantAssociation = Courier::Models::TenantAssociation
+
+  TenantDeleteParams = Courier::Models::TenantDeleteParams
+
+  TenantListParams = Courier::Models::TenantListParams
+
+  TenantListUsersParams = Courier::Models::TenantListUsersParams
+
+  TenantRetrieveParams = Courier::Models::TenantRetrieveParams
+
+  Tenants = Courier::Models::Tenants
+
+  TenantUpdateParams = Courier::Models::TenantUpdateParams
+
+  TextStyle = Courier::Models::TextStyle
+
+  Token = Courier::Models::Token
+
+  TranslationRetrieveParams = Courier::Models::TranslationRetrieveParams
+
+  TranslationUpdateParams = Courier::Models::TranslationUpdateParams
+
+  UserProfile = Courier::Models::UserProfile
+
+  UserProfileFirebaseToken = Courier::Models::UserProfileFirebaseToken
+
+  UserRecipient = Courier::Models::UserRecipient
+
+  Users = Courier::Models::Users
+
+  Utm = Courier::Models::Utm
+
+  WebhookAuthentication = Courier::Models::WebhookAuthentication
+
+  WebhookAuthMode = Courier::Models::WebhookAuthMode
+
+  WebhookMethod = Courier::Models::WebhookMethod
+
+  WebhookProfile = Courier::Models::WebhookProfile
+
+  WebhookProfileType = Courier::Models::WebhookProfileType
+
+  WebhookRecipient = Courier::Models::WebhookRecipient
+
+  WidgetBackground = Courier::Models::WidgetBackground
+end

data/rbi/courier/request_options.rbi

@@ -0,0 +1,57 @@
+# typed: strong
+
+module Courier
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < Courier::Internal::Type::BaseModel
+    OrHash =
+      T.type_alias do
+        T.any(Courier::RequestOptions, Courier::Internal::AnyHash)
+      end
+
+    # @api private
+    sig { params(opts: Courier::RequestOptions::OrHash).void }
+    def self.validate!(opts)
+    end
+
+    # Idempotency key to send with request and all associated retries. Will only be
+    # sent for write requests.
+    sig { returns(T.nilable(String)) }
+    attr_accessor :idempotency_key
+
+    # Extra query params to send with the request. These are `.merge`’d into any
+    # `query` given at the client level.
+    sig do
+      returns(
+        T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])
+      )
+    end
+    attr_accessor :extra_query
+
+    # Extra headers to send with the request. These are `.merged`’d into any
+    # `extra_headers` given at the client level.
+    sig { returns(T.nilable(T::Hash[String, T.nilable(String)])) }
+    attr_accessor :extra_headers
+
+    # Extra data to send with the request. These are deep merged into any data
+    # generated as part of the normal request.
+    sig { returns(T.nilable(T.anything)) }
+    attr_accessor :extra_body
+
+    # Maximum number of retries to attempt after a failed initial request.
+    sig { returns(T.nilable(Integer)) }
+    attr_accessor :max_retries
+
+    # Request timeout in seconds.
+    sig { returns(T.nilable(Float)) }
+    attr_accessor :timeout
+
+    # Returns a new instance of RequestOptions.
+    sig { params(values: Courier::Internal::AnyHash).returns(T.attached_class) }
+    def self.new(values = {})
+    end
+  end
+end