trycourier 4.6.2 → 4.6.3

data/lib/courier/models/message_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Messages#retrieve
+    class MessageRetrieveParams < Courier::Internal::Type::BaseModel
+      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/message_retrieve_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Messages#retrieve
+    class MessageRetrieveResponse < Courier::Models::MessageDetails
+      # @!attribute providers
+      #
+      #   @return [Array<Hash{Symbol=>Object}>, nil]
+      optional :providers,
+               Courier::Internal::Type::ArrayOf[Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown]],
+               nil?: true
+
+      # @!method initialize(providers: nil)
+      #   @param providers [Array<Hash{Symbol=>Object}>, nil]
+    end
+  end
+end

data/lib/courier/models/message_routing.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class MessageRouting < Courier::Internal::Type::BaseModel
+      # @!attribute channels
+      #
+      #   @return [Array<Courier::Models::MessageRoutingChannel>]
+      required :channels, -> { Courier::Internal::Type::ArrayOf[union: Courier::MessageRoutingChannel] }
+
+      # @!attribute method_
+      #
+      #   @return [Symbol, Courier::Models::MessageRouting::Method]
+      required :method_, enum: -> { Courier::MessageRouting::Method }, api_name: :method
+
+      # @!method initialize(channels:, method_:)
+      #   @param channels [Array<Courier::Models::MessageRoutingChannel>]
+      #   @param method_ [Symbol, Courier::Models::MessageRouting::Method]
+
+      # @see Courier::Models::MessageRouting#method_
+      module Method
+        extend Courier::Internal::Type::Enum
+
+        ALL = :all
+        SINGLE = :single
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/message_routing_channel.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module MessageRoutingChannel
+      extend Courier::Internal::Type::Union
+
+      variant String
+
+      variant -> { Courier::MessageRouting }
+
+      # @!method self.variants
+      #   @return [Array(String, Courier::Models::MessageRouting)]
+    end
+  end
+end

data/lib/courier/models/ms_teams.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module MsTeams
+      extend Courier::Internal::Type::Union
+
+      variant -> { Courier::SendToMsTeamsUserID }
+
+      variant -> { Courier::SendToMsTeamsEmail }
+
+      variant -> { Courier::SendToMsTeamsChannelID }
+
+      variant -> { Courier::SendToMsTeamsConversationID }
+
+      variant -> { Courier::SendToMsTeamsChannelName }
+
+      # @!method self.variants
+      #   @return [Array(Courier::Models::SendToMsTeamsUserID, Courier::Models::SendToMsTeamsEmail, Courier::Models::SendToMsTeamsChannelID, Courier::Models::SendToMsTeamsConversationID, Courier::Models::SendToMsTeamsChannelName)]
+    end
+  end
+end

data/lib/courier/models/ms_teams_base_properties.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class MsTeamsBaseProperties < Courier::Internal::Type::BaseModel
+      # @!attribute service_url
+      #
+      #   @return [String]
+      required :service_url, String
+
+      # @!attribute tenant_id
+      #
+      #   @return [String]
+      required :tenant_id, String
+
+      # @!method initialize(service_url:, tenant_id:)
+      #   @param service_url [String]
+      #   @param tenant_id [String]
+    end
+  end
+end

data/lib/courier/models/ms_teams_recipient.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class MsTeamsRecipient < Courier::Internal::Type::BaseModel
+      # @!attribute ms_teams
+      #
+      #   @return [Courier::Models::SendToMsTeamsUserID, Courier::Models::SendToMsTeamsEmail, Courier::Models::SendToMsTeamsChannelID, Courier::Models::SendToMsTeamsConversationID, Courier::Models::SendToMsTeamsChannelName]
+      required :ms_teams, union: -> { Courier::MsTeams }
+
+      # @!method initialize(ms_teams:)
+      #   Send via Microsoft Teams
+      #
+      #   @param ms_teams [Courier::Models::SendToMsTeamsUserID, Courier::Models::SendToMsTeamsEmail, Courier::Models::SendToMsTeamsChannelID, Courier::Models::SendToMsTeamsConversationID, Courier::Models::SendToMsTeamsChannelName]
+    end
+  end
+end

data/lib/courier/models/multiple_tokens.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class MultipleTokens < Courier::Internal::Type::BaseModel
+      # @!attribute tokens
+      #
+      #   @return [Array<Courier::Models::Token>]
+      required :tokens, -> { Courier::Internal::Type::ArrayOf[Courier::Token] }
+
+      # @!method initialize(tokens:)
+      #   @param tokens [Array<Courier::Models::Token>]
+    end
+  end
+end

data/lib/courier/models/notification_get_content.rb

