orb-billing 1.35.0 → 1.37.0

data/rbi/orb/models/invoice_payment_processing_webhook_event.rbi

@@ -0,0 +1,156 @@
+# typed: strong
+
+module Orb
+  module Models
+    class InvoicePaymentProcessingWebhookEvent < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Orb::InvoicePaymentProcessingWebhookEvent,
+            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::InvoicePaymentProcessingWebhookEvent::Properties) }
+      attr_reader :properties
+
+      sig do
+        params(
+          properties:
+            Orb::InvoicePaymentProcessingWebhookEvent::Properties::OrHash
+        ).void
+      end
+      attr_writer :properties
+
+      # The event this payload describes.
+      sig do
+        returns(Orb::InvoicePaymentProcessingWebhookEvent::Type::TaggedSymbol)
+      end
+      attr_accessor :type
+
+      # Issued when an invoice payment is being processed.
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          invoice: Orb::Invoice::OrHash,
+          properties:
+            Orb::InvoicePaymentProcessingWebhookEvent::Properties::OrHash,
+          type: Orb::InvoicePaymentProcessingWebhookEvent::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::InvoicePaymentProcessingWebhookEvent::Properties,
+            type: Orb::InvoicePaymentProcessingWebhookEvent::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Properties < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::InvoicePaymentProcessingWebhookEvent::Properties,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :payment_provider_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :payment_provider
+
+        sig { params(payment_provider: String).void }
+        attr_writer :payment_provider
+
+        sig do
+          params(
+            payment_provider_id: T.nilable(String),
+            payment_provider: String
+          ).returns(T.attached_class)
+        end
+        def self.new(payment_provider_id:, payment_provider: nil)
+        end
+
+        sig do
+          override.returns(
+            { payment_provider_id: T.nilable(String), payment_provider: String }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      # The event this payload describes.
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Orb::InvoicePaymentProcessingWebhookEvent::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        INVOICE_PAYMENT_PROCESSING =
+          T.let(
+            :"invoice.payment_processing",
+            Orb::InvoicePaymentProcessingWebhookEvent::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Orb::InvoicePaymentProcessingWebhookEvent::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/orb/models/invoice_payment_succeeded_webhook_event.rbi

@@ -0,0 +1,175 @@
+# typed: strong
+
+module Orb
+  module Models
+    class InvoicePaymentSucceededWebhookEvent < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Orb::InvoicePaymentSucceededWebhookEvent,
+            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
+
+      # `shared_payment_token_id` is only on the wire when the payment used one.
+      sig { returns(Orb::InvoicePaymentSucceededWebhookEvent::Properties) }
+      attr_reader :properties
+
+      sig do
+        params(
+          properties:
+            Orb::InvoicePaymentSucceededWebhookEvent::Properties::OrHash
+        ).void
+      end
+      attr_writer :properties
+
+      # The event this payload describes.
+      sig do
+        returns(Orb::InvoicePaymentSucceededWebhookEvent::Type::TaggedSymbol)
+      end
+      attr_accessor :type
+
+      # Issued when automated payment collection for an invoice succeeds for a
+      # configured payment gateway.
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          invoice: Orb::Invoice::OrHash,
+          properties:
+            Orb::InvoicePaymentSucceededWebhookEvent::Properties::OrHash,
+          type: Orb::InvoicePaymentSucceededWebhookEvent::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:,
+        # `shared_payment_token_id` is only on the wire when the payment used one.
+        properties:,
+        # The event this payload describes.
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            invoice: Orb::Invoice,
+            properties: Orb::InvoicePaymentSucceededWebhookEvent::Properties,
+            type: Orb::InvoicePaymentSucceededWebhookEvent::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Properties < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::InvoicePaymentSucceededWebhookEvent::Properties,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :payment_provider
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :payment_provider_id
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :payment_provider_transaction_id
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :shared_payment_token_id
+
+        # `shared_payment_token_id` is only on the wire when the payment used one.
+        sig do
+          params(
+            payment_provider: T.nilable(String),
+            payment_provider_id: T.nilable(String),
+            payment_provider_transaction_id: T.nilable(String),
+            shared_payment_token_id: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          payment_provider:,
+          payment_provider_id:,
+          payment_provider_transaction_id:,
+          shared_payment_token_id: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              payment_provider: T.nilable(String),
+              payment_provider_id: T.nilable(String),
+              payment_provider_transaction_id: T.nilable(String),
+              shared_payment_token_id: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      # The event this payload describes.
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Orb::InvoicePaymentSucceededWebhookEvent::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        INVOICE_PAYMENT_SUCCEEDED =
+          T.let(
+            :"invoice.payment_succeeded",
+            Orb::InvoicePaymentSucceededWebhookEvent::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Orb::InvoicePaymentSucceededWebhookEvent::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/orb/models/invoice_sync_failed_webhook_event.rbi

@@ -0,0 +1,147 @@
+# typed: strong
+
+module Orb
+  module Models
+    class InvoiceSyncFailedWebhookEvent < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Orb::InvoiceSyncFailedWebhookEvent, 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::InvoiceSyncFailedWebhookEvent::Properties) }
+      attr_reader :properties
+
+      sig do
+        params(
+          properties: Orb::InvoiceSyncFailedWebhookEvent::Properties::OrHash
+        ).void
+      end
+      attr_writer :properties
+
+      # The event this payload describes.
+      sig { returns(Orb::InvoiceSyncFailedWebhookEvent::Type::TaggedSymbol) }
+      attr_accessor :type
+
+      # Issued when an invoice sync fails.
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          invoice: Orb::Invoice::OrHash,
+          properties: Orb::InvoiceSyncFailedWebhookEvent::Properties::OrHash,
+          type: Orb::InvoiceSyncFailedWebhookEvent::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::InvoiceSyncFailedWebhookEvent::Properties,
+            type: Orb::InvoiceSyncFailedWebhookEvent::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Properties < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::InvoiceSyncFailedWebhookEvent::Properties,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :payment_provider
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :payment_provider_id
+
+        sig do
+          params(
+            payment_provider: T.nilable(String),
+            payment_provider_id: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(payment_provider:, payment_provider_id:)
+        end
+
+        sig do
+          override.returns(
+            {
+              payment_provider: T.nilable(String),
+              payment_provider_id: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      # The event this payload describes.
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Orb::InvoiceSyncFailedWebhookEvent::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        INVOICE_SYNC_FAILED =
+          T.let(
+            :"invoice.sync_failed",
+            Orb::InvoiceSyncFailedWebhookEvent::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Orb::InvoiceSyncFailedWebhookEvent::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/orb/models/invoice_sync_succeeded_webhook_event.rbi

@@ -0,0 +1,147 @@
+# typed: strong
+
+module Orb
+  module Models
+    class InvoiceSyncSucceededWebhookEvent < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Orb::InvoiceSyncSucceededWebhookEvent, 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::InvoiceSyncSucceededWebhookEvent::Properties) }
+      attr_reader :properties
+
+      sig do
+        params(
+          properties: Orb::InvoiceSyncSucceededWebhookEvent::Properties::OrHash
+        ).void
+      end
+      attr_writer :properties
+
+      # The event this payload describes.
+      sig { returns(Orb::InvoiceSyncSucceededWebhookEvent::Type::TaggedSymbol) }
+      attr_accessor :type
+
+      # Issued when an invoice sync succeeds.
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          invoice: Orb::Invoice::OrHash,
+          properties: Orb::InvoiceSyncSucceededWebhookEvent::Properties::OrHash,
+          type: Orb::InvoiceSyncSucceededWebhookEvent::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::InvoiceSyncSucceededWebhookEvent::Properties,
+            type: Orb::InvoiceSyncSucceededWebhookEvent::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Properties < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::InvoiceSyncSucceededWebhookEvent::Properties,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :payment_provider
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :payment_provider_id
+
+        sig do
+          params(
+            payment_provider: T.nilable(String),
+            payment_provider_id: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(payment_provider:, payment_provider_id:)
+        end
+
+        sig do
+          override.returns(
+            {
+              payment_provider: T.nilable(String),
+              payment_provider_id: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      # The event this payload describes.
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Orb::InvoiceSyncSucceededWebhookEvent::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        INVOICE_SYNC_SUCCEEDED =
+          T.let(
+            :"invoice.sync_succeeded",
+            Orb::InvoiceSyncSucceededWebhookEvent::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Orb::InvoiceSyncSucceededWebhookEvent::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end