trycourier 4.6.2 → 4.6.3

data/lib/trycourier/models/bulk_create_job_response.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    # @see Trycourier::Resources::Bulk#create_job
-    class BulkCreateJobResponse < Trycourier::Internal::Type::BaseModel
-      # @!attribute job_id
-      #
-      #   @return [String]
-      required :job_id, String, api_name: :jobId
-
-      # @!method initialize(job_id:)
-      #   @param job_id [String]
-    end
-  end
-end

data/lib/trycourier/models/bulk_list_users_params.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    # @see Trycourier::Resources::Bulk#list_users
-    class BulkListUsersParams < Trycourier::Internal::Type::BaseModel
-      extend Trycourier::Internal::Type::RequestParameters::Converter
-      include Trycourier::Internal::Type::RequestParameters
-
-      # @!attribute cursor
-      #   A unique identifier that allows for fetching the next set of users added to the
-      #   bulk job
-      #
-      #   @return [String, nil]
-      optional :cursor, String, nil?: true
-
-      # @!method initialize(cursor: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Trycourier::Models::BulkListUsersParams} for more details.
-      #
-      #   @param cursor [String, nil] A unique identifier that allows for fetching the next set of users added to the
-      #
-      #   @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/trycourier/models/bulk_list_users_response.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    # @see Trycourier::Resources::Bulk#list_users
-    class BulkListUsersResponse < Trycourier::Internal::Type::BaseModel
-      # @!attribute items
-      #
-      #   @return [Array<Trycourier::Models::BulkListUsersResponse::Item>]
-      required :items,
-               -> { Trycourier::Internal::Type::ArrayOf[Trycourier::Models::BulkListUsersResponse::Item] }
-
-      # @!attribute paging
-      #
-      #   @return [Trycourier::Models::Paging]
-      required :paging, -> { Trycourier::Paging }
-
-      # @!method initialize(items:, paging:)
-      #   @param items [Array<Trycourier::Models::BulkListUsersResponse::Item>]
-      #   @param paging [Trycourier::Models::Paging]
-
-      class Item < Trycourier::Models::InboundBulkMessageUser
-        # @!attribute status
-        #
-        #   @return [Symbol, Trycourier::Models::BulkListUsersResponse::Item::Status]
-        required :status, enum: -> { Trycourier::Models::BulkListUsersResponse::Item::Status }
-
-        # @!attribute message_id
-        #
-        #   @return [String, nil]
-        optional :message_id, String, api_name: :messageId, nil?: true
-
-        # @!method initialize(status:, message_id: nil)
-        #   @param status [Symbol, Trycourier::Models::BulkListUsersResponse::Item::Status]
-        #   @param message_id [String, nil]
-
-        module Status
-          extend Trycourier::Internal::Type::Enum
-
-          PENDING = :PENDING
-          ENQUEUED = :ENQUEUED
-          ERROR = :ERROR
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-    end
-  end
-end

data/lib/trycourier/models/bulk_retrieve_job_params.rb

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

data/lib/trycourier/models/bulk_retrieve_job_response.rb

