trycourier 4.6.2 → 4.6.3

data/lib/trycourier/models/lists/subscription_add_params.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    module Lists
-      # @see Trycourier::Resources::Lists::Subscriptions#add
-      class SubscriptionAddParams < Trycourier::Internal::Type::BaseModel
-        extend Trycourier::Internal::Type::RequestParameters::Converter
-        include Trycourier::Internal::Type::RequestParameters
-
-        # @!attribute recipients
-        #
-        #   @return [Array<Trycourier::Models::PutSubscriptionsRecipient>]
-        required :recipients, -> { Trycourier::Internal::Type::ArrayOf[Trycourier::PutSubscriptionsRecipient] }
-
-        # @!method initialize(recipients:, request_options: {})
-        #   @param recipients [Array<Trycourier::Models::PutSubscriptionsRecipient>]
-        #   @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}]
-      end
-    end
-  end
-end

data/lib/trycourier/models/lists/subscription_list_params.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    module Lists
-      # @see Trycourier::Resources::Lists::Subscriptions#list
-      class SubscriptionListParams < 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 list subscriptions
-        #
-        #   @return [String, nil]
-        optional :cursor, String, nil?: true
-
-        # @!method initialize(cursor: nil, request_options: {})
-        #   @param cursor [String, nil] A unique identifier that allows for fetching the next set of list subscriptions
-        #
-        #   @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}]
-      end
-    end
-  end
-end

data/lib/trycourier/models/lists/subscription_list_response.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    module Lists
-      # @see Trycourier::Resources::Lists::Subscriptions#list
-      class SubscriptionListResponse < Trycourier::Internal::Type::BaseModel
-        # @!attribute items
-        #
-        #   @return [Array<Trycourier::Models::Lists::SubscriptionListResponse::Item>]
-        required :items,
-                 -> { Trycourier::Internal::Type::ArrayOf[Trycourier::Models::Lists::SubscriptionListResponse::Item] }
-
-        # @!attribute paging
-        #
-        #   @return [Trycourier::Models::Paging]
-        required :paging, -> { Trycourier::Paging }
-
-        # @!method initialize(items:, paging:)
-        #   @param items [Array<Trycourier::Models::Lists::SubscriptionListResponse::Item>]
-        #   @param paging [Trycourier::Models::Paging]
-
-        class Item < Trycourier::Internal::Type::BaseModel
-          # @!attribute recipient_id
-          #
-          #   @return [String]
-          required :recipient_id, String, api_name: :recipientId
-
-          # @!attribute created
-          #
-          #   @return [String, nil]
-          optional :created, String, nil?: true
-
-          # @!attribute preferences
-          #
-          #   @return [Trycourier::Models::RecipientPreferences, nil]
-          optional :preferences, -> { Trycourier::RecipientPreferences }, nil?: true
-
-          # @!method initialize(recipient_id:, created: nil, preferences: nil)
-          #   @param recipient_id [String]
-          #   @param created [String, nil]
-          #   @param preferences [Trycourier::Models::RecipientPreferences, nil]
-        end
-      end
-    end
-  end
-end

data/lib/trycourier/models/lists/subscription_subscribe_params.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    module Lists
-      # @see Trycourier::Resources::Lists::Subscriptions#subscribe
-      class SubscriptionSubscribeParams < Trycourier::Internal::Type::BaseModel
-        extend Trycourier::Internal::Type::RequestParameters::Converter
-        include Trycourier::Internal::Type::RequestParameters
-
-        # @!attribute recipients
-        #
-        #   @return [Array<Trycourier::Models::PutSubscriptionsRecipient>]
-        required :recipients, -> { Trycourier::Internal::Type::ArrayOf[Trycourier::PutSubscriptionsRecipient] }
-
-        # @!method initialize(recipients:, request_options: {})
-        #   @param recipients [Array<Trycourier::Models::PutSubscriptionsRecipient>]
-        #   @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}]
-      end
-    end
-  end
-end

data/lib/trycourier/models/lists/subscription_subscribe_user_params.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    module Lists
-      # @see Trycourier::Resources::Lists::Subscriptions#subscribe_user
-      class SubscriptionSubscribeUserParams < Trycourier::Internal::Type::BaseModel
-        extend Trycourier::Internal::Type::RequestParameters::Converter
-        include Trycourier::Internal::Type::RequestParameters
-
-        # @!attribute list_id
-        #
-        #   @return [String]
-        required :list_id, String
-
-        # @!attribute preferences
-        #
-        #   @return [Trycourier::Models::RecipientPreferences, nil]
-        optional :preferences, -> { Trycourier::RecipientPreferences }, nil?: true
-
-        # @!method initialize(list_id:, preferences: nil, request_options: {})
-        #   @param list_id [String]
-        #   @param preferences [Trycourier::Models::RecipientPreferences, nil]
-        #   @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}]
-      end
-    end
-  end
-end

