trycourier 4.7.1 → 4.9.0

data/lib/courier/models/message_cancel_params.rb

@@ -7,7 +7,13 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!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

data/lib/courier/models/message_channels.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @type [Courier::Internal::Type::Converter]
+    MessageChannels = Courier::Internal::Type::HashOf[-> { Courier::Channel }]
+  end
+end

data/lib/courier/models/message_content_params.rb

@@ -7,7 +7,13 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!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

data/lib/courier/models/message_details.rb

@@ -11,20 +11,6 @@ module Courier
       #   @return [String]
       required :id, String
 
-      # @!attribute clicked
-      #   A UTC timestamp at which the recipient clicked on a tracked link for the first
-      #   time. Stored as a millisecond representation of the Unix epoch.
-      #
-      #   @return [Integer]
-      required :clicked, Integer
-
-      # @!attribute delivered
-      #   A UTC timestamp at which the Integration provider delivered the message. Stored
-      #   as a millisecond representation of the Unix epoch.
-      #
-      #   @return [Integer]
-      required :delivered, Integer
-
       # @!attribute enqueued
       #   A UTC timestamp at which Courier received the message request. Stored as a
       #   millisecond representation of the Unix epoch.
@@ -44,71 +30,85 @@ module Courier
       #   @return [String]
       required :notification, String
 
-      # @!attribute opened
-      #   A UTC timestamp at which the recipient opened a message for the first time.
-      #   Stored as a millisecond representation of the Unix epoch.
-      #
-      #   @return [Integer]
-      required :opened, Integer
-
       # @!attribute recipient
       #   A unique identifier associated with the recipient of the delivered message.
       #
       #   @return [String]
       required :recipient, String
 
-      # @!attribute sent
-      #   A UTC timestamp at which Courier passed the message to the Integration provider.
-      #   Stored as a millisecond representation of the Unix epoch.
-      #
-      #   @return [Integer]
-      required :sent, Integer
-
       # @!attribute status
       #   The current status of the message.
       #
       #   @return [Symbol, Courier::Models::MessageDetails::Status]
       required :status, enum: -> { Courier::MessageDetails::Status }
 
+      # @!attribute clicked
+      #   A UTC timestamp at which the recipient clicked on a tracked link for the first
+      #   time. Stored as a millisecond representation of the Unix epoch.
+      #
+      #   @return [Integer, nil]
+      optional :clicked, Integer
+
+      # @!attribute delivered
+      #   A UTC timestamp at which the Integration provider delivered the message. Stored
+      #   as a millisecond representation of the Unix epoch.
+      #
+      #   @return [Integer, nil]
+      optional :delivered, Integer
+
       # @!attribute error
       #   A message describing the error that occurred.
       #
       #   @return [String, nil]
       optional :error, String, nil?: true
 
+      # @!attribute opened
+      #   A UTC timestamp at which the recipient opened a message for the first time.
+      #   Stored as a millisecond representation of the Unix epoch.
+      #
+      #   @return [Integer, nil]
+      optional :opened, Integer
+
       # @!attribute reason
       #   The reason for the current status of the message.
       #
       #   @return [Symbol, Courier::Models::MessageDetails::Reason, nil]
       optional :reason, enum: -> { Courier::MessageDetails::Reason }, nil?: true
 
-      # @!method initialize(id:, clicked:, delivered:, enqueued:, event:, notification:, opened:, recipient:, sent:, status:, error: nil, reason: nil)
+      # @!attribute sent
+      #   A UTC timestamp at which Courier passed the message to the Integration provider.
+      #   Stored as a millisecond representation of the Unix epoch.
+      #
+      #   @return [Integer, nil]
+      optional :sent, Integer
+
+      # @!method initialize(id:, enqueued:, event:, notification:, recipient:, status:, clicked: nil, delivered: nil, error: nil, opened: nil, reason: nil, sent: nil)
       #   Some parameter documentations has been truncated, see
       #   {Courier::Models::MessageDetails} for more details.
       #
       #   @param id [String] A unique identifier associated with the message you wish to retrieve (results fr
       #
-      #   @param clicked [Integer] A UTC timestamp at which the recipient clicked on a tracked link for the first t
-      #
-      #   @param delivered [Integer] A UTC timestamp at which the Integration provider delivered the message. Stored
-      #
       #   @param enqueued [Integer] A UTC timestamp at which Courier received the message request. Stored as a milli
       #
       #   @param event [String] A unique identifier associated with the event of the delivered message.
       #
       #   @param notification [String] A unique identifier associated with the notification of the delivered message.
       #