@@ -1,76 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    # @see Trycourier::Resources::Bulk#retrieve_job
-    class BulkRetrieveJobResponse < Trycourier::Internal::Type::BaseModel
-      # @!attribute job
-      #
-      #   @return [Trycourier::Models::BulkRetrieveJobResponse::Job]
-      required :job, -> { Trycourier::Models::BulkRetrieveJobResponse::Job }
-
-      # @!method initialize(job:)
-      #   @param job [Trycourier::Models::BulkRetrieveJobResponse::Job]
-
-      # @see Trycourier::Models::BulkRetrieveJobResponse#job
-      class Job < Trycourier::Internal::Type::BaseModel
-        # @!attribute definition
-        #   Bulk message definition. Supports two formats:
-        #
-        #   - V1 format: Requires `event` field (event ID or notification ID)
-        #   - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
-        #     content) in addition to `event`
-        #
-        #   @return [Trycourier::Models::InboundBulkMessage]
-        required :definition, -> { Trycourier::InboundBulkMessage }
-
-        # @!attribute enqueued
-        #
-        #   @return [Integer]
-        required :enqueued, Integer
-
-        # @!attribute failures
-        #
-        #   @return [Integer]
-        required :failures, Integer
-
-        # @!attribute received
-        #
-        #   @return [Integer]
-        required :received, Integer
-
-        # @!attribute status
-        #
-        #   @return [Symbol, Trycourier::Models::BulkRetrieveJobResponse::Job::Status]
-        required :status, enum: -> { Trycourier::Models::BulkRetrieveJobResponse::Job::Status }
-
-        # @!method initialize(definition:, enqueued:, failures:, received:, status:)
-        #   Some parameter documentations has been truncated, see
-        #   {Trycourier::Models::BulkRetrieveJobResponse::Job} for more details.
-        #
-        #   @param definition [Trycourier::Models::InboundBulkMessage] Bulk message definition. Supports two formats:
-        #
-        #   @param enqueued [Integer]
-        #
-        #   @param failures [Integer]
-        #
-        #   @param received [Integer]
-        #
-        #   @param status [Symbol, Trycourier::Models::BulkRetrieveJobResponse::Job::Status]
-
-        # @see Trycourier::Models::BulkRetrieveJobResponse::Job#status
-        module Status
-          extend Trycourier::Internal::Type::Enum
-
-          CREATED = :CREATED
-          PROCESSING = :PROCESSING
-          COMPLETED = :COMPLETED
-          ERROR = :ERROR
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-    end
-  end
-end

data/lib/trycourier/models/bulk_run_job_params.rb

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

data/lib/trycourier/models/channel_classification.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    module ChannelClassification
-      extend Trycourier::Internal::Type::Enum
-
-      DIRECT_MESSAGE = :direct_message
-      EMAIL = :email
-      PUSH = :push
-      SMS = :sms
-      WEBHOOK = :webhook
-      INBOX = :inbox
-
-      # @!method self.values
-      #   @return [Array<Symbol>]
-    end
-  end
-end

data/lib/trycourier/models/channel_preference.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    class ChannelPreference < Trycourier::Internal::Type::BaseModel
-      # @!attribute channel
-      #
-      #   @return [Symbol, Trycourier::Models::ChannelClassification]
-      required :channel, enum: -> { Trycourier::ChannelClassification }
-
-      # @!method initialize(channel:)
-      #   @param channel [Symbol, Trycourier::Models::ChannelClassification]
-    end
-  end
-end

data/lib/trycourier/models/check.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    class Check < Trycourier::Models::BaseCheck
-      # @!attribute updated
-      #
-      #   @return [Integer]
-      required :updated, Integer
-
-      # @!method initialize(updated:)
-      #   @param updated [Integer]
-    end
-  end
-end

data/lib/trycourier/models/default_preferences.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    class DefaultPreferences < Trycourier::Internal::Type::BaseModel
-      # @!attribute items
-      #
-      #   @return [Array<Trycourier::Models::DefaultPreferences::Item>, nil]
-      optional :items,
-               -> { Trycourier::Internal::Type::ArrayOf[Trycourier::DefaultPreferences::Item] },
-               nil?: true
-
-      # @!method initialize(items: nil)
-      #   @param items [Array<Trycourier::Models::DefaultPreferences::Item>, nil]
-
-      class Item < Trycourier::Models::SubscriptionTopicNew
-        # @!attribute id
-        #   Topic ID
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!method initialize(id:)
-        #   @param id [String] Topic ID
-      end
-    end
-  end
-end

data/lib/trycourier/models/device_type.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    DeviceType = String
-  end
-end

data/lib/trycourier/models/discord.rb

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

