dodopayments 2.27.0 → 2.28.0

data/rbi/dodopayments/models/customers/email_body.rbi

@@ -0,0 +1,88 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Customers
+      class EmailBody < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Customers::EmailBody,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        # Whether the merchant wrote this content. It is true for the recovery and dunning
+        # emails, which the merchant writes.
+        #
+        # The content is email HTML. Render it in a sandbox, whatever this value is.
+        sig { returns(T::Boolean) }
+        attr_accessor :merchant_authored
+
+        # Why the email did not arrive. It is null unless the email failed.
+        sig do
+          returns(
+            T.nilable(Dodopayments::Customers::EmailFailureCode::TaggedSymbol)
+          )
+        end
+        attr_accessor :failure_code
+
+        # A sentence that explains `failure_code`. It is null unless the email failed.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :failure_reason
+
+        # The stored HTML. It is null on a text-only email.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :html
+
+        # The stored plain text.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :text
+
+        sig do
+          params(
+            merchant_authored: T::Boolean,
+            failure_code:
+              T.nilable(Dodopayments::Customers::EmailFailureCode::OrSymbol),
+            failure_reason: T.nilable(String),
+            html: T.nilable(String),
+            text: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Whether the merchant wrote this content. It is true for the recovery and dunning
+          # emails, which the merchant writes.
+          #
+          # The content is email HTML. Render it in a sandbox, whatever this value is.
+          merchant_authored:,
+          # Why the email did not arrive. It is null unless the email failed.
+          failure_code: nil,
+          # A sentence that explains `failure_code`. It is null unless the email failed.
+          failure_reason: nil,
+          # The stored HTML. It is null on a text-only email.
+          html: nil,
+          # The stored plain text.
+          text: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              merchant_authored: T::Boolean,
+              failure_code:
+                T.nilable(
+                  Dodopayments::Customers::EmailFailureCode::TaggedSymbol
+                ),
+              failure_reason: T.nilable(String),
+              html: T.nilable(String),
+              text: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/customers/email_failure_code.rbi

@@ -0,0 +1,70 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Customers
+      # Why an email did not reach the recipient.
+      #
+      # The code is stable. `send_failed` is the catch-all: it covers every failure that
+      # the other codes do not name.
+      module EmailFailureCode
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Dodopayments::Customers::EmailFailureCode)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        MAILBOX_NOT_FOUND =
+          T.let(
+            :mailbox_not_found,
+            Dodopayments::Customers::EmailFailureCode::TaggedSymbol
+          )
+        ADDRESS_REJECTED =
+          T.let(
+            :address_rejected,
+            Dodopayments::Customers::EmailFailureCode::TaggedSymbol
+          )
+        ADDRESS_SUPPRESSED =
+          T.let(
+            :address_suppressed,
+            Dodopayments::Customers::EmailFailureCode::TaggedSymbol
+          )
+        MAILBOX_FULL =
+          T.let(
+            :mailbox_full,
+            Dodopayments::Customers::EmailFailureCode::TaggedSymbol
+          )
+        TEMPORARY_FAILURE =
+          T.let(
+            :temporary_failure,
+            Dodopayments::Customers::EmailFailureCode::TaggedSymbol
+          )
+        MESSAGE_TOO_LARGE =
+          T.let(
+            :message_too_large,
+            Dodopayments::Customers::EmailFailureCode::TaggedSymbol
+          )
+        MARKED_AS_SPAM =
+          T.let(
+            :marked_as_spam,
+            Dodopayments::Customers::EmailFailureCode::TaggedSymbol
+          )
+        SEND_FAILED =
+          T.let(
+            :send_failed,
+            Dodopayments::Customers::EmailFailureCode::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Dodopayments::Customers::EmailFailureCode::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/customers/email_list_params.rbi

@@ -0,0 +1,68 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Customers
+      class EmailListParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Customers::EmailListParams,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :customer_id
+
+        # Which page to return. The default is 0.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_number
+
+        sig { params(page_number: Integer).void }
+        attr_writer :page_number
+
+        # How many emails to return. The default is 10 and the maximum is 100.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_size
+
+        sig { params(page_size: Integer).void }
+        attr_writer :page_size
+
+        sig do
+          params(
+            customer_id: String,
+            page_number: Integer,
+            page_size: Integer,
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          customer_id:,
+          # Which page to return. The default is 0.
+          page_number: nil,
+          # How many emails to return. The default is 10 and the maximum is 100.
+          page_size: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              customer_id: String,
+              page_number: Integer,
+              page_size: Integer,
+              request_options: Dodopayments::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/customers/email_log_item.rbi

@@ -0,0 +1,157 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Customers
+      class EmailLogItem < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Customers::EmailLogItem,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        # The group this email belongs to: payments, refunds, subscriptions,
+        # dunning_recovery, entitlements or auth.
+        sig { returns(String) }
+        attr_accessor :category
+
+        # When this email was sent.
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # Identifies this email. Use it to read the body or to send it again.
+        sig { returns(String) }
+        attr_accessor :email_log_id
+
+        # What kind of email this is, for example `payment_successful`.
+        sig { returns(String) }
+        attr_accessor :email_type
+
+        # Whether this email has content to show. The content endpoint can still refuse,
+        # because the content is removed after 180 days.
+        sig { returns(T::Boolean) }
+        attr_accessor :has_preview
+
+        # What you may do with this email.
+        sig { returns(Dodopayments::Customers::EmailPolicies) }
+        attr_reader :policies
+
+        sig do
+          params(policies: Dodopayments::Customers::EmailPolicies::OrHash).void
+        end
+        attr_writer :policies
+
+        # Where the email got to: sent, delivered, failed, complained or blocked.
+        sig { returns(Dodopayments::Customers::EmailLogStatus::TaggedSymbol) }
+        attr_accessor :status
+
+        # Why the email did not arrive. It is null unless the email failed.
+        sig do
+          returns(
+            T.nilable(Dodopayments::Customers::EmailFailureCode::TaggedSymbol)
+          )
+        end
+        attr_accessor :failure_code
+
+        # A sentence that explains `failure_code`. It is null unless the email failed.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :failure_reason
+
+        # The address the email was sent from.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :from
+
+        # What the merchant typed, when test mode redirected the send to the business
+        # owner.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :intended_recipient
+
+        # The address the email reached.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :recipient
+
+        # The subject line as it was sent. Empty until the provider replicates.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :subject
+
+        sig do
+          params(
+            category: String,
+            created_at: Time,
+            email_log_id: String,
+            email_type: String,
+            has_preview: T::Boolean,
+            policies: Dodopayments::Customers::EmailPolicies::OrHash,
+            status: Dodopayments::Customers::EmailLogStatus::OrSymbol,
+            failure_code:
+              T.nilable(Dodopayments::Customers::EmailFailureCode::OrSymbol),
+            failure_reason: T.nilable(String),
+            from: T.nilable(String),
+            intended_recipient: T.nilable(String),
+            recipient: T.nilable(String),
+            subject: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The group this email belongs to: payments, refunds, subscriptions,
+          # dunning_recovery, entitlements or auth.
+          category:,
+          # When this email was sent.
+          created_at:,
+          # Identifies this email. Use it to read the body or to send it again.
+          email_log_id:,
+          # What kind of email this is, for example `payment_successful`.
+          email_type:,
+          # Whether this email has content to show. The content endpoint can still refuse,
+          # because the content is removed after 180 days.
+          has_preview:,
+          # What you may do with this email.
+          policies:,
+          # Where the email got to: sent, delivered, failed, complained or blocked.
+          status:,
+          # Why the email did not arrive. It is null unless the email failed.
+          failure_code: nil,
+          # A sentence that explains `failure_code`. It is null unless the email failed.
+          failure_reason: nil,
+          # The address the email was sent from.
+          from: nil,
+          # What the merchant typed, when test mode redirected the send to the business
+          # owner.
+          intended_recipient: nil,
+          # The address the email reached.
+          recipient: nil,
+          # The subject line as it was sent. Empty until the provider replicates.
+          subject: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              category: String,
+              created_at: Time,
+              email_log_id: String,
+              email_type: String,
+              has_preview: T::Boolean,
+              policies: Dodopayments::Customers::EmailPolicies,
+              status: Dodopayments::Customers::EmailLogStatus::TaggedSymbol,
+              failure_code:
+                T.nilable(
+                  Dodopayments::Customers::EmailFailureCode::TaggedSymbol
+                ),
+              failure_reason: T.nilable(String),
+              from: T.nilable(String),
+              intended_recipient: T.nilable(String),
+              recipient: T.nilable(String),
+              subject: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/customers/email_log_status.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Customers
+      # The delivery status of one email.
+      #
+      # `sent` also covers an email that is still on its way. A status only becomes
+      # `delivered`, `failed` or `complained` when the mail server answers.
+      module EmailLogStatus
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Dodopayments::Customers::EmailLogStatus)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        SENT =
+          T.let(:sent, Dodopayments::Customers::EmailLogStatus::TaggedSymbol)
+        DELIVERED =
+          T.let(
+            :delivered,
+            Dodopayments::Customers::EmailLogStatus::TaggedSymbol
+          )
+        FAILED =
+          T.let(:failed, Dodopayments::Customers::EmailLogStatus::TaggedSymbol)
+        COMPLAINED =
+          T.let(
+            :complained,
+            Dodopayments::Customers::EmailLogStatus::TaggedSymbol
+          )
+        BLOCKED =
+          T.let(:blocked, Dodopayments::Customers::EmailLogStatus::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Dodopayments::Customers::EmailLogStatus::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/customers/email_policies.rbi

@@ -0,0 +1,68 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Customers
+      class EmailPolicies < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Customers::EmailPolicies,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        # A permanent failure was recorded, so the same address would be a no-op.
+        sig { returns(T::Boolean) }
+        attr_accessor :requires_different_address
+
+        # The row was delivered and may be sent again.
+        sig { returns(T::Boolean) }
+        attr_accessor :resend_allowed
+
+        # How many sends are left in this email's chain.
+        sig { returns(Integer) }
+        attr_accessor :resends_remaining
+
+        # The row failed and may be sent again.
+        sig { returns(T::Boolean) }
+        attr_accessor :retry_allowed
+
+        # What the merchant may do with one row. The server decides; the client never
+        # derives eligibility itself.
+        sig do
+          params(
+            requires_different_address: T::Boolean,
+            resend_allowed: T::Boolean,
+            resends_remaining: Integer,
+            retry_allowed: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # A permanent failure was recorded, so the same address would be a no-op.
+          requires_different_address:,
+          # The row was delivered and may be sent again.
+          resend_allowed:,
+          # How many sends are left in this email's chain.
+          resends_remaining:,
+          # The row failed and may be sent again.
+          retry_allowed:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              requires_different_address: T::Boolean,
+              resend_allowed: T::Boolean,
+              resends_remaining: Integer,
+              retry_allowed: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/customers/email_retrieve_body_params.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Customers
+      class EmailRetrieveBodyParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Customers::EmailRetrieveBodyParams,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :customer_id
+
+        sig { returns(String) }
+        attr_accessor :email_log_id
+
+        sig do
+          params(
+            customer_id: String,
+            email_log_id: String,
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(customer_id:, email_log_id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            {
+              customer_id: String,
+              email_log_id: String,
+              request_options: Dodopayments::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end