-      #   @param opened [Integer] A UTC timestamp at which the recipient opened a message for the first time. Stor
-      #
       #   @param recipient [String] A unique identifier associated with the recipient of the delivered message.
       #
-      #   @param sent [Integer] A UTC timestamp at which Courier passed the message to the Integration provider.
-      #
       #   @param status [Symbol, Courier::Models::MessageDetails::Status] The current status of the message.
       #
+      #   @param clicked [Integer] A UTC timestamp at which the recipient clicked on a tracked link for the first t
+      #
+      #   @param delivered [Integer] A UTC timestamp at which the Integration provider delivered the message. Stored
+      #
       #   @param error [String, nil] A message describing the error that occurred.
       #
+      #   @param opened [Integer] A UTC timestamp at which the recipient opened a message for the first time. Stor
+      #
       #   @param reason [Symbol, Courier::Models::MessageDetails::Reason, nil] The reason for the current status of the message.
+      #
+      #   @param sent [Integer] A UTC timestamp at which Courier passed the message to the Integration provider.
 
       # The current status of the message.
       #

data/lib/courier/models/message_history_params.rb

@@ -7,13 +7,20 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
+      # @!attribute message_id
+      #
+      #   @return [String]
+      required :message_id, String
+
       # @!attribute type
       #   A supported Message History type that will filter the events returned.
       #
       #   @return [String, nil]
       optional :type, String, nil?: true
 
-      # @!method initialize(type: nil, request_options: {})
+      # @!method initialize(message_id:, type: nil, request_options: {})
+      #   @param message_id [String]
+      #
       #   @param type [String, nil] A supported Message History type that will filter the events returned.
       #
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]

data/lib/courier/models/message_providers.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @type [Courier::Internal::Type::Converter]
+    MessageProviders = Courier::Internal::Type::HashOf[-> { Courier::MessageProvidersType }]
+  end
+end

data/lib/courier/models/message_providers_type.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class MessageProvidersType < Courier::Internal::Type::BaseModel
+      # @!attribute if_
+      #   JS conditional with access to data/profile.
+      #
+      #   @return [String, nil]
+      optional :if_, String, api_name: :if, nil?: true
+
+      # @!attribute metadata
+      #
+      #   @return [Courier::Models::Metadata, nil]
+      optional :metadata, -> { Courier::Metadata }, nil?: true
+
+      # @!attribute override
+      #   Provider-specific overrides.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :override, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown], nil?: true
+
+      # @!attribute timeouts
+      #
+      #   @return [Integer, nil]
+      optional :timeouts, Integer, nil?: true
+
+      # @!method initialize(if_: nil, metadata: nil, override: nil, timeouts: nil)
+      #   @param if_ [String, nil] JS conditional with access to data/profile.
+      #
+      #   @param metadata [Courier::Models::Metadata, nil]
+      #
+      #   @param override [Hash{Symbol=>Object}, nil] Provider-specific overrides.
+      #
+      #   @param timeouts [Integer, nil]
+    end
+  end
+end

data/lib/courier/models/message_retrieve_params.rb

@@ -7,7 +7,13 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!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

data/lib/courier/models/metadata.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class Metadata < Courier::Internal::Type::BaseModel
+      # @!attribute utm
+      #
+      #   @return [Courier::Models::Utm, nil]
+      optional :utm, -> { Courier::Utm }, nil?: true
+
+      # @!method initialize(utm: nil)
+      #   @param utm [Courier::Models::Utm, nil]
+    end
+  end
+end

data/lib/courier/models/notification_archive_params.rb

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

data/lib/courier/models/notification_create_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Notifications#create
+    class NotificationCreateParams < Courier::Models::NotificationTemplateCreateRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/notification_list_params.rb

@@ -8,20 +8,29 @@ module Courier
       include Courier::Internal::Type::RequestParameters
 
       # @!attribute cursor
+      #   Opaque pagination cursor from a previous response. Omit for the first page.
       #
       #   @return [String, nil]
       optional :cursor, String, nil?: true
 
