trycourier 4.21.0 → 4.23.0

data/lib/courier/models/broadcast_send_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Broadcasts#send_
+    class BroadcastSendParams < Courier::Models::SendBroadcastRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute broadcast_id
+      #
+      #   @return [String]
+      required :broadcast_id, String
+
+      # @!method initialize(broadcast_id:, request_options: {})
+      #   @param broadcast_id [String]
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/broadcast_update_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Broadcasts#update
+    class BroadcastUpdateParams < Courier::Models::UpdateBroadcastRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute broadcast_id
+      #
+      #   @return [String]
+      required :broadcast_id, String
+
+      # @!method initialize(broadcast_id:, request_options: {})
+      #   @param broadcast_id [String]
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/create_broadcast_request.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class CreateBroadcastRequest < Courier::Internal::Type::BaseModel
+      # @!attribute channel
+      #   The single delivery channel for this broadcast.
+      #
+      #   @return [Symbol, Courier::Models::CreateBroadcastRequest::Channel]
+      required :channel, enum: -> { Courier::CreateBroadcastRequest::Channel }
+
+      # @!attribute name
+      #   Human-readable name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!method initialize(channel:, name:)
+      #   Request body for creating a broadcast.
+      #
+      #   @param channel [Symbol, Courier::Models::CreateBroadcastRequest::Channel] The single delivery channel for this broadcast.
+      #
+      #   @param name [String] Human-readable name.
+
+      # The single delivery channel for this broadcast.
+      #
+      # @see Courier::Models::CreateBroadcastRequest#channel
+      module Channel
+        extend Courier::Internal::Type::Enum
+
+        EMAIL = :email
+        SMS = :sms
+        PUSH = :push
+        INBOX = :inbox
+        SLACK = :slack
+        MSTEAMS = :msteams
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/inbox/message_delete_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Inbox
+      # @see Courier::Resources::Inbox::Messages#delete
+      class MessageDeleteParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        # @!attribute message_id
+        #
+        #   @return [String]
+        required :message_id, String
+
+        # @!method initialize(message_id:, request_options: {})
+        #   @param message_id [String]
+        #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/courier/models/inbox/message_restore_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Inbox
+      # @see Courier::Resources::Inbox::Messages#restore
+      class MessageRestoreParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        # @!attribute message_id
+        #
+        #   @return [String]
+        required :message_id, String
+
+        # @!method initialize(message_id:, request_options: {})
+        #   @param message_id [String]
+        #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/courier/models/journey_cancel_params.rb

@@ -7,7 +7,19 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!attribute x_idempotency_expiration
+      #
+      #   @return [String, nil]
+      optional :x_idempotency_expiration, String
+
+      # @!method initialize(idempotency_key: nil, x_idempotency_expiration: nil, request_options: {})
+      #   @param idempotency_key [String]
+      #   @param x_idempotency_expiration [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/journey_create_params.rb

@@ -7,7 +7,19 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!attribute x_idempotency_expiration
+      #
+      #   @return [String, nil]
+      optional :x_idempotency_expiration, String
+
+      # @!method initialize(idempotency_key: nil, x_idempotency_expiration: nil, request_options: {})
+      #   @param idempotency_key [String]
+      #   @param x_idempotency_expiration [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/journey_invoke_params.rb

@@ -12,8 +12,20 @@ module Courier
       #   @return [String]
       required :template_id, String
 
-      # @!method initialize(template_id:, request_options: {})
+      # @!attribute idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!attribute x_idempotency_expiration
+      #
+      #   @return [String, nil]
+      optional :x_idempotency_expiration, String
+
+      # @!method initialize(template_id:, idempotency_key: nil, x_idempotency_expiration: nil, request_options: {})
       #   @param template_id [String]
+      #   @param idempotency_key [String]
+      #   @param x_idempotency_expiration [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/journey_publish_params.rb

@@ -12,8 +12,20 @@ module Courier
       #   @return [String]
       required :template_id, String
 
-      # @!method initialize(template_id:, request_options: {})
+      # @!attribute idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!attribute x_idempotency_expiration
+      #
+      #   @return [String, nil]
+      optional :x_idempotency_expiration, String
+
+      # @!method initialize(template_id:, idempotency_key: nil, x_idempotency_expiration: nil, request_options: {})
       #   @param template_id [String]
