orb-billing 1.35.0 → 1.37.0

data/rbi/orb/models/price_edited_webhook_event.rbi

@@ -0,0 +1,235 @@
+# typed: strong
+
+module Orb
+  module Models
+    class PriceEditedWebhookEvent < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Orb::PriceEditedWebhookEvent, 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 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 { returns(Orb::PriceEditedWebhookEvent::Properties) }
+      attr_reader :properties
+
+      sig do
+        params(
+          properties: Orb::PriceEditedWebhookEvent::Properties::OrHash
+        ).void
+      end
+      attr_writer :properties
+
+      # The event this payload describes.
+      sig { returns(Orb::PriceEditedWebhookEvent::Type::TaggedSymbol) }
+      attr_accessor :type
+
+      # Issued when a price is edited.
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          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::PriceEditedWebhookEvent::Properties::OrHash,
+          type: Orb::PriceEditedWebhookEvent::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 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,
+            price: Orb::Price::Variants,
+            properties: Orb::PriceEditedWebhookEvent::Properties,
+            type: Orb::PriceEditedWebhookEvent::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Properties < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::PriceEditedWebhookEvent::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::PriceEditedWebhookEvent::Properties::PreviousAttributes)
+        end
+        attr_reader :previous_attributes
+
+        sig do
+          params(
+            previous_attributes:
+              Orb::PriceEditedWebhookEvent::Properties::PreviousAttributes::OrHash
+          ).void
+        end
+        attr_writer :previous_attributes
+
+        sig do
+          params(
+            previous_attributes:
+              Orb::PriceEditedWebhookEvent::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::PriceEditedWebhookEvent::Properties::PreviousAttributes
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class PreviousAttributes < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::PriceEditedWebhookEvent::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 { T.all(Symbol, Orb::PriceEditedWebhookEvent::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PRICE_EDITED =
+          T.let(
+            :"price.edited",
+            Orb::PriceEditedWebhookEvent::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Orb::PriceEditedWebhookEvent::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/orb/models/resource_event_test_webhook_event.rbi

@@ -0,0 +1,116 @@
+# typed: strong
+
+module Orb
+  module Models
+    class ResourceEventTestWebhookEvent < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Orb::ResourceEventTestWebhookEvent, 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::ResourceEventTestWebhookEvent::Properties) }
+      attr_reader :properties
+
+      sig do
+        params(
+          properties: Orb::ResourceEventTestWebhookEvent::Properties::OrHash
+        ).void
+      end
+      attr_writer :properties
+
+      # The event this payload describes.
+      sig { returns(Orb::ResourceEventTestWebhookEvent::Type::TaggedSymbol) }
+      attr_accessor :type
+
+      # Issued when a test webhook is sent.
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          properties: Orb::ResourceEventTestWebhookEvent::Properties::OrHash,
+          type: Orb::ResourceEventTestWebhookEvent::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:,
+        properties:,
+        # The event this payload describes.
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            properties: Orb::ResourceEventTestWebhookEvent::Properties,
+            type: Orb::ResourceEventTestWebhookEvent::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Properties < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::ResourceEventTestWebhookEvent::Properties,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :message
+
+        sig { params(message: String).void }
+        attr_writer :message
+
+        sig { params(message: String).returns(T.attached_class) }
+        def self.new(message: nil)
+        end
+
+        sig { override.returns({ message: String }) }
+        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::ResourceEventTestWebhookEvent::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        RESOURCE_EVENT_TEST =
+          T.let(
+            :"resource_event.test",
+            Orb::ResourceEventTestWebhookEvent::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Orb::ResourceEventTestWebhookEvent::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/orb/models/sales_order_accounting_sync_failed_webhook_event.rbi

@@ -0,0 +1,321 @@
+# typed: strong
+
+module Orb
+  module Models
+    class SalesOrderAccountingSyncFailedWebhookEvent < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Orb::SalesOrderAccountingSyncFailedWebhookEvent,
+            Orb::Internal::AnyHash
+          )
+        end
+
+      # The ID of this webhook event.
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig do
+        returns(
+          Orb::SalesOrderAccountingSyncFailedWebhookEvent::AccountingSyncRecord
+        )
+      end
+      attr_reader :accounting_sync_record
+
+      sig do
+        params(
+          accounting_sync_record:
+            Orb::SalesOrderAccountingSyncFailedWebhookEvent::AccountingSyncRecord::OrHash
+        ).void
+      end
+      attr_writer :accounting_sync_record
+
+      # The time at which this event was created, to the second.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity,
+      # representing the request for payment for a single subscription. This includes a
+      # set of line items, which correspond to prices in the subscription's plan and can
+      # 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.
+      sig { returns(Orb::Invoice) }
+      attr_reader :invoice
+
+      sig { params(invoice: Orb::Invoice::OrHash).void }
+      attr_writer :invoice
+
+      sig do
+        returns(Orb::SalesOrderAccountingSyncFailedWebhookEvent::Properties)
+      end
+      attr_reader :properties
+
+      sig do
+        params(
+          properties:
+            Orb::SalesOrderAccountingSyncFailedWebhookEvent::Properties::OrHash
+        ).void
+      end
+      attr_writer :properties
+
+      # The event this payload describes.
+      sig do
+        returns(
+          Orb::SalesOrderAccountingSyncFailedWebhookEvent::Type::TaggedSymbol
+        )
+      end
+      attr_accessor :type
+
+      # Issued when a sales order accounting sync fails.
+      sig do
+        params(
+          id: String,
+          accounting_sync_record:
+            Orb::SalesOrderAccountingSyncFailedWebhookEvent::AccountingSyncRecord::OrHash,
+          created_at: Time,
+          invoice: Orb::Invoice::OrHash,
+          properties:
+            Orb::SalesOrderAccountingSyncFailedWebhookEvent::Properties::OrHash,
+          type: Orb::SalesOrderAccountingSyncFailedWebhookEvent::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of this webhook event.
+        id:,
+        accounting_sync_record:,
+        # The time at which this event was created, to the second.
+        created_at:,
+        # An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity,
+        # representing the request for payment for a single subscription. This includes a
+        # set of line items, which correspond to prices in the subscription's plan and can
+        # 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:,
+        properties:,
+        # The event this payload describes.
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            accounting_sync_record:
+              Orb::SalesOrderAccountingSyncFailedWebhookEvent::AccountingSyncRecord,
+            created_at: Time,
+            invoice: Orb::Invoice,
+            properties:
+              Orb::SalesOrderAccountingSyncFailedWebhookEvent::Properties,
+            type:
+              Orb::SalesOrderAccountingSyncFailedWebhookEvent::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class AccountingSyncRecord < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::SalesOrderAccountingSyncFailedWebhookEvent::AccountingSyncRecord,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(String) }
+        attr_accessor :customer_id
+
+        sig do
+          returns(
+            Orb::SalesOrderAccountingSyncFailedWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+          )
+        end
+        attr_accessor :record_type
+
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_accessor :error_details
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :invoice_id
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :provider_customer_id
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :status
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :sync_action
+
+        sig do
+          params(
+            id: String,
+            customer_id: String,
+            record_type:
+              Orb::SalesOrderAccountingSyncFailedWebhookEvent::AccountingSyncRecord::RecordType::OrSymbol,
+            error_details: T.nilable(T::Hash[Symbol, T.anything]),
+            invoice_id: T.nilable(String),
+            provider_customer_id: T.nilable(String),
+            status: T.nilable(String),
+            sync_action: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          customer_id:,
+          record_type:,
+          error_details: nil,
+          invoice_id: nil,
+          provider_customer_id: nil,
+          status: nil,
+          sync_action: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              customer_id: String,
+              record_type:
+                Orb::SalesOrderAccountingSyncFailedWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol,
+              error_details: T.nilable(T::Hash[Symbol, T.anything]),
+              invoice_id: T.nilable(String),
+              provider_customer_id: T.nilable(String),
+              status: T.nilable(String),
+              sync_action: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module RecordType
+          extend Orb::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Orb::SalesOrderAccountingSyncFailedWebhookEvent::AccountingSyncRecord::RecordType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          CUSTOMER =
+            T.let(
+              :customer,
+              Orb::SalesOrderAccountingSyncFailedWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+            )
+          INVOICE =
+            T.let(
+              :invoice,
+              Orb::SalesOrderAccountingSyncFailedWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+            )
+          TRANSACTION =
+            T.let(
+              :transaction,
+              Orb::SalesOrderAccountingSyncFailedWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+            )
+          CUSTOMER_BALANCE_TRANSACTION =
+            T.let(
+              :customer_balance_transaction,
+              Orb::SalesOrderAccountingSyncFailedWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+            )
+          CREDIT_NOTE =
+            T.let(
+              :credit_note,
+              Orb::SalesOrderAccountingSyncFailedWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+            )
+          SUBSCRIPTION =
+            T.let(
+              :subscription,
+              Orb::SalesOrderAccountingSyncFailedWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+            )
+          SALES_ORDER =
+            T.let(
+              :sales_order,
+              Orb::SalesOrderAccountingSyncFailedWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+            )
+          BLOCK =
+            T.let(
+              :block,
+              Orb::SalesOrderAccountingSyncFailedWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::SalesOrderAccountingSyncFailedWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      class Properties < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::SalesOrderAccountingSyncFailedWebhookEvent::Properties,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :connection_type
+
+        sig { returns(String) }
+        attr_accessor :failure_reason
+
+        sig do
+          params(connection_type: String, failure_reason: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(connection_type:, failure_reason:)
+        end
+
+        sig do
+          override.returns({ connection_type: String, failure_reason: 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::SalesOrderAccountingSyncFailedWebhookEvent::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        SALES_ORDER_ACCOUNTING_SYNC_FAILED =
+          T.let(
+            :"sales_order.accounting_sync_failed",
+            Orb::SalesOrderAccountingSyncFailedWebhookEvent::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Orb::SalesOrderAccountingSyncFailedWebhookEvent::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end