orb-billing 1.34.0 → 1.36.0

data/lib/orb/models/credit_note_accounting_sync_succeeded_webhook_event.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class CreditNoteAccountingSyncSucceededWebhookEvent < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of this webhook event.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute accounting_sync_record
+      #
+      #   @return [Orb::Models::CreditNoteAccountingSyncSucceededWebhookEvent::AccountingSyncRecord]
+      required :accounting_sync_record,
+               -> { Orb::CreditNoteAccountingSyncSucceededWebhookEvent::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 properties
+      #
+      #   @return [Orb::Models::CreditNoteAccountingSyncSucceededWebhookEvent::Properties]
+      required :properties, -> { Orb::CreditNoteAccountingSyncSucceededWebhookEvent::Properties }
+
+      # @!attribute type
+      #   The event this payload describes.
+      #
+      #   @return [Symbol, Orb::Models::CreditNoteAccountingSyncSucceededWebhookEvent::Type]
+      required :type, enum: -> { Orb::CreditNoteAccountingSyncSucceededWebhookEvent::Type }
+
+      # @!method initialize(id:, accounting_sync_record:, created_at:, credit_note:, properties:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::CreditNoteAccountingSyncSucceededWebhookEvent} 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::CreditNoteAccountingSyncSucceededWebhookEvent::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 properties [Orb::Models::CreditNoteAccountingSyncSucceededWebhookEvent::Properties]
+      #
+      #   @param type [Symbol, Orb::Models::CreditNoteAccountingSyncSucceededWebhookEvent::Type] The event this payload describes.
+
+      # @see Orb::Models::CreditNoteAccountingSyncSucceededWebhookEvent#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::CreditNoteAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType]
+        required :record_type,
+                 enum: -> { Orb::CreditNoteAccountingSyncSucceededWebhookEvent::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::CreditNoteAccountingSyncSucceededWebhookEvent::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::CreditNoteAccountingSyncSucceededWebhookEvent::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::CreditNoteAccountingSyncSucceededWebhookEvent#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::CreditNoteAccountingSyncSucceededWebhookEvent#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

data/lib/orb/models/credit_note_issued_webhook_event.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class CreditNoteIssuedWebhookEvent < 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 properties
+      #
+      #   @return [Object]
+      required :properties, Orb::Internal::Type::Unknown
+
+      # @!attribute type
+      #   The event this payload describes.
+      #
+      #   @return [Symbol, Orb::Models::CreditNoteIssuedWebhookEvent::Type]
+      required :type, enum: -> { Orb::CreditNoteIssuedWebhookEvent::Type }
+
+      # @!method initialize(id:, created_at:, credit_note:, properties:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::CreditNoteIssuedWebhookEvent} 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 properties [Object]
+      #
+      #   @param type [Symbol, Orb::Models::CreditNoteIssuedWebhookEvent::Type] The event this payload describes.
+
+      # The event this payload describes.
+      #
+      # @see Orb::Models::CreditNoteIssuedWebhookEvent#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        CREDIT_NOTE_ISSUED = :"credit_note.issued"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/credit_note_marked_as_void_webhook_event.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class CreditNoteMarkedAsVoidWebhookEvent < 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 properties
+      #
+      #   @return [Object]
+      required :properties, Orb::Internal::Type::Unknown
+
+      # @!attribute type
+      #   The event this payload describes.
+      #
+      #   @return [Symbol, Orb::Models::CreditNoteMarkedAsVoidWebhookEvent::Type]
+      required :type, enum: -> { Orb::CreditNoteMarkedAsVoidWebhookEvent::Type }
+
+      # @!method initialize(id:, created_at:, credit_note:, properties:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::CreditNoteMarkedAsVoidWebhookEvent} 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 properties [Object]
+      #
+      #   @param type [Symbol, Orb::Models::CreditNoteMarkedAsVoidWebhookEvent::Type] The event this payload describes.
+
+      # The event this payload describes.
+      #
+      # @see Orb::Models::CreditNoteMarkedAsVoidWebhookEvent#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

data/lib/orb/models/customer_accounting_sync_failed_webhook_event.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class CustomerAccountingSyncFailedWebhookEvent < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of this webhook event.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute accounting_sync_record
+      #
+      #   @return [Orb::Models::CustomerAccountingSyncFailedWebhookEvent::AccountingSyncRecord]
+      required :accounting_sync_record,
+               -> { Orb::CustomerAccountingSyncFailedWebhookEvent::AccountingSyncRecord }
+
+      # @!attribute created_at
+      #   The time at which this event was created, to the second.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute customer
+      #   A customer is a buyer of your products, and the other party to the billing
+      #   relationship.
+      #
+      #   In Orb, customers are assigned system generated identifiers automatically, but
+      #   it's often desirable to have these match existing identifiers in your system. To
+      #   avoid having to denormalize Orb ID information, you can pass in an
+      #   `external_customer_id` with your own identifier. See
+      #   [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
+      #   information about how these aliases work in Orb.
+      #
+      #   In addition to having an identifier in your system, a customer may exist in a
+      #   payment provider solution like Stripe. Use the `payment_provider_id` and the
+      #   `payment_provider` enum field to express this mapping.
+      #
+      #   A customer also has a timezone (from the standard
+      #   [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
+      #   your account's timezone. See [Timezone localization](/essentials/timezones) for
+      #   information on what this timezone parameter influences within Orb.
+      #
+      #   @return [Orb::Models::Customer]
+      required :customer, -> { Orb::Customer }
+
+      # @!attribute properties
+      #
+      #   @return [Orb::Models::CustomerAccountingSyncFailedWebhookEvent::Properties]
+      required :properties, -> { Orb::CustomerAccountingSyncFailedWebhookEvent::Properties }
+
+      # @!attribute type
+      #   The event this payload describes.
+      #
+      #   @return [Symbol, Orb::Models::CustomerAccountingSyncFailedWebhookEvent::Type]
+      required :type, enum: -> { Orb::CustomerAccountingSyncFailedWebhookEvent::Type }
+
+      # @!method initialize(id:, accounting_sync_record:, created_at:, customer:, properties:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::CustomerAccountingSyncFailedWebhookEvent} for more details.
+      #
+      #   Issued when a customer accounting sync fails.
+      #
+      #   @param id [String] The ID of this webhook event.
+      #
+      #   @param accounting_sync_record [Orb::Models::CustomerAccountingSyncFailedWebhookEvent::AccountingSyncRecord]
+      #
+      #   @param created_at [Time] The time at which this event was created, to the second.
+      #
+      #   @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
+      #
+      #   @param properties [Orb::Models::CustomerAccountingSyncFailedWebhookEvent::Properties]
+      #
+      #   @param type [Symbol, Orb::Models::CustomerAccountingSyncFailedWebhookEvent::Type] The event this payload describes.
+
+      # @see Orb::Models::CustomerAccountingSyncFailedWebhookEvent#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::CustomerAccountingSyncFailedWebhookEvent::AccountingSyncRecord::RecordType]
+        required :record_type,
+                 enum: -> { Orb::CustomerAccountingSyncFailedWebhookEvent::AccountingSyncRecord::RecordType }
+
+        # @!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:, 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::CustomerAccountingSyncFailedWebhookEvent::AccountingSyncRecord::RecordType]
+        #   @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::CustomerAccountingSyncFailedWebhookEvent::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::CustomerAccountingSyncFailedWebhookEvent#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::CustomerAccountingSyncFailedWebhookEvent#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        CUSTOMER_ACCOUNTING_SYNC_FAILED = :"customer.accounting_sync_failed"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/customer_accounting_sync_succeeded_webhook_event.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class CustomerAccountingSyncSucceededWebhookEvent < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of this webhook event.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute accounting_sync_record
+      #
+      #   @return [Orb::Models::CustomerAccountingSyncSucceededWebhookEvent::AccountingSyncRecord]
+      required :accounting_sync_record,
+               -> { Orb::CustomerAccountingSyncSucceededWebhookEvent::AccountingSyncRecord }
+
+      # @!attribute created_at
+      #   The time at which this event was created, to the second.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute customer
+      #   A customer is a buyer of your products, and the other party to the billing
+      #   relationship.
+      #
+      #   In Orb, customers are assigned system generated identifiers automatically, but
+      #   it's often desirable to have these match existing identifiers in your system. To
+      #   avoid having to denormalize Orb ID information, you can pass in an
+      #   `external_customer_id` with your own identifier. See
+      #   [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
+      #   information about how these aliases work in Orb.
+      #
+      #   In addition to having an identifier in your system, a customer may exist in a
+      #   payment provider solution like Stripe. Use the `payment_provider_id` and the
+      #   `payment_provider` enum field to express this mapping.
+      #
+      #   A customer also has a timezone (from the standard
+      #   [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
+      #   your account's timezone. See [Timezone localization](/essentials/timezones) for
+      #   information on what this timezone parameter influences within Orb.
+      #
+      #   @return [Orb::Models::Customer]
+      required :customer, -> { Orb::Customer }
+
+      # @!attribute properties
+      #
+      #   @return [Orb::Models::CustomerAccountingSyncSucceededWebhookEvent::Properties]
+      required :properties, -> { Orb::CustomerAccountingSyncSucceededWebhookEvent::Properties }
+
+      # @!attribute type
+      #   The event this payload describes.
+      #
+      #   @return [Symbol, Orb::Models::CustomerAccountingSyncSucceededWebhookEvent::Type]
+      required :type, enum: -> { Orb::CustomerAccountingSyncSucceededWebhookEvent::Type }
+
+      # @!method initialize(id:, accounting_sync_record:, created_at:, customer:, properties:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::CustomerAccountingSyncSucceededWebhookEvent} for more details.
+      #
+      #   Issued when a customer accounting sync succeeds.
+      #
+      #   @param id [String] The ID of this webhook event.
+      #
+      #   @param accounting_sync_record [Orb::Models::CustomerAccountingSyncSucceededWebhookEvent::AccountingSyncRecord]
+      #
+      #   @param created_at [Time] The time at which this event was created, to the second.
+      #
+      #   @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
+      #
+      #   @param properties [Orb::Models::CustomerAccountingSyncSucceededWebhookEvent::Properties]
+      #
+      #   @param type [Symbol, Orb::Models::CustomerAccountingSyncSucceededWebhookEvent::Type] The event this payload describes.
+
+      # @see Orb::Models::CustomerAccountingSyncSucceededWebhookEvent#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::CustomerAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType]
+        required :record_type,
+                 enum: -> { Orb::CustomerAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType }
+
+        # @!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:, 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::CustomerAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType]
+        #   @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::CustomerAccountingSyncSucceededWebhookEvent::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::CustomerAccountingSyncSucceededWebhookEvent#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::CustomerAccountingSyncSucceededWebhookEvent#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        CUSTOMER_ACCOUNTING_SYNC_SUCCEEDED = :"customer.accounting_sync_succeeded"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end