orb-billing 1.45.0 → 1.46.0

data/rbi/orb/models/webhooks/payment_method_deleted_standard_webhook_event.rbi

@@ -0,0 +1,331 @@
+# typed: strong
+
+module Orb
+  module Models
+    module Webhooks
+      class PaymentMethodDeletedStandardWebhookEvent < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent,
+              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 serialization style this payload was rendered in, as configured on the
+        # endpoint.
+        sig do
+          returns(
+            Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+        end
+        attr_accessor :payload_style
+
+        # 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
+          returns(
+            Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent::PaymentMethod
+          )
+        end
+        attr_reader :payment_method
+
+        sig do
+          params(
+            payment_method:
+              Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent::PaymentMethod::OrHash
+          ).void
+        end
+        attr_writer :payment_method
+
+        sig { returns(T.anything) }
+        attr_accessor :properties
+
+        # The event this payload describes.
+        sig do
+          returns(
+            Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent::Type::TaggedSymbol
+          )
+        end
+        attr_accessor :type
+
+        # Issued when a payment method is deleted.
+        sig do
+          params(
+            id: String,
+            created_at: Time,
+            payload_style:
+              Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent::PayloadStyle::OrSymbol,
+            payment_method:
+              Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent::PaymentMethod::OrHash,
+            properties: T.anything,
+            type:
+              Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent::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 serialization style this payload was rendered in, as configured on the
+          # endpoint.
+          payload_style:,
+          # 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,
+              payload_style:
+                Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent::PayloadStyle::TaggedSymbol,
+              payment_method:
+                Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent::PaymentMethod,
+              properties: T.anything,
+              type:
+                Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent::Type::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The serialization style this payload was rendered in, as configured on the
+        # endpoint.
+        module PayloadStyle
+          extend Orb::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent::PayloadStyle
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EXPANDED =
+            T.let(
+              :expanded,
+              Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent::PayloadStyle::TaggedSymbol
+            )
+          STANDARD =
+            T.let(
+              :standard,
+              Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent::PayloadStyle::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent::PayloadStyle::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class PaymentMethod < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent::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::Webhooks::PaymentMethodDeletedStandardWebhookEvent::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::Webhooks::PaymentMethodDeletedStandardWebhookEvent::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::Webhooks::PaymentMethodDeletedStandardWebhookEvent::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::Webhooks::PaymentMethodDeletedStandardWebhookEvent::PaymentMethod::PaymentMethodType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            CARD =
+              T.let(
+                :card,
+                Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent::PaymentMethod::PaymentMethodType::TaggedSymbol
+              )
+            US_BANK_ACCOUNT =
+              T.let(
+                :us_bank_account,
+                Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent::PaymentMethod::PaymentMethodType::TaggedSymbol
+              )
+            LINK =
+              T.let(
+                :link,
+                Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent::PaymentMethod::PaymentMethodType::TaggedSymbol
+              )
+            AMAZON_PAY =
+              T.let(
+                :amazon_pay,
+                Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent::PaymentMethod::PaymentMethodType::TaggedSymbol
+              )
+            CRYPTO =
+              T.let(
+                :crypto,
+                Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent::PaymentMethod::PaymentMethodType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent::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::Webhooks::PaymentMethodDeletedStandardWebhookEvent::Type
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PAYMENT_METHOD_DELETED =
+            T.let(
+              :"payment_method.deleted",
+              Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/orb/models/webhooks/plan_created_standard_webhook_event.rbi

@@ -0,0 +1,216 @@
+# typed: strong
+
+module Orb
+  module Models
+    module Webhooks
+      class PlanCreatedStandardWebhookEvent < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::Webhooks::PlanCreatedStandardWebhookEvent,
+              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 serialization style this payload was rendered in, as configured on the
+        # endpoint.
+        sig do
+          returns(
+            Orb::Webhooks::PlanCreatedStandardWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+        end
+        attr_accessor :payload_style
+
+        sig { returns(Orb::Webhooks::PlanCreatedStandardWebhookEvent::Plan) }
+        attr_reader :plan
+
+        sig do
+          params(
+            plan: Orb::Webhooks::PlanCreatedStandardWebhookEvent::Plan::OrHash
+          ).void
+        end
+        attr_writer :plan
+
+        sig { returns(T.anything) }
+        attr_accessor :properties
+
+        # The event this payload describes.
+        sig do
+          returns(
+            Orb::Webhooks::PlanCreatedStandardWebhookEvent::Type::TaggedSymbol
+          )
+        end
+        attr_accessor :type
+
+        # Issued when a plan is created, or when a draft plan is published.
+        sig do
+          params(
+            id: String,
+            created_at: Time,
+            payload_style:
+              Orb::Webhooks::PlanCreatedStandardWebhookEvent::PayloadStyle::OrSymbol,
+            plan: Orb::Webhooks::PlanCreatedStandardWebhookEvent::Plan::OrHash,
+            properties: T.anything,
+            type: Orb::Webhooks::PlanCreatedStandardWebhookEvent::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 serialization style this payload was rendered in, as configured on the
+          # endpoint.
+          payload_style:,
+          plan:,
+          properties:,
+          # The event this payload describes.
+          type:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Time,
+              payload_style:
+                Orb::Webhooks::PlanCreatedStandardWebhookEvent::PayloadStyle::TaggedSymbol,
+              plan: Orb::Webhooks::PlanCreatedStandardWebhookEvent::Plan,
+              properties: T.anything,
+              type:
+                Orb::Webhooks::PlanCreatedStandardWebhookEvent::Type::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The serialization style this payload was rendered in, as configured on the
+        # endpoint.
+        module PayloadStyle
+          extend Orb::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Orb::Webhooks::PlanCreatedStandardWebhookEvent::PayloadStyle
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EXPANDED =
+            T.let(
+              :expanded,
+              Orb::Webhooks::PlanCreatedStandardWebhookEvent::PayloadStyle::TaggedSymbol
+            )
+          STANDARD =
+            T.let(
+              :standard,
+              Orb::Webhooks::PlanCreatedStandardWebhookEvent::PayloadStyle::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::Webhooks::PlanCreatedStandardWebhookEvent::PayloadStyle::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class Plan < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::Webhooks::PlanCreatedStandardWebhookEvent::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
+
+        # The event this payload describes.
+        module Type
+          extend Orb::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Orb::Webhooks::PlanCreatedStandardWebhookEvent::Type
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PLAN_CREATED =
+            T.let(
+              :"plan.created",
+              Orb::Webhooks::PlanCreatedStandardWebhookEvent::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::Webhooks::PlanCreatedStandardWebhookEvent::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end