orb-billing 1.44.0 → 1.46.0

data/rbi/orb/models/webhooks/plan_version_created_standard_webhook_event.rbi

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

data/rbi/orb/models/webhooks/price_edited_standard_webhook_event.rbi

@@ -0,0 +1,311 @@
+# typed: strong
+
+module Orb
+  module Models
+    module Webhooks
+      class PriceEditedStandardWebhookEvent < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::Webhooks::PriceEditedStandardWebhookEvent,
+              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::PriceEditedStandardWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+        end
+        attr_accessor :payload_style
+
+        # The Price resource represents a price that can be billed on a subscription,
+        # resulting in a charge on an invoice in the form of an invoice line item. Prices
+        # take a quantity and determine an amount to bill.
+        #
+        # Orb supports a few different pricing models out of the box. Each of these models
+        # is serialized differently in a given Price object. The model_type field
+        # determines the key for the configuration object that is present.
+        #
+        # For more on the types of prices, see
+        # [the core concepts documentation](/core-concepts#plan-and-price)
+        sig { returns(Orb::Price::Variants) }
+        attr_accessor :price
+
+        sig do
+          returns(Orb::Webhooks::PriceEditedStandardWebhookEvent::Properties)
+        end
+        attr_reader :properties
+
+        sig do
+          params(
+            properties:
+              Orb::Webhooks::PriceEditedStandardWebhookEvent::Properties::OrHash
+          ).void
+        end
+        attr_writer :properties
+
+        # The event this payload describes.
+        sig do
+          returns(
+            Orb::Webhooks::PriceEditedStandardWebhookEvent::Type::TaggedSymbol
+          )
+        end
+        attr_accessor :type
+
+        # Issued when a price is edited.
+        sig do
+          params(
+            id: String,
+            created_at: Time,
+            payload_style:
+              Orb::Webhooks::PriceEditedStandardWebhookEvent::PayloadStyle::OrSymbol,
+            price:
+              T.any(
+                Orb::Price::Unit::OrHash,
+                Orb::Price::Tiered::OrHash,
+                Orb::Price::Bulk::OrHash,
+                Orb::Price::BulkWithFilters::OrHash,
+                Orb::Price::Package::OrHash,
+                Orb::Price::Matrix::OrHash,
+                Orb::Price::ThresholdTotalAmount::OrHash,
+                Orb::Price::TieredPackage::OrHash,
+                Orb::Price::TieredWithMinimum::OrHash,
+                Orb::Price::GroupedTiered::OrHash,
+                Orb::Price::GroupedTieredMatrix::OrHash,
+                Orb::Price::TieredPackageWithMinimum::OrHash,
+                Orb::Price::PackageWithAllocation::OrHash,
+                Orb::Price::UnitWithPercent::OrHash,
+                Orb::Price::MatrixWithAllocation::OrHash,
+                Orb::Price::TieredMatrixWithAllocation::OrHash,
+                Orb::Price::MatrixWithThresholdDiscounts::OrHash,
+                Orb::Price::TieredWithProration::OrHash,
+                Orb::Price::UnitWithProration::OrHash,
+                Orb::Price::GroupedAllocation::OrHash,
+                Orb::Price::BulkWithProration::OrHash,
+                Orb::Price::GroupedWithProratedMinimum::OrHash,
+                Orb::Price::GroupedWithMeteredMinimum::OrHash,
+                Orb::Price::GroupedWithMinMaxThresholds::OrHash,
+                Orb::Price::MatrixWithDisplayName::OrHash,
+                Orb::Price::GroupedTieredPackage::OrHash,
+                Orb::Price::MaxGroupTieredPackage::OrHash,
+                Orb::Price::ScalableMatrixWithUnitPricing::OrHash,
+                Orb::Price::ScalableMatrixWithTieredPricing::OrHash,
+                Orb::Price::CumulativeGroupedBulk::OrHash,
+                Orb::Price::CumulativeGroupedAllocation::OrHash,
+                Orb::Price::DailyCreditAllowance::OrHash,
+                Orb::Price::MeteredAllowance::OrHash,
+                Orb::Price::MinimumComposite::OrHash,
+                Orb::Price::Percent::OrHash,
+                Orb::Price::EventOutput::OrHash
+              ),
+            properties:
+              Orb::Webhooks::PriceEditedStandardWebhookEvent::Properties::OrHash,
+            type: Orb::Webhooks::PriceEditedStandardWebhookEvent::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 Price resource represents a price that can be billed on a subscription,
+          # resulting in a charge on an invoice in the form of an invoice line item. Prices
+          # take a quantity and determine an amount to bill.
+          #
+          # Orb supports a few different pricing models out of the box. Each of these models
+          # is serialized differently in a given Price object. The model_type field
+          # determines the key for the configuration object that is present.
+          #
+          # For more on the types of prices, see
+          # [the core concepts documentation](/core-concepts#plan-and-price)
+          price:,
+          properties:,
+          # The event this payload describes.
+          type:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Time,
+              payload_style:
+                Orb::Webhooks::PriceEditedStandardWebhookEvent::PayloadStyle::TaggedSymbol,
+              price: Orb::Price::Variants,
+              properties:
+                Orb::Webhooks::PriceEditedStandardWebhookEvent::Properties,
+              type:
+                Orb::Webhooks::PriceEditedStandardWebhookEvent::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::PriceEditedStandardWebhookEvent::PayloadStyle
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EXPANDED =
+            T.let(
+              :expanded,
+              Orb::Webhooks::PriceEditedStandardWebhookEvent::PayloadStyle::TaggedSymbol
+            )
+          STANDARD =
+            T.let(
+              :standard,
+              Orb::Webhooks::PriceEditedStandardWebhookEvent::PayloadStyle::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::Webhooks::PriceEditedStandardWebhookEvent::PayloadStyle::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class Properties < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::Webhooks::PriceEditedStandardWebhookEvent::Properties,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          # metadata values are non-null on the wire (deleting a key removes it from
+          # storage); the Optional[str] values only exist on the new half of a metadata
+          # FieldChange.
+          sig do
+            returns(
+              Orb::Webhooks::PriceEditedStandardWebhookEvent::Properties::PreviousAttributes
+            )
+          end
+          attr_reader :previous_attributes
+
+          sig do
+            params(
+              previous_attributes:
+                Orb::Webhooks::PriceEditedStandardWebhookEvent::Properties::PreviousAttributes::OrHash
+            ).void
+          end
+          attr_writer :previous_attributes
+
+          sig do
+            params(
+              previous_attributes:
+                Orb::Webhooks::PriceEditedStandardWebhookEvent::Properties::PreviousAttributes::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # metadata values are non-null on the wire (deleting a key removes it from
+            # storage); the Optional[str] values only exist on the new half of a metadata
+            # FieldChange.
+            previous_attributes:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                previous_attributes:
+                  Orb::Webhooks::PriceEditedStandardWebhookEvent::Properties::PreviousAttributes
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class PreviousAttributes < Orb::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Orb::Webhooks::PriceEditedStandardWebhookEvent::Properties::PreviousAttributes,
+                  Orb::Internal::AnyHash
+                )
+              end
+
+            sig { returns(T.nilable(T::Hash[Symbol, String])) }
+            attr_accessor :metadata
+
+            # metadata values are non-null on the wire (deleting a key removes it from
+            # storage); the Optional[str] values only exist on the new half of a metadata
+            # FieldChange.
+            sig do
+              params(metadata: T.nilable(T::Hash[Symbol, String])).returns(
+                T.attached_class
+              )
+            end
+            def self.new(metadata: nil)
+            end
+
+            sig do
+              override.returns({ metadata: T.nilable(T::Hash[Symbol, String]) })
+            end
+            def to_hash
+            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::PriceEditedStandardWebhookEvent::Type
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PRICE_EDITED =
+            T.let(
+              :"price.edited",
+              Orb::Webhooks::PriceEditedStandardWebhookEvent::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::Webhooks::PriceEditedStandardWebhookEvent::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end