trycourier 4.21.0 → 4.22.0

data/rbi/courier/models/notification_create_params.rbi

@@ -11,15 +11,41 @@ module Courier
           T.any(Courier::NotificationCreateParams, Courier::Internal::AnyHash)
         end
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_idempotency_expiration
+
+      sig { params(x_idempotency_expiration: String).void }
+      attr_writer :x_idempotency_expiration
+
       sig do
-        params(request_options: Courier::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          idempotency_key: String,
+          x_idempotency_expiration: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(
+        idempotency_key: nil,
+        x_idempotency_expiration: nil,
+        request_options: {}
+      )
       end
 
-      sig { override.returns({ request_options: Courier::RequestOptions }) }
+      sig do
+        override.returns(
+          {
+            idempotency_key: String,
+            x_idempotency_expiration: String,
+            request_options: Courier::RequestOptions
+          }
+        )
+      end
       def to_hash
       end
     end

data/rbi/courier/models/notification_publish_params.rbi

@@ -14,18 +14,42 @@ module Courier
       sig { returns(String) }
       attr_accessor :id
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_idempotency_expiration
+
+      sig { params(x_idempotency_expiration: String).void }
+      attr_writer :x_idempotency_expiration
+
       sig do
         params(
           id: String,
+          idempotency_key: String,
+          x_idempotency_expiration: String,
           request_options: Courier::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(id:, request_options: {})
+      def self.new(
+        id:,
+        idempotency_key: nil,
+        x_idempotency_expiration: nil,
+        request_options: {}
+      )
       end
 
       sig do
         override.returns(
-          { id: String, request_options: Courier::RequestOptions }
+          {
+            id: String,
+            idempotency_key: String,
+            x_idempotency_expiration: String,
+            request_options: Courier::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/courier/models/profile_create_params.rbi

@@ -17,14 +17,34 @@ module Courier
       sig { returns(T::Hash[Symbol, T.anything]) }
       attr_accessor :profile
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_idempotency_expiration
+
+      sig { params(x_idempotency_expiration: String).void }
+      attr_writer :x_idempotency_expiration
+
       sig do
         params(
           user_id: String,
           profile: T::Hash[Symbol, T.anything],
+          idempotency_key: String,
+          x_idempotency_expiration: String,
           request_options: Courier::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(user_id:, profile:, request_options: {})
+      def self.new(
+        user_id:,
+        profile:,
+        idempotency_key: nil,
+        x_idempotency_expiration: nil,
+        request_options: {}
+      )
       end
 
       sig do
@@ -32,6 +52,8 @@ module Courier
           {
             user_id: String,
             profile: T::Hash[Symbol, T.anything],
+            idempotency_key: String,
+            x_idempotency_expiration: String,
             request_options: Courier::RequestOptions
           }
         )

data/rbi/courier/models/profiles/list_subscribe_params.rbi

@@ -21,14 +21,34 @@ module Courier
         sig { returns(T::Array[Courier::SubscribeToListsRequestItem]) }
         attr_accessor :lists
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :x_idempotency_expiration
+
+        sig { params(x_idempotency_expiration: String).void }
+        attr_writer :x_idempotency_expiration
+
         sig do
           params(
             user_id: String,
             lists: T::Array[Courier::SubscribeToListsRequestItem::OrHash],
+            idempotency_key: String,
+            x_idempotency_expiration: String,
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(user_id:, lists:, request_options: {})
+        def self.new(
+          user_id:,
+          lists:,
+          idempotency_key: nil,
+          x_idempotency_expiration: nil,
+          request_options: {}
+        )
         end
 
         sig do
@@ -36,6 +56,8 @@ module Courier
             {
               user_id: String,
               lists: T::Array[Courier::SubscribeToListsRequestItem],
+              idempotency_key: String,
+              x_idempotency_expiration: String,
               request_options: Courier::RequestOptions
             }
           )

data/rbi/courier/models/provider_create_params.rbi

@@ -39,12 +39,26 @@ module Courier
       sig { params(title: String).void }
       attr_writer :title
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_idempotency_expiration
+
+      sig { params(x_idempotency_expiration: String).void }
+      attr_writer :x_idempotency_expiration
+
       sig do
         params(
           provider: String,
           alias_: String,
           settings: T::Hash[Symbol, T.anything],
           title: String,
+          idempotency_key: String,
+          x_idempotency_expiration: String,
           request_options: Courier::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -60,6 +74,8 @@ module Courier
         settings: nil,
         # Optional display title. Omit to use "Default Configuration".
         title: nil,
+        idempotency_key: nil,
+        x_idempotency_expiration: nil,
         request_options: {}
       )
       end
@@ -71,6 +87,8 @@ module Courier
             alias_: String,
             settings: T::Hash[Symbol, T.anything],
             title: String,
+            idempotency_key: String,
+            x_idempotency_expiration: String,
             request_options: Courier::RequestOptions
           }
         )

data/rbi/courier/models/routing_strategy_create_params.rbi

@@ -14,15 +14,41 @@ module Courier
           )
         end
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_idempotency_expiration
+
+      sig { params(x_idempotency_expiration: String).void }
+      attr_writer :x_idempotency_expiration
+
       sig do
-        params(request_options: Courier::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          idempotency_key: String,
+          x_idempotency_expiration: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(
+        idempotency_key: nil,
+        x_idempotency_expiration: nil,
+        request_options: {}
+      )
       end
 
-      sig { override.returns({ request_options: Courier::RequestOptions }) }
+      sig do
+        override.returns(
+          {
+            idempotency_key: String,
+            x_idempotency_expiration: String,
+            request_options: Courier::RequestOptions
+          }
+        )
+      end
       def to_hash
       end
     end

data/rbi/courier/models/send_message_params.rbi

@@ -19,9 +19,23 @@ module Courier
       sig { params(message: Courier::SendMessageParams::Message::OrHash).void }
       attr_writer :message
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_idempotency_expiration
+
+      sig { params(x_idempotency_expiration: String).void }
+      attr_writer :x_idempotency_expiration
+
       sig do
         params(
           message: Courier::SendMessageParams::Message::OrHash,
+          idempotency_key: String,
+          x_idempotency_expiration: String,
           request_options: Courier::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -29,6 +43,8 @@ module Courier
         # The message property has the following primary top-level properties. They define
         # the destination and content of the message.
         message:,
+        idempotency_key: nil,
+        x_idempotency_expiration: nil,
         request_options: {}
       )
       end
@@ -37,6 +53,8 @@ module Courier
         override.returns(
           {
             message: Courier::SendMessageParams::Message,
+            idempotency_key: String,
+            x_idempotency_expiration: String,
             request_options: Courier::RequestOptions
           }
         )

data/rbi/courier/models/users/preference_bulk_update_params.rbi

@@ -29,6 +29,18 @@ module Courier
         sig { returns(T.nilable(String)) }
         attr_accessor :tenant_id
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :x_idempotency_expiration
+
+        sig { params(x_idempotency_expiration: String).void }
+        attr_writer :x_idempotency_expiration
+
         sig do
           params(
             user_id: String,
@@ -37,6 +49,8 @@ module Courier
                 Courier::Users::PreferenceBulkUpdateParams::Topic::OrHash
               ],
             tenant_id: T.nilable(String),
+            idempotency_key: String,
+            x_idempotency_expiration: String,
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -47,6 +61,8 @@ module Courier
           topics:,
           # Update the preferences of a user for this specific tenant context.
           tenant_id: nil,
+          idempotency_key: nil,
+          x_idempotency_expiration: nil,
           request_options: {}
         )
         end
@@ -58,6 +74,8 @@ module Courier
               topics:
                 T::Array[Courier::Users::PreferenceBulkUpdateParams::Topic],
               tenant_id: T.nilable(String),
+              idempotency_key: String,
+              x_idempotency_expiration: String,
               request_options: Courier::RequestOptions
             }
           )

