trycourier 4.8.0 → 4.10.0

data/lib/courier/models/notification_template_get_response.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Notifications#retrieve
+    class NotificationTemplateGetResponse < Courier::Internal::Type::BaseModel
+      # @!attribute created
+      #   Epoch milliseconds when the template was created.
+      #
+      #   @return [Integer]
+      required :created, Integer
+
+      # @!attribute creator
+      #   User ID of the creator.
+      #
+      #   @return [String]
+      required :creator, String
+
+      # @!attribute notification
+      #   Full document shape used in POST and PUT request bodies, and returned inside the
+      #   GET response envelope.
+      #
+      #   @return [Courier::Models::NotificationTemplateGetResponse::Notification]
+      required :notification, -> { Courier::NotificationTemplateGetResponse::Notification }
+
+      # @!attribute state
+      #   The template state. Always uppercase.
+      #
+      #   @return [Symbol, Courier::Models::NotificationTemplateGetResponse::State]
+      required :state, enum: -> { Courier::NotificationTemplateGetResponse::State }
+
+      # @!attribute updated
+      #   Epoch milliseconds of last update.
+      #
+      #   @return [Integer, nil]
+      optional :updated, Integer
+
+      # @!attribute updater
+      #   User ID of the last updater.
+      #
+      #   @return [String, nil]
+      optional :updater, String
+
+      # @!method initialize(created:, creator:, notification:, state:, updated: nil, updater: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::NotificationTemplateGetResponse} for more details.
+      #
+      #   Envelope response for GET /notifications/{id}. The notification object mirrors
+      #   the POST/PUT input shape. Nullable fields return null when unset.
+      #
+      #   @param created [Integer] Epoch milliseconds when the template was created.
+      #
+      #   @param creator [String] User ID of the creator.
+      #
+      #   @param notification [Courier::Models::NotificationTemplateGetResponse::Notification] Full document shape used in POST and PUT request bodies, and returned inside the
+      #
+      #   @param state [Symbol, Courier::Models::NotificationTemplateGetResponse::State] The template state. Always uppercase.
+      #
+      #   @param updated [Integer] Epoch milliseconds of last update.
+      #
+      #   @param updater [String] User ID of the last updater.
+
+      # @see Courier::Models::NotificationTemplateGetResponse#notification
+      class Notification < Courier::Models::NotificationTemplatePayload
+        # @!attribute id
+        #   The template ID.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:)
+        #   Full document shape used in POST and PUT request bodies, and returned inside the
+        #   GET response envelope.
+        #
+        #   @param id [String] The template ID.
+      end
+
+      # The template state. Always uppercase.
+      #
+      # @see Courier::Models::NotificationTemplateGetResponse#state
+      module State
+        extend Courier::Internal::Type::Enum
+
+        DRAFT = :DRAFT
+        PUBLISHED = :PUBLISHED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/notification_template_mutation_response.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Notifications#create
+    class NotificationTemplateMutationResponse < Courier::Internal::Type::BaseModel
+      # @!attribute notification
+      #
+      #   @return [Courier::Models::NotificationTemplateMutationResponse::Notification]
+      required :notification, -> { Courier::NotificationTemplateMutationResponse::Notification }
+
+      # @!attribute state
+      #   The template state after the operation. Always uppercase.
+      #
+      #   @return [Symbol, Courier::Models::NotificationTemplateMutationResponse::State]
+      required :state, enum: -> { Courier::NotificationTemplateMutationResponse::State }
+
+      # @!method initialize(notification:, state:)
+      #   Response returned by POST and PUT operations.
+      #
+      #   @param notification [Courier::Models::NotificationTemplateMutationResponse::Notification]
+      #
+      #   @param state [Symbol, Courier::Models::NotificationTemplateMutationResponse::State] The template state after the operation. Always uppercase.
+
+      # @see Courier::Models::NotificationTemplateMutationResponse#notification
+      class Notification < Courier::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the created or updated template.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:)
+        #   @param id [String] The ID of the created or updated template.
+      end
+
+      # The template state after the operation. Always uppercase.
+      #
+      # @see Courier::Models::NotificationTemplateMutationResponse#state
+      module State
+        extend Courier::Internal::Type::Enum
+
+        DRAFT = :DRAFT
+        PUBLISHED = :PUBLISHED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/notification_template_payload.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class NotificationTemplatePayload < Courier::Internal::Type::BaseModel
+      # @!attribute brand
+      #   Brand reference, or null for no brand.
+      #
+      #   @return [Courier::Models::NotificationTemplatePayload::Brand, nil]
+      required :brand, -> { Courier::NotificationTemplatePayload::Brand }, nil?: true
+
+      # @!attribute content
+      #   Elemental content definition.
+      #
+      #   @return [Courier::Models::ElementalContent]
+      required :content, -> { Courier::ElementalContent }
+
+      # @!attribute name
+      #   Display name for the template.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute routing
+      #   Routing strategy reference, or null for none.
+      #
+      #   @return [Courier::Models::NotificationTemplatePayload::Routing, nil]
+      required :routing, -> { Courier::NotificationTemplatePayload::Routing }, nil?: true
+
+      # @!attribute subscription
+      #   Subscription topic reference, or null for none.
+      #
+      #   @return [Courier::Models::NotificationTemplatePayload::Subscription, nil]
+      required :subscription, -> { Courier::NotificationTemplatePayload::Subscription }, nil?: true
+
+      # @!attribute tags
+      #   Tags for categorization. Send empty array for none.
+      #
+      #   @return [Array<String>]
+      required :tags, Courier::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(brand:, content:, name:, routing:, subscription:, tags:)
+      #   Full document shape used in POST and PUT request bodies, and returned inside the
+      #   GET response envelope.
+      #
+      #   @param brand [Courier::Models::NotificationTemplatePayload::Brand, nil] Brand reference, or null for no brand.
+      #
+      #   @param content [Courier::Models::ElementalContent] Elemental content definition.
+      #
+      #   @param name [String] Display name for the template.
+      #
+      #   @param routing [Courier::Models::NotificationTemplatePayload::Routing, nil] Routing strategy reference, or null for none.
+      #
+      #   @param subscription [Courier::Models::NotificationTemplatePayload::Subscription, nil] Subscription topic reference, or null for none.
+      #
+      #   @param tags [Array<String>] Tags for categorization. Send empty array for none.
+
+      # @see Courier::Models::NotificationTemplatePayload#brand
+      class Brand < Courier::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:)
+        #   Brand reference, or null for no brand.
+        #
+        #   @param id [String]
+      end
+
+      # @see Courier::Models::NotificationTemplatePayload#routing
+      class Routing < Courier::Internal::Type::BaseModel
+        # @!attribute strategy_id
+        #
+        #   @return [String]
+        required :strategy_id, String
+
+        # @!method initialize(strategy_id:)
+        #   Routing strategy reference, or null for none.
+        #
+        #   @param strategy_id [String]
+      end
+
+      # @see Courier::Models::NotificationTemplatePayload#subscription
+      class Subscription < Courier::Internal::Type::BaseModel
+        # @!attribute topic_id
+        #
+        #   @return [String]
+        required :topic_id, String
+
+        # @!method initialize(topic_id:)
+        #   Subscription topic reference, or null for none.
+        #
+        #   @param topic_id [String]
+      end
+    end
+  end
+end

