trycourier 4.22.0 → 4.23.0

data/sig/courier/models/broadcast_schedule.rbs

@@ -0,0 +1,46 @@
+module Courier
+  module Models
+    type broadcast_schedule =
+      {
+        recipient_id: String,
+        recipient_type: Courier::Models::BroadcastSchedule::recipient_type,
+        scheduled_to: String?,
+        timezone: String?
+      }
+
+    class BroadcastSchedule < Courier::Internal::Type::BaseModel
+      attr_accessor recipient_id: String
+
+      attr_accessor recipient_type: Courier::Models::BroadcastSchedule::recipient_type
+
+      attr_accessor scheduled_to: String?
+
+      attr_accessor timezone: String?
+
+      def initialize: (
+        recipient_id: String,
+        recipient_type: Courier::Models::BroadcastSchedule::recipient_type,
+        ?scheduled_to: String?,
+        ?timezone: String?
+      ) -> void
+
+      def to_hash: -> {
+        recipient_id: String,
+        recipient_type: Courier::Models::BroadcastSchedule::recipient_type,
+        scheduled_to: String?,
+        timezone: String?
+      }
+
+      type recipient_type = :list | :audience
+
+      module RecipientType
+        extend Courier::Internal::Type::Enum
+
+        LIST: :list
+        AUDIENCE: :audience
+
+        def self?.values: -> ::Array[Courier::Models::BroadcastSchedule::recipient_type]
+      end
+    end
+  end
+end

data/sig/courier/models/broadcast_schedule_params.rbs

@@ -0,0 +1,25 @@
+module Courier
+  module Models
+    type broadcast_schedule_params =
+      { broadcast_id: String } & Courier::Internal::Type::request_parameters
+
+    class BroadcastScheduleParams < Courier::Models::ScheduleBroadcastRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      def broadcast_id: -> String
+
+      def broadcast_id=: (String _) -> String
+
+      def initialize: (
+        broadcast_id: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        broadcast_id: String,
+        request_options: Courier::RequestOptions
+      }
+    end
+  end
+end

data/sig/courier/models/broadcast_send_params.rbs

@@ -0,0 +1,25 @@
+module Courier
+  module Models
+    type broadcast_send_params =
+      { broadcast_id: String } & Courier::Internal::Type::request_parameters
+
+    class BroadcastSendParams < Courier::Models::SendBroadcastRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      def broadcast_id: -> String
+
+      def broadcast_id=: (String _) -> String
+
+      def initialize: (
+        broadcast_id: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        broadcast_id: String,
+        request_options: Courier::RequestOptions
+      }
+    end
+  end
+end

data/sig/courier/models/broadcast_update_params.rbs

@@ -0,0 +1,25 @@
+module Courier
+  module Models
+    type broadcast_update_params =
+      { broadcast_id: String } & Courier::Internal::Type::request_parameters
+
+    class BroadcastUpdateParams < Courier::Models::UpdateBroadcastRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      def broadcast_id: -> String
+
+      def broadcast_id=: (String _) -> String
+
+      def initialize: (
+        broadcast_id: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        broadcast_id: String,
+        request_options: Courier::RequestOptions
+      }
+    end
+  end
+end

data/sig/courier/models/create_broadcast_request.rbs

@@ -0,0 +1,40 @@
+module Courier
+  module Models
+    type create_broadcast_request =
+      {
+        channel: Courier::Models::CreateBroadcastRequest::channel,
+        name: String
+      }
+
+    class CreateBroadcastRequest < Courier::Internal::Type::BaseModel
+      attr_accessor channel: Courier::Models::CreateBroadcastRequest::channel
+
+      attr_accessor name: String
+
+      def initialize: (
+        channel: Courier::Models::CreateBroadcastRequest::channel,
+        name: String
+      ) -> void
+
+      def to_hash: -> {
+        channel: Courier::Models::CreateBroadcastRequest::channel,
+        name: String
+      }
+
+      type channel = :email | :sms | :push | :inbox | :slack | :msteams
+
+      module Channel
+        extend Courier::Internal::Type::Enum
+
+        EMAIL: :email
+        SMS: :sms
+        PUSH: :push
+        INBOX: :inbox
+        SLACK: :slack
+        MSTEAMS: :msteams
+
+        def self?.values: -> ::Array[Courier::Models::CreateBroadcastRequest::channel]
+      end
+    end
+  end
+end