data/lib/trycourier/models/lists/subscription_unsubscribe_user_params.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    module Lists
-      # @see Trycourier::Resources::Lists::Subscriptions#unsubscribe_user
-      class SubscriptionUnsubscribeUserParams < Trycourier::Internal::Type::BaseModel
-        extend Trycourier::Internal::Type::RequestParameters::Converter
-        include Trycourier::Internal::Type::RequestParameters
-
-        # @!attribute list_id
-        #
-        #   @return [String]
-        required :list_id, String
-
-        # @!method initialize(list_id:, request_options: {})
-        #   @param list_id [String]
-        #   @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}]
-      end
-    end
-  end
-end

data/lib/trycourier/models/logo.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    class Logo < Trycourier::Internal::Type::BaseModel
-      # @!attribute href
-      #
-      #   @return [String, nil]
-      optional :href, String, nil?: true
-
-      # @!attribute image
-      #
-      #   @return [String, nil]
-      optional :image, String, nil?: true
-
-      # @!method initialize(href: nil, image: nil)
-      #   @param href [String, nil]
-      #   @param image [String, nil]
-    end
-  end
-end

data/lib/trycourier/models/message_cancel_params.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    # @see Trycourier::Resources::Messages#cancel
-    class MessageCancelParams < 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/message_content_params.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    # @see Trycourier::Resources::Messages#content
-    class MessageContentParams < 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/message_content_response.rb

@@ -1,119 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    # @see Trycourier::Resources::Messages#content
-    class MessageContentResponse < Trycourier::Internal::Type::BaseModel
-      # @!attribute results
-      #   An array of render output of a previously sent message.
-      #
-      #   @return [Array<Trycourier::Models::MessageContentResponse::Result>]
-      required :results,
-               -> { Trycourier::Internal::Type::ArrayOf[Trycourier::Models::MessageContentResponse::Result] }
-
-      # @!method initialize(results:)
-      #   @param results [Array<Trycourier::Models::MessageContentResponse::Result>] An array of render output of a previously sent message.
-
-      class Result < Trycourier::Internal::Type::BaseModel
-        # @!attribute channel
-        #   The channel used for rendering the message.
-        #
-        #   @return [String]
-        required :channel, String
-
-        # @!attribute channel_id
-        #   The ID of channel used for rendering the message.
-        #
-        #   @return [String]
-        required :channel_id, String
-
-        # @!attribute content
-        #   Content details of the rendered message.
-        #
-        #   @return [Trycourier::Models::MessageContentResponse::Result::Content]
-        required :content, -> { Trycourier::Models::MessageContentResponse::Result::Content }
-
-        # @!method initialize(channel:, channel_id:, content:)
-        #   @param channel [String] The channel used for rendering the message.
-        #
-        #   @param channel_id [String] The ID of channel used for rendering the message.
-        #
-        #   @param content [Trycourier::Models::MessageContentResponse::Result::Content] Content details of the rendered message.
-
-        # @see Trycourier::Models::MessageContentResponse::Result#content
-        class Content < Trycourier::Internal::Type::BaseModel
-          # @!attribute blocks
-          #   The blocks of the rendered message.
-          #
-          #   @return [Array<Trycourier::Models::MessageContentResponse::Result::Content::Block>]
-          required :blocks,
-                   -> { Trycourier::Internal::Type::ArrayOf[Trycourier::Models::MessageContentResponse::Result::Content::Block] }
-
-          # @!attribute body
-          #   The body of the rendered message.
-          #
-          #   @return [String]
-          required :body, String
-
-          # @!attribute html
-          #   The html content of the rendered message.
-          #
-          #   @return [String]
-          required :html, String
-
-          # @!attribute subject
-          #   The subject of the rendered message.
-          #
-          #   @return [String]
-          required :subject, String
-
-          # @!attribute text
-          #   The text of the rendered message.
-          #
-          #   @return [String]
-          required :text, String
-
-          # @!attribute title
-          #   The title of the rendered message.
-          #
-          #   @return [String]
-          required :title, String
-
-          # @!method initialize(blocks:, body:, html:, subject:, text:, title:)
-          #   Content details of the rendered message.
-          #
-          #   @param blocks [Array<Trycourier::Models::MessageContentResponse::Result::Content::Block>] The blocks of the rendered message.
-          #
-          #   @param body [String] The body of the rendered message.
-          #
-          #   @param html [String] The html content of the rendered message.
-          #
-          #   @param subject [String] The subject of the rendered message.
-          #
-          #   @param text [String] The text of the rendered message.
-          #
-          #   @param title [String] The title of the rendered message.
-
-          class Block < Trycourier::Internal::Type::BaseModel
-            # @!attribute text
-            #   The block text of the rendered message block.
-            #
-            #   @return [String]
-            required :text, String
-
-            # @!attribute type
-            #   The block type of the rendered message block.
-            #
-            #   @return [String]
-            required :type, String
-
-            # @!method initialize(text:, type:)
-            #   @param text [String] The block text of the rendered message block.
-            #
-            #   @param type [String] The block type of the rendered message block.
-          end
-        end
-      end
-    end
-  end
-end