+      #   @param idempotency_key [String]
+      #   @param x_idempotency_expiration [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/journeys/template_create_params.rb

@@ -13,8 +13,20 @@ module Courier
         #   @return [String]
         required :template_id, String
 
-        # @!method initialize(template_id:, request_options: {})
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute x_idempotency_expiration
+        #
+        #   @return [String, nil]
+        optional :x_idempotency_expiration, String
+
+        # @!method initialize(template_id:, idempotency_key: nil, x_idempotency_expiration: nil, request_options: {})
         #   @param template_id [String]
+        #   @param idempotency_key [String]
+        #   @param x_idempotency_expiration [String]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/courier/models/journeys/template_publish_params.rb

@@ -18,9 +18,21 @@ module Courier
         #   @return [String]
         required :notification_id, String
 
-        # @!method initialize(template_id:, notification_id:, request_options: {})
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute x_idempotency_expiration
+        #
+        #   @return [String, nil]
+        optional :x_idempotency_expiration, String
+
+        # @!method initialize(template_id:, notification_id:, idempotency_key: nil, x_idempotency_expiration: nil, request_options: {})
         #   @param template_id [String]
         #   @param notification_id [String]
+        #   @param idempotency_key [String]
+        #   @param x_idempotency_expiration [String]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/courier/models/lists/subscription_add_params.rb

@@ -18,9 +18,21 @@ module Courier
         #   @return [Array<Courier::Models::PutSubscriptionsRecipient>]
         required :recipients, -> { Courier::Internal::Type::ArrayOf[Courier::PutSubscriptionsRecipient] }
 
-        # @!method initialize(list_id:, recipients:, request_options: {})
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute x_idempotency_expiration
+        #
+        #   @return [String, nil]
+        optional :x_idempotency_expiration, String
+
+        # @!method initialize(list_id:, recipients:, idempotency_key: nil, x_idempotency_expiration: nil, request_options: {})
         #   @param list_id [String]
         #   @param recipients [Array<Courier::Models::PutSubscriptionsRecipient>]
+        #   @param idempotency_key [String]
+        #   @param x_idempotency_expiration [String]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/courier/models/notification_create_params.rb

@@ -7,7 +7,19 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!attribute x_idempotency_expiration
+      #
+      #   @return [String, nil]
+      optional :x_idempotency_expiration, String
+
+      # @!method initialize(idempotency_key: nil, x_idempotency_expiration: nil, request_options: {})
+      #   @param idempotency_key [String]
+      #   @param x_idempotency_expiration [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/notification_publish_params.rb

@@ -12,8 +12,20 @@ module Courier
       #   @return [String]
       required :id, String
 
-      # @!method initialize(id:, request_options: {})
+      # @!attribute idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!attribute x_idempotency_expiration
+      #
+      #   @return [String, nil]
+      optional :x_idempotency_expiration, String
+
+      # @!method initialize(id:, idempotency_key: nil, x_idempotency_expiration: nil, request_options: {})
       #   @param id [String]
+      #   @param idempotency_key [String]
+      #   @param x_idempotency_expiration [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/profile_create_params.rb

@@ -17,9 +17,21 @@ module Courier
       #   @return [Hash{Symbol=>Object}]
       required :profile, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown]
 
-      # @!method initialize(user_id:, profile:, request_options: {})
+      # @!attribute idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!attribute x_idempotency_expiration
+      #
+      #   @return [String, nil]
+      optional :x_idempotency_expiration, String
+
+      # @!method initialize(user_id:, profile:, idempotency_key: nil, x_idempotency_expiration: nil, request_options: {})
       #   @param user_id [String]
       #   @param profile [Hash{Symbol=>Object}]
+      #   @param idempotency_key [String]
+      #   @param x_idempotency_expiration [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/profiles/list_subscribe_params.rb

@@ -18,9 +18,21 @@ module Courier
         #   @return [Array<Courier::Models::SubscribeToListsRequestItem>]
         required :lists, -> { Courier::Internal::Type::ArrayOf[Courier::SubscribeToListsRequestItem] }
 
-        # @!method initialize(user_id:, lists:, request_options: {})
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute x_idempotency_expiration
+        #
+        #   @return [String, nil]
+        optional :x_idempotency_expiration, String
+
+        # @!method initialize(user_id:, lists:, idempotency_key: nil, x_idempotency_expiration: nil, request_options: {})
         #   @param user_id [String]
         #   @param lists [Array<Courier::Models::SubscribeToListsRequestItem>]