data/sig/courier/models/schedule_broadcast_request.rbs

@@ -0,0 +1,48 @@
+module Courier
+  module Models
+    type schedule_broadcast_request =
+      {
+        recipient_id: String,
+        recipient_type: Courier::Models::ScheduleBroadcastRequest::recipient_type,
+        scheduled_to: String,
+        timezone: String
+      }
+
+    class ScheduleBroadcastRequest < Courier::Internal::Type::BaseModel
+      attr_accessor recipient_id: String
+
+      attr_accessor recipient_type: Courier::Models::ScheduleBroadcastRequest::recipient_type
+
+      attr_accessor scheduled_to: String
+
+      attr_reader timezone: String?
+
+      def timezone=: (String) -> String
+
+      def initialize: (
+        recipient_id: String,
+        recipient_type: Courier::Models::ScheduleBroadcastRequest::recipient_type,
+        scheduled_to: String,
+        ?timezone: String
+      ) -> void
+
+      def to_hash: -> {
+        recipient_id: String,
+        recipient_type: Courier::Models::ScheduleBroadcastRequest::recipient_type,
+        scheduled_to: String,
+        timezone: String
+      }
+
+      type recipient_type = :list | :audience
+
+      module RecipientType
+        extend Courier::Internal::Type::Enum
+
+        LIST: :list
+        AUDIENCE: :audience
+
+        def self?.values: -> ::Array[Courier::Models::ScheduleBroadcastRequest::recipient_type]
+      end
+    end
+  end
+end

data/sig/courier/models/send_broadcast_request.rbs

@@ -0,0 +1,36 @@
+module Courier
+  module Models
+    type send_broadcast_request =
+      {
+        recipient_id: String,
+        recipient_type: Courier::Models::SendBroadcastRequest::recipient_type
+      }
+
+    class SendBroadcastRequest < Courier::Internal::Type::BaseModel
+      attr_accessor recipient_id: String
+
+      attr_accessor recipient_type: Courier::Models::SendBroadcastRequest::recipient_type
+
+      def initialize: (
+        recipient_id: String,
+        recipient_type: Courier::Models::SendBroadcastRequest::recipient_type
+      ) -> void
+
+      def to_hash: -> {
+        recipient_id: String,
+        recipient_type: Courier::Models::SendBroadcastRequest::recipient_type
+      }
+
+      type recipient_type = :list | :audience
+
+      module RecipientType
+        extend Courier::Internal::Type::Enum
+
+        LIST: :list
+        AUDIENCE: :audience
+
+        def self?.values: -> ::Array[Courier::Models::SendBroadcastRequest::recipient_type]
+      end
+    end
+  end
+end

data/sig/courier/models/update_broadcast_request.rbs

@@ -0,0 +1,13 @@
+module Courier
+  module Models
+    type update_broadcast_request = { name: String }
+
+    class UpdateBroadcastRequest < Courier::Internal::Type::BaseModel
+      attr_accessor name: String
+
+      def initialize: (name: String) -> void
+
+      def to_hash: -> { name: String }
+    end
+  end
+end

data/sig/courier/models.rbs

@@ -73,6 +73,34 @@ module Courier
 
   class BrandUpdateParams = Courier::Models::BrandUpdateParams
 
+  class Broadcast = Courier::Models::Broadcast
+
+  class BroadcastArchiveParams = Courier::Models::BroadcastArchiveParams
+
+  class BroadcastCancelParams = Courier::Models::BroadcastCancelParams
+
+  class BroadcastCreateParams = Courier::Models::BroadcastCreateParams
+
+  class BroadcastDuplicateParams = Courier::Models::BroadcastDuplicateParams
+
+  class BroadcastListParams = Courier::Models::BroadcastListParams
+
+  class BroadcastListResponse = Courier::Models::BroadcastListResponse
+
+  class BroadcastPutContentParams = Courier::Models::BroadcastPutContentParams
+
+  class BroadcastRetrieveContentParams = Courier::Models::BroadcastRetrieveContentParams
+
+  class BroadcastRetrieveParams = Courier::Models::BroadcastRetrieveParams
+
+  class BroadcastSchedule = Courier::Models::BroadcastSchedule
+
+  class BroadcastScheduleParams = Courier::Models::BroadcastScheduleParams
+
+  class BroadcastSendParams = Courier::Models::BroadcastSendParams
+
+  class BroadcastUpdateParams = Courier::Models::BroadcastUpdateParams
+
   module CancelJourneyRequest = Courier::Models::CancelJourneyRequest
 
   module CancelJourneyResponse = Courier::Models::CancelJourneyResponse