@@ -0,0 +1,224 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Notifications#retrieve_content
+    class NotificationGetContent < Courier::Internal::Type::BaseModel
+      # @!attribute blocks
+      #
+      #   @return [Array<Courier::Models::NotificationGetContent::Block>, nil]
+      optional :blocks,
+               -> { Courier::Internal::Type::ArrayOf[Courier::NotificationGetContent::Block] },
+               nil?: true
+
+      # @!attribute channels
+      #
+      #   @return [Array<Courier::Models::NotificationGetContent::Channel>, nil]
+      optional :channels,
+               -> { Courier::Internal::Type::ArrayOf[Courier::NotificationGetContent::Channel] },
+               nil?: true
+
+      # @!attribute checksum
+      #
+      #   @return [String, nil]
+      optional :checksum, String, nil?: true
+
+      # @!method initialize(blocks: nil, channels: nil, checksum: nil)
+      #   @param blocks [Array<Courier::Models::NotificationGetContent::Block>, nil]
+      #   @param channels [Array<Courier::Models::NotificationGetContent::Channel>, nil]
+      #   @param checksum [String, nil]
+
+      class Block < Courier::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute type
+        #
+        #   @return [Symbol, Courier::Models::NotificationGetContent::Block::Type]
+        required :type, enum: -> { Courier::NotificationGetContent::Block::Type }
+
+        # @!attribute alias_
+        #
+        #   @return [String, nil]
+        optional :alias_, String, api_name: :alias, nil?: true
+
+        # @!attribute checksum
+        #
+        #   @return [String, nil]
+        optional :checksum, String, nil?: true
+
+        # @!attribute content
+        #
+        #   @return [String, Courier::Models::NotificationGetContent::Block::Content::NotificationContentHierarchy, nil]
+        optional :content, union: -> { Courier::NotificationGetContent::Block::Content }, nil?: true
+
+        # @!attribute context
+        #
+        #   @return [String, nil]
+        optional :context, String, nil?: true
+
+        # @!attribute locales
+        #
+        #   @return [Hash{Symbol=>String, Courier::Models::NotificationGetContent::Block::Locale::NotificationContentHierarchy}, nil]
+        optional :locales,
+                 -> {
+                   Courier::Internal::Type::HashOf[union: Courier::NotificationGetContent::Block::Locale]
+                 },
+                 nil?: true
+
+        # @!method initialize(id:, type:, alias_: nil, checksum: nil, content: nil, context: nil, locales: nil)
+        #   @param id [String]
+        #   @param type [Symbol, Courier::Models::NotificationGetContent::Block::Type]
+        #   @param alias_ [String, nil]
+        #   @param checksum [String, nil]
+        #   @param content [String, Courier::Models::NotificationGetContent::Block::Content::NotificationContentHierarchy, nil]
+        #   @param context [String, nil]
+        #   @param locales [Hash{Symbol=>String, Courier::Models::NotificationGetContent::Block::Locale::NotificationContentHierarchy}, nil]
+
+        # @see Courier::Models::NotificationGetContent::Block#type
+        module Type
+          extend Courier::Internal::Type::Enum
+
+          ACTION = :action
+          DIVIDER = :divider
+          IMAGE = :image
+          JSONNET = :jsonnet
+          LIST = :list
+          MARKDOWN = :markdown
+          QUOTE = :quote
+          TEMPLATE = :template
+          TEXT = :text
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Courier::Models::NotificationGetContent::Block#content
+        module Content
+          extend Courier::Internal::Type::Union
+
+          variant String
+
+          variant -> { Courier::NotificationGetContent::Block::Content::NotificationContentHierarchy }
+
+          class NotificationContentHierarchy < Courier::Internal::Type::BaseModel
+            # @!attribute children
+            #
+            #   @return [String, nil]
+            optional :children, String, nil?: true
+
+            # @!attribute parent
+            #
+            #   @return [String, nil]
+            optional :parent, String, nil?: true
+
+            # @!method initialize(children: nil, parent: nil)
+            #   @param children [String, nil]
+            #   @param parent [String, nil]
+          end
+
+          # @!method self.variants
+          #   @return [Array(String, Courier::Models::NotificationGetContent::Block::Content::NotificationContentHierarchy)]
+        end
+
+        module Locale
+          extend Courier::Internal::Type::Union
+
+          variant String
+
+          variant -> { Courier::NotificationGetContent::Block::Locale::NotificationContentHierarchy }
+
+          class NotificationContentHierarchy < Courier::Internal::Type::BaseModel
+            # @!attribute children
+            #
+            #   @return [String, nil]
+            optional :children, String, nil?: true
+
+            # @!attribute parent
+            #
+            #   @return [String, nil]
+            optional :parent, String, nil?: true
+
+            # @!method initialize(children: nil, parent: nil)
+            #   @param children [String, nil]
+            #   @param parent [String, nil]
+          end
+
+          # @!method self.variants
+          #   @return [Array(String, Courier::Models::NotificationGetContent::Block::Locale::NotificationContentHierarchy)]
+        end
+      end
+
+      class Channel < Courier::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute checksum
+        #
+        #   @return [String, nil]
+        optional :checksum, String, nil?: true
+
+        # @!attribute content
+        #
+        #   @return [Courier::Models::NotificationGetContent::Channel::Content, nil]
+        optional :content, -> { Courier::NotificationGetContent::Channel::Content }, nil?: true
+
+        # @!attribute locales
+        #
+        #   @return [Hash{Symbol=>Courier::Models::NotificationGetContent::Channel::Locale}, nil]
+        optional :locales,
+                 -> { Courier::Internal::Type::HashOf[Courier::NotificationGetContent::Channel::Locale] },
+                 nil?: true
+
+        # @!attribute type
+        #
+        #   @return [String, nil]
+        optional :type, String, nil?: true
+
+        # @!method initialize(id:, checksum: nil, content: nil, locales: nil, type: nil)
+        #   @param id [String]
+        #   @param checksum [String, nil]
+        #   @param content [Courier::Models::NotificationGetContent::Channel::Content, nil]
+        #   @param locales [Hash{Symbol=>Courier::Models::NotificationGetContent::Channel::Locale}, nil]
+        #   @param type [String, nil]
+
+        # @see Courier::Models::NotificationGetContent::Channel#content
+        class Content < Courier::Internal::Type::BaseModel
+          # @!attribute subject
+          #
+          #   @return [String, nil]
+          optional :subject, String, nil?: true
+
+          # @!attribute title
+          #
+          #   @return [String, nil]
+          optional :title, String, nil?: true
+
+          # @!method initialize(subject: nil, title: nil)
+          #   @param subject [String, nil]
+          #   @param title [String, nil]
+        end
+
+        class Locale < Courier::Internal::Type::BaseModel
+          # @!attribute subject
+          #
+          #   @return [String, nil]
+          optional :subject, String, nil?: true
+
+          # @!attribute title
+          #
+          #   @return [String, nil]
+          optional :title, String, nil?: true
+
+          # @!method initialize(subject: nil, title: nil)
+          #   @param subject [String, nil]
+          #   @param title [String, nil]
+        end
+      end
+    end
+  end
+end

