orb-billing 1.45.0 → 1.46.0

data/lib/orb/models/webhooks/credit_note_accounting_sync_failed_standard_webhook_event.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Webhooks
+      class CreditNoteAccountingSyncFailedStandardWebhookEvent < Orb::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of this webhook event.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute accounting_sync_record
+        #
+        #   @return [Orb::Models::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent::AccountingSyncRecord]
+        required :accounting_sync_record,
+                 -> { Orb::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent::AccountingSyncRecord }
+
+        # @!attribute created_at
+        #   The time at which this event was created, to the second.
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute credit_note
+        #   The [Credit Note](/invoicing/credit-notes) resource represents a credit that has
+        #   been applied to a particular invoice.
+        #
+        #   @return [Orb::Models::CreditNote]
+        required :credit_note, -> { Orb::CreditNote }
+
+        # @!attribute payload_style
+        #   The serialization style this payload was rendered in, as configured on the
+        #   endpoint.
+        #
+        #   @return [Symbol, Orb::Models::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent::PayloadStyle]
+        required :payload_style,
+                 enum: -> { Orb::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent::PayloadStyle }
+
+        # @!attribute properties
+        #
+        #   @return [Orb::Models::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent::Properties]
+        required :properties, -> { Orb::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent::Properties }
+
+        # @!attribute type
+        #   The event this payload describes.
+        #
+        #   @return [Symbol, Orb::Models::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent::Type]
+        required :type, enum: -> { Orb::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent::Type }
+
+        # @!method initialize(id:, accounting_sync_record:, created_at:, credit_note:, payload_style:, properties:, type:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent} for
+        #   more details.
+        #
+        #   Issued when a credit note accounting sync fails.
+        #
+        #   @param id [String] The ID of this webhook event.
+        #
+        #   @param accounting_sync_record [Orb::Models::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent::AccountingSyncRecord]
+        #
+        #   @param created_at [Time] The time at which this event was created, to the second.
+        #
+        #   @param credit_note [Orb::Models::CreditNote] The [Credit Note](/invoicing/credit-notes) resource represents a credit that has
+        #
+        #   @param payload_style [Symbol, Orb::Models::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
+        #
+        #   @param properties [Orb::Models::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent::Properties]
+        #
+        #   @param type [Symbol, Orb::Models::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent::Type] The event this payload describes.
+
+        # @see Orb::Models::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent#accounting_sync_record
+        class AccountingSyncRecord < Orb::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute customer_id
+          #
+          #   @return [String]
+          required :customer_id, String
+
+          # @!attribute record_type
+          #
+          #   @return [Symbol, Orb::Models::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent::AccountingSyncRecord::RecordType]
+          required :record_type,
+                   enum: -> { Orb::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent::AccountingSyncRecord::RecordType }
+
+          # @!attribute credit_note_id
+          #
+          #   @return [String, nil]
+          optional :credit_note_id, String, nil?: true
+
+          # @!attribute error_details
+          #
+          #   @return [Hash{Symbol=>Object}, nil]
+          optional :error_details, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown], nil?: true
+
+          # @!attribute provider_customer_id
+          #
+          #   @return [String, nil]
+          optional :provider_customer_id, String, nil?: true
+
+          # @!attribute status
+          #
+          #   @return [String, nil]
+          optional :status, String, nil?: true
+
+          # @!attribute sync_action
+          #
+          #   @return [String, nil]
+          optional :sync_action, String, nil?: true
+
+          # @!method initialize(id:, customer_id:, record_type:, credit_note_id: nil, error_details: nil, provider_customer_id: nil, status: nil, sync_action: nil)
+          #   @param id [String]
+          #   @param customer_id [String]
+          #   @param record_type [Symbol, Orb::Models::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent::AccountingSyncRecord::RecordType]
+          #   @param credit_note_id [String, nil]
+          #   @param error_details [Hash{Symbol=>Object}, nil]
+          #   @param provider_customer_id [String, nil]
+          #   @param status [String, nil]
+          #   @param sync_action [String, nil]
+
+          # @see Orb::Models::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent::AccountingSyncRecord#record_type
+          module RecordType
+            extend Orb::Internal::Type::Enum
+
+            CUSTOMER = :customer
+            INVOICE = :invoice
+            TRANSACTION = :transaction
+            CUSTOMER_BALANCE_TRANSACTION = :customer_balance_transaction
+            CREDIT_NOTE = :credit_note
+            SUBSCRIPTION = :subscription
+            SALES_ORDER = :sales_order
+            BLOCK = :block
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # The serialization style this payload was rendered in, as configured on the
+        # endpoint.
+        #
+        # @see Orb::Models::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent#payload_style
+        module PayloadStyle
+          extend Orb::Internal::Type::Enum
+
+          EXPANDED = :expanded
+          STANDARD = :standard
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Orb::Models::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent#properties
+        class Properties < Orb::Internal::Type::BaseModel
+          # @!attribute connection_type
+          #
+          #   @return [String]
+          required :connection_type, String
+
+          # @!attribute failure_reason
+          #
+          #   @return [String]
+          required :failure_reason, String
+
+          # @!method initialize(connection_type:, failure_reason:)
+          #   @param connection_type [String]
+          #   @param failure_reason [String]
+        end
+
+        # The event this payload describes.
+        #
+        # @see Orb::Models::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent#type
+        module Type
+          extend Orb::Internal::Type::Enum
+
+          CREDIT_NOTE_ACCOUNTING_SYNC_FAILED = :"credit_note.accounting_sync_failed"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/orb/models/webhooks/credit_note_accounting_sync_succeeded_standard_webhook_event.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Webhooks
+      class CreditNoteAccountingSyncSucceededStandardWebhookEvent < Orb::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of this webhook event.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute accounting_sync_record
+        #
+        #   @return [Orb::Models::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord]
+        required :accounting_sync_record,
+                 -> { Orb::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord }
+
+        # @!attribute created_at
+        #   The time at which this event was created, to the second.
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute credit_note
+        #   The [Credit Note](/invoicing/credit-notes) resource represents a credit that has
+        #   been applied to a particular invoice.
+        #
+        #   @return [Orb::Models::CreditNote]
+        required :credit_note, -> { Orb::CreditNote }
+
+        # @!attribute payload_style
+        #   The serialization style this payload was rendered in, as configured on the
+        #   endpoint.
+        #
+        #   @return [Symbol, Orb::Models::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent::PayloadStyle]
+        required :payload_style,
+                 enum: -> { Orb::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent::PayloadStyle }
+
+        # @!attribute properties
+        #
+        #   @return [Orb::Models::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent::Properties]
+        required :properties,
+                 -> { Orb::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent::Properties }
+
+        # @!attribute type
+        #   The event this payload describes.
+        #
+        #   @return [Symbol, Orb::Models::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent::Type]
+        required :type, enum: -> { Orb::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent::Type }
+
+        # @!method initialize(id:, accounting_sync_record:, created_at:, credit_note:, payload_style:, properties:, type:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent}
+        #   for more details.
+        #
+        #   Issued when a credit note accounting sync succeeds.
+        #
+        #   @param id [String] The ID of this webhook event.
+        #
+        #   @param accounting_sync_record [Orb::Models::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord]
+        #
+        #   @param created_at [Time] The time at which this event was created, to the second.
+        #
+        #   @param credit_note [Orb::Models::CreditNote] The [Credit Note](/invoicing/credit-notes) resource represents a credit that has
+        #
+        #   @param payload_style [Symbol, Orb::Models::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
+        #
+        #   @param properties [Orb::Models::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent::Properties]
+        #
+        #   @param type [Symbol, Orb::Models::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent::Type] The event this payload describes.
+
+        # @see Orb::Models::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent#accounting_sync_record
+        class AccountingSyncRecord < Orb::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute customer_id
+          #
+          #   @return [String]
+          required :customer_id, String
+
+          # @!attribute record_type
+          #
+          #   @return [Symbol, Orb::Models::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType]
+          required :record_type,
+                   enum: -> { Orb::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType }
+
+          # @!attribute credit_note_id
+          #
+          #   @return [String, nil]
+          optional :credit_note_id, String, nil?: true
+
+          # @!attribute error_details
+          #
+          #   @return [Hash{Symbol=>Object}, nil]
+          optional :error_details, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown], nil?: true
+
+          # @!attribute provider_customer_id
+          #
+          #   @return [String, nil]
+          optional :provider_customer_id, String, nil?: true
+
+          # @!attribute status
+          #
+          #   @return [String, nil]
+          optional :status, String, nil?: true
+
+          # @!attribute sync_action
+          #
+          #   @return [String, nil]
+          optional :sync_action, String, nil?: true
+
+          # @!method initialize(id:, customer_id:, record_type:, credit_note_id: nil, error_details: nil, provider_customer_id: nil, status: nil, sync_action: nil)
+          #   @param id [String]
+          #   @param customer_id [String]
+          #   @param record_type [Symbol, Orb::Models::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType]
+          #   @param credit_note_id [String, nil]
+          #   @param error_details [Hash{Symbol=>Object}, nil]
+          #   @param provider_customer_id [String, nil]
+          #   @param status [String, nil]
+          #   @param sync_action [String, nil]
+
+          # @see Orb::Models::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord#record_type
+          module RecordType
+            extend Orb::Internal::Type::Enum
+
+            CUSTOMER = :customer
+            INVOICE = :invoice
+            TRANSACTION = :transaction
+            CUSTOMER_BALANCE_TRANSACTION = :customer_balance_transaction
+            CREDIT_NOTE = :credit_note
+            SUBSCRIPTION = :subscription
+            SALES_ORDER = :sales_order
+            BLOCK = :block
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # The serialization style this payload was rendered in, as configured on the
+        # endpoint.
+        #
+        # @see Orb::Models::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent#payload_style
+        module PayloadStyle
+          extend Orb::Internal::Type::Enum
+
+          EXPANDED = :expanded
+          STANDARD = :standard
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Orb::Models::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent#properties
+        class Properties < Orb::Internal::Type::BaseModel
+          # @!attribute connection_type
+          #
+          #   @return [String]
+          required :connection_type, String
+
+          # @!method initialize(connection_type:)
+          #   @param connection_type [String]
+        end
+
+        # The event this payload describes.
+        #
+        # @see Orb::Models::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent#type
+        module Type
+          extend Orb::Internal::Type::Enum
+
+          CREDIT_NOTE_ACCOUNTING_SYNC_SUCCEEDED = :"credit_note.accounting_sync_succeeded"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/orb/models/webhooks/credit_note_issued_standard_webhook_event.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Webhooks
+      class CreditNoteIssuedStandardWebhookEvent < 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 credit_note
+        #   The [Credit Note](/invoicing/credit-notes) resource represents a credit that has
+        #   been applied to a particular invoice.
+        #
+        #   @return [Orb::Models::CreditNote]
+        required :credit_note, -> { Orb::CreditNote }
+
+        # @!attribute payload_style
+        #   The serialization style this payload was rendered in, as configured on the
+        #   endpoint.
+        #
+        #   @return [Symbol, Orb::Models::Webhooks::CreditNoteIssuedStandardWebhookEvent::PayloadStyle]
+        required :payload_style, enum: -> { Orb::Webhooks::CreditNoteIssuedStandardWebhookEvent::PayloadStyle }
+
+        # @!attribute properties
+        #
+        #   @return [Object]
+        required :properties, Orb::Internal::Type::Unknown
+
+        # @!attribute type
+        #   The event this payload describes.
+        #
+        #   @return [Symbol, Orb::Models::Webhooks::CreditNoteIssuedStandardWebhookEvent::Type]
+        required :type, enum: -> { Orb::Webhooks::CreditNoteIssuedStandardWebhookEvent::Type }
+
+        # @!method initialize(id:, created_at:, credit_note:, payload_style:, properties:, type:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Webhooks::CreditNoteIssuedStandardWebhookEvent} for more details.
+        #
+        #   Issued when a credit note is created.
+        #
+        #   @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 credit_note [Orb::Models::CreditNote] The [Credit Note](/invoicing/credit-notes) resource represents a credit that has
+        #
+        #   @param payload_style [Symbol, Orb::Models::Webhooks::CreditNoteIssuedStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
+        #
+        #   @param properties [Object]
+        #
+        #   @param type [Symbol, Orb::Models::Webhooks::CreditNoteIssuedStandardWebhookEvent::Type] The event this payload describes.
+
+        # The serialization style this payload was rendered in, as configured on the
+        # endpoint.
+        #
+        # @see Orb::Models::Webhooks::CreditNoteIssuedStandardWebhookEvent#payload_style
+        module PayloadStyle
+          extend Orb::Internal::Type::Enum
+
+          EXPANDED = :expanded
+          STANDARD = :standard
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The event this payload describes.
+        #
+        # @see Orb::Models::Webhooks::CreditNoteIssuedStandardWebhookEvent#type
+        module Type
+          extend Orb::Internal::Type::Enum
+
+          CREDIT_NOTE_ISSUED = :"credit_note.issued"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/orb/models/webhooks/credit_note_marked_as_void_standard_webhook_event.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Webhooks
+      class CreditNoteMarkedAsVoidStandardWebhookEvent < 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 credit_note
+        #   The [Credit Note](/invoicing/credit-notes) resource represents a credit that has
+        #   been applied to a particular invoice.
+        #
+        #   @return [Orb::Models::CreditNote]
+        required :credit_note, -> { Orb::CreditNote }
+
+        # @!attribute payload_style
+        #   The serialization style this payload was rendered in, as configured on the
+        #   endpoint.
+        #
+        #   @return [Symbol, Orb::Models::Webhooks::CreditNoteMarkedAsVoidStandardWebhookEvent::PayloadStyle]
+        required :payload_style,
+                 enum: -> { Orb::Webhooks::CreditNoteMarkedAsVoidStandardWebhookEvent::PayloadStyle }
+
+        # @!attribute properties
+        #
+        #   @return [Object]
+        required :properties, Orb::Internal::Type::Unknown
+
+        # @!attribute type
+        #   The event this payload describes.
+        #
+        #   @return [Symbol, Orb::Models::Webhooks::CreditNoteMarkedAsVoidStandardWebhookEvent::Type]
+        required :type, enum: -> { Orb::Webhooks::CreditNoteMarkedAsVoidStandardWebhookEvent::Type }
+
+        # @!method initialize(id:, created_at:, credit_note:, payload_style:, properties:, type:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Webhooks::CreditNoteMarkedAsVoidStandardWebhookEvent} for more
+        #   details.
+        #
+        #   Issued when a credit note 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 credit_note [Orb::Models::CreditNote] The [Credit Note](/invoicing/credit-notes) resource represents a credit that has
+        #
+        #   @param payload_style [Symbol, Orb::Models::Webhooks::CreditNoteMarkedAsVoidStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
+        #
+        #   @param properties [Object]
+        #
+        #   @param type [Symbol, Orb::Models::Webhooks::CreditNoteMarkedAsVoidStandardWebhookEvent::Type] The event this payload describes.
+
+        # The serialization style this payload was rendered in, as configured on the
+        # endpoint.
+        #
+        # @see Orb::Models::Webhooks::CreditNoteMarkedAsVoidStandardWebhookEvent#payload_style
+        module PayloadStyle
+          extend Orb::Internal::Type::Enum
+
+          EXPANDED = :expanded
+          STANDARD = :standard
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The event this payload describes.
+        #
+        # @see Orb::Models::Webhooks::CreditNoteMarkedAsVoidStandardWebhookEvent#type
+        module Type
+          extend Orb::Internal::Type::Enum
+
+          CREDIT_NOTE_MARKED_AS_VOID = :"credit_note.marked_as_void"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end