orb-billing 1.34.0 → 1.36.0

data/rbi/orb/models/subscription_accounting_sync_succeeded_webhook_event.rbi

@@ -0,0 +1,346 @@
+# typed: strong
+
+module Orb
+  module Models
+    class SubscriptionAccountingSyncSucceededWebhookEvent < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Orb::SubscriptionAccountingSyncSucceededWebhookEvent,
+            Orb::Internal::AnyHash
+          )
+        end
+
+      # The ID of this webhook event.
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig do
+        returns(
+          Orb::SubscriptionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord
+        )
+      end
+      attr_reader :accounting_sync_record
+
+      sig do
+        params(
+          accounting_sync_record:
+            Orb::SubscriptionAccountingSyncSucceededWebhookEvent::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::SubscriptionAccountingSyncSucceededWebhookEvent::Properties
+        )
+      end
+      attr_reader :properties
+
+      sig do
+        params(
+          properties:
+            Orb::SubscriptionAccountingSyncSucceededWebhookEvent::Properties::OrHash
+        ).void
+      end
+      attr_writer :properties
+
+      # A [subscription](/core-concepts#subscription) represents the purchase of a plan
+      # by a customer.
+      #
+      # By default, subscriptions begin on the day that they're created and renew
+      # automatically for each billing cycle at the cadence that's configured in the
+      # plan definition.
+      #
+      # Subscriptions also default to **beginning of month alignment**, which means the
+      # first invoice issued for the subscription will have pro-rated charges between
+      # the `start_date` and the first of the following month. Subsequent billing
+      # periods will always start and end on a month boundary (e.g. subsequent month
+      # starts for monthly billing).
+      #
+      # Depending on the plan configuration, any _flat_ recurring fees will be billed
+      # either at the beginning (in-advance) or end (in-arrears) of each billing cycle.
+      # Plans default to **in-advance billing**. Usage-based fees are billed in arrears
+      # as usage is accumulated. In the normal course of events, you can expect an
+      # invoice to contain usage-based charges for the previous period, and a recurring
+      # fee for the following period.
+      sig { returns(Orb::Subscription) }
+      attr_reader :subscription
+
+      sig { params(subscription: Orb::Subscription::OrHash).void }
+      attr_writer :subscription
+
+      # The event this payload describes.
+      sig do
+        returns(
+          Orb::SubscriptionAccountingSyncSucceededWebhookEvent::Type::TaggedSymbol
+        )
+      end
+      attr_accessor :type
+
+      # Issued when a subscription accounting sync succeeds.
+      sig do
+        params(
+          id: String,
+          accounting_sync_record:
+            Orb::SubscriptionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::OrHash,
+          created_at: Time,
+          properties:
+            Orb::SubscriptionAccountingSyncSucceededWebhookEvent::Properties::OrHash,
+          subscription: Orb::Subscription::OrHash,
+          type:
+            Orb::SubscriptionAccountingSyncSucceededWebhookEvent::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:,
+        # A [subscription](/core-concepts#subscription) represents the purchase of a plan
+        # by a customer.
+        #
+        # By default, subscriptions begin on the day that they're created and renew
+        # automatically for each billing cycle at the cadence that's configured in the
+        # plan definition.
+        #
+        # Subscriptions also default to **beginning of month alignment**, which means the
+        # first invoice issued for the subscription will have pro-rated charges between
+        # the `start_date` and the first of the following month. Subsequent billing
+        # periods will always start and end on a month boundary (e.g. subsequent month
+        # starts for monthly billing).
+        #
+        # Depending on the plan configuration, any _flat_ recurring fees will be billed
+        # either at the beginning (in-advance) or end (in-arrears) of each billing cycle.
+        # Plans default to **in-advance billing**. Usage-based fees are billed in arrears
+        # as usage is accumulated. In the normal course of events, you can expect an
+        # invoice to contain usage-based charges for the previous period, and a recurring
+        # fee for the following period.
+        subscription:,
+        # The event this payload describes.
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            accounting_sync_record:
+              Orb::SubscriptionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord,
+            created_at: Time,
+            properties:
+              Orb::SubscriptionAccountingSyncSucceededWebhookEvent::Properties,
+            subscription: Orb::Subscription,
+            type:
+              Orb::SubscriptionAccountingSyncSucceededWebhookEvent::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class AccountingSyncRecord < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::SubscriptionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(String) }
+        attr_accessor :customer_id
+
+        sig do
+          returns(
+            Orb::SubscriptionAccountingSyncSucceededWebhookEvent::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 :subscription_id
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :sync_action
+
+        sig do
+          params(
+            id: String,
+            customer_id: String,
+            record_type:
+              Orb::SubscriptionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType::OrSymbol,
+            error_details: T.nilable(T::Hash[Symbol, T.anything]),
+            provider_customer_id: T.nilable(String),
+            status: T.nilable(String),
+            subscription_id: T.nilable(String),
+            sync_action: 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,
+          subscription_id: nil,
+          sync_action: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              customer_id: String,
+              record_type:
+                Orb::SubscriptionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol,
+              error_details: T.nilable(T::Hash[Symbol, T.anything]),
+              provider_customer_id: T.nilable(String),
+              status: T.nilable(String),
+              subscription_id: 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::SubscriptionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          CUSTOMER =
+            T.let(
+              :customer,
+              Orb::SubscriptionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+            )
+          INVOICE =
+            T.let(
+              :invoice,
+              Orb::SubscriptionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+            )
+          TRANSACTION =
+            T.let(
+              :transaction,
+              Orb::SubscriptionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+            )
+          CUSTOMER_BALANCE_TRANSACTION =
+            T.let(
+              :customer_balance_transaction,
+              Orb::SubscriptionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+            )
+          CREDIT_NOTE =
+            T.let(
+              :credit_note,
+              Orb::SubscriptionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+            )
+          SUBSCRIPTION =
+            T.let(
+              :subscription,
+              Orb::SubscriptionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+            )
+          SALES_ORDER =
+            T.let(
+              :sales_order,
+              Orb::SubscriptionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+            )
+          BLOCK =
+            T.let(
+              :block,
+              Orb::SubscriptionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::SubscriptionAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      class Properties < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::SubscriptionAccountingSyncSucceededWebhookEvent::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
+
+      # The event this payload describes.
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Orb::SubscriptionAccountingSyncSucceededWebhookEvent::Type
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        SUBSCRIPTION_ACCOUNTING_SYNC_SUCCEEDED =
+          T.let(
+            :"subscription.accounting_sync_succeeded",
+            Orb::SubscriptionAccountingSyncSucceededWebhookEvent::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Orb::SubscriptionAccountingSyncSucceededWebhookEvent::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end