data/lib/trycourier/models/elemental_action_node_with_type.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    class ElementalActionNodeWithType < Trycourier::Models::ElementalBaseNode
-      # @!attribute type
-      #
-      #   @return [Symbol, Trycourier::Models::ElementalActionNodeWithType::Type, nil]
-      optional :type, enum: -> { Trycourier::ElementalActionNodeWithType::Type }
-
-      # @!method initialize(type: nil)
-      #   @param type [Symbol, Trycourier::Models::ElementalActionNodeWithType::Type]
-
-      module Type
-        extend Trycourier::Internal::Type::Enum
-
-        ACTION = :action
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

data/lib/trycourier/models/elemental_base_node.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    class ElementalBaseNode < Trycourier::Internal::Type::BaseModel
-      # @!attribute channels
-      #
-      #   @return [Array<String>, nil]
-      optional :channels, Trycourier::Internal::Type::ArrayOf[String], nil?: true
-
-      # @!attribute if_
-      #
-      #   @return [String, nil]
-      optional :if_, String, api_name: :if, nil?: true
-
-      # @!attribute loop_
-      #
-      #   @return [String, nil]
-      optional :loop_, String, api_name: :loop, nil?: true
-
-      # @!attribute ref
-      #
-      #   @return [String, nil]
-      optional :ref, String, nil?: true
-
-      # @!method initialize(channels: nil, if_: nil, loop_: nil, ref: nil)
-      #   @param channels [Array<String>, nil]
-      #   @param if_ [String, nil]
-      #   @param loop_ [String, nil]
-      #   @param ref [String, nil]
-    end
-  end
-end

data/lib/trycourier/models/elemental_channel_node.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    class ElementalChannelNode < Trycourier::Models::ElementalBaseNode
-      # @!attribute channel
-      #   The channel the contents of this element should be applied to. Can be `email`,
-      #   `push`, `direct_message`, `sms` or a provider such as slack
-      #
-      #   @return [String, nil]
-      optional :channel, String
-
-      # @!attribute raw
-      #   Raw data to apply to the channel. If `elements` has not been specified, `raw` is
-      #   required.
-      #
-      #   @return [Hash{Symbol=>Object}, nil]
-      optional :raw, Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown], nil?: true
-
-      # @!method initialize(channel: nil, raw: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {Trycourier::Models::ElementalChannelNode} for more details.
-      #
-      #   The channel element allows a notification to be customized based on which
-      #   channel it is sent through. For example, you may want to display a detailed
-      #   message when the notification is sent through email, and a more concise message
-      #   in a push notification. Channel elements are only valid as top-level elements;
-      #   you cannot nest channel elements. If there is a channel element specified at the
-      #   top-level of the document, all sibling elements must be channel elements. Note:
-      #   As an alternative, most elements support a `channel` property. Which allows you
-      #   to selectively display an individual element on a per channel basis. See the
-      #   [control flow docs](https://www.courier.com/docs/platform/content/elemental/control-flow/)
-      #   for more details.
-      #
-      #   @param channel [String] The channel the contents of this element should be applied to. Can be `email`,
-      #
-      #   @param raw [Hash{Symbol=>Object}, nil] Raw data to apply to the channel. If `elements` has not been specified, `raw` is
-    end
-  end
-end

data/lib/trycourier/models/elemental_channel_node_with_type.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    class ElementalChannelNodeWithType < Trycourier::Models::ElementalChannelNode
-      # @!attribute type
-      #
-      #   @return [Symbol, Trycourier::Models::ElementalChannelNodeWithType::Type, nil]
-      optional :type, enum: -> { Trycourier::ElementalChannelNodeWithType::Type }
-
-      # @!method initialize(type: nil)
-      #   The channel element allows a notification to be customized based on which
-      #   channel it is sent through. For example, you may want to display a detailed
-      #   message when the notification is sent through email, and a more concise message
-      #   in a push notification. Channel elements are only valid as top-level elements;
-      #   you cannot nest channel elements. If there is a channel element specified at the
-      #   top-level of the document, all sibling elements must be channel elements. Note:
-      #   As an alternative, most elements support a `channel` property. Which allows you
-      #   to selectively display an individual element on a per channel basis. See the
-      #   [control flow docs](https://www.courier.com/docs/platform/content/elemental/control-flow/)
-      #   for more details.
-      #
-      #   @param type [Symbol, Trycourier::Models::ElementalChannelNodeWithType::Type]
-
-      module Type
-        extend Trycourier::Internal::Type::Enum
-
-        CHANNEL = :channel
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