data/lib/courier/models/notification_template_publish_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class NotificationTemplatePublishRequest < Courier::Internal::Type::BaseModel
+      # @!attribute version
+      #   Historical version to publish (e.g. "v001"). Omit to publish the current draft.
+      #
+      #   @return [String, nil]
+      optional :version, String
+
+      # @!method initialize(version: nil)
+      #   Optional request body for publishing a notification template. Omit or send an
+      #   empty object to publish the current draft.
+      #
+      #   @param version [String] Historical version to publish (e.g. "v001"). Omit to publish the current draft.
+    end
+  end
+end

data/lib/courier/models/notification_template_state.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # Template state. Defaults to `DRAFT`.
+    module NotificationTemplateState
+      extend Courier::Internal::Type::Enum
+
+      DRAFT = :DRAFT
+      PUBLISHED = :PUBLISHED
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/courier/models/notification_template_summary.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class NotificationTemplateSummary < Courier::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created
+      #   Epoch milliseconds when the template was created.
+      #
+      #   @return [Integer]
+      required :created, Integer
+
+      # @!attribute creator
+      #   User ID of the creator.
+      #
+      #   @return [String]
+      required :creator, String
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute state
+      #
+      #   @return [Symbol, Courier::Models::NotificationTemplateSummary::State]
+      required :state, enum: -> { Courier::NotificationTemplateSummary::State }
+
+      # @!attribute tags
+      #
+      #   @return [Array<String>]
+      required :tags, Courier::Internal::Type::ArrayOf[String]
+
+      # @!attribute updated
+      #   Epoch milliseconds of last update.
+      #
+      #   @return [Integer, nil]
+      optional :updated, Integer
+
+      # @!attribute updater
+      #   User ID of the last updater.
+      #
+      #   @return [String, nil]
+      optional :updater, String
+
+      # @!method initialize(id:, created:, creator:, name:, state:, tags:, updated: nil, updater: nil)
+      #   V2 (CDS) template summary returned in list responses.
+      #
+      #   @param id [String]
+      #
+      #   @param created [Integer] Epoch milliseconds when the template was created.
+      #
+      #   @param creator [String] User ID of the creator.
+      #
+      #   @param name [String]
+      #
+      #   @param state [Symbol, Courier::Models::NotificationTemplateSummary::State]
+      #
+      #   @param tags [Array<String>]
+      #
+      #   @param updated [Integer] Epoch milliseconds of last update.
+      #
+      #   @param updater [String] User ID of the last updater.
+
+      # @see Courier::Models::NotificationTemplateSummary#state
+      module State
+        extend Courier::Internal::Type::Enum
+
+        DRAFT = :DRAFT
+        PUBLISHED = :PUBLISHED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/notification_template_update_request.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class NotificationTemplateUpdateRequest < Courier::Internal::Type::BaseModel
+      # @!attribute notification
+      #   Full document shape used in POST and PUT request bodies, and returned inside the
+      #   GET response envelope.
+      #
+      #   @return [Courier::Models::NotificationTemplatePayload]
+      required :notification, -> { Courier::NotificationTemplatePayload }
+
+      # @!attribute state
+      #   Template state after update. Case-insensitive input, normalized to uppercase in
+      #   the response. Defaults to "DRAFT".
+      #
+      #   @return [Symbol, Courier::Models::NotificationTemplateUpdateRequest::State, nil]
+      optional :state, enum: -> { Courier::NotificationTemplateUpdateRequest::State }
+
+      # @!method initialize(notification:, state: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::NotificationTemplateUpdateRequest} for more details.
+      #
+      #   Request body for replacing a notification template. Same shape as create. All
+      #   fields required (PUT = full replacement).
+      #
+      #   @param notification [Courier::Models::NotificationTemplatePayload] Full document shape used in POST and PUT request bodies, and returned inside the
+      #
+      #   @param state [Symbol, Courier::Models::NotificationTemplateUpdateRequest::State] Template state after update. Case-insensitive input, normalized to uppercase in
+
+      # Template state after update. Case-insensitive input, normalized to uppercase in
+      # the response. Defaults to "DRAFT".
+      #
+      # @see Courier::Models::NotificationTemplateUpdateRequest#state
+      module State
+        extend Courier::Internal::Type::Enum
+
+        DRAFT = :DRAFT
+        PUBLISHED = :PUBLISHED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/notification_template_version_list_response.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Notifications#list_versions
+    class NotificationTemplateVersionListResponse < Courier::Internal::Type::BaseModel
+      # @!attribute paging
+      #
+      #   @return [Courier::Models::Paging]
+      required :paging, -> { Courier::Paging }
+
+      # @!attribute versions
+      #
+      #   @return [Array<Courier::Models::VersionNode>]
+      required :versions, -> { Courier::Internal::Type::ArrayOf[Courier::VersionNode] }
+
+      # @!method initialize(paging:, versions:)
+      #   @param paging [Courier::Models::Paging]
+      #   @param versions [Array<Courier::Models::VersionNode>]
+    end
+  end
+end