@@ -87,6 +115,8 @@ module Courier
 
   class Check = Courier::Models::Check
 
+  class CreateBroadcastRequest = Courier::Models::CreateBroadcastRequest
+
   class CreateJourneyRequest = Courier::Models::CreateJourneyRequest
 
   class DefaultPreferences = Courier::Models::DefaultPreferences
@@ -431,6 +461,10 @@ module Courier
 
   class Rule = Courier::Models::Rule
 
+  class ScheduleBroadcastRequest = Courier::Models::ScheduleBroadcastRequest
+
+  class SendBroadcastRequest = Courier::Models::SendBroadcastRequest
+
   class SendDirectMessage = Courier::Models::SendDirectMessage
 
   class SendMessageParams = Courier::Models::SendMessageParams
@@ -493,6 +527,8 @@ module Courier
 
   class TranslationUpdateParams = Courier::Models::TranslationUpdateParams
 
+  class UpdateBroadcastRequest = Courier::Models::UpdateBroadcastRequest
+
   class UserProfile = Courier::Models::UserProfile
 
   module UserProfileFirebaseToken = Courier::Models::UserProfileFirebaseToken

data/sig/courier/resources/broadcasts.rbs

@@ -0,0 +1,74 @@
+module Courier
+  module Resources
+    class Broadcasts
+      def create: (
+        channel: Courier::Models::CreateBroadcastRequest::channel,
+        name: String,
+        ?request_options: Courier::request_opts
+      ) -> Courier::Broadcast
+
+      def retrieve: (
+        String broadcast_id,
+        ?request_options: Courier::request_opts
+      ) -> Courier::Broadcast
+
+      def update: (
+        String broadcast_id,
+        name: String,
+        ?request_options: Courier::request_opts
+      ) -> Courier::Broadcast
+
+      def list: (
+        ?cursor: String?,
+        ?limit: Integer,
+        ?request_options: Courier::request_opts
+      ) -> Courier::BroadcastListResponse
+
+      def archive: (
+        String broadcast_id,
+        ?request_options: Courier::request_opts
+      ) -> Courier::Broadcast
+
+      def cancel: (
+        String broadcast_id,
+        ?request_options: Courier::request_opts
+      ) -> Courier::Broadcast
+
+      def duplicate: (
+        String broadcast_id,
+        ?request_options: Courier::request_opts
+      ) -> Courier::Broadcast
+
+      def put_content: (
+        String broadcast_id,
+        content: Courier::NotificationContentPutRequest::Content,
+        ?state: Courier::Models::notification_template_state,
+        ?request_options: Courier::request_opts
+      ) -> Courier::NotificationContentMutationResponse
+
+      def retrieve_content: (
+        String broadcast_id,
+        ?version: String,
+        ?request_options: Courier::request_opts
+      ) -> Courier::NotificationContentGetResponse
+
+      def schedule: (
+        String broadcast_id,
+        recipient_id: String,
+        recipient_type: Courier::Models::ScheduleBroadcastRequest::recipient_type,
+        scheduled_to: String,
+        ?timezone: String,
+        ?request_options: Courier::request_opts
+      ) -> Courier::Broadcast
+
+      def send_: (
+        String broadcast_id,
+        recipient_id: String,
+        recipient_type: Courier::Models::SendBroadcastRequest::recipient_type,
+        ?request_options: Courier::request_opts
+      ) -> Courier::Broadcast
+
+      def initialize: (client: Courier::Client) -> void
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trycourier
 version: !ruby/object:Gem::Version
-  version: 4.22.0
+  version: 4.23.0
 platform: ruby
 authors:
 - Courier
@@ -113,6 +113,20 @@ files:
 - lib/courier/models/brand_snippets.rb
 - lib/courier/models/brand_template.rb
 - lib/courier/models/brand_update_params.rb
