dodopayments 2.26.0 → 2.28.0

data/rbi/dodopayments/models/blocklist/blocked_customer.rbi

@@ -0,0 +1,161 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Blocklist
+      class BlockedCustomer < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Blocklist::BlockedCustomer,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        sig { returns(String) }
+        attr_accessor :customer_email
+
+        sig { returns(String) }
+        attr_accessor :customer_id
+
+        sig { returns(String) }
+        attr_accessor :customer_name
+
+        # Customer id or email that the merchant supplied.
+        sig { returns(String) }
+        attr_accessor :identifier
+
+        # Where a block came from. `Api` marks an API-key caller, which carries no
+        # dashboard actor. The other values name the screen the merchant used.
+        sig do
+          returns(Dodopayments::Blocklist::BlockedCustomerSource::TaggedSymbol)
+        end
+        attr_accessor :source
+
+        # Dashboard user who blocked the customer. `null` for an API-key caller.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :blocked_by_email
+
+        # Subscriptions this block cancelled. Present on the create response only.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :cancelled_subscription_ids
+
+        # Activity log. Present on the detail response only.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[Dodopayments::Blocklist::Customers::BlockedCustomerNote]
+            )
+          )
+        end
+        attr_accessor :notes
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :reason
+
+        # Subscriptions this block left live, because the cancel failed or the inline
+        # batch filled up. Repeat the create call to continue; the block itself is already
+        # in force.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :remaining_subscription_ids
+
+        # False when the block left live subscriptions behind, including the case where
+        # the sweep could not list them and `remaining_subscription_ids` is therefore
+        # unknown. Repeat the create call until it reads true.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :subscriptions_swept
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :unblocked_at
+
+        sig do
+          params(
+            id: String,
+            created_at: Time,
+            customer_email: String,
+            customer_id: String,
+            customer_name: String,
+            identifier: String,
+            source: Dodopayments::Blocklist::BlockedCustomerSource::OrSymbol,
+            blocked_by_email: T.nilable(String),
+            cancelled_subscription_ids: T.nilable(T::Array[String]),
+            notes:
+              T.nilable(
+                T::Array[
+                  Dodopayments::Blocklist::Customers::BlockedCustomerNote::OrHash
+                ]
+              ),
+            reason: T.nilable(String),
+            remaining_subscription_ids: T.nilable(T::Array[String]),
+            subscriptions_swept: T.nilable(T::Boolean),
+            unblocked_at: T.nilable(Time)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          created_at:,
+          customer_email:,
+          customer_id:,
+          customer_name:,
+          # Customer id or email that the merchant supplied.
+          identifier:,
+          # Where a block came from. `Api` marks an API-key caller, which carries no
+          # dashboard actor. The other values name the screen the merchant used.
+          source:,
+          # Dashboard user who blocked the customer. `null` for an API-key caller.
+          blocked_by_email: nil,
+          # Subscriptions this block cancelled. Present on the create response only.
+          cancelled_subscription_ids: nil,
+          # Activity log. Present on the detail response only.
+          notes: nil,
+          reason: nil,
+          # Subscriptions this block left live, because the cancel failed or the inline
+          # batch filled up. Repeat the create call to continue; the block itself is already
+          # in force.
+          remaining_subscription_ids: nil,
+          # False when the block left live subscriptions behind, including the case where
+          # the sweep could not list them and `remaining_subscription_ids` is therefore
+          # unknown. Repeat the create call until it reads true.
+          subscriptions_swept: nil,
+          unblocked_at: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Time,
+              customer_email: String,
+              customer_id: String,
+              customer_name: String,
+              identifier: String,
+              source:
+                Dodopayments::Blocklist::BlockedCustomerSource::TaggedSymbol,
+              blocked_by_email: T.nilable(String),
+              cancelled_subscription_ids: T.nilable(T::Array[String]),
+              notes:
+                T.nilable(
+                  T::Array[
+                    Dodopayments::Blocklist::Customers::BlockedCustomerNote
+                  ]
+                ),
+              reason: T.nilable(String),
+              remaining_subscription_ids: T.nilable(T::Array[String]),
+              subscriptions_swept: T.nilable(T::Boolean),
+              unblocked_at: T.nilable(Time)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/blocklist/blocked_customer_source.rbi

@@ -0,0 +1,55 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Blocklist
+      # Where a block came from. `Api` marks an API-key caller, which carries no
+      # dashboard actor. The other values name the screen the merchant used.
+      module BlockedCustomerSource
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Dodopayments::Blocklist::BlockedCustomerSource)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        BLOCKLIST_PAGE =
+          T.let(
+            :blocklist_page,
+            Dodopayments::Blocklist::BlockedCustomerSource::TaggedSymbol
+          )
+        CUSTOMER_PAGE =
+          T.let(
+            :customer_page,
+            Dodopayments::Blocklist::BlockedCustomerSource::TaggedSymbol
+          )
+        PAYMENT_PAGE =
+          T.let(
+            :payment_page,
+            Dodopayments::Blocklist::BlockedCustomerSource::TaggedSymbol
+          )
+        DISPUTE_PAGE =
+          T.let(
+            :dispute_page,
+            Dodopayments::Blocklist::BlockedCustomerSource::TaggedSymbol
+          )
+        API =
+          T.let(
+            :api,
+            Dodopayments::Blocklist::BlockedCustomerSource::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Dodopayments::Blocklist::BlockedCustomerSource::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/blocklist/create_blocked_customer_request.rbi

@@ -0,0 +1,143 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Blocklist
+      module CreateBlockedCustomerRequest
+        extend Dodopayments::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              Dodopayments::Blocklist::CreateBlockedCustomerRequest::BlocklistCustomersBlockByCustomerID,
+              Dodopayments::Blocklist::CreateBlockedCustomerRequest::BlocklistCustomersBlockByEmail
+            )
+          end
+
+        class BlocklistCustomersBlockByCustomerID < Dodopayments::Models::Blocklist::BlockByCustomerID
+          OrHash =
+            T.type_alias do
+              T.any(
+                Dodopayments::Blocklist::CreateBlockedCustomerRequest::BlocklistCustomersBlockByCustomerID,
+                Dodopayments::Internal::AnyHash
+              )
+            end
+
+          # Why the merchant blocked this customer. The entry page shows it.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :reason
+
+          # Screen the merchant blocked from. Ignored for an API-key caller, whose entry
+          # always records `api`. A dashboard caller that omits it records `blocklist_page`.
+          sig do
+            returns(
+              T.nilable(
+                Dodopayments::Blocklist::BlockedCustomerSource::OrSymbol
+              )
+            )
+          end
+          attr_accessor :source
+
+          sig do
+            params(
+              reason: T.nilable(String),
+              source:
+                T.nilable(
+                  Dodopayments::Blocklist::BlockedCustomerSource::OrSymbol
+                )
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Why the merchant blocked this customer. The entry page shows it.
+            reason: nil,
+            # Screen the merchant blocked from. Ignored for an API-key caller, whose entry
+            # always records `api`. A dashboard caller that omits it records `blocklist_page`.
+            source: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                reason: T.nilable(String),
+                source:
+                  T.nilable(
+                    Dodopayments::Blocklist::BlockedCustomerSource::OrSymbol
+                  )
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        class BlocklistCustomersBlockByEmail < Dodopayments::Models::Blocklist::BlockByEmail
+          OrHash =
+            T.type_alias do
+              T.any(
+                Dodopayments::Blocklist::CreateBlockedCustomerRequest::BlocklistCustomersBlockByEmail,
+                Dodopayments::Internal::AnyHash
+              )
+            end
+
+          # Why the merchant blocked this customer. The entry page shows it.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :reason
+
+          # Screen the merchant blocked from. Ignored for an API-key caller, whose entry
+          # always records `api`. A dashboard caller that omits it records `blocklist_page`.
+          sig do
+            returns(
+              T.nilable(
+                Dodopayments::Blocklist::BlockedCustomerSource::OrSymbol
+              )
+            )
+          end
+          attr_accessor :source
+
+          sig do
+            params(
+              reason: T.nilable(String),
+              source:
+                T.nilable(
+                  Dodopayments::Blocklist::BlockedCustomerSource::OrSymbol
+                )
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Why the merchant blocked this customer. The entry page shows it.
+            reason: nil,
+            # Screen the merchant blocked from. Ignored for an API-key caller, whose entry
+            # always records `api`. A dashboard caller that omits it records `blocklist_page`.
+            source: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                reason: T.nilable(String),
+                source:
+                  T.nilable(
+                    Dodopayments::Blocklist::BlockedCustomerSource::OrSymbol
+                  )
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        sig do
+          override.returns(
+            T::Array[
+              Dodopayments::Blocklist::CreateBlockedCustomerRequest::Variants
+            ]
+          )
+        end
+        def self.variants
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/blocklist/customer_create_params.rbi

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

data/rbi/dodopayments/models/blocklist/customer_delete_params.rbi

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

data/rbi/dodopayments/models/blocklist/customer_list_params.rbi

@@ -0,0 +1,88 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Blocklist
+      class CustomerListParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Blocklist::CustomerListParams,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        # Filter by the dashboard user who blocked the customer.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :blocked_by_email
+
+        # Blocked on or after this time.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :created_at_gte
+
+        # Blocked on or before this time.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :created_at_lte
+
+        # Partial, case-insensitive match on the email and on the customer id.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :identifier
+
+        # Page number. Default 0.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :page_number
+
+        # Page size. Default 10, maximum 100.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :page_size
+
+        sig do
+          params(
+            blocked_by_email: T.nilable(String),
+            created_at_gte: T.nilable(Time),
+            created_at_lte: T.nilable(Time),
+            identifier: T.nilable(String),
+            page_number: T.nilable(Integer),
+            page_size: T.nilable(Integer),
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Filter by the dashboard user who blocked the customer.
+          blocked_by_email: nil,
+          # Blocked on or after this time.
+          created_at_gte: nil,
+          # Blocked on or before this time.
+          created_at_lte: nil,
+          # Partial, case-insensitive match on the email and on the customer id.
+          identifier: nil,
+          # Page number. Default 0.
+          page_number: nil,
+          # Page size. Default 10, maximum 100.
+          page_size: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              blocked_by_email: T.nilable(String),
+              created_at_gte: T.nilable(Time),
+              created_at_lte: T.nilable(Time),
+              identifier: T.nilable(String),
+              page_number: T.nilable(Integer),
+              page_size: T.nilable(Integer),
+              request_options: Dodopayments::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/blocklist/customer_retrieve_params.rbi

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

data/rbi/dodopayments/models/blocklist/customers/blocked_customer_note.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Blocklist
+      module Customers
+        class BlockedCustomerNote < Dodopayments::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Dodopayments::Blocklist::Customers::BlockedCustomerNote,
+                Dodopayments::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { returns(Time) }
+          attr_accessor :created_at
+
+          sig { returns(String) }
+          attr_accessor :note
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :author_email
+
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :updated_at
+
+          sig do
+            params(
+              id: String,
+              created_at: Time,
+              note: String,
+              author_email: T.nilable(String),
+              updated_at: T.nilable(Time)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            id:,
+            created_at:,
+            note:,
+            author_email: nil,
+            updated_at: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                created_at: Time,
+                note: String,
+                author_email: T.nilable(String),
+                updated_at: T.nilable(Time)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/blocklist/customers/note_create_params.rbi

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

data/rbi/dodopayments/models/blocklist/customers/note_request.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Blocklist
+      module Customers
+        class NoteRequest < Dodopayments::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Dodopayments::Blocklist::Customers::NoteRequest,
+                Dodopayments::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :note
+
+          sig { params(note: String).returns(T.attached_class) }
+          def self.new(note:)
+          end
+
+          sig { override.returns({ note: String }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end