+        #   @param idempotency_key [String]
+        #   @param x_idempotency_expiration [String]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/courier/models/provider_create_params.rb

@@ -34,7 +34,17 @@ module Courier
       #   @return [String, nil]
       optional :title, String
 
-      # @!method initialize(provider:, alias_: nil, settings: nil, title: nil, request_options: {})
+      # @!attribute idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!attribute x_idempotency_expiration
+      #
+      #   @return [String, nil]
+      optional :x_idempotency_expiration, String
+
+      # @!method initialize(provider:, alias_: nil, settings: nil, title: nil, idempotency_key: nil, x_idempotency_expiration: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Courier::Models::ProviderCreateParams} for more details.
       #
@@ -46,6 +56,10 @@ module Courier
       #
       #   @param title [String] Optional display title. Omit to use "Default Configuration".
       #
+      #   @param idempotency_key [String]
+      #
+      #   @param x_idempotency_expiration [String]
+      #
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/routing_strategy_create_params.rb

@@ -7,7 +7,19 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!attribute x_idempotency_expiration
+      #
+      #   @return [String, nil]
+      optional :x_idempotency_expiration, String
+
+      # @!method initialize(idempotency_key: nil, x_idempotency_expiration: nil, request_options: {})
+      #   @param idempotency_key [String]
+      #   @param x_idempotency_expiration [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/schedule_broadcast_request.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class ScheduleBroadcastRequest < Courier::Internal::Type::BaseModel
+      # @!attribute recipient_id
+      #   ID of the target list or audience.
+      #
+      #   @return [String]
+      required :recipient_id, String
+
+      # @!attribute recipient_type
+      #   Whether the broadcast targets a list or an audience.
+      #
+      #   @return [Symbol, Courier::Models::ScheduleBroadcastRequest::RecipientType]
+      required :recipient_type, enum: -> { Courier::ScheduleBroadcastRequest::RecipientType }
+
+      # @!attribute scheduled_to
+      #   Wall-clock timestamp of the future send, no timezone offset (e.g.
+      #   "2026-07-21T20:00:00"). The zone is given by `timezone`.
+      #
+      #   @return [String]
+      required :scheduled_to, String
+
+      # @!attribute timezone
+      #   IANA timezone for the scheduled send (e.g. America/New_York).
+      #
+      #   @return [String, nil]
+      optional :timezone, String
+
+      # @!method initialize(recipient_id:, recipient_type:, scheduled_to:, timezone: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::ScheduleBroadcastRequest} for more details.
+      #
+      #   Request body for scheduling a broadcast for a future send.
+      #
+      #   @param recipient_id [String] ID of the target list or audience.
+      #
+      #   @param recipient_type [Symbol, Courier::Models::ScheduleBroadcastRequest::RecipientType] Whether the broadcast targets a list or an audience.
+      #
+      #   @param scheduled_to [String] Wall-clock timestamp of the future send, no timezone offset (e.g. "2026-07-21T20
+      #
+      #   @param timezone [String] IANA timezone for the scheduled send (e.g. America/New_York).
+
+      # Whether the broadcast targets a list or an audience.
+      #
+      # @see Courier::Models::ScheduleBroadcastRequest#recipient_type
+      module RecipientType
+        extend Courier::Internal::Type::Enum
+
+        LIST = :list
+        AUDIENCE = :audience
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/send_broadcast_request.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class SendBroadcastRequest < Courier::Internal::Type::BaseModel
+      # @!attribute recipient_id
+      #   ID of the target list or audience.
+      #
+      #   @return [String]
+      required :recipient_id, String
+
+      # @!attribute recipient_type
+      #   Whether the broadcast targets a list or an audience.
+      #
+      #   @return [Symbol, Courier::Models::SendBroadcastRequest::RecipientType]
+      required :recipient_type, enum: -> { Courier::SendBroadcastRequest::RecipientType }
+
+      # @!method initialize(recipient_id:, recipient_type:)
+      #   Request body for sending a broadcast immediately.
+      #
+      #   @param recipient_id [String] ID of the target list or audience.
+      #
+      #   @param recipient_type [Symbol, Courier::Models::SendBroadcastRequest::RecipientType] Whether the broadcast targets a list or an audience.
+
+      # Whether the broadcast targets a list or an audience.
+      #
+      # @see Courier::Models::SendBroadcastRequest#recipient_type
+      module RecipientType
+        extend Courier::Internal::Type::Enum
+
+        LIST = :list
+        AUDIENCE = :audience
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/send_message_params.rb