+- lib/courier/models/broadcast.rb
+- lib/courier/models/broadcast_archive_params.rb
+- lib/courier/models/broadcast_cancel_params.rb
+- lib/courier/models/broadcast_create_params.rb
+- lib/courier/models/broadcast_duplicate_params.rb
+- lib/courier/models/broadcast_list_params.rb
+- lib/courier/models/broadcast_list_response.rb
+- lib/courier/models/broadcast_put_content_params.rb
+- lib/courier/models/broadcast_retrieve_content_params.rb
+- lib/courier/models/broadcast_retrieve_params.rb
+- lib/courier/models/broadcast_schedule.rb
+- lib/courier/models/broadcast_schedule_params.rb
+- lib/courier/models/broadcast_send_params.rb
+- lib/courier/models/broadcast_update_params.rb
 - lib/courier/models/cancel_journey_request.rb
 - lib/courier/models/cancel_journey_response.rb
 - lib/courier/models/channel.rb
@@ -120,6 +134,7 @@ files:
 - lib/courier/models/channel_metadata.rb
 - lib/courier/models/channel_preference.rb
 - lib/courier/models/check.rb
+- lib/courier/models/create_broadcast_request.rb
 - lib/courier/models/create_journey_request.rb
 - lib/courier/models/default_preferences.rb
 - lib/courier/models/device_type.rb
@@ -331,6 +346,8 @@ files:
 - lib/courier/models/routing_strategy_retrieve_params.rb
 - lib/courier/models/routing_strategy_summary.rb
 - lib/courier/models/rule.rb
+- lib/courier/models/schedule_broadcast_request.rb
+- lib/courier/models/send_broadcast_request.rb
 - lib/courier/models/send_direct_message.rb
 - lib/courier/models/send_message_params.rb
 - lib/courier/models/send_message_response.rb
@@ -374,6 +391,7 @@ files:
 - lib/courier/models/translation_retrieve_params.rb
 - lib/courier/models/translation_retrieve_response.rb
 - lib/courier/models/translation_update_params.rb
+- lib/courier/models/update_broadcast_request.rb
 - lib/courier/models/user_profile.rb
 - lib/courier/models/user_profile_firebase_token.rb
 - lib/courier/models/user_recipient.rb
@@ -440,6 +458,7 @@ files:
 - lib/courier/resources/automations.rb
 - lib/courier/resources/automations/invoke.rb
 - lib/courier/resources/brands.rb
+- lib/courier/resources/broadcasts.rb
 - lib/courier/resources/digests.rb
 - lib/courier/resources/digests/schedules.rb
 - lib/courier/resources/inbound.rb
@@ -536,6 +555,20 @@ files:
 - rbi/courier/models/brand_snippets.rbi
 - rbi/courier/models/brand_template.rbi
 - rbi/courier/models/brand_update_params.rbi
+- rbi/courier/models/broadcast.rbi
+- rbi/courier/models/broadcast_archive_params.rbi
+- rbi/courier/models/broadcast_cancel_params.rbi
+- rbi/courier/models/broadcast_create_params.rbi
+- rbi/courier/models/broadcast_duplicate_params.rbi
+- rbi/courier/models/broadcast_list_params.rbi
+- rbi/courier/models/broadcast_list_response.rbi
+- rbi/courier/models/broadcast_put_content_params.rbi
+- rbi/courier/models/broadcast_retrieve_content_params.rbi
+- rbi/courier/models/broadcast_retrieve_params.rbi
+- rbi/courier/models/broadcast_schedule.rbi
+- rbi/courier/models/broadcast_schedule_params.rbi
+- rbi/courier/models/broadcast_send_params.rbi
+- rbi/courier/models/broadcast_update_params.rbi
 - rbi/courier/models/cancel_journey_request.rbi
 - rbi/courier/models/cancel_journey_response.rbi
 - rbi/courier/models/channel.rbi
@@ -543,6 +576,7 @@ files:
 - rbi/courier/models/channel_metadata.rbi
 - rbi/courier/models/channel_preference.rbi
 - rbi/courier/models/check.rbi
+- rbi/courier/models/create_broadcast_request.rbi
 - rbi/courier/models/create_journey_request.rbi
 - rbi/courier/models/default_preferences.rbi
 - rbi/courier/models/device_type.rbi
