orb-billing 1.43.0 → 1.45.0

data/rbi/orb/models/plan_edited_webhook_event.rbi

@@ -0,0 +1,301 @@
+# typed: strong
+
+module Orb
+  module Models
+    class PlanEditedWebhookEvent < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Orb::PlanEditedWebhookEvent, 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 { returns(Orb::PlanEditedWebhookEvent::PayloadStyle::TaggedSymbol) }
+      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 { returns(Orb::PlanEditedWebhookEvent::Properties) }
+      attr_reader :properties
+
+      sig do
+        params(properties: Orb::PlanEditedWebhookEvent::Properties::OrHash).void
+      end
+      attr_writer :properties
+
+      # The event this payload describes.
+      sig { returns(Orb::PlanEditedWebhookEvent::Type::TaggedSymbol) }
+      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::PlanEditedWebhookEvent::PayloadStyle::OrSymbol,
+          plan: Orb::Plan::OrHash,
+          properties: Orb::PlanEditedWebhookEvent::Properties::OrHash,
+          type: Orb::PlanEditedWebhookEvent::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::PlanEditedWebhookEvent::PayloadStyle::TaggedSymbol,
+            plan: Orb::Plan,
+            properties: Orb::PlanEditedWebhookEvent::Properties,
+            type: Orb::PlanEditedWebhookEvent::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::PlanEditedWebhookEvent::PayloadStyle)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EXPANDED =
+          T.let(
+            :expanded,
+            Orb::PlanEditedWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+        STANDARD =
+          T.let(
+            :standard,
+            Orb::PlanEditedWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Orb::PlanEditedWebhookEvent::PayloadStyle::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class Properties < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::PlanEditedWebhookEvent::Properties,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        # metadata values are non-null on the wire, as on the price event.
+        sig do
+          returns(Orb::PlanEditedWebhookEvent::Properties::PreviousAttributes)
+        end
+        attr_reader :previous_attributes
+
+        sig do
+          params(
+            previous_attributes:
+              Orb::PlanEditedWebhookEvent::Properties::PreviousAttributes::OrHash
+          ).void
+        end
+        attr_writer :previous_attributes
+
+        sig do
+          params(
+            previous_attributes:
+              Orb::PlanEditedWebhookEvent::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::PlanEditedWebhookEvent::Properties::PreviousAttributes
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class PreviousAttributes < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::PlanEditedWebhookEvent::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::PlanEditedWebhookEvent::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::PlanEditedWebhookEvent::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::PlanEditedWebhookEvent::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::PlanEditedWebhookEvent::Properties::PreviousAttributes::Status
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ACTIVE =
+              T.let(
+                :active,
+                Orb::PlanEditedWebhookEvent::Properties::PreviousAttributes::Status::TaggedSymbol
+              )
+            ARCHIVED =
+              T.let(
+                :archived,
+                Orb::PlanEditedWebhookEvent::Properties::PreviousAttributes::Status::TaggedSymbol
+              )
+            DRAFT =
+              T.let(
+                :draft,
+                Orb::PlanEditedWebhookEvent::Properties::PreviousAttributes::Status::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Orb::PlanEditedWebhookEvent::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 { T.all(Symbol, Orb::PlanEditedWebhookEvent::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PLAN_EDITED =
+          T.let(:"plan.edited", Orb::PlanEditedWebhookEvent::Type::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Orb::PlanEditedWebhookEvent::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/orb/models/plan_version_created_webhook_event.rbi

@@ -16,6 +16,13 @@ module Orb
       sig { returns(Time) }
       attr_accessor :created_at
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      sig do
+        returns(Orb::PlanVersionCreatedWebhookEvent::PayloadStyle::TaggedSymbol)
+      end
+      attr_accessor :payload_style
+
       sig { returns(Orb::PlanVersionCreatedWebhookEvent::Plan) }
       attr_reader :plan
 
@@ -43,6 +50,8 @@ module Orb
         params(
           id: String,
           created_at: Time,
+          payload_style:
+            Orb::PlanVersionCreatedWebhookEvent::PayloadStyle::OrSymbol,
           plan: Orb::PlanVersionCreatedWebhookEvent::Plan::OrHash,
           properties: Orb::PlanVersionCreatedWebhookEvent::Properties::OrHash,
           type: Orb::PlanVersionCreatedWebhookEvent::Type::OrSymbol
@@ -53,6 +62,9 @@ module Orb
         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.
@@ -65,6 +77,8 @@ module Orb
           {
             id: String,
             created_at: Time,
+            payload_style:
+              Orb::PlanVersionCreatedWebhookEvent::PayloadStyle::TaggedSymbol,
             plan: Orb::PlanVersionCreatedWebhookEvent::Plan,
             properties: Orb::PlanVersionCreatedWebhookEvent::Properties,
             type: Orb::PlanVersionCreatedWebhookEvent::Type::TaggedSymbol
@@ -74,6 +88,39 @@ module Orb
       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::PlanVersionCreatedWebhookEvent::PayloadStyle)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EXPANDED =
+          T.let(
+            :expanded,
+            Orb::PlanVersionCreatedWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+        STANDARD =
+          T.let(
+            :standard,
+            Orb::PlanVersionCreatedWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Orb::PlanVersionCreatedWebhookEvent::PayloadStyle::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
       class Plan < Orb::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/orb/models/price_edited_webhook_event.rbi

@@ -16,6 +16,11 @@ module Orb
       sig { returns(Time) }
       attr_accessor :created_at
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      sig { returns(Orb::PriceEditedWebhookEvent::PayloadStyle::TaggedSymbol) }
+      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.
@@ -48,6 +53,7 @@ module Orb
         params(
           id: String,
           created_at: Time,
+          payload_style: Orb::PriceEditedWebhookEvent::PayloadStyle::OrSymbol,
           price:
             T.any(
               Orb::Price::Unit::OrHash,
@@ -96,6 +102,9 @@ module Orb
         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.
@@ -118,6 +127,8 @@ module Orb
           {
             id: String,
             created_at: Time,
+            payload_style:
+              Orb::PriceEditedWebhookEvent::PayloadStyle::TaggedSymbol,
             price: Orb::Price::Variants,
             properties: Orb::PriceEditedWebhookEvent::Properties,
             type: Orb::PriceEditedWebhookEvent::Type::TaggedSymbol
@@ -127,6 +138,37 @@ module Orb
       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::PriceEditedWebhookEvent::PayloadStyle)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EXPANDED =
+          T.let(
+            :expanded,
+            Orb::PriceEditedWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+        STANDARD =
+          T.let(
+            :standard,
+            Orb::PriceEditedWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Orb::PriceEditedWebhookEvent::PayloadStyle::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
       class Properties < Orb::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/orb/models/resource_event_test_webhook_event.rbi

@@ -16,6 +16,13 @@ module Orb
       sig { returns(Time) }
       attr_accessor :created_at
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      sig do
+        returns(Orb::ResourceEventTestWebhookEvent::PayloadStyle::TaggedSymbol)
+      end
+      attr_accessor :payload_style
+
       sig { returns(Orb::ResourceEventTestWebhookEvent::Properties) }
       attr_reader :properties
 
@@ -35,6 +42,8 @@ module Orb
         params(
           id: String,
           created_at: Time,
+          payload_style:
+            Orb::ResourceEventTestWebhookEvent::PayloadStyle::OrSymbol,
           properties: Orb::ResourceEventTestWebhookEvent::Properties::OrHash,
           type: Orb::ResourceEventTestWebhookEvent::Type::OrSymbol
         ).returns(T.attached_class)
@@ -44,6 +53,9 @@ module Orb
         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:,
         properties:,
         # The event this payload describes.
         type:
@@ -55,6 +67,8 @@ module Orb
           {
             id: String,
             created_at: Time,
+            payload_style:
+              Orb::ResourceEventTestWebhookEvent::PayloadStyle::TaggedSymbol,
             properties: Orb::ResourceEventTestWebhookEvent::Properties,
             type: Orb::ResourceEventTestWebhookEvent::Type::TaggedSymbol
           }
@@ -63,6 +77,39 @@ module Orb
       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::ResourceEventTestWebhookEvent::PayloadStyle)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EXPANDED =
+          T.let(
+            :expanded,
+            Orb::ResourceEventTestWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+        STANDARD =
+          T.let(
+            :standard,
+            Orb::ResourceEventTestWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Orb::ResourceEventTestWebhookEvent::PayloadStyle::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
       class Properties < Orb::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/orb/models/sales_order_accounting_sync_failed_webhook_event.rbi

@@ -45,6 +45,15 @@ module Orb
       sig { params(invoice: Orb::Invoice::OrHash).void }
       attr_writer :invoice
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      sig do
+        returns(
+          Orb::SalesOrderAccountingSyncFailedWebhookEvent::PayloadStyle::TaggedSymbol
+        )
+      end
+      attr_accessor :payload_style
+
       sig do
         returns(Orb::SalesOrderAccountingSyncFailedWebhookEvent::Properties)
       end
@@ -74,6 +83,8 @@ module Orb
             Orb::SalesOrderAccountingSyncFailedWebhookEvent::AccountingSyncRecord::OrHash,
           created_at: Time,
           invoice: Orb::Invoice::OrHash,
+          payload_style:
+            Orb::SalesOrderAccountingSyncFailedWebhookEvent::PayloadStyle::OrSymbol,
           properties:
             Orb::SalesOrderAccountingSyncFailedWebhookEvent::Properties::OrHash,
           type: Orb::SalesOrderAccountingSyncFailedWebhookEvent::Type::OrSymbol
@@ -91,6 +102,9 @@ module Orb
         # 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:,
+        # The serialization style this payload was rendered in, as configured on the
+        # endpoint.
+        payload_style:,
         properties:,
         # The event this payload describes.
         type:
@@ -105,6 +119,8 @@ module Orb
               Orb::SalesOrderAccountingSyncFailedWebhookEvent::AccountingSyncRecord,
             created_at: Time,
             invoice: Orb::Invoice,
+            payload_style:
+              Orb::SalesOrderAccountingSyncFailedWebhookEvent::PayloadStyle::TaggedSymbol,
             properties:
               Orb::SalesOrderAccountingSyncFailedWebhookEvent::Properties,
             type:
@@ -260,6 +276,42 @@ module Orb
         end
       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::SalesOrderAccountingSyncFailedWebhookEvent::PayloadStyle
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EXPANDED =
+          T.let(
+            :expanded,
+            Orb::SalesOrderAccountingSyncFailedWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+        STANDARD =
+          T.let(
+            :standard,
+            Orb::SalesOrderAccountingSyncFailedWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Orb::SalesOrderAccountingSyncFailedWebhookEvent::PayloadStyle::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
       class Properties < Orb::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/orb/models/sales_order_accounting_sync_succeeded_webhook_event.rbi

@@ -45,6 +45,15 @@ module Orb
       sig { params(invoice: Orb::Invoice::OrHash).void }
       attr_writer :invoice
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      sig do
+        returns(
+          Orb::SalesOrderAccountingSyncSucceededWebhookEvent::PayloadStyle::TaggedSymbol
+        )
+      end
+      attr_accessor :payload_style
+
       sig do
         returns(Orb::SalesOrderAccountingSyncSucceededWebhookEvent::Properties)
       end
@@ -74,6 +83,8 @@ module Orb
             Orb::SalesOrderAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::OrHash,
           created_at: Time,
           invoice: Orb::Invoice::OrHash,
+          payload_style:
+            Orb::SalesOrderAccountingSyncSucceededWebhookEvent::PayloadStyle::OrSymbol,
           properties:
             Orb::SalesOrderAccountingSyncSucceededWebhookEvent::Properties::OrHash,
           type:
@@ -92,6 +103,9 @@ module Orb
         # 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:,
+        # The serialization style this payload was rendered in, as configured on the
+        # endpoint.
+        payload_style:,
         properties:,
         # The event this payload describes.
         type:
@@ -106,6 +120,8 @@ module Orb
               Orb::SalesOrderAccountingSyncSucceededWebhookEvent::AccountingSyncRecord,
             created_at: Time,
             invoice: Orb::Invoice,
+            payload_style:
+              Orb::SalesOrderAccountingSyncSucceededWebhookEvent::PayloadStyle::TaggedSymbol,
             properties:
               Orb::SalesOrderAccountingSyncSucceededWebhookEvent::Properties,
             type:
@@ -261,6 +277,42 @@ module Orb
         end
       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::SalesOrderAccountingSyncSucceededWebhookEvent::PayloadStyle
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EXPANDED =
+          T.let(
+            :expanded,
+            Orb::SalesOrderAccountingSyncSucceededWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+        STANDARD =
+          T.let(
+            :standard,
+            Orb::SalesOrderAccountingSyncSucceededWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Orb::SalesOrderAccountingSyncSucceededWebhookEvent::PayloadStyle::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
       class Properties < Orb::Internal::Type::BaseModel
         OrHash =
           T.type_alias do