orb-billing 1.35.0 → 1.36.0

data/rbi/orb/models/invoice_automation_schedule_step_executed_webhook_event.rbi

@@ -0,0 +1,614 @@
+# typed: strong
+
+module Orb
+  module Models
+    class InvoiceAutomationScheduleStepExecutedWebhookEvent < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent,
+            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
+
+      # The invoice fields a consumer needs to run their own notification flows without
+      # a follow-up API call, mirroring the variables Orb's own automation emails render
+      # against.
+      sig do
+        returns(Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Invoice)
+      end
+      attr_reader :invoice
+
+      sig do
+        params(
+          invoice:
+            Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Invoice::OrHash
+        ).void
+      end
+      attr_writer :invoice
+
+      sig do
+        returns(
+          Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties
+        )
+      end
+      attr_reader :properties
+
+      sig do
+        params(
+          properties:
+            Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::OrHash
+        ).void
+      end
+      attr_writer :properties
+
+      # The event this payload describes.
+      sig do
+        returns(
+          Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Type::TaggedSymbol
+        )
+      end
+      attr_accessor :type
+
+      # Issued when a collections-automation schedule step is executed for an invoice.
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          invoice:
+            Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Invoice::OrHash,
+          properties:
+            Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::OrHash,
+          type:
+            Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::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:,
+        # The invoice fields a consumer needs to run their own notification flows without
+        # a follow-up API call, mirroring the variables Orb's own automation emails render
+        # against.
+        invoice:,
+        properties:,
+        # The event this payload describes.
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            invoice:
+              Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Invoice,
+            properties:
+              Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties,
+            type:
+              Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Invoice < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Invoice,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(String) }
+        attr_accessor :amount_due
+
+        sig { returns(String) }
+        attr_accessor :currency
+
+        sig { returns(String) }
+        attr_accessor :customer_id
+
+        sig { returns(String) }
+        attr_accessor :customer_name
+
+        sig { returns(T.nilable(Date)) }
+        attr_accessor :due_date
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :external_customer_id
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :hosted_invoice_url
+
+        sig { returns(Time) }
+        attr_accessor :invoice_date
+
+        sig { returns(String) }
+        attr_accessor :invoice_number
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :issued_at
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :memo
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :payment_method_last_four_digits
+
+        sig { returns(String) }
+        attr_accessor :status
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :subscription_id
+
+        # The invoice fields a consumer needs to run their own notification flows without
+        # a follow-up API call, mirroring the variables Orb's own automation emails render
+        # against.
+        sig do
+          params(
+            id: String,
+            amount_due: String,
+            currency: String,
+            customer_id: String,
+            customer_name: String,
+            due_date: T.nilable(Date),
+            external_customer_id: T.nilable(String),
+            hosted_invoice_url: T.nilable(String),
+            invoice_date: Time,
+            invoice_number: String,
+            issued_at: T.nilable(Time),
+            memo: T.nilable(String),
+            payment_method_last_four_digits: T.nilable(String),
+            status: String,
+            subscription_id: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          amount_due:,
+          currency:,
+          customer_id:,
+          customer_name:,
+          due_date:,
+          external_customer_id:,
+          hosted_invoice_url:,
+          invoice_date:,
+          invoice_number:,
+          issued_at:,
+          memo:,
+          payment_method_last_four_digits:,
+          status:,
+          subscription_id:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              amount_due: String,
+              currency: String,
+              customer_id: String,
+              customer_name: String,
+              due_date: T.nilable(Date),
+              external_customer_id: T.nilable(String),
+              hosted_invoice_url: T.nilable(String),
+              invoice_date: Time,
+              invoice_number: String,
+              issued_at: T.nilable(Time),
+              memo: T.nilable(String),
+              payment_method_last_four_digits: T.nilable(String),
+              status: String,
+              subscription_id: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class Properties < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T::Array[
+              Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::Variants
+            ]
+          )
+        end
+        attr_accessor :actions
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :automation_schedule_template_id
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :automation_schedule_template_name
+
+        sig { returns(Time) }
+        attr_accessor :executed_at
+
+        sig { returns(String) }
+        attr_accessor :label
+
+        sig { returns(Time) }
+        attr_accessor :scheduled_at
+
+        sig { returns(String) }
+        attr_accessor :step_id
+
+        sig do
+          params(
+            actions:
+              T::Array[
+                T.any(
+                  Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::SendEmail::OrHash,
+                  Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::RetryPayment::OrHash
+                )
+              ],
+            automation_schedule_template_id: T.nilable(String),
+            automation_schedule_template_name: T.nilable(String),
+            executed_at: Time,
+            label: String,
+            scheduled_at: Time,
+            step_id: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          actions:,
+          automation_schedule_template_id:,
+          automation_schedule_template_name:,
+          executed_at:,
+          label:,
+          scheduled_at:,
+          step_id:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              actions:
+                T::Array[
+                  Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::Variants
+                ],
+              automation_schedule_template_id: T.nilable(String),
+              automation_schedule_template_name: T.nilable(String),
+              executed_at: Time,
+              label: String,
+              scheduled_at: Time,
+              step_id: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Action
+          extend Orb::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::SendEmail,
+                Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::RetryPayment
+              )
+            end
+
+          class SendEmail < Orb::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::SendEmail,
+                  Orb::Internal::AnyHash
+                )
+              end
+
+            sig { returns(T.nilable(String)) }
+            attr_accessor :recipient
+
+            sig { returns(T::Boolean) }
+            attr_accessor :sent
+
+            sig do
+              returns(
+                T.nilable(
+                  Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::SendEmail::ActionType::TaggedSymbol
+                )
+              )
+            end
+            attr_reader :action_type
+
+            sig do
+              params(
+                action_type:
+                  Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::SendEmail::ActionType::OrSymbol
+              ).void
+            end
+            attr_writer :action_type
+
+            sig do
+              params(
+                recipient: T.nilable(String),
+                sent: T::Boolean,
+                action_type:
+                  Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::SendEmail::ActionType::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(recipient:, sent:, action_type: nil)
+            end
+
+            sig do
+              override.returns(
+                {
+                  recipient: T.nilable(String),
+                  sent: T::Boolean,
+                  action_type:
+                    Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::SendEmail::ActionType::TaggedSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            module ActionType
+              extend Orb::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::SendEmail::ActionType
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              SEND_EMAIL =
+                T.let(
+                  :send_email,
+                  Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::SendEmail::ActionType::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::SendEmail::ActionType::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+
+          class RetryPayment < Orb::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::RetryPayment,
+                  Orb::Internal::AnyHash
+                )
+              end
+
+            sig { returns(T.nilable(String)) }
+            attr_accessor :amount_attempted
+
+            sig { returns(T.nilable(String)) }
+            attr_accessor :currency
+
+            sig { returns(T.nilable(String)) }
+            attr_accessor :failure_reason
+
+            sig do
+              returns(
+                Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::RetryPayment::Outcome::TaggedSymbol
+              )
+            end
+            attr_accessor :outcome
+
+            sig { returns(T.nilable(String)) }
+            attr_accessor :payment_provider
+
+            sig { returns(T.nilable(String)) }
+            attr_accessor :payment_provider_transaction_id
+
+            sig { returns(T.nilable(String)) }
+            attr_accessor :payment_transaction_record_id
+
+            sig do
+              returns(
+                T.nilable(
+                  Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::RetryPayment::ActionType::TaggedSymbol
+                )
+              )
+            end
+            attr_reader :action_type
+
+            sig do
+              params(
+                action_type:
+                  Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::RetryPayment::ActionType::OrSymbol
+              ).void
+            end
+            attr_writer :action_type
+
+            sig do
+              params(
+                amount_attempted: T.nilable(String),
+                currency: T.nilable(String),
+                failure_reason: T.nilable(String),
+                outcome:
+                  Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::RetryPayment::Outcome::OrSymbol,
+                payment_provider: T.nilable(String),
+                payment_provider_transaction_id: T.nilable(String),
+                payment_transaction_record_id: T.nilable(String),
+                action_type:
+                  Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::RetryPayment::ActionType::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              amount_attempted:,
+              currency:,
+              failure_reason:,
+              outcome:,
+              payment_provider:,
+              payment_provider_transaction_id:,
+              payment_transaction_record_id:,
+              action_type: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  amount_attempted: T.nilable(String),
+                  currency: T.nilable(String),
+                  failure_reason: T.nilable(String),
+                  outcome:
+                    Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::RetryPayment::Outcome::TaggedSymbol,
+                  payment_provider: T.nilable(String),
+                  payment_provider_transaction_id: T.nilable(String),
+                  payment_transaction_record_id: T.nilable(String),
+                  action_type:
+                    Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::RetryPayment::ActionType::TaggedSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            module Outcome
+              extend Orb::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::RetryPayment::Outcome
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              SUCCEEDED =
+                T.let(
+                  :succeeded,
+                  Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::RetryPayment::Outcome::TaggedSymbol
+                )
+              FAILED =
+                T.let(
+                  :failed,
+                  Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::RetryPayment::Outcome::TaggedSymbol
+                )
+              SKIPPED =
+                T.let(
+                  :skipped,
+                  Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::RetryPayment::Outcome::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::RetryPayment::Outcome::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+
+            module ActionType
+              extend Orb::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::RetryPayment::ActionType
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              RETRY_PAYMENT =
+                T.let(
+                  :retry_payment,
+                  Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::RetryPayment::ActionType::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::RetryPayment::ActionType::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties::Action::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+
+      # The event this payload describes.
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Type
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        INVOICE_AUTOMATION_SCHEDULE_STEP_EXECUTED =
+          T.let(
+            :"invoice.automation_schedule_step_executed",
+            Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end