orb-billing 1.44.0 → 1.46.0

data/rbi/orb/models/webhooks/transaction_accounting_sync_succeeded_standard_webhook_event.rbi

@@ -0,0 +1,505 @@
+# typed: strong
+
+module Orb
+  module Models
+    module Webhooks
+      class TransactionAccountingSyncSucceededStandardWebhookEvent < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        # The ID of this webhook event.
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig do
+          returns(
+            Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord
+          )
+        end
+        attr_reader :accounting_sync_record
+
+        sig do
+          params(
+            accounting_sync_record:
+              Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::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
+
+        # The serialization style this payload was rendered in, as configured on the
+        # endpoint.
+        sig do
+          returns(
+            Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+        end
+        attr_accessor :payload_style
+
+        sig do
+          returns(
+            Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Properties
+          )
+        end
+        attr_reader :properties
+
+        sig do
+          params(
+            properties:
+              Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Properties::OrHash
+          ).void
+        end
+        attr_writer :properties
+
+        sig do
+          returns(
+            Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Transaction
+          )
+        end
+        attr_reader :transaction
+
+        sig do
+          params(
+            transaction:
+              Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Transaction::OrHash
+          ).void
+        end
+        attr_writer :transaction
+
+        # The event this payload describes.
+        sig do
+          returns(
+            Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Type::TaggedSymbol
+          )
+        end
+        attr_accessor :type
+
+        # Issued when a transaction accounting sync succeeds.
+        sig do
+          params(
+            id: String,
+            accounting_sync_record:
+              Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::OrHash,
+            created_at: Time,
+            payload_style:
+              Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::PayloadStyle::OrSymbol,
+            properties:
+              Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Properties::OrHash,
+            transaction:
+              Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Transaction::OrHash,
+            type:
+              Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::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:,
+          # The serialization style this payload was rendered in, as configured on the
+          # endpoint.
+          payload_style:,
+          properties:,
+          transaction:,
+          # The event this payload describes.
+          type:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              accounting_sync_record:
+                Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord,
+              created_at: Time,
+              payload_style:
+                Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::PayloadStyle::TaggedSymbol,
+              properties:
+                Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Properties,
+              transaction:
+                Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Transaction,
+              type:
+                Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Type::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class AccountingSyncRecord < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { returns(String) }
+          attr_accessor :customer_id
+
+          sig do
+            returns(
+              Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::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 :provider_customer_id
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :status
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :sync_action
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :transaction_record_id
+
+          sig do
+            params(
+              id: String,
+              customer_id: String,
+              record_type:
+                Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::OrSymbol,
+              error_details: T.nilable(T::Hash[Symbol, T.anything]),
+              provider_customer_id: T.nilable(String),
+              status: T.nilable(String),
+              sync_action: T.nilable(String),
+              transaction_record_id: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            id:,
+            customer_id:,
+            record_type:,
+            error_details: nil,
+            provider_customer_id: nil,
+            status: nil,
+            sync_action: nil,
+            transaction_record_id: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                customer_id: String,
+                record_type:
+                  Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol,
+                error_details: T.nilable(T::Hash[Symbol, T.anything]),
+                provider_customer_id: T.nilable(String),
+                status: T.nilable(String),
+                sync_action: T.nilable(String),
+                transaction_record_id: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module RecordType
+            extend Orb::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            CUSTOMER =
+              T.let(
+                :customer,
+                Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+              )
+            INVOICE =
+              T.let(
+                :invoice,
+                Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+              )
+            TRANSACTION =
+              T.let(
+                :transaction,
+                Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+              )
+            CUSTOMER_BALANCE_TRANSACTION =
+              T.let(
+                :customer_balance_transaction,
+                Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+              )
+            CREDIT_NOTE =
+              T.let(
+                :credit_note,
+                Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+              )
+            SUBSCRIPTION =
+              T.let(
+                :subscription,
+                Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+              )
+            SALES_ORDER =
+              T.let(
+                :sales_order,
+                Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+              )
+            BLOCK =
+              T.let(
+                :block,
+                Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          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::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::PayloadStyle
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EXPANDED =
+            T.let(
+              :expanded,
+              Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::PayloadStyle::TaggedSymbol
+            )
+          STANDARD =
+            T.let(
+              :standard,
+              Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::PayloadStyle::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::PayloadStyle::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class Properties < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Properties,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :connection_type
+
+          sig { params(connection_type: String).returns(T.attached_class) }
+          def self.new(connection_type:)
+          end
+
+          sig { override.returns({ connection_type: String }) }
+          def to_hash
+          end
+        end
+
+        class Transaction < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Transaction,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          # The ID of the payment attempt.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The amount of the payment attempt.
+          sig { returns(String) }
+          attr_accessor :amount
+
+          # The time at which the payment attempt was created.
+          sig { returns(Time) }
+          attr_accessor :created_at
+
+          # The payment provider that attempted to collect the payment.
+          sig do
+            returns(
+              T.nilable(
+                Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Transaction::PaymentProvider::TaggedSymbol
+              )
+            )
+          end
+          attr_accessor :payment_provider
+
+          # The ID of the payment attempt in the payment provider.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :payment_provider_id
+
+          # URL to the downloadable PDF version of the receipt. This field will be `null`
+          # for payment attempts that did not succeed.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :receipt_pdf
+
+          # Whether the payment attempt succeeded.
+          sig { returns(T::Boolean) }
+          attr_accessor :succeeded
+
+          sig do
+            params(
+              id: String,
+              amount: String,
+              created_at: Time,
+              payment_provider:
+                T.nilable(
+                  Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Transaction::PaymentProvider::OrSymbol
+                ),
+              payment_provider_id: T.nilable(String),
+              receipt_pdf: T.nilable(String),
+              succeeded: T::Boolean
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The ID of the payment attempt.
+            id:,
+            # The amount of the payment attempt.
+            amount:,
+            # The time at which the payment attempt was created.
+            created_at:,
+            # The payment provider that attempted to collect the payment.
+            payment_provider:,
+            # The ID of the payment attempt in the payment provider.
+            payment_provider_id:,
+            # URL to the downloadable PDF version of the receipt. This field will be `null`
+            # for payment attempts that did not succeed.
+            receipt_pdf:,
+            # Whether the payment attempt succeeded.
+            succeeded:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                amount: String,
+                created_at: Time,
+                payment_provider:
+                  T.nilable(
+                    Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Transaction::PaymentProvider::TaggedSymbol
+                  ),
+                payment_provider_id: T.nilable(String),
+                receipt_pdf: T.nilable(String),
+                succeeded: T::Boolean
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The payment provider that attempted to collect the payment.
+          module PaymentProvider
+            extend Orb::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Transaction::PaymentProvider
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            STRIPE =
+              T.let(
+                :stripe,
+                Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Transaction::PaymentProvider::TaggedSymbol
+              )
+            ADYEN =
+              T.let(
+                :adyen,
+                Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Transaction::PaymentProvider::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Transaction::PaymentProvider::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::TransactionAccountingSyncSucceededStandardWebhookEvent::Type
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          TRANSACTION_ACCOUNTING_SYNC_SUCCEEDED =
+            T.let(
+              :"transaction.accounting_sync_succeeded",
+              Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/orb/models/webhooks/unwrap_standard_webhook_event.rbi

@@ -0,0 +1,107 @@
+# typed: strong
+
+module Orb
+  module Models
+    module Webhooks
+      # Issued when a backfill is closed and its events are reflected into usage.
+      module UnwrapStandardWebhookEvent
+        extend Orb::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              Orb::Webhooks::BackfillReflectedStandardWebhookEvent,
+              Orb::Webhooks::BackfillRevertedStandardWebhookEvent,
+              Orb::Webhooks::BillableMetricEditedStandardWebhookEvent,
+              Orb::Webhooks::CreditBlockAccountingSyncFailedStandardWebhookEvent,
+              Orb::Webhooks::CreditBlockAccountingSyncSucceededStandardWebhookEvent,
+              Orb::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent,
+              Orb::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent,
+              Orb::Webhooks::CreditNoteIssuedStandardWebhookEvent,
+              Orb::Webhooks::CreditNoteMarkedAsVoidStandardWebhookEvent,
+              Orb::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent,
+              Orb::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent,
+              Orb::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent,
+              Orb::Webhooks::CustomerCreatedStandardWebhookEvent,
+              Orb::Webhooks::CustomerCreditBalanceDepletedStandardWebhookEvent,
+              Orb::Webhooks::CustomerCreditBalanceDroppedStandardWebhookEvent,
+              Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent,
+              Orb::Webhooks::CustomerCreditLedgerIncrementedStandardWebhookEvent,
+              Orb::Webhooks::CustomerEditedStandardWebhookEvent,
+              Orb::Webhooks::DataExportsTransferErrorStandardWebhookEvent,
+              Orb::Webhooks::DataExportsTransferSuccessStandardWebhookEvent,
+              Orb::Webhooks::EventUnmatchedEventStandardWebhookEvent,
+              Orb::Webhooks::IngestionUnmatchedCustomerIDsStandardWebhookEvent,
+              Orb::Webhooks::InvoiceAccountingSyncFailedStandardWebhookEvent,
+              Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent,
+              Orb::Webhooks::InvoiceAutomationScheduleStepExecutedStandardWebhookEvent,
+              Orb::Webhooks::InvoiceCostDataExportedStandardWebhookEvent,
+              Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent,
+              Orb::Webhooks::InvoiceDunningScheduleEndedStandardWebhookEvent,
+              Orb::Webhooks::InvoiceDunningScheduleResetStandardWebhookEvent,
+              Orb::Webhooks::InvoiceDunningScheduleStepExecutedStandardWebhookEvent,
+              Orb::Webhooks::InvoiceEditedStandardWebhookEvent,
+              Orb::Webhooks::InvoiceInvoiceDateElapsedStandardWebhookEvent,
+              Orb::Webhooks::InvoiceIssueFailedStandardWebhookEvent,
+              Orb::Webhooks::InvoiceIssuedStandardWebhookEvent,
+              Orb::Webhooks::InvoiceIssuedSummaryStandardWebhookEvent,
+              Orb::Webhooks::InvoiceManuallyMarkedAsPaidStandardWebhookEvent,
+              Orb::Webhooks::InvoiceManuallyMarkedAsVoidStandardWebhookEvent,
+              Orb::Webhooks::InvoicePaymentFailedStandardWebhookEvent,
+              Orb::Webhooks::InvoicePaymentProcessingStandardWebhookEvent,
+              Orb::Webhooks::InvoicePaymentSucceededStandardWebhookEvent,
+              Orb::Webhooks::InvoiceSyncFailedStandardWebhookEvent,
+              Orb::Webhooks::InvoiceSyncSucceededStandardWebhookEvent,
+              Orb::Webhooks::InvoiceUndoMarkAsPaidStandardWebhookEvent,
+              Orb::Webhooks::InvoiceDueDateRecalculationCanceledStandardWebhookEvent,
+              Orb::Webhooks::InvoiceDueDateRecalculationCompletedStandardWebhookEvent,
+              Orb::Webhooks::InvoiceDueDateRecalculationStartedStandardWebhookEvent,
+              Orb::Webhooks::MetricEventsDroppedByWatermarkStandardWebhookEvent,
+              Orb::Webhooks::PaymentMethodCreatedStandardWebhookEvent,
+              Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent,
+              Orb::Webhooks::PlanCreatedStandardWebhookEvent,
+              Orb::Webhooks::PlanDefaultVersionSetStandardWebhookEvent,
+              Orb::Webhooks::PlanEditedStandardWebhookEvent,
+              Orb::Webhooks::PlanVersionCreatedStandardWebhookEvent,
+              Orb::Webhooks::PriceEditedStandardWebhookEvent,
+              Orb::Webhooks::ResourceEventTestStandardWebhookEvent,
+              Orb::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent,
+              Orb::Webhooks::SalesOrderAccountingSyncSucceededStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionAccountingSyncFailedStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionAccountingSyncSucceededStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionCancellationScheduledStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionCancellationUnscheduledStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionCostExceededStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionCreatedStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionEditedStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionEndedStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionFixedFeeQuantityUpdatedStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionGroupedCostExceededStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionLicenseBalanceThresholdReachedStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionPlanChangeScheduledStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionPlanChangedStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionPlanVersionChangeScheduledStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionPlanVersionChangedStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionSpendExceededStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionStartedStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionTrialEndedStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionUsageExceededStandardWebhookEvent,
+              Orb::Webhooks::TransactionAccountingSyncFailedStandardWebhookEvent,
+              Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent
+            )
+          end
+
+        sig do
+          override.returns(
+            T::Array[Orb::Webhooks::UnwrapStandardWebhookEvent::Variants]
+          )
+        end
+        def self.variants
+        end
+      end
+    end
+  end
+end

data/rbi/orb/models.rbi

@@ -914,5 +914,7 @@ module Orb
 
   WebhookEndpointWithSecret = Orb::Models::WebhookEndpointWithSecret
 
+  Webhooks = Orb::Models::Webhooks
+
   WebhookUnwrapParams = Orb::Models::WebhookUnwrapParams
 end