orb-billing 1.35.0 → 1.36.0

data/rbi/orb/models/payment_method_deleted_webhook_event.rbi

@@ -0,0 +1,259 @@
+# typed: strong
+
+module Orb
+  module Models
+    class PaymentMethodDeletedWebhookEvent < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Orb::PaymentMethodDeletedWebhookEvent, 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
+
+      # A payment method represents a customer's stored payment instrument held with an
+      # external payment provider (such as Adyen or Stripe).
+      #
+      # The serialization is intentionally minimal for now; provider-pulled details
+      # (e.g. card display metadata) will be added over time.
+      sig { returns(Orb::PaymentMethodDeletedWebhookEvent::PaymentMethod) }
+      attr_reader :payment_method
+
+      sig do
+        params(
+          payment_method:
+            Orb::PaymentMethodDeletedWebhookEvent::PaymentMethod::OrHash
+        ).void
+      end
+      attr_writer :payment_method
+
+      sig { returns(T.anything) }
+      attr_accessor :properties
+
+      # The event this payload describes.
+      sig { returns(Orb::PaymentMethodDeletedWebhookEvent::Type::TaggedSymbol) }
+      attr_accessor :type
+
+      # Issued when a payment method is deleted.
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          payment_method:
+            Orb::PaymentMethodDeletedWebhookEvent::PaymentMethod::OrHash,
+          properties: T.anything,
+          type: Orb::PaymentMethodDeletedWebhookEvent::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:,
+        # A payment method represents a customer's stored payment instrument held with an
+        # external payment provider (such as Adyen or Stripe).
+        #
+        # The serialization is intentionally minimal for now; provider-pulled details
+        # (e.g. card display metadata) will be added over time.
+        payment_method:,
+        properties:,
+        # The event this payload describes.
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            payment_method:
+              Orb::PaymentMethodDeletedWebhookEvent::PaymentMethod,
+            properties: T.anything,
+            type: Orb::PaymentMethodDeletedWebhookEvent::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class PaymentMethod < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::PaymentMethodDeletedWebhookEvent::PaymentMethod,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        # The Orb-assigned unique identifier for the payment method.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The time at which the payment method was created.
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # The ID of the Orb customer this payment method is attached to.
+        sig { returns(String) }
+        attr_accessor :customer_id
+
+        # Whether this is the customer's default payment method.
+        sig { returns(T::Boolean) }
+        attr_accessor :default
+
+        # The identifier of this payment method in the external payment provider.
+        sig { returns(String) }
+        attr_accessor :external_payment_method_id
+
+        # The type of the underlying payment instrument, e.g. `card` or `us_bank_account`.
+        sig do
+          returns(
+            Orb::PaymentMethodDeletedWebhookEvent::PaymentMethod::PaymentMethodType::TaggedSymbol
+          )
+        end
+        attr_accessor :payment_method_type
+
+        # The external payment provider this method belongs to, derived from the linked
+        # payment gateway connection (e.g. `adyen` or `stripe`). Null if the connection
+        # has been removed.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :provider_type
+
+        # A payment method represents a customer's stored payment instrument held with an
+        # external payment provider (such as Adyen or Stripe).
+        #
+        # The serialization is intentionally minimal for now; provider-pulled details
+        # (e.g. card display metadata) will be added over time.
+        sig do
+          params(
+            id: String,
+            created_at: Time,
+            customer_id: String,
+            default: T::Boolean,
+            external_payment_method_id: String,
+            payment_method_type:
+              Orb::PaymentMethodDeletedWebhookEvent::PaymentMethod::PaymentMethodType::OrSymbol,
+            provider_type: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The Orb-assigned unique identifier for the payment method.
+          id:,
+          # The time at which the payment method was created.
+          created_at:,
+          # The ID of the Orb customer this payment method is attached to.
+          customer_id:,
+          # Whether this is the customer's default payment method.
+          default:,
+          # The identifier of this payment method in the external payment provider.
+          external_payment_method_id:,
+          # The type of the underlying payment instrument, e.g. `card` or `us_bank_account`.
+          payment_method_type:,
+          # The external payment provider this method belongs to, derived from the linked
+          # payment gateway connection (e.g. `adyen` or `stripe`). Null if the connection
+          # has been removed.
+          provider_type:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Time,
+              customer_id: String,
+              default: T::Boolean,
+              external_payment_method_id: String,
+              payment_method_type:
+                Orb::PaymentMethodDeletedWebhookEvent::PaymentMethod::PaymentMethodType::TaggedSymbol,
+              provider_type: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The type of the underlying payment instrument, e.g. `card` or `us_bank_account`.
+        module PaymentMethodType
+          extend Orb::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Orb::PaymentMethodDeletedWebhookEvent::PaymentMethod::PaymentMethodType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          CARD =
+            T.let(
+              :card,
+              Orb::PaymentMethodDeletedWebhookEvent::PaymentMethod::PaymentMethodType::TaggedSymbol
+            )
+          US_BANK_ACCOUNT =
+            T.let(
+              :us_bank_account,
+              Orb::PaymentMethodDeletedWebhookEvent::PaymentMethod::PaymentMethodType::TaggedSymbol
+            )
+          LINK =
+            T.let(
+              :link,
+              Orb::PaymentMethodDeletedWebhookEvent::PaymentMethod::PaymentMethodType::TaggedSymbol
+            )
+          AMAZON_PAY =
+            T.let(
+              :amazon_pay,
+              Orb::PaymentMethodDeletedWebhookEvent::PaymentMethod::PaymentMethodType::TaggedSymbol
+            )
+          CRYPTO =
+            T.let(
+              :crypto,
+              Orb::PaymentMethodDeletedWebhookEvent::PaymentMethod::PaymentMethodType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::PaymentMethodDeletedWebhookEvent::PaymentMethod::PaymentMethodType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      # The event this payload describes.
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Orb::PaymentMethodDeletedWebhookEvent::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PAYMENT_METHOD_DELETED =
+          T.let(
+            :"payment_method.deleted",
+            Orb::PaymentMethodDeletedWebhookEvent::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Orb::PaymentMethodDeletedWebhookEvent::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/orb/models/plan_default_version_set_webhook_event.rbi

@@ -0,0 +1,196 @@
+# typed: strong
+
+module Orb
+  module Models
+    class PlanDefaultVersionSetWebhookEvent < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Orb::PlanDefaultVersionSetWebhookEvent, 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
+
+      sig { returns(Orb::PlanDefaultVersionSetWebhookEvent::Plan) }
+      attr_reader :plan
+
+      sig do
+        params(plan: Orb::PlanDefaultVersionSetWebhookEvent::Plan::OrHash).void
+      end
+      attr_writer :plan
+
+      sig { returns(Orb::PlanDefaultVersionSetWebhookEvent::Properties) }
+      attr_reader :properties
+
+      sig do
+        params(
+          properties: Orb::PlanDefaultVersionSetWebhookEvent::Properties::OrHash
+        ).void
+      end
+      attr_writer :properties
+
+      # The event this payload describes.
+      sig do
+        returns(Orb::PlanDefaultVersionSetWebhookEvent::Type::TaggedSymbol)
+      end
+      attr_accessor :type
+
+      # Issued when a plan's default version is set.
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          plan: Orb::PlanDefaultVersionSetWebhookEvent::Plan::OrHash,
+          properties:
+            Orb::PlanDefaultVersionSetWebhookEvent::Properties::OrHash,
+          type: Orb::PlanDefaultVersionSetWebhookEvent::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:,
+        plan:,
+        properties:,
+        # The event this payload describes.
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            plan: Orb::PlanDefaultVersionSetWebhookEvent::Plan,
+            properties: Orb::PlanDefaultVersionSetWebhookEvent::Properties,
+            type: Orb::PlanDefaultVersionSetWebhookEvent::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Plan < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::PlanDefaultVersionSetWebhookEvent::Plan,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :id
+
+        # An optional user-defined ID for this plan resource, used throughout the system
+        # as an alias for this Plan. Use this field to identify a plan by an existing
+        # identifier in your system.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :external_plan_id
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        sig do
+          params(
+            id: T.nilable(String),
+            external_plan_id: T.nilable(String),
+            name: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          # An optional user-defined ID for this plan resource, used throughout the system
+          # as an alias for this Plan. Use this field to identify a plan by an existing
+          # identifier in your system.
+          external_plan_id:,
+          name:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: T.nilable(String),
+              external_plan_id: T.nilable(String),
+              name: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class Properties < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::PlanDefaultVersionSetWebhookEvent::Properties,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Integer) }
+        attr_accessor :new_default_version_number
+
+        sig { returns(Integer) }
+        attr_accessor :previous_default_version_number
+
+        sig do
+          params(
+            new_default_version_number: Integer,
+            previous_default_version_number: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          new_default_version_number:,
+          previous_default_version_number:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              new_default_version_number: Integer,
+              previous_default_version_number: Integer
+            }
+          )
+        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::PlanDefaultVersionSetWebhookEvent::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PLAN_DEFAULT_VERSION_SET =
+          T.let(
+            :"plan.default_version_set",
+            Orb::PlanDefaultVersionSetWebhookEvent::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Orb::PlanDefaultVersionSetWebhookEvent::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/orb/models/plan_version_created_webhook_event.rbi

@@ -0,0 +1,190 @@
+# typed: strong
+
+module Orb
+  module Models
+    class PlanVersionCreatedWebhookEvent < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Orb::PlanVersionCreatedWebhookEvent, 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
+
+      sig { returns(Orb::PlanVersionCreatedWebhookEvent::Plan) }
+      attr_reader :plan
+
+      sig do
+        params(plan: Orb::PlanVersionCreatedWebhookEvent::Plan::OrHash).void
+      end
+      attr_writer :plan
+
+      sig { returns(Orb::PlanVersionCreatedWebhookEvent::Properties) }
+      attr_reader :properties
+
+      sig do
+        params(
+          properties: Orb::PlanVersionCreatedWebhookEvent::Properties::OrHash
+        ).void
+      end
+      attr_writer :properties
+
+      # The event this payload describes.
+      sig { returns(Orb::PlanVersionCreatedWebhookEvent::Type::TaggedSymbol) }
+      attr_accessor :type
+
+      # Issued when a new plan version is created.
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          plan: Orb::PlanVersionCreatedWebhookEvent::Plan::OrHash,
+          properties: Orb::PlanVersionCreatedWebhookEvent::Properties::OrHash,
+          type: Orb::PlanVersionCreatedWebhookEvent::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:,
+        plan:,
+        properties:,
+        # The event this payload describes.
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            plan: Orb::PlanVersionCreatedWebhookEvent::Plan,
+            properties: Orb::PlanVersionCreatedWebhookEvent::Properties,
+            type: Orb::PlanVersionCreatedWebhookEvent::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Plan < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::PlanVersionCreatedWebhookEvent::Plan,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :id
+
+        # An optional user-defined ID for this plan resource, used throughout the system
+        # as an alias for this Plan. Use this field to identify a plan by an existing
+        # identifier in your system.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :external_plan_id
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        sig do
+          params(
+            id: T.nilable(String),
+            external_plan_id: T.nilable(String),
+            name: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          # An optional user-defined ID for this plan resource, used throughout the system
+          # as an alias for this Plan. Use this field to identify a plan by an existing
+          # identifier in your system.
+          external_plan_id:,
+          name:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: T.nilable(String),
+              external_plan_id: T.nilable(String),
+              name: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class Properties < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::PlanVersionCreatedWebhookEvent::Properties,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :plan_version_description
+
+        sig { returns(Integer) }
+        attr_accessor :plan_version_number
+
+        sig do
+          params(
+            plan_version_description: T.nilable(String),
+            plan_version_number: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(plan_version_description:, plan_version_number:)
+        end
+
+        sig do
+          override.returns(
+            {
+              plan_version_description: T.nilable(String),
+              plan_version_number: Integer
+            }
+          )
+        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::PlanVersionCreatedWebhookEvent::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PLAN_VERSION_CREATED =
+          T.let(
+            :"plan.version_created",
+            Orb::PlanVersionCreatedWebhookEvent::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Orb::PlanVersionCreatedWebhookEvent::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end