data/rbi/courier/models/users/preference_update_or_create_topic_params.rbi

@@ -81,10 +81,14 @@ module Courier
               )
             end
 
+          # The subscription status to set: OPTED_IN or OPTED_OUT. REQUIRED is a topic-level
+          # default, not a user choice; the API rejects opting a user out of a REQUIRED
+          # topic.
           sig { returns(Courier::PreferenceStatus::OrSymbol) }
           attr_accessor :status
 
-          # The Channels a user has chosen to receive notifications through for this topic
+          # The channels to deliver this topic on when has_custom_routing is true. One or
+          # more of: direct_message, email, push, sms, webhook, inbox.
           sig do
             returns(
               T.nilable(T::Array[Courier::ChannelClassification::OrSymbol])
@@ -92,6 +96,8 @@ module Courier
           end
           attr_accessor :custom_routing
 
+          # Set to true to route this topic to the channels in custom_routing instead of the
+          # topic's default routing.
           sig { returns(T.nilable(T::Boolean)) }
           attr_accessor :has_custom_routing
 
@@ -104,9 +110,15 @@ module Courier
             ).returns(T.attached_class)
           end
           def self.new(
+            # The subscription status to set: OPTED_IN or OPTED_OUT. REQUIRED is a topic-level
+            # default, not a user choice; the API rejects opting a user out of a REQUIRED
+            # topic.
             status:,
-            # The Channels a user has chosen to receive notifications through for this topic
+            # The channels to deliver this topic on when has_custom_routing is true. One or
+            # more of: direct_message, email, push, sms, webhook, inbox.
             custom_routing: nil,
+            # Set to true to route this topic to the channels in custom_routing instead of the
+            # topic's default routing.
             has_custom_routing: nil
           )
           end

