trycourier 3.1.4 → 3.4.0.pre.alpha1

data/lib/trycourier/models/message_content_response.rb

@@ -0,0 +1,119 @@
+# 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

@@ -0,0 +1,16 @@
+# 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

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    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

@@ -0,0 +1,22 @@
+# 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

@@ -0,0 +1,17 @@
+# 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

data/lib/trycourier/models/message_list_params.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    # @see Trycourier::Resources::Messages#list
+    class MessageListParams < Trycourier::Internal::Type::BaseModel
+      extend Trycourier::Internal::Type::RequestParameters::Converter
+      include Trycourier::Internal::Type::RequestParameters
+
+      # @!attribute archived
+      #   A boolean value that indicates whether archived messages should be included in
+      #   the response.
+      #
+      #   @return [Boolean, nil]
+      optional :archived, Trycourier::Internal::Type::Boolean, nil?: true
+
+      # @!attribute cursor
+      #   A unique identifier that allows for fetching the next set of messages.
+      #
+      #   @return [String, nil]
+      optional :cursor, String, nil?: true
+
+      # @!attribute enqueued_after
+      #   The enqueued datetime of a message to filter out messages received before.
+      #
+      #   @return [String, nil]
+      optional :enqueued_after, String, nil?: true
+
+      # @!attribute event
+      #   A unique identifier representing the event that was used to send the event.
+      #
+      #   @return [String, nil]
+      optional :event, String, nil?: true
+
+      # @!attribute list
+      #   A unique identifier representing the list the message was sent to.
+      #
+      #   @return [String, nil]
+      optional :list, String, nil?: true
+
+      # @!attribute message_id
+      #   A unique identifier representing the message_id returned from either /send or
+      #   /send/list.
+      #
+      #   @return [String, nil]
+      optional :message_id, String, nil?: true
+
+      # @!attribute notification
+      #   A unique identifier representing the notification that was used to send the
+      #   event.
+      #
+      #   @return [String, nil]
+      optional :notification, String, nil?: true
+
+      # @!attribute provider
+      #   The key assocated to the provider you want to filter on. E.g., sendgrid, inbox,
+      #   twilio, slack, msteams, etc. Allows multiple values to be set in query
+      #   parameters.
+      #
+      #   @return [Array<String, nil>, nil]
+      optional :provider, Trycourier::Internal::Type::ArrayOf[String, nil?: true]
+
+      # @!attribute recipient
+      #   A unique identifier representing the recipient associated with the requested
+      #   profile.
+      #
+      #   @return [String, nil]
+      optional :recipient, String, nil?: true
+
+      # @!attribute status
+      #   An indicator of the current status of the message. Allows multiple values to be
+      #   set in query parameters.
+      #
+      #   @return [Array<String, nil>, nil]
+      optional :status, Trycourier::Internal::Type::ArrayOf[String, nil?: true]
+
+      # @!attribute tag
+      #   A tag placed in the metadata.tags during a notification send. Allows multiple
+      #   values to be set in query parameters.
+      #
+      #   @return [Array<String, nil>, nil]
+      optional :tag, Trycourier::Internal::Type::ArrayOf[String, nil?: true]
+
+      # @!attribute tags
+      #   A comma delimited list of 'tags'. Messages will be returned if they match any of
+      #   the tags passed in.
+      #
+      #   @return [String, nil]
+      optional :tags, String, nil?: true
+
+      # @!attribute tenant_id
+      #   Messages sent with the context of a Tenant
+      #
+      #   @return [String, nil]
+      optional :tenant_id, String, nil?: true
+
+      # @!attribute trace_id
+      #   The unique identifier used to trace the requests
+      #
+      #   @return [String, nil]
+      optional :trace_id, String, nil?: true
+
+      # @!method initialize(archived: nil, cursor: nil, enqueued_after: nil, event: nil, list: nil, message_id: nil, notification: nil, provider: nil, recipient: nil, status: nil, tag: nil, tags: nil, tenant_id: nil, trace_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Trycourier::Models::MessageListParams} for more details.
+      #
+      #   @param archived [Boolean, nil] A boolean value that indicates whether archived messages should be included in t
+      #
+      #   @param cursor [String, nil] A unique identifier that allows for fetching the next set of messages.
+      #
+      #   @param enqueued_after [String, nil] The enqueued datetime of a message to filter out messages received before.
+      #
+      #   @param event [String, nil] A unique identifier representing the event that was used to send the event.
+      #
+      #   @param list [String, nil] A unique identifier representing the list the message was sent to.
+      #
+      #   @param message_id [String, nil] A unique identifier representing the message_id returned from either /send or /s
+      #
+      #   @param notification [String, nil] A unique identifier representing the notification that was used to send the even
+      #
+      #   @param provider [Array<String, nil>] The key assocated to the provider you want to filter on. E.g., sendgrid, inbox,
+      #
+      #   @param recipient [String, nil] A unique identifier representing the recipient associated with the requested pro
+      #
+      #   @param status [Array<String, nil>] An indicator of the current status of the message. Allows multiple values to be
+      #
+      #   @param tag [Array<String, nil>] A tag placed in the metadata.tags during a notification send. Allows multiple va
+      #
+      #   @param tags [String, nil] A comma delimited list of 'tags'. Messages will be returned if they match any of
+      #
+      #   @param tenant_id [String, nil] Messages sent with the context of a Tenant
+      #
+      #   @param trace_id [String, nil] The unique identifier used to trace the requests
+      #
+      #   @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/trycourier/models/message_list_response.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    # @see Trycourier::Resources::Messages#list
+    class MessageListResponse < Trycourier::Internal::Type::BaseModel
+      # @!attribute paging
+      #   Paging information for the result set.
+      #
+      #   @return [Trycourier::Models::Paging]
+      required :paging, -> { Trycourier::Paging }
+
+      # @!attribute results
+      #   An array of messages with their details.
+      #
+      #   @return [Array<Trycourier::Models::MessageDetails>]
+      required :results, -> { Trycourier::Internal::Type::ArrayOf[Trycourier::MessageDetails] }
+
+      # @!method initialize(paging:, results:)
+      #   @param paging [Trycourier::Models::Paging] Paging information for the result set.
+      #
+      #   @param results [Array<Trycourier::Models::MessageDetails>] An array of messages with their details.
+    end
+  end
+end

data/lib/trycourier/models/message_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    # @see Trycourier::Resources::Messages#retrieve
+    class MessageRetrieveParams < 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_retrieve_response.rb

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

data/lib/trycourier/models/message_routing.rb

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

data/lib/trycourier/models/message_routing_channel.rb

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