orb-billing 1.35.0 → 1.36.0

data/lib/orb/models/ingestion_unmatched_customer_ids_webhook_event.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class IngestionUnmatchedCustomerIDsWebhookEvent < 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 properties
+      #
+      #   @return [Orb::Models::IngestionUnmatchedCustomerIDsWebhookEvent::Properties]
+      required :properties, -> { Orb::IngestionUnmatchedCustomerIDsWebhookEvent::Properties }
+
+      # @!attribute type
+      #   The event this payload describes.
+      #
+      #   @return [Symbol, Orb::Models::IngestionUnmatchedCustomerIDsWebhookEvent::Type]
+      required :type, enum: -> { Orb::IngestionUnmatchedCustomerIDsWebhookEvent::Type }
+
+      # @!method initialize(id:, created_at:, properties:, type:)
+      #   Issued when ingestion events reference unmatched customer IDs.
+      #
+      #   @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 properties [Orb::Models::IngestionUnmatchedCustomerIDsWebhookEvent::Properties]
+      #
+      #   @param type [Symbol, Orb::Models::IngestionUnmatchedCustomerIDsWebhookEvent::Type] The event this payload describes.
+
+      # @see Orb::Models::IngestionUnmatchedCustomerIDsWebhookEvent#properties
+      class Properties < Orb::Internal::Type::BaseModel
+        # @!attribute external_customer_ids
+        #
+        #   @return [Array<String>]
+        required :external_customer_ids, Orb::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(external_customer_ids:)
+        #   @param external_customer_ids [Array<String>]
+      end
+
+      # The event this payload describes.
+      #
+      # @see Orb::Models::IngestionUnmatchedCustomerIDsWebhookEvent#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        INGESTION_UNMATCHED_CUSTOMER_IDS = :"ingestion.unmatched_customer_ids"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/invoice_accounting_sync_failed_webhook_event.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class InvoiceAccountingSyncFailedWebhookEvent < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of this webhook event.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute accounting_sync_record
+      #
+      #   @return [Orb::Models::InvoiceAccountingSyncFailedWebhookEvent::AccountingSyncRecord]
+      required :accounting_sync_record,
+               -> { Orb::InvoiceAccountingSyncFailedWebhookEvent::AccountingSyncRecord }
+
+      # @!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::InvoiceAccountingSyncFailedWebhookEvent::Properties]
+      required :properties, -> { Orb::InvoiceAccountingSyncFailedWebhookEvent::Properties }
+
+      # @!attribute type
+      #   The event this payload describes.
+      #
+      #   @return [Symbol, Orb::Models::InvoiceAccountingSyncFailedWebhookEvent::Type]
+      required :type, enum: -> { Orb::InvoiceAccountingSyncFailedWebhookEvent::Type }
+
+      # @!method initialize(id:, accounting_sync_record:, created_at:, invoice:, properties:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::InvoiceAccountingSyncFailedWebhookEvent} for more details.
+      #
+      #   Issued when an invoice accounting sync fails.
+      #
+      #   @param id [String] The ID of this webhook event.
+      #
+      #   @param accounting_sync_record [Orb::Models::InvoiceAccountingSyncFailedWebhookEvent::AccountingSyncRecord]
+      #
+      #   @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::InvoiceAccountingSyncFailedWebhookEvent::Properties]
+      #
+      #   @param type [Symbol, Orb::Models::InvoiceAccountingSyncFailedWebhookEvent::Type] The event this payload describes.
+
+      # @see Orb::Models::InvoiceAccountingSyncFailedWebhookEvent#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::InvoiceAccountingSyncFailedWebhookEvent::AccountingSyncRecord::RecordType]
+        required :record_type,
+                 enum: -> { Orb::InvoiceAccountingSyncFailedWebhookEvent::AccountingSyncRecord::RecordType }
+
+        # @!attribute error_details
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :error_details, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown], nil?: true
+
+        # @!attribute invoice_id
+        #
+        #   @return [String, nil]
+        optional :invoice_id, String, 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:, error_details: nil, invoice_id: nil, provider_customer_id: nil, status: nil, sync_action: nil)
+        #   @param id [String]
+        #   @param customer_id [String]
+        #   @param record_type [Symbol, Orb::Models::InvoiceAccountingSyncFailedWebhookEvent::AccountingSyncRecord::RecordType]
+        #   @param error_details [Hash{Symbol=>Object}, nil]
+        #   @param invoice_id [String, nil]
+        #   @param provider_customer_id [String, nil]
+        #   @param status [String, nil]
+        #   @param sync_action [String, nil]
+
+        # @see Orb::Models::InvoiceAccountingSyncFailedWebhookEvent::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
+
+      # @see Orb::Models::InvoiceAccountingSyncFailedWebhookEvent#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::InvoiceAccountingSyncFailedWebhookEvent#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        INVOICE_ACCOUNTING_SYNC_FAILED = :"invoice.accounting_sync_failed"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/invoice_accounting_sync_succeeded_webhook_event.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class InvoiceAccountingSyncSucceededWebhookEvent < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of this webhook event.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute accounting_sync_record
+      #
+      #   @return [Orb::Models::InvoiceAccountingSyncSucceededWebhookEvent::AccountingSyncRecord]
+      required :accounting_sync_record,
+               -> { Orb::InvoiceAccountingSyncSucceededWebhookEvent::AccountingSyncRecord }
+
+      # @!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::InvoiceAccountingSyncSucceededWebhookEvent::Properties]
+      required :properties, -> { Orb::InvoiceAccountingSyncSucceededWebhookEvent::Properties }
+
+      # @!attribute type
+      #   The event this payload describes.
+      #
+      #   @return [Symbol, Orb::Models::InvoiceAccountingSyncSucceededWebhookEvent::Type]
+      required :type, enum: -> { Orb::InvoiceAccountingSyncSucceededWebhookEvent::Type }
+
+      # @!method initialize(id:, accounting_sync_record:, created_at:, invoice:, properties:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::InvoiceAccountingSyncSucceededWebhookEvent} for more details.
+      #
+      #   Issued when an invoice accounting sync succeeds.
+      #
+      #   @param id [String] The ID of this webhook event.
+      #
+      #   @param accounting_sync_record [Orb::Models::InvoiceAccountingSyncSucceededWebhookEvent::AccountingSyncRecord]
+      #
+      #   @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::InvoiceAccountingSyncSucceededWebhookEvent::Properties]
+      #
+      #   @param type [Symbol, Orb::Models::InvoiceAccountingSyncSucceededWebhookEvent::Type] The event this payload describes.
+
+      # @see Orb::Models::InvoiceAccountingSyncSucceededWebhookEvent#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::InvoiceAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType]
+        required :record_type,
+                 enum: -> { Orb::InvoiceAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType }
+
+        # @!attribute error_details
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :error_details, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown], nil?: true
+
+        # @!attribute invoice_id
+        #
+        #   @return [String, nil]
+        optional :invoice_id, String, 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:, error_details: nil, invoice_id: nil, provider_customer_id: nil, status: nil, sync_action: nil)
+        #   @param id [String]
+        #   @param customer_id [String]
+        #   @param record_type [Symbol, Orb::Models::InvoiceAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType]
+        #   @param error_details [Hash{Symbol=>Object}, nil]
+        #   @param invoice_id [String, nil]
+        #   @param provider_customer_id [String, nil]
+        #   @param status [String, nil]
+        #   @param sync_action [String, nil]
+
+        # @see Orb::Models::InvoiceAccountingSyncSucceededWebhookEvent::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
+
+      # @see Orb::Models::InvoiceAccountingSyncSucceededWebhookEvent#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::InvoiceAccountingSyncSucceededWebhookEvent#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        INVOICE_ACCOUNTING_SYNC_SUCCEEDED = :"invoice.accounting_sync_succeeded"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end