data/rbi/courier/models/users/topic_preference.rbi

@@ -9,19 +9,28 @@ module Courier
             T.any(Courier::Users::TopicPreference, Courier::Internal::AnyHash)
           end
 
+        # The topic's default status, returned on reads. It applies whenever the user has
+        # no override of their own (status equals this value).
         sig { returns(Courier::PreferenceStatus::TaggedSymbol) }
         attr_accessor :default_status
 
+        # The user's subscription status for this topic. OPTED_IN or OPTED_OUT reflect the
+        # user's own choice; REQUIRED is a topic-level default set in the preferences
+        # editor, not a user choice.
         sig { returns(Courier::PreferenceStatus::TaggedSymbol) }
         attr_accessor :status
 
+        # The unique identifier of the subscription topic this preference applies to.
         sig { returns(String) }
         attr_accessor :topic_id
 
+        # The display name of the subscription topic, returned on reads.
         sig { returns(String) }
         attr_accessor :topic_name
 
-        # The Channels a user has chosen to receive notifications through for this topic
+        # The channels the user has chosen to receive this topic on, present only when
+        # has_custom_routing is true. One or more of: direct_message, email, push, sms,
+        # webhook, inbox.
         sig do
           returns(
             T.nilable(T::Array[Courier::ChannelClassification::TaggedSymbol])
@@ -29,6 +38,8 @@ module Courier
         end
         attr_accessor :custom_routing
 
+        # Whether the user has chosen specific delivery channels for this topic (listed in
+        # custom_routing) rather than the topic's default routing.
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :has_custom_routing
 
@@ -44,12 +55,23 @@ module Courier
           ).returns(T.attached_class)
         end
         def self.new(
+          # The topic's default status, returned on reads. It applies whenever the user has
+          # no override of their own (status equals this value).
           default_status:,
+          # The user's subscription status for this topic. OPTED_IN or OPTED_OUT reflect the
+          # user's own choice; REQUIRED is a topic-level default set in the preferences
+          # editor, not a user choice.
           status:,
+          # The unique identifier of the subscription topic this preference applies to.
           topic_id:,
+          # The display name of the subscription topic, returned on reads.
           topic_name:,
-          # The Channels a user has chosen to receive notifications through for this topic
+          # The channels the user has chosen to receive this topic on, present only when
+          # has_custom_routing is true. One or more of: direct_message, email, push, sms,
+          # webhook, inbox.
           custom_routing: nil,
+          # Whether the user has chosen specific delivery channels for this topic (listed in
+          # custom_routing) rather than the topic's default routing.
           has_custom_routing: nil
         )
         end

data/rbi/courier/models/workspace_preference_create_params.rbi

@@ -14,15 +14,41 @@ module Courier
           )
         end
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_idempotency_expiration
+
+      sig { params(x_idempotency_expiration: String).void }
+      attr_writer :x_idempotency_expiration
+
       sig do
