orb-billing 1.35.0 → 1.37.0

data/lib/orb/models/invoice_issue_failed_webhook_event.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class InvoiceIssueFailedWebhookEvent < 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::InvoiceIssueFailedWebhookEvent::Properties]
+      required :properties, -> { Orb::InvoiceIssueFailedWebhookEvent::Properties }
+
+      # @!attribute type
+      #   The event this payload describes.
+      #
+      #   @return [Symbol, Orb::Models::InvoiceIssueFailedWebhookEvent::Type]
+      required :type, enum: -> { Orb::InvoiceIssueFailedWebhookEvent::Type }
+
+      # @!method initialize(id:, created_at:, invoice:, properties:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::InvoiceIssueFailedWebhookEvent} for more details.
+      #
+      #   Issued when an invoice issue attempt 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::InvoiceIssueFailedWebhookEvent::Properties]
+      #
+      #   @param type [Symbol, Orb::Models::InvoiceIssueFailedWebhookEvent::Type] The event this payload describes.
+
+      # @see Orb::Models::InvoiceIssueFailedWebhookEvent#properties
+      class Properties < Orb::Internal::Type::BaseModel
+        # @!attribute reason
+        #
+        #   @return [String, nil]
+        required :reason, String, nil?: true
+
+        # @!method initialize(reason:)
+        #   @param reason [String, nil]
+      end
+
+      # The event this payload describes.
+      #
+      # @see Orb::Models::InvoiceIssueFailedWebhookEvent#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        INVOICE_ISSUE_FAILED = :"invoice.issue_failed"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end