orb-billing 1.44.0 → 1.46.0

data/rbi/orb/models/webhooks/plan_default_version_set_standard_webhook_event.rbi

@@ -0,0 +1,277 @@
+# typed: strong
+
+module Orb
+  module Models
+    module Webhooks
+      class PlanDefaultVersionSetStandardWebhookEvent < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::Webhooks::PlanDefaultVersionSetStandardWebhookEvent,
+              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::PlanDefaultVersionSetStandardWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+        end
+        attr_accessor :payload_style
+
+        sig do
+          returns(
+            Orb::Webhooks::PlanDefaultVersionSetStandardWebhookEvent::Plan
+          )
+        end
+        attr_reader :plan
+
+        sig do
+          params(
+            plan:
+              Orb::Webhooks::PlanDefaultVersionSetStandardWebhookEvent::Plan::OrHash
+          ).void
+        end
+        attr_writer :plan
+
+        sig do
+          returns(
+            Orb::Webhooks::PlanDefaultVersionSetStandardWebhookEvent::Properties
+          )
+        end
+        attr_reader :properties
+
+        sig do
+          params(
+            properties:
+              Orb::Webhooks::PlanDefaultVersionSetStandardWebhookEvent::Properties::OrHash
+          ).void
+        end
+        attr_writer :properties
+
+        # The event this payload describes.
+        sig do
+          returns(
+            Orb::Webhooks::PlanDefaultVersionSetStandardWebhookEvent::Type::TaggedSymbol
+          )
+        end
+        attr_accessor :type
+
+        # Issued when a plan's default version is set.
+        sig do
+          params(
+            id: String,
+            created_at: Time,
+            payload_style:
+              Orb::Webhooks::PlanDefaultVersionSetStandardWebhookEvent::PayloadStyle::OrSymbol,
+            plan:
+              Orb::Webhooks::PlanDefaultVersionSetStandardWebhookEvent::Plan::OrHash,
+            properties:
+              Orb::Webhooks::PlanDefaultVersionSetStandardWebhookEvent::Properties::OrHash,
+            type:
+              Orb::Webhooks::PlanDefaultVersionSetStandardWebhookEvent::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::PlanDefaultVersionSetStandardWebhookEvent::PayloadStyle::TaggedSymbol,
+              plan:
+                Orb::Webhooks::PlanDefaultVersionSetStandardWebhookEvent::Plan,
+              properties:
+                Orb::Webhooks::PlanDefaultVersionSetStandardWebhookEvent::Properties,
+              type:
+                Orb::Webhooks::PlanDefaultVersionSetStandardWebhookEvent::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::PlanDefaultVersionSetStandardWebhookEvent::PayloadStyle
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EXPANDED =
+            T.let(
+              :expanded,
+              Orb::Webhooks::PlanDefaultVersionSetStandardWebhookEvent::PayloadStyle::TaggedSymbol
+            )
+          STANDARD =
+            T.let(
+              :standard,
+              Orb::Webhooks::PlanDefaultVersionSetStandardWebhookEvent::PayloadStyle::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::Webhooks::PlanDefaultVersionSetStandardWebhookEvent::PayloadStyle::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class Plan < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::Webhooks::PlanDefaultVersionSetStandardWebhookEvent::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::Webhooks::PlanDefaultVersionSetStandardWebhookEvent::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::Webhooks::PlanDefaultVersionSetStandardWebhookEvent::Type
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PLAN_DEFAULT_VERSION_SET =
+            T.let(
+              :"plan.default_version_set",
+              Orb::Webhooks::PlanDefaultVersionSetStandardWebhookEvent::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::Webhooks::PlanDefaultVersionSetStandardWebhookEvent::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/orb/models/webhooks/plan_edited_standard_webhook_event.rbi

@@ -0,0 +1,337 @@
+# typed: strong
+
+module Orb
+  module Models
+    module Webhooks
+      class PlanEditedStandardWebhookEvent < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::Webhooks::PlanEditedStandardWebhookEvent,
+              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::PlanEditedStandardWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+        end
+        attr_accessor :payload_style
+
+        # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
+        # subscribed to by a customer. Plans define the billing behavior of the
+        # subscription. You can see more about how to configure prices in the
+        # [Price resource](/reference/price).
+        sig { returns(Orb::Plan) }
+        attr_reader :plan
+
+        sig { params(plan: Orb::Plan::OrHash).void }
+        attr_writer :plan
+
+        sig do
+          returns(Orb::Webhooks::PlanEditedStandardWebhookEvent::Properties)
+        end
+        attr_reader :properties
+
+        sig do
+          params(
+            properties:
+              Orb::Webhooks::PlanEditedStandardWebhookEvent::Properties::OrHash
+          ).void
+        end
+        attr_writer :properties
+
+        # The event this payload describes.
+        sig do
+          returns(
+            Orb::Webhooks::PlanEditedStandardWebhookEvent::Type::TaggedSymbol
+          )
+        end
+        attr_accessor :type
+
+        # Issued when a plan's name, description, external plan ID, metadata or status is
+        # edited.
+        sig do
+          params(
+            id: String,
+            created_at: Time,
+            payload_style:
+              Orb::Webhooks::PlanEditedStandardWebhookEvent::PayloadStyle::OrSymbol,
+            plan: Orb::Plan::OrHash,
+            properties:
+              Orb::Webhooks::PlanEditedStandardWebhookEvent::Properties::OrHash,
+            type: Orb::Webhooks::PlanEditedStandardWebhookEvent::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:,
+          # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
+          # subscribed to by a customer. Plans define the billing behavior of the
+          # subscription. You can see more about how to configure prices in the
+          # [Price resource](/reference/price).
+          plan:,
+          properties:,
+          # The event this payload describes.
+          type:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Time,
+              payload_style:
+                Orb::Webhooks::PlanEditedStandardWebhookEvent::PayloadStyle::TaggedSymbol,
+              plan: Orb::Plan,
+              properties:
+                Orb::Webhooks::PlanEditedStandardWebhookEvent::Properties,
+              type:
+                Orb::Webhooks::PlanEditedStandardWebhookEvent::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::PlanEditedStandardWebhookEvent::PayloadStyle
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EXPANDED =
+            T.let(
+              :expanded,
+              Orb::Webhooks::PlanEditedStandardWebhookEvent::PayloadStyle::TaggedSymbol
+            )
+          STANDARD =
+            T.let(
+              :standard,
+              Orb::Webhooks::PlanEditedStandardWebhookEvent::PayloadStyle::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::Webhooks::PlanEditedStandardWebhookEvent::PayloadStyle::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class Properties < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::Webhooks::PlanEditedStandardWebhookEvent::Properties,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          # metadata values are non-null on the wire, as on the price event.
+          sig do
+            returns(
+              Orb::Webhooks::PlanEditedStandardWebhookEvent::Properties::PreviousAttributes
+            )
+          end
+          attr_reader :previous_attributes
+
+          sig do
+            params(
+              previous_attributes:
+                Orb::Webhooks::PlanEditedStandardWebhookEvent::Properties::PreviousAttributes::OrHash
+            ).void
+          end
+          attr_writer :previous_attributes
+
+          sig do
+            params(
+              previous_attributes:
+                Orb::Webhooks::PlanEditedStandardWebhookEvent::Properties::PreviousAttributes::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # metadata values are non-null on the wire, as on the price event.
+            previous_attributes:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                previous_attributes:
+                  Orb::Webhooks::PlanEditedStandardWebhookEvent::Properties::PreviousAttributes
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class PreviousAttributes < Orb::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Orb::Webhooks::PlanEditedStandardWebhookEvent::Properties::PreviousAttributes,
+                  Orb::Internal::AnyHash
+                )
+              end
+
+            sig { returns(T.nilable(String)) }
+            attr_accessor :description
+
+            sig { returns(T.nilable(String)) }
+            attr_accessor :external_plan_id
+
+            sig { returns(T.nilable(T::Hash[Symbol, String])) }
+            attr_accessor :metadata
+
+            sig { returns(T.nilable(String)) }
+            attr_accessor :name
+
+            sig do
+              returns(
+                T.nilable(
+                  Orb::Webhooks::PlanEditedStandardWebhookEvent::Properties::PreviousAttributes::Status::TaggedSymbol
+                )
+              )
+            end
+            attr_accessor :status
+
+            # metadata values are non-null on the wire, as on the price event.
+            sig do
+              params(
+                description: T.nilable(String),
+                external_plan_id: T.nilable(String),
+                metadata: T.nilable(T::Hash[Symbol, String]),
+                name: T.nilable(String),
+                status:
+                  T.nilable(
+                    Orb::Webhooks::PlanEditedStandardWebhookEvent::Properties::PreviousAttributes::Status::OrSymbol
+                  )
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              description: nil,
+              external_plan_id: nil,
+              metadata: nil,
+              name: nil,
+              status: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  description: T.nilable(String),
+                  external_plan_id: T.nilable(String),
+                  metadata: T.nilable(T::Hash[Symbol, String]),
+                  name: T.nilable(String),
+                  status:
+                    T.nilable(
+                      Orb::Webhooks::PlanEditedStandardWebhookEvent::Properties::PreviousAttributes::Status::TaggedSymbol
+                    )
+                }
+              )
+            end
+            def to_hash
+            end
+
+            module Status
+              extend Orb::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Orb::Webhooks::PlanEditedStandardWebhookEvent::Properties::PreviousAttributes::Status
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              ACTIVE =
+                T.let(
+                  :active,
+                  Orb::Webhooks::PlanEditedStandardWebhookEvent::Properties::PreviousAttributes::Status::TaggedSymbol
+                )
+              ARCHIVED =
+                T.let(
+                  :archived,
+                  Orb::Webhooks::PlanEditedStandardWebhookEvent::Properties::PreviousAttributes::Status::TaggedSymbol
+                )
+              DRAFT =
+                T.let(
+                  :draft,
+                  Orb::Webhooks::PlanEditedStandardWebhookEvent::Properties::PreviousAttributes::Status::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Orb::Webhooks::PlanEditedStandardWebhookEvent::Properties::PreviousAttributes::Status::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            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::PlanEditedStandardWebhookEvent::Type)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PLAN_EDITED =
+            T.let(
+              :"plan.edited",
+              Orb::Webhooks::PlanEditedStandardWebhookEvent::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::Webhooks::PlanEditedStandardWebhookEvent::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end