data/lib/trycourier/models/message_context.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    class MessageContext < Trycourier::Internal::Type::BaseModel
-      # @!attribute tenant_id
-      #   Tenant id used to load brand/default preferences/context.
-      #
-      #   @return [String, nil]
-      optional :tenant_id, String, nil?: true
-
-      # @!method initialize(tenant_id: nil)
-      #   @param tenant_id [String, nil] Tenant id used to load brand/default preferences/context.
-    end
-  end
-end

data/lib/trycourier/models/message_details.rb

@@ -1,160 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    # @see Trycourier::Resources::Messages#cancel
-    class MessageDetails < Trycourier::Internal::Type::BaseModel
-      # @!attribute id
-      #   A unique identifier associated with the message you wish to retrieve (results
-      #   from a send).
-      #
-      #   @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.
-      #
-      #   @return [Integer]
-      required :enqueued, Integer
-
-      # @!attribute event
-      #   A unique identifier associated with the event of the delivered message.
-      #
-      #   @return [String]
-      required :event, String
-
-      # @!attribute notification
-      #   A unique identifier associated with the notification of the delivered message.
-      #
-      #   @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, Trycourier::Models::MessageDetails::Status]
-      required :status, enum: -> { Trycourier::MessageDetails::Status }
-
-      # @!attribute error
-      #   A message describing the error that occurred.
-      #
-      #   @return [String, nil]
-      optional :error, String, nil?: true
-
-      # @!attribute reason
-      #   The reason for the current status of the message.
-      #
-      #   @return [Symbol, Trycourier::Models::MessageDetails::Reason, nil]
-      optional :reason, enum: -> { Trycourier::MessageDetails::Reason }, nil?: true
-
-      # @!method initialize(id:, clicked:, delivered:, enqueued:, event:, notification:, opened:, recipient:, sent:, status:, error: nil, reason: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {Trycourier::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, Trycourier::Models::MessageDetails::Status] The current status of the message.
-      #
-      #   @param error [String, nil] A message describing the error that occurred.
-      #
-      #   @param reason [Symbol, Trycourier::Models::MessageDetails::Reason, nil] The reason for the current status of the message.
-
-      # The current status of the message.
-      #
-      # @see Trycourier::Models::MessageDetails#status
-      module Status
-        extend Trycourier::Internal::Type::Enum
-
-        CANCELED = :CANCELED
-        CLICKED = :CLICKED
-        DELAYED = :DELAYED
-        DELIVERED = :DELIVERED
-        DIGESTED = :DIGESTED
-        ENQUEUED = :ENQUEUED
-        FILTERED = :FILTERED
-        OPENED = :OPENED
-        ROUTED = :ROUTED
-        SENT = :SENT
-        SIMULATED = :SIMULATED
-        THROTTLED = :THROTTLED
-        UNDELIVERABLE = :UNDELIVERABLE
-        UNMAPPED = :UNMAPPED
-        UNROUTABLE = :UNROUTABLE
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # The reason for the current status of the message.
-      #
-      # @see Trycourier::Models::MessageDetails#reason
-      module Reason
-        extend Trycourier::Internal::Type::Enum
-
-        BOUNCED = :BOUNCED
-        FAILED = :FAILED
-        FILTERED = :FILTERED
-        NO_CHANNELS = :NO_CHANNELS
-        NO_PROVIDERS = :NO_PROVIDERS
-        OPT_IN_REQUIRED = :OPT_IN_REQUIRED
-        PROVIDER_ERROR = :PROVIDER_ERROR
-        UNPUBLISHED = :UNPUBLISHED
-        UNSUBSCRIBED = :UNSUBSCRIBED
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

data/lib/trycourier/models/message_history_params.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    # @see Trycourier::Resources::Messages#history
-    class MessageHistoryParams < Trycourier::Internal::Type::BaseModel
-      extend Trycourier::Internal::Type::RequestParameters::Converter
-      include Trycourier::Internal::Type::RequestParameters
-
-      # @!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: {})
-      #   @param type [String, nil] A supported Message History type that will filter the events returned.
-      #
-      #   @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/trycourier/models/message_history_response.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    # @see Trycourier::Resources::Messages#history
-    class MessageHistoryResponse < Trycourier::Internal::Type::BaseModel
-      # @!attribute results
-      #
-      #   @return [Array<Hash{Symbol=>Object}>]
-      required :results,
-               Trycourier::Internal::Type::ArrayOf[Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown]]
-
-      # @!method initialize(results:)
-      #   @param results [Array<Hash{Symbol=>Object}>]
-    end
-  end
-end