data/lib/trycourier/models/elemental_content.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    class ElementalContent < Trycourier::Internal::Type::BaseModel
-      # @!attribute elements
-      #
-      #   @return [Array<Trycourier::Models::ElementalTextNodeWithType, Trycourier::Models::ElementalMetaNodeWithType, Trycourier::Models::ElementalChannelNodeWithType, Trycourier::Models::ElementalImageNodeWithType, Trycourier::Models::ElementalActionNodeWithType, Trycourier::Models::ElementalDividerNodeWithType, Trycourier::Models::ElementalQuoteNodeWithType>]
-      required :elements, -> { Trycourier::Internal::Type::ArrayOf[union: Trycourier::ElementalNode] }
-
-      # @!attribute version
-      #   For example, "2022-01-01"
-      #
-      #   @return [String]
-      required :version, String
-
-      # @!attribute brand
-      #
-      #   @return [String, nil]
-      optional :brand, String, nil?: true
-
-      # @!method initialize(elements:, version:, brand: nil)
-      #   @param elements [Array<Trycourier::Models::ElementalTextNodeWithType, Trycourier::Models::ElementalMetaNodeWithType, Trycourier::Models::ElementalChannelNodeWithType, Trycourier::Models::ElementalImageNodeWithType, Trycourier::Models::ElementalActionNodeWithType, Trycourier::Models::ElementalDividerNodeWithType, Trycourier::Models::ElementalQuoteNodeWithType>]
-      #
-      #   @param version [String] For example, "2022-01-01"
-      #
-      #   @param brand [String, nil]
-    end
-  end
-end

data/lib/trycourier/models/elemental_content_sugar.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    class ElementalContentSugar < Trycourier::Internal::Type::BaseModel
-      # @!attribute body
-      #   The text content displayed in the notification.
-      #
-      #   @return [String]
-      required :body, String
-
-      # @!attribute title
-      #   Title/subject displayed by supported channels.
-      #
-      #   @return [String]
-      required :title, String
-
-      # @!method initialize(body:, title:)
-      #   Syntactic sugar to provide a fast shorthand for Courier Elemental Blocks.
-      #
-      #   @param body [String] The text content displayed in the notification.
-      #
-      #   @param title [String] Title/subject displayed by supported channels.
-    end
-  end
-end

data/lib/trycourier/models/elemental_divider_node_with_type.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    class ElementalDividerNodeWithType < Trycourier::Models::ElementalBaseNode
-      # @!attribute type
-      #
-      #   @return [Symbol, Trycourier::Models::ElementalDividerNodeWithType::Type, nil]
-      optional :type, enum: -> { Trycourier::ElementalDividerNodeWithType::Type }
-
-      # @!method initialize(type: nil)
-      #   @param type [Symbol, Trycourier::Models::ElementalDividerNodeWithType::Type]
-
-      module Type
-        extend Trycourier::Internal::Type::Enum
-
-        DIVIDER = :divider
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

data/lib/trycourier/models/elemental_image_node_with_type.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    class ElementalImageNodeWithType < Trycourier::Models::ElementalBaseNode
-      # @!attribute type
-      #
-      #   @return [Symbol, Trycourier::Models::ElementalImageNodeWithType::Type, nil]
-      optional :type, enum: -> { Trycourier::ElementalImageNodeWithType::Type }
-
-      # @!method initialize(type: nil)
-      #   @param type [Symbol, Trycourier::Models::ElementalImageNodeWithType::Type]
-
-      module Type
-        extend Trycourier::Internal::Type::Enum
-
-        IMAGE = :image
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