@@ -754,6 +788,8 @@ files:
 - rbi/courier/models/routing_strategy_retrieve_params.rbi
 - rbi/courier/models/routing_strategy_summary.rbi
 - rbi/courier/models/rule.rbi
+- rbi/courier/models/schedule_broadcast_request.rbi
+- rbi/courier/models/send_broadcast_request.rbi
 - rbi/courier/models/send_direct_message.rbi
 - rbi/courier/models/send_message_params.rbi
 - rbi/courier/models/send_message_response.rbi
@@ -797,6 +833,7 @@ files:
 - rbi/courier/models/translation_retrieve_params.rbi
 - rbi/courier/models/translation_retrieve_response.rbi
 - rbi/courier/models/translation_update_params.rbi
+- rbi/courier/models/update_broadcast_request.rbi
 - rbi/courier/models/user_profile.rbi
 - rbi/courier/models/user_profile_firebase_token.rbi
 - rbi/courier/models/user_recipient.rbi
@@ -863,6 +900,7 @@ files:
 - rbi/courier/resources/automations.rbi
 - rbi/courier/resources/automations/invoke.rbi
 - rbi/courier/resources/brands.rbi
+- rbi/courier/resources/broadcasts.rbi
 - rbi/courier/resources/digests.rbi
 - rbi/courier/resources/digests/schedules.rbi
 - rbi/courier/resources/inbound.rbi
@@ -958,6 +996,20 @@ files:
 - sig/courier/models/brand_snippets.rbs
 - sig/courier/models/brand_template.rbs
 - sig/courier/models/brand_update_params.rbs
+- sig/courier/models/broadcast.rbs
+- sig/courier/models/broadcast_archive_params.rbs
+- sig/courier/models/broadcast_cancel_params.rbs
+- sig/courier/models/broadcast_create_params.rbs
+- sig/courier/models/broadcast_duplicate_params.rbs
+- sig/courier/models/broadcast_list_params.rbs
+- sig/courier/models/broadcast_list_response.rbs
+- sig/courier/models/broadcast_put_content_params.rbs
+- sig/courier/models/broadcast_retrieve_content_params.rbs
+- sig/courier/models/broadcast_retrieve_params.rbs
+- sig/courier/models/broadcast_schedule.rbs
+- sig/courier/models/broadcast_schedule_params.rbs
+- sig/courier/models/broadcast_send_params.rbs
+- sig/courier/models/broadcast_update_params.rbs
 - sig/courier/models/cancel_journey_request.rbs
 - sig/courier/models/cancel_journey_response.rbs
 - sig/courier/models/channel.rbs
@@ -965,6 +1017,7 @@ files:
 - sig/courier/models/channel_metadata.rbs
 - sig/courier/models/channel_preference.rbs
 - sig/courier/models/check.rbs
+- sig/courier/models/create_broadcast_request.rbs
 - sig/courier/models/create_journey_request.rbs
 - sig/courier/models/default_preferences.rbs
 - sig/courier/models/device_type.rbs
@@ -1176,6 +1229,8 @@ files:
 - sig/courier/models/routing_strategy_retrieve_params.rbs
 - sig/courier/models/routing_strategy_summary.rbs
 - sig/courier/models/rule.rbs
+- sig/courier/models/schedule_broadcast_request.rbs
+- sig/courier/models/send_broadcast_request.rbs
 - sig/courier/models/send_direct_message.rbs
 - sig/courier/models/send_message_params.rbs
 - sig/courier/models/send_message_response.rbs
@@ -1219,6 +1274,7 @@ files:
 - sig/courier/models/translation_retrieve_params.rbs
 - sig/courier/models/translation_retrieve_response.rbs
 - sig/courier/models/translation_update_params.rbs
+- sig/courier/models/update_broadcast_request.rbs
 - sig/courier/models/user_profile.rbs
 - sig/courier/models/user_profile_firebase_token.rbs
 - sig/courier/models/user_recipient.rbs
@@ -1285,6 +1341,7 @@ files:
 - sig/courier/resources/automations.rbs
 - sig/courier/resources/automations/invoke.rbs
 - sig/courier/resources/brands.rbs
+- sig/courier/resources/broadcasts.rbs
 - sig/courier/resources/digests.rbs
 - sig/courier/resources/digests/schedules.rbs
 - sig/courier/resources/inbound.rbs