data/lib/courier/models/provider.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Providers#create
+    class Provider < Courier::Internal::Type::BaseModel
+      # @!attribute id
+      #   A unique identifier for the provider configuration.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created
+      #   Unix timestamp (ms) of when the provider was created.
+      #
+      #   @return [Integer]
+      required :created, Integer
+
+      # @!attribute provider
+      #   The provider key (e.g. "sendgrid", "twilio", "slack").
+      #
+      #   @return [String]
+      required :provider, String
+
+      # @!attribute settings
+      #   Provider-specific settings (snake_case keys on the wire).
+      #
+      #   @return [Hash{Symbol=>Object}]
+      required :settings, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown]
+
+      # @!attribute title
+      #   Display title. Defaults to "Default Configuration" when not explicitly set.
+      #
+      #   @return [String]
+      required :title, String
+
+      # @!attribute alias_
+      #   Optional alias for this configuration.
+      #
+      #   @return [String, nil]
+      optional :alias_, String, api_name: :alias
+
+      # @!attribute updated
+      #   Unix timestamp (ms) of when the provider was last updated.
+      #
+      #   @return [Integer, nil]
+      optional :updated, Integer, nil?: true
+
+      # @!method initialize(id:, created:, provider:, settings:, title:, alias_: nil, updated: nil)
+      #   A configured provider in the workspace.
+      #
+      #   @param id [String] A unique identifier for the provider configuration.
+      #
+      #   @param created [Integer] Unix timestamp (ms) of when the provider was created.
+      #
+      #   @param provider [String] The provider key (e.g. "sendgrid", "twilio", "slack").
+      #
+      #   @param settings [Hash{Symbol=>Object}] Provider-specific settings (snake_case keys on the wire).
+      #
+      #   @param title [String] Display title. Defaults to "Default Configuration" when not explicitly set.
+      #
+      #   @param alias_ [String] Optional alias for this configuration.
+      #
+      #   @param updated [Integer, nil] Unix timestamp (ms) of when the provider was last updated.
+    end
+  end
+end

