orb-billing 1.45.0 → 1.46.0

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

@@ -0,0 +1,222 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Webhooks
+      class SubscriptionInvoicingThresholdExceededStandardWebhookEvent < 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 payload_style
+        #   The serialization style this payload was rendered in, as configured on the
+        #   endpoint.
+        #
+        #   @return [Symbol, Orb::Models::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::PayloadStyle]
+        required :payload_style,
+                 enum: -> { Orb::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::PayloadStyle }
+
+        # @!attribute properties
+        #
+        #   @return [Orb::Models::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::Properties]
+        required :properties,
+                 -> { Orb::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::Properties }
+
+        # @!attribute subscription
+        #   A lightweight subscription representation for webhook payloads.
+        #
+        #   This avoids the expensive to_subscription_params() call required for full
+        #   serialization.
+        #
+        #   @return [Orb::Models::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::Subscription]
+        required :subscription,
+                 -> { Orb::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::Subscription }
+
+        # @!attribute type
+        #   The event this payload describes.
+        #
+        #   @return [Symbol, Orb::Models::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::Type]
+        required :type,
+                 enum: -> { Orb::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::Type }
+
+        # @!method initialize(id:, created_at:, payload_style:, properties:, subscription:, type:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent}
+        #   for more details.
+        #
+        #   Issued when a subscription's invoicing threshold is exceeded and an evaluation
+        #   is performed.
+        #
+        #   @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 payload_style [Symbol, Orb::Models::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
+        #
+        #   @param properties [Orb::Models::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::Properties]
+        #
+        #   @param subscription [Orb::Models::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::Subscription] A lightweight subscription representation for webhook payloads.
+        #
+        #   @param type [Symbol, Orb::Models::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::Type] The event this payload describes.
+
+        # The serialization style this payload was rendered in, as configured on the
+        # endpoint.
+        #
+        # @see Orb::Models::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent#payload_style
+        module PayloadStyle
+          extend Orb::Internal::Type::Enum
+
+          EXPANDED = :expanded
+          STANDARD = :standard
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Orb::Models::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent#properties
+        class Properties < Orb::Internal::Type::BaseModel
+          # @!attribute evaluated_amount
+          #
+          #   @return [String]
+          required :evaluated_amount, String
+
+          # @!attribute invoice_id
+          #
+          #   @return [String]
+          required :invoice_id, String
+
+          # @!attribute invoicing_threshold
+          #
+          #   @return [String]
+          required :invoicing_threshold, String
+
+          # @!attribute threshold_invoice_created
+          #
+          #   @return [Boolean]
+          required :threshold_invoice_created, Orb::Internal::Type::Boolean
+
+          # @!method initialize(evaluated_amount:, invoice_id:, invoicing_threshold:, threshold_invoice_created:)
+          #   @param evaluated_amount [String]
+          #   @param invoice_id [String]
+          #   @param invoicing_threshold [String]
+          #   @param threshold_invoice_created [Boolean]
+        end
+
+        # @see Orb::Models::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent#subscription
+        class Subscription < Orb::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute customer
+          #
+          #   @return [Orb::Models::CustomerMinified]
+          required :customer, -> { Orb::CustomerMinified }
+
+          # @!attribute end_date
+          #
+          #   @return [Time, nil]
+          required :end_date, Time, nil?: true
+
+          # @!attribute plan
+          #
+          #   @return [Orb::Models::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::Subscription::Plan, nil]
+          required :plan,
+                   -> {
+                     Orb::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::Subscription::Plan
+                   },
+                   nil?: true
+
+          # @!attribute start_date
+          #
+          #   @return [Time]
+          required :start_date, Time
+
+          # @!attribute status
+          #
+          #   @return [Symbol, Orb::Models::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::Subscription::Status]
+          required :status,
+                   enum: -> { Orb::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::Subscription::Status }
+
+          # @!method initialize(id:, customer:, end_date:, plan:, start_date:, status:)
+          #   A lightweight subscription representation for webhook payloads.
+          #
+          #   This avoids the expensive to_subscription_params() call required for full
+          #   serialization.
+          #
+          #   @param id [String]
+          #   @param customer [Orb::Models::CustomerMinified]
+          #   @param end_date [Time, nil]
+          #   @param plan [Orb::Models::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::Subscription::Plan, nil]
+          #   @param start_date [Time]
+          #   @param status [Symbol, Orb::Models::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::Subscription::Status]
+
+          # @see Orb::Models::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::Subscription#plan
+          class Plan < Orb::Internal::Type::BaseModel
+            # @!attribute id
+            #
+            #   @return [String, nil]
+            required :id, String, nil?: true
+
+            # @!attribute external_plan_id
+            #   An optional user-defined ID for this plan resource, used throughout the system
+            #   as an alias for this Plan. Use this field to identify a plan by an existing
+            #   identifier in your system.
+            #
+            #   @return [String, nil]
+            required :external_plan_id, String, nil?: true
+
+            # @!attribute name
+            #
+            #   @return [String, nil]
+            required :name, String, nil?: true
+
+            # @!method initialize(id:, external_plan_id:, name:)
+            #   Some parameter documentations has been truncated, see
+            #   {Orb::Models::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::Subscription::Plan}
+            #   for more details.
+            #
+            #   @param id [String, nil]
+            #
+            #   @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
+            #
+            #   @param name [String, nil]
+          end
+
+          # @see Orb::Models::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::Subscription#status
+          module Status
+            extend Orb::Internal::Type::Enum
+
+            ACTIVE = :active
+            ENDED = :ended
+            UPCOMING = :upcoming
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # The event this payload describes.
+        #
+        # @see Orb::Models::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent#type
+        module Type
+          extend Orb::Internal::Type::Enum
+
+          SUBSCRIPTION_INVOICING_THRESHOLD_EXCEEDED = :"subscription.invoicing_threshold_exceeded"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,244 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Webhooks
+      class SubscriptionLicenseAllocationResetStandardWebhookEvent < 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 payload_style
+        #   The serialization style this payload was rendered in, as configured on the
+        #   endpoint.
+        #
+        #   @return [Symbol, Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::PayloadStyle]
+        required :payload_style,
+                 enum: -> { Orb::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::PayloadStyle }
+
+        # @!attribute properties
+        #   Fires at the start of a billing period when license allocations are replenished.
+        #   Allocations sharing a billing period are batched into one message.
+        #
+        #   @return [Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::Properties]
+        required :properties,
+                 -> { Orb::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::Properties }
+
+        # @!attribute subscription
+        #   A lightweight subscription representation for webhook payloads.
+        #
+        #   This avoids the expensive to_subscription_params() call required for full
+        #   serialization.
+        #
+        #   @return [Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::Subscription]
+        required :subscription,
+                 -> { Orb::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::Subscription }
+
+        # @!attribute type
+        #   The event this payload describes.
+        #
+        #   @return [Symbol, Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::Type]
+        required :type, enum: -> { Orb::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::Type }
+
+        # @!method initialize(id:, created_at:, payload_style:, properties:, subscription:, type:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent}
+        #   for more details.
+        #
+        #   Issued when a license allocation is reset.
+        #
+        #   @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 payload_style [Symbol, Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
+        #
+        #   @param properties [Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::Properties] Fires at the start of a billing period when license allocations are replenished.
+        #
+        #   @param subscription [Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::Subscription] A lightweight subscription representation for webhook payloads.
+        #
+        #   @param type [Symbol, Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::Type] The event this payload describes.
+
+        # The serialization style this payload was rendered in, as configured on the
+        # endpoint.
+        #
+        # @see Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent#payload_style
+        module PayloadStyle
+          extend Orb::Internal::Type::Enum
+
+          EXPANDED = :expanded
+          STANDARD = :standard
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent#properties
+        class Properties < Orb::Internal::Type::BaseModel
+          # @!attribute reset_allocations
+          #
+          #   @return [Array<Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::Properties::ResetAllocation>]
+          required :reset_allocations,
+                   -> { Orb::Internal::Type::ArrayOf[Orb::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::Properties::ResetAllocation] }
+
+          # @!attribute timeframe_end
+          #
+          #   @return [Time]
+          required :timeframe_end, Time
+
+          # @!attribute timeframe_start
+          #
+          #   @return [Time]
+          required :timeframe_start, Time
+
+          # @!method initialize(reset_allocations:, timeframe_end:, timeframe_start:)
+          #   Fires at the start of a billing period when license allocations are replenished.
+          #   Allocations sharing a billing period are batched into one message.
+          #
+          #   @param reset_allocations [Array<Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::Properties::ResetAllocation>]
+          #   @param timeframe_end [Time]
+          #   @param timeframe_start [Time]
+
+          class ResetAllocation < Orb::Internal::Type::BaseModel
+            # @!attribute allocation_amount
+            #
+            #   @return [String]
+            required :allocation_amount, String
+
+            # @!attribute license_type_id
+            #
+            #   @return [String]
+            required :license_type_id, String
+
+            # @!attribute pricing_unit_id
+            #
+            #   @return [String]
+            required :pricing_unit_id, String
+
+            # @!method initialize(allocation_amount:, license_type_id:, pricing_unit_id:)
+            #   A license allocation replenished at the start of a billing period.
+            #
+            #   @param allocation_amount [String]
+            #   @param license_type_id [String]
+            #   @param pricing_unit_id [String]
+          end
+        end
+
+        # @see Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent#subscription
+        class Subscription < Orb::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute customer
+          #
+          #   @return [Orb::Models::CustomerMinified]
+          required :customer, -> { Orb::CustomerMinified }
+
+          # @!attribute end_date
+          #
+          #   @return [Time, nil]
+          required :end_date, Time, nil?: true
+
+          # @!attribute plan
+          #
+          #   @return [Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::Subscription::Plan, nil]
+          required :plan,
+                   -> {
+                     Orb::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::Subscription::Plan
+                   },
+                   nil?: true
+
+          # @!attribute start_date
+          #
+          #   @return [Time]
+          required :start_date, Time
+
+          # @!attribute status
+          #
+          #   @return [Symbol, Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::Subscription::Status]
+          required :status,
+                   enum: -> { Orb::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::Subscription::Status }
+
+          # @!method initialize(id:, customer:, end_date:, plan:, start_date:, status:)
+          #   A lightweight subscription representation for webhook payloads.
+          #
+          #   This avoids the expensive to_subscription_params() call required for full
+          #   serialization.
+          #
+          #   @param id [String]
+          #   @param customer [Orb::Models::CustomerMinified]
+          #   @param end_date [Time, nil]
+          #   @param plan [Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::Subscription::Plan, nil]
+          #   @param start_date [Time]
+          #   @param status [Symbol, Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::Subscription::Status]
+
+          # @see Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::Subscription#plan
+          class Plan < Orb::Internal::Type::BaseModel
+            # @!attribute id
+            #
+            #   @return [String, nil]
+            required :id, String, nil?: true
+
+            # @!attribute external_plan_id
+            #   An optional user-defined ID for this plan resource, used throughout the system
+            #   as an alias for this Plan. Use this field to identify a plan by an existing
+            #   identifier in your system.
+            #
+            #   @return [String, nil]
+            required :external_plan_id, String, nil?: true
+
+            # @!attribute name
+            #
+            #   @return [String, nil]
+            required :name, String, nil?: true
+
+            # @!method initialize(id:, external_plan_id:, name:)
+            #   Some parameter documentations has been truncated, see
+            #   {Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::Subscription::Plan}
+            #   for more details.
+            #
+            #   @param id [String, nil]
+            #
+            #   @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
+            #
+            #   @param name [String, nil]
+          end
+
+          # @see Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::Subscription#status
+          module Status
+            extend Orb::Internal::Type::Enum
+
+            ACTIVE = :active
+            ENDED = :ended
+            UPCOMING = :upcoming
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # The event this payload describes.
+        #
+        # @see Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent#type
+        module Type
+          extend Orb::Internal::Type::Enum
+
+          SUBSCRIPTION_LICENSE_ALLOCATION_RESET = :"subscription.license_allocation_reset"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end