orb-billing 1.35.0 → 1.36.0

data/rbi/orb/models/invoice_dunning_schedule_created_webhook_event.rbi

@@ -0,0 +1,331 @@
+# typed: strong
+
+module Orb
+  module Models
+    class InvoiceDunningScheduleCreatedWebhookEvent < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Orb::InvoiceDunningScheduleCreatedWebhookEvent,
+            Orb::Internal::AnyHash
+          )
+        end
+
+      # The ID of this webhook event.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The time at which this event was created, to the second.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity,
+      # representing the request for payment for a single subscription. This includes a
+      # set of line items, which correspond to prices in the subscription's plan and can
+      # represent fixed recurring fees or usage-based fees. They are generated at the
+      # end of a billing period, or as the result of an action, such as a cancellation.
+      sig { returns(Orb::Invoice) }
+      attr_reader :invoice
+
+      sig { params(invoice: Orb::Invoice::OrHash).void }
+      attr_writer :invoice
+
+      sig do
+        returns(Orb::InvoiceDunningScheduleCreatedWebhookEvent::Properties)
+      end
+      attr_reader :properties
+
+      sig do
+        params(
+          properties:
+            Orb::InvoiceDunningScheduleCreatedWebhookEvent::Properties::OrHash
+        ).void
+      end
+      attr_writer :properties
+
+      # The event this payload describes.
+      sig do
+        returns(
+          Orb::InvoiceDunningScheduleCreatedWebhookEvent::Type::TaggedSymbol
+        )
+      end
+      attr_accessor :type
+
+      # Issued when a dunning schedule is created for an invoice.
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          invoice: Orb::Invoice::OrHash,
+          properties:
+            Orb::InvoiceDunningScheduleCreatedWebhookEvent::Properties::OrHash,
+          type: Orb::InvoiceDunningScheduleCreatedWebhookEvent::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of this webhook event.
+        id:,
+        # The time at which this event was created, to the second.
+        created_at:,
+        # An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity,
+        # representing the request for payment for a single subscription. This includes a
+        # set of line items, which correspond to prices in the subscription's plan and can
+        # represent fixed recurring fees or usage-based fees. They are generated at the
+        # end of a billing period, or as the result of an action, such as a cancellation.
+        invoice:,
+        properties:,
+        # The event this payload describes.
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            invoice: Orb::Invoice,
+            properties:
+              Orb::InvoiceDunningScheduleCreatedWebhookEvent::Properties,
+            type:
+              Orb::InvoiceDunningScheduleCreatedWebhookEvent::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Properties < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::InvoiceDunningScheduleCreatedWebhookEvent::Properties,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            Orb::InvoiceDunningScheduleCreatedWebhookEvent::Properties::DunningSchedule
+          )
+        end
+        attr_reader :dunning_schedule
+
+        sig do
+          params(
+            dunning_schedule:
+              Orb::InvoiceDunningScheduleCreatedWebhookEvent::Properties::DunningSchedule::OrHash
+          ).void
+        end
+        attr_writer :dunning_schedule
+
+        sig do
+          returns(
+            T::Array[
+              Orb::InvoiceDunningScheduleCreatedWebhookEvent::Properties::DunningStep
+            ]
+          )
+        end
+        attr_accessor :dunning_steps
+
+        sig { returns(String) }
+        attr_accessor :source
+
+        sig do
+          params(
+            dunning_schedule:
+              Orb::InvoiceDunningScheduleCreatedWebhookEvent::Properties::DunningSchedule::OrHash,
+            dunning_steps:
+              T::Array[
+                Orb::InvoiceDunningScheduleCreatedWebhookEvent::Properties::DunningStep::OrHash
+              ],
+            source: String
+          ).returns(T.attached_class)
+        end
+        def self.new(dunning_schedule:, dunning_steps:, source:)
+        end
+
+        sig do
+          override.returns(
+            {
+              dunning_schedule:
+                Orb::InvoiceDunningScheduleCreatedWebhookEvent::Properties::DunningSchedule,
+              dunning_steps:
+                T::Array[
+                  Orb::InvoiceDunningScheduleCreatedWebhookEvent::Properties::DunningStep
+                ],
+              source: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class DunningSchedule < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::InvoiceDunningScheduleCreatedWebhookEvent::Properties::DunningSchedule,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :completion_time
+
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :created_at
+
+          sig { returns(String) }
+          attr_accessor :invoice_id
+
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :modified_at
+
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :start_time
+
+          sig { returns(String) }
+          attr_accessor :status
+
+          sig do
+            params(
+              completion_time: T.nilable(Time),
+              created_at: T.nilable(Time),
+              invoice_id: String,
+              modified_at: T.nilable(Time),
+              start_time: T.nilable(Time),
+              status: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            completion_time:,
+            created_at:,
+            invoice_id:,
+            modified_at:,
+            start_time:,
+            status:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                completion_time: T.nilable(Time),
+                created_at: T.nilable(Time),
+                invoice_id: String,
+                modified_at: T.nilable(Time),
+                start_time: T.nilable(Time),
+                status: String
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        class DunningStep < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::InvoiceDunningScheduleCreatedWebhookEvent::Properties::DunningStep,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T::Array[String]) }
+          attr_accessor :actions
+
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :created_at
+
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :execution_time
+
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :manually_triggered_at
+
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :modified_at
+
+          sig { returns(String) }
+          attr_accessor :status
+
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :step_number
+
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :timestamp
+
+          sig do
+            params(
+              actions: T::Array[String],
+              created_at: T.nilable(Time),
+              execution_time: T.nilable(Time),
+              manually_triggered_at: T.nilable(Time),
+              modified_at: T.nilable(Time),
+              status: String,
+              step_number: T.nilable(Integer),
+              timestamp: T.nilable(Time)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            actions:,
+            created_at:,
+            execution_time:,
+            manually_triggered_at:,
+            modified_at:,
+            status:,
+            step_number:,
+            timestamp:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                actions: T::Array[String],
+                created_at: T.nilable(Time),
+                execution_time: T.nilable(Time),
+                manually_triggered_at: T.nilable(Time),
+                modified_at: T.nilable(Time),
+                status: String,
+                step_number: T.nilable(Integer),
+                timestamp: T.nilable(Time)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+
+      # The event this payload describes.
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Orb::InvoiceDunningScheduleCreatedWebhookEvent::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        INVOICE_DUNNING_SCHEDULE_CREATED =
+          T.let(
+            :"invoice.dunning_schedule_created",
+            Orb::InvoiceDunningScheduleCreatedWebhookEvent::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Orb::InvoiceDunningScheduleCreatedWebhookEvent::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/orb/models/invoice_dunning_schedule_ended_webhook_event.rbi

@@ -0,0 +1,324 @@
+# typed: strong
+
+module Orb
+  module Models
+    class InvoiceDunningScheduleEndedWebhookEvent < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Orb::InvoiceDunningScheduleEndedWebhookEvent,
+            Orb::Internal::AnyHash
+          )
+        end
+
+      # The ID of this webhook event.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The time at which this event was created, to the second.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity,
+      # representing the request for payment for a single subscription. This includes a
+      # set of line items, which correspond to prices in the subscription's plan and can
+      # represent fixed recurring fees or usage-based fees. They are generated at the
+      # end of a billing period, or as the result of an action, such as a cancellation.
+      sig { returns(Orb::Invoice) }
+      attr_reader :invoice
+
+      sig { params(invoice: Orb::Invoice::OrHash).void }
+      attr_writer :invoice
+
+      sig { returns(Orb::InvoiceDunningScheduleEndedWebhookEvent::Properties) }
+      attr_reader :properties
+
+      sig do
+        params(
+          properties:
+            Orb::InvoiceDunningScheduleEndedWebhookEvent::Properties::OrHash
+        ).void
+      end
+      attr_writer :properties
+
+      # The event this payload describes.
+      sig do
+        returns(
+          Orb::InvoiceDunningScheduleEndedWebhookEvent::Type::TaggedSymbol
+        )
+      end
+      attr_accessor :type
+
+      # Issued when a dunning schedule ends.
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          invoice: Orb::Invoice::OrHash,
+          properties:
+            Orb::InvoiceDunningScheduleEndedWebhookEvent::Properties::OrHash,
+          type: Orb::InvoiceDunningScheduleEndedWebhookEvent::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of this webhook event.
+        id:,
+        # The time at which this event was created, to the second.
+        created_at:,
+        # An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity,
+        # representing the request for payment for a single subscription. This includes a
+        # set of line items, which correspond to prices in the subscription's plan and can
+        # represent fixed recurring fees or usage-based fees. They are generated at the
+        # end of a billing period, or as the result of an action, such as a cancellation.
+        invoice:,
+        properties:,
+        # The event this payload describes.
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            invoice: Orb::Invoice,
+            properties:
+              Orb::InvoiceDunningScheduleEndedWebhookEvent::Properties,
+            type:
+              Orb::InvoiceDunningScheduleEndedWebhookEvent::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Properties < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::InvoiceDunningScheduleEndedWebhookEvent::Properties,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            Orb::InvoiceDunningScheduleEndedWebhookEvent::Properties::DunningSchedule
+          )
+        end
+        attr_reader :dunning_schedule
+
+        sig do
+          params(
+            dunning_schedule:
+              Orb::InvoiceDunningScheduleEndedWebhookEvent::Properties::DunningSchedule::OrHash
+          ).void
+        end
+        attr_writer :dunning_schedule
+
+        sig do
+          returns(
+            T::Array[
+              Orb::InvoiceDunningScheduleEndedWebhookEvent::Properties::DunningStep
+            ]
+          )
+        end
+        attr_accessor :dunning_steps
+
+        sig do
+          params(
+            dunning_schedule:
+              Orb::InvoiceDunningScheduleEndedWebhookEvent::Properties::DunningSchedule::OrHash,
+            dunning_steps:
+              T::Array[
+                Orb::InvoiceDunningScheduleEndedWebhookEvent::Properties::DunningStep::OrHash
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(dunning_schedule:, dunning_steps:)
+        end
+
+        sig do
+          override.returns(
+            {
+              dunning_schedule:
+                Orb::InvoiceDunningScheduleEndedWebhookEvent::Properties::DunningSchedule,
+              dunning_steps:
+                T::Array[
+                  Orb::InvoiceDunningScheduleEndedWebhookEvent::Properties::DunningStep
+                ]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class DunningSchedule < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::InvoiceDunningScheduleEndedWebhookEvent::Properties::DunningSchedule,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :completion_time
+
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :created_at
+
+          sig { returns(String) }
+          attr_accessor :invoice_id
+
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :modified_at
+
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :start_time
+
+          sig { returns(String) }
+          attr_accessor :status
+
+          sig do
+            params(
+              completion_time: T.nilable(Time),
+              created_at: T.nilable(Time),
+              invoice_id: String,
+              modified_at: T.nilable(Time),
+              start_time: T.nilable(Time),
+              status: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            completion_time:,
+            created_at:,
+            invoice_id:,
+            modified_at:,
+            start_time:,
+            status:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                completion_time: T.nilable(Time),
+                created_at: T.nilable(Time),
+                invoice_id: String,
+                modified_at: T.nilable(Time),
+                start_time: T.nilable(Time),
+                status: String
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        class DunningStep < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::InvoiceDunningScheduleEndedWebhookEvent::Properties::DunningStep,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T::Array[String]) }
+          attr_accessor :actions
+
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :created_at
+
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :execution_time
+
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :manually_triggered_at
+
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :modified_at
+
+          sig { returns(String) }
+          attr_accessor :status
+
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :step_number
+
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :timestamp
+
+          sig do
+            params(
+              actions: T::Array[String],
+              created_at: T.nilable(Time),
+              execution_time: T.nilable(Time),
+              manually_triggered_at: T.nilable(Time),
+              modified_at: T.nilable(Time),
+              status: String,
+              step_number: T.nilable(Integer),
+              timestamp: T.nilable(Time)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            actions:,
+            created_at:,
+            execution_time:,
+            manually_triggered_at:,
+            modified_at:,
+            status:,
+            step_number:,
+            timestamp:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                actions: T::Array[String],
+                created_at: T.nilable(Time),
+                execution_time: T.nilable(Time),
+                manually_triggered_at: T.nilable(Time),
+                modified_at: T.nilable(Time),
+                status: String,
+                step_number: T.nilable(Integer),
+                timestamp: T.nilable(Time)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+
+      # The event this payload describes.
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Orb::InvoiceDunningScheduleEndedWebhookEvent::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        INVOICE_DUNNING_SCHEDULE_ENDED =
+          T.let(
+            :"invoice.dunning_schedule_ended",
+            Orb::InvoiceDunningScheduleEndedWebhookEvent::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Orb::InvoiceDunningScheduleEndedWebhookEvent::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end