data/lib/courier/models/provider_create_params.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Providers#create
+    class ProviderCreateParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute provider
+      #   The provider key identifying the type (e.g. "sendgrid", "twilio"). Must be a
+      #   known Courier provider — see the catalog endpoint for valid keys.
+      #
+      #   @return [String]
+      required :provider, String
+
+      # @!attribute alias_
+      #   Optional alias for this configuration.
+      #
+      #   @return [String, nil]
+      optional :alias_, String, api_name: :alias
+
+      # @!attribute settings
+      #   Provider-specific settings (snake_case keys). Defaults to an empty object when
+      #   omitted. Use the catalog endpoint to discover required fields for a given
+      #   provider — omitting a required field returns a 400 validation error.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :settings, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown]
+
+      # @!attribute title
+      #   Optional display title. Omit to use "Default Configuration".
+      #
+      #   @return [String, nil]
+      optional :title, String
+
+      # @!method initialize(provider:, alias_: nil, settings: nil, title: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::ProviderCreateParams} for more details.
+      #
+      #   @param provider [String] The provider key identifying the type (e.g. "sendgrid", "twilio"). Must be a kno
+      #
+      #   @param alias_ [String] Optional alias for this configuration.
+      #
+      #   @param settings [Hash{Symbol=>Object}] Provider-specific settings (snake_case keys). Defaults to an empty object when o
+      #
+      #   @param title [String] Optional display title. Omit to use "Default Configuration".
+      #
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/provider_delete_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Providers#delete
+    class ProviderDeleteParams < 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/provider_list_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Providers#list
+    class ProviderListParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute cursor
+      #   Opaque cursor for fetching the next page.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!method initialize(cursor: nil, request_options: {})
+      #   @param cursor [String] Opaque cursor for fetching the next page.
+      #
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/provider_list_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Providers#list
+    class ProviderListResponse < Courier::Internal::Type::BaseModel
+      # @!attribute paging
+      #
+      #   @return [Courier::Models::Paging]
+      required :paging, -> { Courier::Paging }
+
+      # @!attribute results
+      #
+      #   @return [Array<Courier::Models::Provider>]
+      required :results, -> { Courier::Internal::Type::ArrayOf[Courier::Provider] }
+
+      # @!method initialize(paging:, results:)
+      #   Paginated list of provider configurations.
+      #
+      #   @param paging [Courier::Models::Paging]
+      #   @param results [Array<Courier::Models::Provider>]
+    end
+  end
+end

data/lib/courier/models/provider_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Providers#retrieve
+    class ProviderRetrieveParams < 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