data/lib/courier/models/notification_list_params.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Notifications#list
+    class NotificationListParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute cursor
+      #
+      #   @return [String, nil]
+      optional :cursor, String, nil?: true
+
+      # @!attribute notes
+      #   Retrieve the notes from the Notification template settings.
+      #
+      #   @return [Boolean, nil]
+      optional :notes, Courier::Internal::Type::Boolean, nil?: true
+
+      # @!method initialize(cursor: nil, notes: nil, request_options: {})
+      #   @param cursor [String, nil]
+      #
+      #   @param notes [Boolean, nil] Retrieve the notes from the Notification template settings.
+      #
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/notification_list_response.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Notifications#list
+    class NotificationListResponse < Courier::Internal::Type::BaseModel
+      # @!attribute paging
+      #
+      #   @return [Courier::Models::Paging]
+      required :paging, -> { Courier::Paging }
+
+      # @!attribute results
+      #
+      #   @return [Array<Courier::Models::NotificationListResponse::Result>]
+      required :results,
+               -> { Courier::Internal::Type::ArrayOf[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
+
+            # @!attribute name
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!method initialize(id:, name:)
+            #   @param id [String]
+            #   @param name [String]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/courier/models/notification_preference_details.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class NotificationPreferenceDetails < Courier::Internal::Type::BaseModel
+      # @!attribute status
+      #
+      #   @return [Symbol, Courier::Models::PreferenceStatus]
+      required :status, enum: -> { Courier::PreferenceStatus }
+
+      # @!attribute channel_preferences
+      #
+      #   @return [Array<Courier::Models::ChannelPreference>, nil]
+      optional :channel_preferences,
+               -> { Courier::Internal::Type::ArrayOf[Courier::ChannelPreference] },
+               nil?: true
+
+      # @!attribute rules
+      #
+      #   @return [Array<Courier::Models::Rule>, nil]
+      optional :rules, -> { Courier::Internal::Type::ArrayOf[Courier::Rule] }, nil?: true
+
+      # @!method initialize(status:, channel_preferences: nil, rules: nil)
+      #   @param status [Symbol, Courier::Models::PreferenceStatus]
+      #   @param channel_preferences [Array<Courier::Models::ChannelPreference>, nil]
+      #   @param rules [Array<Courier::Models::Rule>, nil]
+    end
+  end
+end

data/lib/courier/models/notification_retrieve_content_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Notifications#retrieve_content
+    class NotificationRetrieveContentParams < Courier::Internal::Type::BaseModel
+      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/notifications/check_delete_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Notifications
+      # @see Courier::Resources::Notifications::Checks#delete
+      class CheckDeleteParams < 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
+end

data/lib/courier/models/notifications/check_list_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Notifications
+      # @see Courier::Resources::Notifications::Checks#list
+      class CheckListParams < 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
+end

data/lib/courier/models/notifications/check_list_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Notifications
+      # @see Courier::Resources::Notifications::Checks#list
+      class CheckListResponse < Courier::Internal::Type::BaseModel
+        # @!attribute checks
+        #
+        #   @return [Array<Courier::Models::Check>]
+        required :checks, -> { Courier::Internal::Type::ArrayOf[Courier::Check] }
+
+        # @!method initialize(checks:)
+        #   @param checks [Array<Courier::Models::Check>]
+      end
+    end
+  end
+end

data/lib/courier/models/notifications/check_update_params.rb

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