@@ -14,12 +14,26 @@ module Courier
       #   @return [Courier::Models::SendMessageParams::Message]
       required :message, -> { Courier::SendMessageParams::Message }
 
-      # @!method initialize(message:, request_options: {})
+      # @!attribute idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!attribute x_idempotency_expiration
+      #
+      #   @return [String, nil]
+      optional :x_idempotency_expiration, String
+
+      # @!method initialize(message:, idempotency_key: nil, x_idempotency_expiration: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Courier::Models::SendMessageParams} for more details.
       #
       #   @param message [Courier::Models::SendMessageParams::Message] The message property has the following primary top-level properties. They define
       #
+      #   @param idempotency_key [String]
+      #
+      #   @param x_idempotency_expiration [String]
+      #
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
 
       class Message < Courier::Internal::Type::BaseModel

data/lib/courier/models/update_broadcast_request.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class UpdateBroadcastRequest < Courier::Internal::Type::BaseModel
+      # @!attribute name
+      #   New human-readable name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!method initialize(name:)
+      #   Request body for updating a broadcast. Only the name is mutable.
+      #
+      #   @param name [String] New human-readable name.
+    end
+  end
+end

data/lib/courier/models/users/preference_bulk_update_params.rb

@@ -27,7 +27,17 @@ module Courier
         #   @return [String, nil]
         optional :tenant_id, String, nil?: true
 
-        # @!method initialize(user_id:, topics:, tenant_id: nil, request_options: {})
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute x_idempotency_expiration
+        #
+        #   @return [String, nil]
+        optional :x_idempotency_expiration, String
+
+        # @!method initialize(user_id:, topics:, tenant_id: nil, idempotency_key: nil, x_idempotency_expiration: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Courier::Models::Users::PreferenceBulkUpdateParams} for more details.
         #
@@ -37,6 +47,10 @@ module Courier
         #
         #   @param tenant_id [String, nil] Update the preferences of a user for this specific tenant context.
         #
+        #   @param idempotency_key [String]
+        #
+        #   @param x_idempotency_expiration [String]
+        #
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
 
         class Topic < Courier::Internal::Type::BaseModel

data/lib/courier/models/users/preference_update_or_create_topic_params.rb

@@ -42,12 +42,16 @@ module Courier
 
         class Topic < Courier::Internal::Type::BaseModel
           # @!attribute status
+          #   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.
           #
           #   @return [Symbol, Courier::Models::PreferenceStatus]
           required :status, enum: -> { Courier::PreferenceStatus }
 
           # @!attribute custom_routing
-          #   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.
           #
           #   @return [Array<Symbol, Courier::Models::ChannelClassification>, nil]
           optional :custom_routing,
@@ -55,16 +59,22 @@ module Courier
                    nil?: true
 
           # @!attribute has_custom_routing
+          #   Set to true to route this topic to the channels in custom_routing instead of the
+          #   topic's default routing.
           #
           #   @return [Boolean, nil]
           optional :has_custom_routing, Courier::Internal::Type::Boolean, nil?: true
 
           # @!method initialize(status:, custom_routing: nil, has_custom_routing: nil)
-          #   @param status [Symbol, Courier::Models::PreferenceStatus]
+          #   Some parameter documentations has been truncated, see
+          #   {Courier::Models::Users::PreferenceUpdateOrCreateTopicParams::Topic} for more
+          #   details.
           #
-          #   @param custom_routing [Array<Symbol, Courier::Models::ChannelClassification>, nil] The Channels a user has chosen to receive notifications through for this topic
+          #   @param status [Symbol, Courier::Models::PreferenceStatus] The subscription status to set: OPTED_IN or OPTED_OUT. REQUIRED is a topic-level
           #
-          #   @param has_custom_routing [Boolean, nil]
+          #   @param custom_routing [Array<Symbol, Courier::Models::ChannelClassification>, nil] The channels to deliver this topic on when has_custom_routing is true. One or mo
+          #
+          #   @param has_custom_routing [Boolean, nil] Set to true to route this topic to the channels in custom_routing instead of the
         end
       end
     end