orb-billing 1.34.0 → 1.36.0

data/lib/orb/models/invoice_issued_webhook_event.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class InvoiceIssuedWebhookEvent < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of this webhook event.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The time at which this event was created, to the second.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute invoice
+      #   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.
+      #
+      #   @return [Orb::Models::Invoice]
+      required :invoice, -> { Orb::Invoice }
+
+      # @!attribute properties
+      #
+      #   @return [Orb::Models::InvoiceIssuedWebhookEvent::Properties]
+      required :properties, -> { Orb::InvoiceIssuedWebhookEvent::Properties }
+
+      # @!attribute type
+      #   The event this payload describes.
+      #
+      #   @return [Symbol, Orb::Models::InvoiceIssuedWebhookEvent::Type]
+      required :type, enum: -> { Orb::InvoiceIssuedWebhookEvent::Type }
+
+      # @!method initialize(id:, created_at:, invoice:, properties:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::InvoiceIssuedWebhookEvent} for more details.
+      #
+      #   Issued when an invoice transitions to the "issued" state.
+      #
+      #   @param id [String] The ID of this webhook event.
+      #
+      #   @param created_at [Time] The time at which this event was created, to the second.
+      #
+      #   @param invoice [Orb::Models::Invoice] An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, represen
+      #
+      #   @param properties [Orb::Models::InvoiceIssuedWebhookEvent::Properties]
+      #
+      #   @param type [Symbol, Orb::Models::InvoiceIssuedWebhookEvent::Type] The event this payload describes.
+
+      # @see Orb::Models::InvoiceIssuedWebhookEvent#properties
+      class Properties < Orb::Internal::Type::BaseModel
+        # @!attribute automatically_marked_as_paid
+        #
+        #   @return [Boolean]
+        required :automatically_marked_as_paid, Orb::Internal::Type::Boolean
+
+        # @!method initialize(automatically_marked_as_paid:)
+        #   @param automatically_marked_as_paid [Boolean]
+      end
+
+      # The event this payload describes.
+      #
+      # @see Orb::Models::InvoiceIssuedWebhookEvent#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        INVOICE_ISSUED = :"invoice.issued"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/invoice_manually_marked_as_paid_webhook_event.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class InvoiceManuallyMarkedAsPaidWebhookEvent < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of this webhook event.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The time at which this event was created, to the second.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute invoice
+      #   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.
+      #
+      #   @return [Orb::Models::Invoice]
+      required :invoice, -> { Orb::Invoice }
+
+      # @!attribute properties
+      #
+      #   @return [Orb::Models::InvoiceManuallyMarkedAsPaidWebhookEvent::Properties]
+      required :properties, -> { Orb::InvoiceManuallyMarkedAsPaidWebhookEvent::Properties }
+
+      # @!attribute type
+      #   The event this payload describes.
+      #
+      #   @return [Symbol, Orb::Models::InvoiceManuallyMarkedAsPaidWebhookEvent::Type]
+      required :type, enum: -> { Orb::InvoiceManuallyMarkedAsPaidWebhookEvent::Type }
+
+      # @!method initialize(id:, created_at:, invoice:, properties:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::InvoiceManuallyMarkedAsPaidWebhookEvent} for more details.
+      #
+      #   Issued when an invoice is manually marked as paid.
+      #
+      #   @param id [String] The ID of this webhook event.
+      #
+      #   @param created_at [Time] The time at which this event was created, to the second.
+      #
+      #   @param invoice [Orb::Models::Invoice] An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, represen
+      #
+      #   @param properties [Orb::Models::InvoiceManuallyMarkedAsPaidWebhookEvent::Properties]
+      #
+      #   @param type [Symbol, Orb::Models::InvoiceManuallyMarkedAsPaidWebhookEvent::Type] The event this payload describes.
+
+      # @see Orb::Models::InvoiceManuallyMarkedAsPaidWebhookEvent#properties
+      class Properties < Orb::Internal::Type::BaseModel
+        # @!attribute external_id
+        #
+        #   @return [String, nil]
+        required :external_id, String, nil?: true
+
+        # @!attribute notes
+        #
+        #   @return [String, nil]
+        required :notes, String, nil?: true
+
+        # @!attribute payment_received_date
+        #
+        #   @return [Time, nil]
+        required :payment_received_date, Time, nil?: true
+
+        # @!method initialize(external_id:, notes:, payment_received_date:)
+        #   @param external_id [String, nil]
+        #   @param notes [String, nil]
+        #   @param payment_received_date [Time, nil]
+      end
+
+      # The event this payload describes.
+      #
+      # @see Orb::Models::InvoiceManuallyMarkedAsPaidWebhookEvent#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        INVOICE_MANUALLY_MARKED_AS_PAID = :"invoice.manually_marked_as_paid"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/invoice_manually_marked_as_void_webhook_event.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class InvoiceManuallyMarkedAsVoidWebhookEvent < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of this webhook event.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The time at which this event was created, to the second.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute invoice
+      #   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.
+      #
+      #   @return [Orb::Models::Invoice]
+      required :invoice, -> { Orb::Invoice }
+
+      # @!attribute properties
+      #
+      #   @return [Object]
+      required :properties, Orb::Internal::Type::Unknown
+
+      # @!attribute type
+      #   The event this payload describes.
+      #
+      #   @return [Symbol, Orb::Models::InvoiceManuallyMarkedAsVoidWebhookEvent::Type]
+      required :type, enum: -> { Orb::InvoiceManuallyMarkedAsVoidWebhookEvent::Type }
+
+      # @!method initialize(id:, created_at:, invoice:, properties:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::InvoiceManuallyMarkedAsVoidWebhookEvent} for more details.
+      #
+      #   Issued when an invoice is marked as void.
+      #
+      #   @param id [String] The ID of this webhook event.
+      #
+      #   @param created_at [Time] The time at which this event was created, to the second.
+      #
+      #   @param invoice [Orb::Models::Invoice] An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, represen
+      #
+      #   @param properties [Object]
+      #
+      #   @param type [Symbol, Orb::Models::InvoiceManuallyMarkedAsVoidWebhookEvent::Type] The event this payload describes.
+
+      # The event this payload describes.
+      #
+      # @see Orb::Models::InvoiceManuallyMarkedAsVoidWebhookEvent#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        INVOICE_MANUALLY_MARKED_AS_VOID = :"invoice.manually_marked_as_void"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/invoice_payment_failed_webhook_event.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class InvoicePaymentFailedWebhookEvent < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of this webhook event.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The time at which this event was created, to the second.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute invoice
+      #   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.
+      #
+      #   @return [Orb::Models::Invoice]
+      required :invoice, -> { Orb::Invoice }
+
+      # @!attribute properties
+      #
+      #   @return [Orb::Models::InvoicePaymentFailedWebhookEvent::Properties]
+      required :properties, -> { Orb::InvoicePaymentFailedWebhookEvent::Properties }
+
+      # @!attribute type
+      #   The event this payload describes.
+      #
+      #   @return [Symbol, Orb::Models::InvoicePaymentFailedWebhookEvent::Type]
+      required :type, enum: -> { Orb::InvoicePaymentFailedWebhookEvent::Type }
+
+      # @!method initialize(id:, created_at:, invoice:, properties:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::InvoicePaymentFailedWebhookEvent} for more details.
+      #
+      #   Issued when automated payment collection for an invoice fails for a configured
+      #   payment gateway.
+      #
+      #   @param id [String] The ID of this webhook event.
+      #
+      #   @param created_at [Time] The time at which this event was created, to the second.
+      #
+      #   @param invoice [Orb::Models::Invoice] An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, represen
+      #
+      #   @param properties [Orb::Models::InvoicePaymentFailedWebhookEvent::Properties]
+      #
+      #   @param type [Symbol, Orb::Models::InvoicePaymentFailedWebhookEvent::Type] The event this payload describes.
+
+      # @see Orb::Models::InvoicePaymentFailedWebhookEvent#properties
+      class Properties < Orb::Internal::Type::BaseModel
+        # @!attribute payment_provider
+        #
+        #   @return [String, nil]
+        required :payment_provider, String, nil?: true
+
+        # @!attribute payment_provider_id
+        #
+        #   @return [String, nil]
+        required :payment_provider_id, String, nil?: true
+
+        # @!attribute payment_provider_transaction_id
+        #
+        #   @return [String, nil]
+        required :payment_provider_transaction_id, String, nil?: true
+
+        # @!method initialize(payment_provider:, payment_provider_id:, payment_provider_transaction_id:)
+        #   @param payment_provider [String, nil]
+        #   @param payment_provider_id [String, nil]
+        #   @param payment_provider_transaction_id [String, nil]
+      end
+
+      # The event this payload describes.
+      #
+      # @see Orb::Models::InvoicePaymentFailedWebhookEvent#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        INVOICE_PAYMENT_FAILED = :"invoice.payment_failed"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/invoice_payment_processing_webhook_event.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class InvoicePaymentProcessingWebhookEvent < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of this webhook event.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The time at which this event was created, to the second.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute invoice
+      #   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.
+      #
+      #   @return [Orb::Models::Invoice]
+      required :invoice, -> { Orb::Invoice }
+
+      # @!attribute properties
+      #
+      #   @return [Orb::Models::InvoicePaymentProcessingWebhookEvent::Properties]
+      required :properties, -> { Orb::InvoicePaymentProcessingWebhookEvent::Properties }
+
+      # @!attribute type
+      #   The event this payload describes.
+      #
+      #   @return [Symbol, Orb::Models::InvoicePaymentProcessingWebhookEvent::Type]
+      required :type, enum: -> { Orb::InvoicePaymentProcessingWebhookEvent::Type }
+
+      # @!method initialize(id:, created_at:, invoice:, properties:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::InvoicePaymentProcessingWebhookEvent} for more details.
+      #
+      #   Issued when an invoice payment is being processed.
+      #
+      #   @param id [String] The ID of this webhook event.
+      #
+      #   @param created_at [Time] The time at which this event was created, to the second.
+      #
+      #   @param invoice [Orb::Models::Invoice] An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, represen
+      #
+      #   @param properties [Orb::Models::InvoicePaymentProcessingWebhookEvent::Properties]
+      #
+      #   @param type [Symbol, Orb::Models::InvoicePaymentProcessingWebhookEvent::Type] The event this payload describes.
+
+      # @see Orb::Models::InvoicePaymentProcessingWebhookEvent#properties
+      class Properties < Orb::Internal::Type::BaseModel
+        # @!attribute payment_provider_id
+        #
+        #   @return [String, nil]
+        required :payment_provider_id, String, nil?: true
+
+        # @!attribute payment_provider
+        #
+        #   @return [String, nil]
+        optional :payment_provider, String
+
+        # @!method initialize(payment_provider_id:, payment_provider: nil)
+        #   @param payment_provider_id [String, nil]
+        #   @param payment_provider [String]
+      end
+
+      # The event this payload describes.
+      #
+      # @see Orb::Models::InvoicePaymentProcessingWebhookEvent#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        INVOICE_PAYMENT_PROCESSING = :"invoice.payment_processing"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/invoice_payment_succeeded_webhook_event.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class InvoicePaymentSucceededWebhookEvent < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of this webhook event.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The time at which this event was created, to the second.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute invoice
+      #   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.
+      #
+      #   @return [Orb::Models::Invoice]
+      required :invoice, -> { Orb::Invoice }
+
+      # @!attribute properties
+      #   `shared_payment_token_id` is only on the wire when the payment used one.
+      #
+      #   @return [Orb::Models::InvoicePaymentSucceededWebhookEvent::Properties]
+      required :properties, -> { Orb::InvoicePaymentSucceededWebhookEvent::Properties }
+
+      # @!attribute type
+      #   The event this payload describes.
+      #
+      #   @return [Symbol, Orb::Models::InvoicePaymentSucceededWebhookEvent::Type]
+      required :type, enum: -> { Orb::InvoicePaymentSucceededWebhookEvent::Type }
+
+      # @!method initialize(id:, created_at:, invoice:, properties:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::InvoicePaymentSucceededWebhookEvent} for more details.
+      #
+      #   Issued when automated payment collection for an invoice succeeds for a
+      #   configured payment gateway.
+      #
+      #   @param id [String] The ID of this webhook event.
+      #
+      #   @param created_at [Time] The time at which this event was created, to the second.
+      #
+      #   @param invoice [Orb::Models::Invoice] An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, represen
+      #
+      #   @param properties [Orb::Models::InvoicePaymentSucceededWebhookEvent::Properties] `shared_payment_token_id` is only on the wire when the payment used one.
+      #
+      #   @param type [Symbol, Orb::Models::InvoicePaymentSucceededWebhookEvent::Type] The event this payload describes.
+
+      # @see Orb::Models::InvoicePaymentSucceededWebhookEvent#properties
+      class Properties < Orb::Internal::Type::BaseModel
+        # @!attribute payment_provider
+        #
+        #   @return [String, nil]
+        required :payment_provider, String, nil?: true
+
+        # @!attribute payment_provider_id
+        #
+        #   @return [String, nil]
+        required :payment_provider_id, String, nil?: true
+
+        # @!attribute payment_provider_transaction_id
+        #
+        #   @return [String, nil]
+        required :payment_provider_transaction_id, String, nil?: true
+
+        # @!attribute shared_payment_token_id
+        #
+        #   @return [String, nil]
+        optional :shared_payment_token_id, String, nil?: true
+
+        # @!method initialize(payment_provider:, payment_provider_id:, payment_provider_transaction_id:, shared_payment_token_id: nil)
+        #   `shared_payment_token_id` is only on the wire when the payment used one.
+        #
+        #   @param payment_provider [String, nil]
+        #   @param payment_provider_id [String, nil]
+        #   @param payment_provider_transaction_id [String, nil]
+        #   @param shared_payment_token_id [String, nil]
+      end
+
+      # The event this payload describes.
+      #
+      # @see Orb::Models::InvoicePaymentSucceededWebhookEvent#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        INVOICE_PAYMENT_SUCCEEDED = :"invoice.payment_succeeded"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/invoice_sync_failed_webhook_event.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class InvoiceSyncFailedWebhookEvent < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of this webhook event.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The time at which this event was created, to the second.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute invoice
+      #   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.
+      #
+      #   @return [Orb::Models::Invoice]
+      required :invoice, -> { Orb::Invoice }
+
+      # @!attribute properties
+      #
+      #   @return [Orb::Models::InvoiceSyncFailedWebhookEvent::Properties]
+      required :properties, -> { Orb::InvoiceSyncFailedWebhookEvent::Properties }
+
+      # @!attribute type
+      #   The event this payload describes.
+      #
+      #   @return [Symbol, Orb::Models::InvoiceSyncFailedWebhookEvent::Type]
+      required :type, enum: -> { Orb::InvoiceSyncFailedWebhookEvent::Type }
+
+      # @!method initialize(id:, created_at:, invoice:, properties:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::InvoiceSyncFailedWebhookEvent} for more details.
+      #
+      #   Issued when an invoice sync fails.
+      #
+      #   @param id [String] The ID of this webhook event.
+      #
+      #   @param created_at [Time] The time at which this event was created, to the second.
+      #
+      #   @param invoice [Orb::Models::Invoice] An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, represen
+      #
+      #   @param properties [Orb::Models::InvoiceSyncFailedWebhookEvent::Properties]
+      #
+      #   @param type [Symbol, Orb::Models::InvoiceSyncFailedWebhookEvent::Type] The event this payload describes.
+
+      # @see Orb::Models::InvoiceSyncFailedWebhookEvent#properties
+      class Properties < Orb::Internal::Type::BaseModel
+        # @!attribute payment_provider
+        #
+        #   @return [String, nil]
+        required :payment_provider, String, nil?: true
+
+        # @!attribute payment_provider_id
+        #
+        #   @return [String, nil]
+        required :payment_provider_id, String, nil?: true
+
+        # @!method initialize(payment_provider:, payment_provider_id:)
+        #   @param payment_provider [String, nil]
+        #   @param payment_provider_id [String, nil]
+      end
+
+      # The event this payload describes.
+      #
+      # @see Orb::Models::InvoiceSyncFailedWebhookEvent#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        INVOICE_SYNC_FAILED = :"invoice.sync_failed"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/invoice_sync_succeeded_webhook_event.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class InvoiceSyncSucceededWebhookEvent < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of this webhook event.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The time at which this event was created, to the second.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute invoice
+      #   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.
+      #
+      #   @return [Orb::Models::Invoice]
+      required :invoice, -> { Orb::Invoice }
+
+      # @!attribute properties
+      #
+      #   @return [Orb::Models::InvoiceSyncSucceededWebhookEvent::Properties]
+      required :properties, -> { Orb::InvoiceSyncSucceededWebhookEvent::Properties }
+
+      # @!attribute type
+      #   The event this payload describes.
+      #
+      #   @return [Symbol, Orb::Models::InvoiceSyncSucceededWebhookEvent::Type]
+      required :type, enum: -> { Orb::InvoiceSyncSucceededWebhookEvent::Type }
+
+      # @!method initialize(id:, created_at:, invoice:, properties:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::InvoiceSyncSucceededWebhookEvent} for more details.
+      #
+      #   Issued when an invoice sync succeeds.
+      #
+      #   @param id [String] The ID of this webhook event.
+      #
+      #   @param created_at [Time] The time at which this event was created, to the second.
+      #
+      #   @param invoice [Orb::Models::Invoice] An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, represen
+      #
+      #   @param properties [Orb::Models::InvoiceSyncSucceededWebhookEvent::Properties]
+      #
+      #   @param type [Symbol, Orb::Models::InvoiceSyncSucceededWebhookEvent::Type] The event this payload describes.
+
+      # @see Orb::Models::InvoiceSyncSucceededWebhookEvent#properties
+      class Properties < Orb::Internal::Type::BaseModel
+        # @!attribute payment_provider
+        #
+        #   @return [String, nil]
+        required :payment_provider, String, nil?: true
+
+        # @!attribute payment_provider_id
+        #
+        #   @return [String, nil]
+        required :payment_provider_id, String, nil?: true
+
+        # @!method initialize(payment_provider:, payment_provider_id:)
+        #   @param payment_provider [String, nil]
+        #   @param payment_provider_id [String, nil]
+      end
+
+      # The event this payload describes.
+      #
+      # @see Orb::Models::InvoiceSyncSucceededWebhookEvent#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        INVOICE_SYNC_SUCCEEDED = :"invoice.sync_succeeded"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end