orb-billing 1.34.0 → 1.36.0

data/rbi/orb/models/transaction_accounting_sync_succeeded_webhook_event.rbi

@@ -0,0 +1,449 @@
+# typed: strong
+
+module Orb
+  module Models
+    class TransactionAccountingSyncSucceededWebhookEvent < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Orb::TransactionAccountingSyncSucceededWebhookEvent,
+            Orb::Internal::AnyHash
+          )
+        end
+
+      # The ID of this webhook event.
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig do
+        returns(
+          Orb::TransactionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord
+        )
+      end
+      attr_reader :accounting_sync_record
+
+      sig do
+        params(
+          accounting_sync_record:
+            Orb::TransactionAccountingSyncSucceededWebhookEvent::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
+
+      sig do
+        returns(Orb::TransactionAccountingSyncSucceededWebhookEvent::Properties)
+      end
+      attr_reader :properties
+
+      sig do
+        params(
+          properties:
+            Orb::TransactionAccountingSyncSucceededWebhookEvent::Properties::OrHash
+        ).void
+      end
+      attr_writer :properties
+
+      sig do
+        returns(
+          Orb::TransactionAccountingSyncSucceededWebhookEvent::Transaction
+        )
+      end
+      attr_reader :transaction
+
+      sig do
+        params(
+          transaction:
+            Orb::TransactionAccountingSyncSucceededWebhookEvent::Transaction::OrHash
+        ).void
+      end
+      attr_writer :transaction
+
+      # The event this payload describes.
+      sig do
+        returns(
+          Orb::TransactionAccountingSyncSucceededWebhookEvent::Type::TaggedSymbol
+        )
+      end
+      attr_accessor :type
+
+      # Issued when a transaction accounting sync succeeds.
+      sig do
+        params(
+          id: String,
+          accounting_sync_record:
+            Orb::TransactionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::OrHash,
+          created_at: Time,
+          properties:
+            Orb::TransactionAccountingSyncSucceededWebhookEvent::Properties::OrHash,
+          transaction:
+            Orb::TransactionAccountingSyncSucceededWebhookEvent::Transaction::OrHash,
+          type:
+            Orb::TransactionAccountingSyncSucceededWebhookEvent::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:,
+        properties:,
+        transaction:,
+        # The event this payload describes.
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            accounting_sync_record:
+              Orb::TransactionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord,
+            created_at: Time,
+            properties:
+              Orb::TransactionAccountingSyncSucceededWebhookEvent::Properties,
+            transaction:
+              Orb::TransactionAccountingSyncSucceededWebhookEvent::Transaction,
+            type:
+              Orb::TransactionAccountingSyncSucceededWebhookEvent::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class AccountingSyncRecord < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::TransactionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(String) }
+        attr_accessor :customer_id
+
+        sig do
+          returns(
+            Orb::TransactionAccountingSyncSucceededWebhookEvent::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::TransactionAccountingSyncSucceededWebhookEvent::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::TransactionAccountingSyncSucceededWebhookEvent::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::TransactionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          CUSTOMER =
+            T.let(
+              :customer,
+              Orb::TransactionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+            )
+          INVOICE =
+            T.let(
+              :invoice,
+              Orb::TransactionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+            )
+          TRANSACTION =
+            T.let(
+              :transaction,
+              Orb::TransactionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+            )
+          CUSTOMER_BALANCE_TRANSACTION =
+            T.let(
+              :customer_balance_transaction,
+              Orb::TransactionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+            )
+          CREDIT_NOTE =
+            T.let(
+              :credit_note,
+              Orb::TransactionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+            )
+          SUBSCRIPTION =
+            T.let(
+              :subscription,
+              Orb::TransactionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+            )
+          SALES_ORDER =
+            T.let(
+              :sales_order,
+              Orb::TransactionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+            )
+          BLOCK =
+            T.let(
+              :block,
+              Orb::TransactionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::TransactionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      class Properties < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::TransactionAccountingSyncSucceededWebhookEvent::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::TransactionAccountingSyncSucceededWebhookEvent::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::TransactionAccountingSyncSucceededWebhookEvent::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::TransactionAccountingSyncSucceededWebhookEvent::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::TransactionAccountingSyncSucceededWebhookEvent::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::TransactionAccountingSyncSucceededWebhookEvent::Transaction::PaymentProvider
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          STRIPE =
+            T.let(
+              :stripe,
+              Orb::TransactionAccountingSyncSucceededWebhookEvent::Transaction::PaymentProvider::TaggedSymbol
+            )
+          ADYEN =
+            T.let(
+              :adyen,
+              Orb::TransactionAccountingSyncSucceededWebhookEvent::Transaction::PaymentProvider::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::TransactionAccountingSyncSucceededWebhookEvent::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::TransactionAccountingSyncSucceededWebhookEvent::Type
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TRANSACTION_ACCOUNTING_SYNC_SUCCEEDED =
+          T.let(
+            :"transaction.accounting_sync_succeeded",
+            Orb::TransactionAccountingSyncSucceededWebhookEvent::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Orb::TransactionAccountingSyncSucceededWebhookEvent::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/orb/models/unwrap_webhook_event.rbi

@@ -0,0 +1,99 @@
+# typed: strong
+
+module Orb
+  module Models
+    # Issued when a backfill is closed and its events are reflected into usage.
+    module UnwrapWebhookEvent
+      extend Orb::Internal::Type::Union
+
+      Variants =
+        T.type_alias do
+          T.any(
+            Orb::BackfillReflectedWebhookEvent,
+            Orb::BackfillRevertedWebhookEvent,
+            Orb::BillableMetricEditedWebhookEvent,
+            Orb::CreditBlockAccountingSyncFailedWebhookEvent,
+            Orb::CreditBlockAccountingSyncSucceededWebhookEvent,
+            Orb::CreditNoteAccountingSyncFailedWebhookEvent,
+            Orb::CreditNoteAccountingSyncSucceededWebhookEvent,
+            Orb::CreditNoteIssuedWebhookEvent,
+            Orb::CreditNoteMarkedAsVoidWebhookEvent,
+            Orb::CustomerAccountingSyncFailedWebhookEvent,
+            Orb::CustomerAccountingSyncSucceededWebhookEvent,
+            Orb::CustomerBalanceTransactionCreatedWebhookEvent,
+            Orb::CustomerCreatedWebhookEvent,
+            Orb::CustomerCreditBalanceDepletedWebhookEvent,
+            Orb::CustomerCreditBalanceDroppedWebhookEvent,
+            Orb::CustomerCreditBalanceRecoveredWebhookEvent,
+            Orb::CustomerCreditLedgerIncrementedWebhookEvent,
+            Orb::CustomerEditedWebhookEvent,
+            Orb::DataExportsTransferErrorWebhookEvent,
+            Orb::DataExportsTransferSuccessWebhookEvent,
+            Orb::EventUnmatchedEventWebhookEvent,
+            Orb::IngestionUnmatchedCustomerIDsWebhookEvent,
+            Orb::InvoiceAccountingSyncFailedWebhookEvent,
+            Orb::InvoiceAccountingSyncSucceededWebhookEvent,
+            Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent,
+            Orb::InvoiceCostDataExportedWebhookEvent,
+            Orb::InvoiceDunningScheduleCreatedWebhookEvent,
+            Orb::InvoiceDunningScheduleEndedWebhookEvent,
+            Orb::InvoiceDunningScheduleResetWebhookEvent,
+            Orb::InvoiceDunningScheduleStepExecutedWebhookEvent,
+            Orb::InvoiceEditedWebhookEvent,
+            Orb::InvoiceInvoiceDateElapsedWebhookEvent,
+            Orb::InvoiceIssueFailedWebhookEvent,
+            Orb::InvoiceIssuedWebhookEvent,
+            Orb::InvoiceIssuedSummaryWebhookEvent,
+            Orb::InvoiceManuallyMarkedAsPaidWebhookEvent,
+            Orb::InvoiceManuallyMarkedAsVoidWebhookEvent,
+            Orb::InvoicePaymentFailedWebhookEvent,
+            Orb::InvoicePaymentProcessingWebhookEvent,
+            Orb::InvoicePaymentSucceededWebhookEvent,
+            Orb::InvoiceSyncFailedWebhookEvent,
+            Orb::InvoiceSyncSucceededWebhookEvent,
+            Orb::InvoiceUndoMarkAsPaidWebhookEvent,
+            Orb::InvoiceDueDateRecalculationCanceledWebhookEvent,
+            Orb::InvoiceDueDateRecalculationCompletedWebhookEvent,
+            Orb::InvoiceDueDateRecalculationStartedWebhookEvent,
+            Orb::MetricEventsDroppedByWatermarkWebhookEvent,
+            Orb::PaymentMethodCreatedWebhookEvent,
+            Orb::PaymentMethodDeletedWebhookEvent,
+            Orb::PlanDefaultVersionSetWebhookEvent,
+            Orb::PlanVersionCreatedWebhookEvent,
+            Orb::PriceEditedWebhookEvent,
+            Orb::ResourceEventTestWebhookEvent,
+            Orb::SalesOrderAccountingSyncFailedWebhookEvent,
+            Orb::SalesOrderAccountingSyncSucceededWebhookEvent,
+            Orb::SubscriptionAccountingSyncFailedWebhookEvent,
+            Orb::SubscriptionAccountingSyncSucceededWebhookEvent,
+            Orb::SubscriptionAlertDisabledWebhookEvent,
+            Orb::SubscriptionCancellationScheduledWebhookEvent,
+            Orb::SubscriptionCancellationUnscheduledWebhookEvent,
+            Orb::SubscriptionCostExceededWebhookEvent,
+            Orb::SubscriptionCreatedWebhookEvent,
+            Orb::SubscriptionEditedWebhookEvent,
+            Orb::SubscriptionEndedWebhookEvent,
+            Orb::SubscriptionFixedFeeQuantityUpdatedWebhookEvent,
+            Orb::SubscriptionGroupedCostExceededWebhookEvent,
+            Orb::SubscriptionInvoicingThresholdExceededWebhookEvent,
+            Orb::SubscriptionLicenseAllocationResetWebhookEvent,
+            Orb::SubscriptionLicenseBalanceThresholdReachedWebhookEvent,
+            Orb::SubscriptionPlanChangeScheduledWebhookEvent,
+            Orb::SubscriptionPlanChangedWebhookEvent,
+            Orb::SubscriptionPlanVersionChangeScheduledWebhookEvent,
+            Orb::SubscriptionPlanVersionChangedWebhookEvent,
+            Orb::SubscriptionSpendExceededWebhookEvent,
+            Orb::SubscriptionStartedWebhookEvent,
+            Orb::SubscriptionTrialEndedWebhookEvent,
+            Orb::SubscriptionUsageExceededWebhookEvent,
+            Orb::TransactionAccountingSyncFailedWebhookEvent,
+            Orb::TransactionAccountingSyncSucceededWebhookEvent
+          )
+        end
+
+      sig { override.returns(T::Array[Orb::UnwrapWebhookEvent::Variants]) }
+      def self.variants
+      end
+    end
+  end
+end

data/rbi/orb/models/webhook_unwrap_params.rbi

@@ -0,0 +1,25 @@
+# typed: strong
+
+module Orb
+  module Models
+    class WebhookUnwrapParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias { T.any(Orb::WebhookUnwrapParams, Orb::Internal::AnyHash) }
+
+      sig do
+        params(request_options: Orb::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Orb::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end