data/lib/trycourier/models/elemental_meta_node_with_type.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    class ElementalMetaNodeWithType < Trycourier::Models::ElementalBaseNode
-      # @!attribute type
-      #
-      #   @return [Symbol, Trycourier::Models::ElementalMetaNodeWithType::Type, nil]
-      optional :type, enum: -> { Trycourier::ElementalMetaNodeWithType::Type }
-
-      # @!method initialize(type: nil)
-      #   @param type [Symbol, Trycourier::Models::ElementalMetaNodeWithType::Type]
-
-      module Type
-        extend Trycourier::Internal::Type::Enum
-
-        META = :meta
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

data/lib/trycourier/models/elemental_node.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    # The channel element allows a notification to be customized based on which
-    # channel it is sent through. For example, you may want to display a detailed
-    # message when the notification is sent through email, and a more concise message
-    # in a push notification. Channel elements are only valid as top-level elements;
-    # you cannot nest channel elements. If there is a channel element specified at the
-    # top-level of the document, all sibling elements must be channel elements. Note:
-    # As an alternative, most elements support a `channel` property. Which allows you
-    # to selectively display an individual element on a per channel basis. See the
-    # [control flow docs](https://www.courier.com/docs/platform/content/elemental/control-flow/)
-    # for more details.
-    module ElementalNode
-      extend Trycourier::Internal::Type::Union
-
-      variant -> { Trycourier::ElementalTextNodeWithType }
-
-      variant -> { Trycourier::ElementalMetaNodeWithType }
-
-      # The channel element allows a notification to be customized based on which channel it is sent through.
-      # For example, you may want to display a detailed message when the notification is sent through email,
-      # and a more concise message in a push notification. Channel elements are only valid as top-level
-      # elements; you cannot nest channel elements. If there is a channel element specified at the top-level
-      # of the document, all sibling elements must be channel elements.
-      # Note: As an alternative, most elements support a `channel` property. Which allows you to selectively
-      # display an individual element on a per channel basis. See the
-      # [control flow docs](https://www.courier.com/docs/platform/content/elemental/control-flow/) for more details.
-      variant -> { Trycourier::ElementalChannelNodeWithType }
-
-      variant -> { Trycourier::ElementalImageNodeWithType }
-
-      variant -> { Trycourier::ElementalActionNodeWithType }
-
-      variant -> { Trycourier::ElementalDividerNodeWithType }
-
-      variant -> { Trycourier::ElementalQuoteNodeWithType }
-
-      # @!method self.variants
-      #   @return [Array(Trycourier::Models::ElementalTextNodeWithType, Trycourier::Models::ElementalMetaNodeWithType, Trycourier::Models::ElementalChannelNodeWithType, Trycourier::Models::ElementalImageNodeWithType, Trycourier::Models::ElementalActionNodeWithType, Trycourier::Models::ElementalDividerNodeWithType, Trycourier::Models::ElementalQuoteNodeWithType)]
-    end
-  end
-end

data/lib/trycourier/models/elemental_quote_node_with_type.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    class ElementalQuoteNodeWithType < Trycourier::Models::ElementalBaseNode
-      # @!attribute type
-      #
-      #   @return [Symbol, Trycourier::Models::ElementalQuoteNodeWithType::Type, nil]
-      optional :type, enum: -> { Trycourier::ElementalQuoteNodeWithType::Type }
-
-      # @!method initialize(type: nil)
-      #   @param type [Symbol, Trycourier::Models::ElementalQuoteNodeWithType::Type]
-
-      module Type
-        extend Trycourier::Internal::Type::Enum
-
-        QUOTE = :quote
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

data/lib/trycourier/models/elemental_text_node_with_type.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    class ElementalTextNodeWithType < Trycourier::Models::ElementalBaseNode
-      # @!attribute type
-      #
-      #   @return [Symbol, Trycourier::Models::ElementalTextNodeWithType::Type, nil]
-      optional :type, enum: -> { Trycourier::ElementalTextNodeWithType::Type }
-
-      # @!method initialize(type: nil)
-      #   @param type [Symbol, Trycourier::Models::ElementalTextNodeWithType::Type]
-
-      module Type
-        extend Trycourier::Internal::Type::Enum
-
-        TEXT = :text
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end