+      # @!attribute event_id
+      #   Filter to templates linked to this event map ID.
+      #
+      #   @return [String, nil]
+      optional :event_id, String
+
       # @!attribute notes
-      #   Retrieve the notes from the Notification template settings.
+      #   Include template notes in the response. Only applies to legacy templates.
       #
       #   @return [Boolean, nil]
       optional :notes, Courier::Internal::Type::Boolean, nil?: true
 
-      # @!method initialize(cursor: nil, notes: nil, request_options: {})
-      #   @param cursor [String, nil]
+      # @!method initialize(cursor: nil, event_id: nil, notes: nil, request_options: {})
+      #   @param cursor [String, nil] Opaque pagination cursor from a previous response. Omit for the first page.
+      #
+      #   @param event_id [String] Filter to templates linked to this event map ID.
       #
-      #   @param notes [Boolean, nil] Retrieve the notes from the Notification template settings.
+      #   @param notes [Boolean, nil] Include template notes in the response. Only applies to legacy templates.
       #
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/courier/models/notification_list_response.rb

@@ -10,108 +10,123 @@ module Courier
       required :paging, -> { Courier::Paging }
 
       # @!attribute results
+      #   Notification templates in this workspace.
       #
-      #   @return [Array<Courier::Models::NotificationListResponse::Result>]
+      #   @return [Array<Courier::Models::NotificationListResponse::Result::Notification, Courier::Models::NotificationTemplateSummary>]
       required :results,
-               -> { Courier::Internal::Type::ArrayOf[Courier::Models::NotificationListResponse::Result] }
+               -> { Courier::Internal::Type::ArrayOf[union: Courier::Models::NotificationListResponse::Result] }
 
       # @!method initialize(paging:, results:)
       #   @param paging [Courier::Models::Paging]
-      #   @param results [Array<Courier::Models::NotificationListResponse::Result>]
-
-      class Result < Courier::Internal::Type::BaseModel
-        # @!attribute id
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute created_at
-        #
-        #   @return [Integer]
-        required :created_at, Integer
-
-        # @!attribute event_ids
-        #   Array of event IDs associated with this notification
-        #
-        #   @return [Array<String>]
-        required :event_ids, Courier::Internal::Type::ArrayOf[String]
-
-        # @!attribute note
-        #
-        #   @return [String]
-        required :note, String
-
-        # @!attribute routing
-        #
-        #   @return [Courier::Models::MessageRouting]
-        required :routing, -> { Courier::MessageRouting }
-
-        # @!attribute topic_id
-        #
-        #   @return [String]
-        required :topic_id, String
-
-        # @!attribute updated_at
-        #
-        #   @return [Integer]
-        required :updated_at, Integer
-
-        # @!attribute tags
-        #
-        #   @return [Courier::Models::NotificationListResponse::Result::Tags, nil]
-        optional :tags, -> { Courier::Models::NotificationListResponse::Result::Tags }, nil?: true
-
-        # @!attribute title
-        #
-        #   @return [String, nil]
-        optional :title, String, nil?: true
-
-        # @!method initialize(id:, created_at:, event_ids:, note:, routing:, topic_id:, updated_at:, tags: nil, title: nil)
-        #   @param id [String]
-        #
-        #   @param created_at [Integer]
-        #
-        #   @param event_ids [Array<String>] Array of event IDs associated with this notification
-        #
-        #   @param note [String]
-        #
-        #   @param routing [Courier::Models::MessageRouting]
-        #
-        #   @param topic_id [String]
-        #
-        #   @param updated_at [Integer]
-        #
-        #   @param tags [Courier::Models::NotificationListResponse::Result::Tags, nil]
-        #
-        #   @param title [String, nil]
-
-        # @see Courier::Models::NotificationListResponse::Result#tags
-        class Tags < Courier::Internal::Type::BaseModel
-          # @!attribute data
-          #
-          #   @return [Array<Courier::Models::NotificationListResponse::Result::Tags::Data>]
-          required :data,
-                   -> { Courier::Internal::Type::ArrayOf[Courier::Models::NotificationListResponse::Result::Tags::Data] }
-
-          # @!method initialize(data:)
-          #   @param data [Array<Courier::Models::NotificationListResponse::Result::Tags::Data>]
-
-          class Data < Courier::Internal::Type::BaseModel
-            # @!attribute id
-            #
-            #   @return [String]
-            required :id, String
+      #
+      #   @param results [Array<Courier::Models::NotificationListResponse::Result::Notification, Courier::Models::NotificationTemplateSummary>] Notification templates in this workspace.
 