-        params(request_options: Courier::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          idempotency_key: String,
+          x_idempotency_expiration: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(
+        idempotency_key: nil,
+        x_idempotency_expiration: nil,
+        request_options: {}
+      )
       end
 
-      sig { override.returns({ request_options: Courier::RequestOptions }) }
+      sig do
+        override.returns(
+          {
+            idempotency_key: String,
+            x_idempotency_expiration: String,
+            request_options: Courier::RequestOptions
+          }
+        )
+      end
       def to_hash
       end
     end

data/rbi/courier/models/workspace_preference_publish_params.rbi

@@ -14,15 +14,41 @@ module Courier
           )
         end
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_idempotency_expiration
+
+      sig { params(x_idempotency_expiration: String).void }
+      attr_writer :x_idempotency_expiration
+
       sig do
-        params(request_options: Courier::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          idempotency_key: String,
+          x_idempotency_expiration: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(
+        idempotency_key: nil,
+        x_idempotency_expiration: nil,
+        request_options: {}
+      )
       end
 
-      sig { override.returns({ request_options: Courier::RequestOptions }) }
+      sig do
+        override.returns(
+          {
+            idempotency_key: String,
+            x_idempotency_expiration: String,
+            request_options: Courier::RequestOptions
+          }
+        )
+      end
       def to_hash
       end
     end

data/rbi/courier/models/workspace_preferences/topic_create_params.rbi

@@ -18,18 +18,42 @@ module Courier
         sig { returns(String) }
         attr_accessor :section_id
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :x_idempotency_expiration
+
+        sig { params(x_idempotency_expiration: String).void }
+        attr_writer :x_idempotency_expiration
+
         sig do
           params(
             section_id: String,
+            idempotency_key: String,
+            x_idempotency_expiration: String,
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(section_id:, request_options: {})
+        def self.new(
+          section_id:,
+          idempotency_key: nil,
+          x_idempotency_expiration: nil,
+          request_options: {}
+        )
         end
 
         sig do
           override.returns(
-            { section_id: String, request_options: Courier::RequestOptions }
+            {
+              section_id: String,
+              idempotency_key: String,
+              x_idempotency_expiration: String,
+              request_options: Courier::RequestOptions
+            }
           )
         end
         def to_hash

data/rbi/courier/models.rbi

@@ -149,6 +149,8 @@ module Courier
 
   InboundTrackEventParams = Courier::Models::InboundTrackEventParams
 
+  Inbox = Courier::Models::Inbox
+
   Intercom = Courier::Models::Intercom
 
   IntercomRecipient = Courier::Models::IntercomRecipient

data/rbi/courier/resources/audiences.rbi

@@ -2,8 +2,11 @@
 
 module Courier
   module Resources
+    # Define filter-based groups whose membership Courier recalculates as user
+    # profiles change.
     class Audiences
-      # Returns the specified audience by id.
+      # Returns one audience with its name, description, and the filter and AND or OR
+      # operator that decide which users belong to it.
       sig do
         params(
           audience_id: String,
@@ -17,7 +20,8 @@ module Courier
       )
       end
 
-      # Creates or updates audience.
+      # Creates or replaces an audience from a filter and an AND or OR operator.
+      # Membership recalculates automatically as profiles change.
       sig do
         params(
           audience_id: String,
@@ -46,7 +50,8 @@ module Courier
       )
       end
 
-      # Get the audiences associated with the authorization token.
+      # Returns the audiences in the workspace with paging. Audiences are filter-based
+      # groups that recalculate as user profiles change.
       sig do
         params(
           cursor: T.nilable(String),
@@ -60,7 +65,8 @@ module Courier
       )
       end
 
-      # Deletes the specified audience.
+      # Deletes an audience permanently, so update any caller sending to it by audience
+      # id first. Those sends fail once the audience is gone.
       sig do
         params(
           audience_id: String,
@@ -74,7 +80,8 @@ module Courier
       )
       end
 
-      # Get list of members of an audience.
+      # Returns the users currently matching an audience filter, with paging. Membership
+      # is recalculated, so results shift as profiles change.
       sig do
         params(
           audience_id: String,