-            # @!attribute name
-            #
-            #   @return [String]
-            required :name, String
+      # V2 (CDS) template summary returned in list responses.
+      module Result
+        extend Courier::Internal::Type::Union
+
+        variant -> { Courier::Models::NotificationListResponse::Result::Notification }
+
+        # V2 (CDS) template summary returned in list responses.
+        variant -> { Courier::NotificationTemplateSummary }
+
+        class Notification < Courier::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute created_at
+          #
+          #   @return [Integer]
+          required :created_at, Integer
+
+          # @!attribute event_ids
+          #   Array of event IDs associated with this notification
+          #
+          #   @return [Array<String>]
+          required :event_ids, Courier::Internal::Type::ArrayOf[String]
+
+          # @!attribute note
+          #
+          #   @return [String]
+          required :note, String
+
+          # @!attribute routing
+          #
+          #   @return [Courier::Models::MessageRouting]
+          required :routing, -> { Courier::MessageRouting }
+
+          # @!attribute topic_id
+          #
+          #   @return [String]
+          required :topic_id, String
 
-            # @!method initialize(id:, name:)
-            #   @param id [String]
-            #   @param name [String]
+          # @!attribute updated_at
+          #
+          #   @return [Integer]
+          required :updated_at, Integer
+
+          # @!attribute tags
+          #
+          #   @return [Courier::Models::NotificationListResponse::Result::Notification::Tags, nil]
+          optional :tags, -> { Courier::Models::NotificationListResponse::Result::Notification::Tags }, nil?: true
+
+          # @!attribute title
+          #
+          #   @return [String, nil]
+          optional :title, String, nil?: true
+
+          # @!method initialize(id:, created_at:, event_ids:, note:, routing:, topic_id:, updated_at:, tags: nil, title: nil)
+          #   @param id [String]
+          #
+          #   @param created_at [Integer]
+          #
+          #   @param event_ids [Array<String>] Array of event IDs associated with this notification
+          #
+          #   @param note [String]
+          #
+          #   @param routing [Courier::Models::MessageRouting]
+          #
+          #   @param topic_id [String]
+          #
+          #   @param updated_at [Integer]
+          #
+          #   @param tags [Courier::Models::NotificationListResponse::Result::Notification::Tags, nil]
+          #
+          #   @param title [String, nil]
+
+          # @see Courier::Models::NotificationListResponse::Result::Notification#tags
+          class Tags < Courier::Internal::Type::BaseModel
+            # @!attribute data
+            #
+            #   @return [Array<Courier::Models::NotificationListResponse::Result::Notification::Tags::Data>]
+            required :data,
+                     -> { Courier::Internal::Type::ArrayOf[Courier::Models::NotificationListResponse::Result::Notification::Tags::Data] }
+
+            # @!method initialize(data:)
+            #   @param data [Array<Courier::Models::NotificationListResponse::Result::Notification::Tags::Data>]
+
+            class Data < Courier::Internal::Type::BaseModel
+              # @!attribute id
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute name
+              #
+              #   @return [String]
+              required :name, String
+
+              # @!method initialize(id:, name:)
+              #   @param id [String]
+              #   @param name [String]
+            end
           end
         end
+
+        # @!method self.variants
+        #   @return [Array(Courier::Models::NotificationListResponse::Result::Notification, Courier::Models::NotificationTemplateSummary)]
       end
     end
   end

data/lib/courier/models/notification_list_versions_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Notifications#list_versions
+    class NotificationListVersionsParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute cursor
+      #   Opaque pagination cursor from a previous response. Omit for the first page.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute limit
+      #   Maximum number of versions to return per page. Default 10, max 10.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!method initialize(id:, cursor: nil, limit: nil, request_options: {})
+      #   @param id [String]
+      #
+      #   @param cursor [String] Opaque pagination cursor from a previous response. Omit for the first page.
+      #
+      #   @param limit [Integer] Maximum number of versions to return per page. Default 10, max 10.
+      #
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/notification_publish_params.rb

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

data/lib/courier/models/notification_replace_params.rb

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

data/lib/courier/models/notification_retrieve_content_params.rb

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