orb-billing 1.45.0 → 1.46.0

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

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Webhooks
+      class MetricEventsDroppedByWatermarkStandardWebhookEvent < 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::MetricEventsDroppedByWatermarkStandardWebhookEvent::PayloadStyle]
+        required :payload_style,
+                 enum: -> { Orb::Webhooks::MetricEventsDroppedByWatermarkStandardWebhookEvent::PayloadStyle }
+
+        # @!attribute properties
+        #   `window_start` and `window_end` are ISO-8601 strings rather than datetimes: the
+        #   untyped message called `.isoformat()` on them, so they keep microseconds where
+        #   the webhook JSON provider would have truncated them.
+        #
+        #   @return [Orb::Models::Webhooks::MetricEventsDroppedByWatermarkStandardWebhookEvent::Properties]
+        required :properties, -> { Orb::Webhooks::MetricEventsDroppedByWatermarkStandardWebhookEvent::Properties }
+
+        # @!attribute type
+        #   The event this payload describes.
+        #
+        #   @return [Symbol, Orb::Models::Webhooks::MetricEventsDroppedByWatermarkStandardWebhookEvent::Type]
+        required :type, enum: -> { Orb::Webhooks::MetricEventsDroppedByWatermarkStandardWebhookEvent::Type }
+
+        # @!method initialize(id:, created_at:, payload_style:, properties:, type:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Webhooks::MetricEventsDroppedByWatermarkStandardWebhookEvent} for
+        #   more details.
+        #
+        #   Issued when metric events are dropped by watermark threshold.
+        #
+        #   @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::MetricEventsDroppedByWatermarkStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
+        #
+        #   @param properties [Orb::Models::Webhooks::MetricEventsDroppedByWatermarkStandardWebhookEvent::Properties] `window_start` and `window_end` are ISO-8601 strings rather than datetimes: the
+        #
+        #   @param type [Symbol, Orb::Models::Webhooks::MetricEventsDroppedByWatermarkStandardWebhookEvent::Type] The event this payload describes.
+
+        # The serialization style this payload was rendered in, as configured on the
+        # endpoint.
+        #
+        # @see Orb::Models::Webhooks::MetricEventsDroppedByWatermarkStandardWebhookEvent#payload_style
+        module PayloadStyle
+          extend Orb::Internal::Type::Enum
+
+          EXPANDED = :expanded
+          STANDARD = :standard
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Orb::Models::Webhooks::MetricEventsDroppedByWatermarkStandardWebhookEvent#properties
+        class Properties < Orb::Internal::Type::BaseModel
+          # @!attribute dropped
+          #
+          #   @return [Integer]
+          required :dropped, Integer
+
+          # @!attribute event_name
+          #
+          #   @return [String]
+          required :event_name, String
+
+          # @!attribute total
+          #
+          #   @return [Integer]
+          required :total, Integer
+
+          # @!attribute window_end
+          #
+          #   @return [String]
+          required :window_end, String
+
+          # @!attribute window_start
+          #
+          #   @return [String]
+          required :window_start, String
+
+          # @!method initialize(dropped:, event_name:, total:, window_end:, window_start:)
+          #   `window_start` and `window_end` are ISO-8601 strings rather than datetimes: the
+          #   untyped message called `.isoformat()` on them, so they keep microseconds where
+          #   the webhook JSON provider would have truncated them.
+          #
+          #   @param dropped [Integer]
+          #   @param event_name [String]
+          #   @param total [Integer]
+          #   @param window_end [String]
+          #   @param window_start [String]
+        end
+
+        # The event this payload describes.
+        #
+        # @see Orb::Models::Webhooks::MetricEventsDroppedByWatermarkStandardWebhookEvent#type
+        module Type
+          extend Orb::Internal::Type::Enum
+
+          METRIC_EVENTS_DROPPED_BY_WATERMARK = :"metric.events_dropped_by_watermark"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Webhooks
+      class PaymentMethodCreatedStandardWebhookEvent < 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::PaymentMethodCreatedStandardWebhookEvent::PayloadStyle]
+        required :payload_style,
+                 enum: -> { Orb::Webhooks::PaymentMethodCreatedStandardWebhookEvent::PayloadStyle }
+
+        # @!attribute payment_method
+        #   A payment method represents a customer's stored payment instrument held with an
+        #   external payment provider (such as Adyen or Stripe).
+        #
+        #   The serialization is intentionally minimal for now; provider-pulled details
+        #   (e.g. card display metadata) will be added over time.
+        #
+        #   @return [Orb::Models::Webhooks::PaymentMethodCreatedStandardWebhookEvent::PaymentMethod]
+        required :payment_method, -> { Orb::Webhooks::PaymentMethodCreatedStandardWebhookEvent::PaymentMethod }
+
+        # @!attribute properties
+        #
+        #   @return [Object]
+        required :properties, Orb::Internal::Type::Unknown
+
+        # @!attribute type
+        #   The event this payload describes.
+        #
+        #   @return [Symbol, Orb::Models::Webhooks::PaymentMethodCreatedStandardWebhookEvent::Type]
+        required :type, enum: -> { Orb::Webhooks::PaymentMethodCreatedStandardWebhookEvent::Type }
+
+        # @!method initialize(id:, created_at:, payload_style:, payment_method:, properties:, type:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Webhooks::PaymentMethodCreatedStandardWebhookEvent} for more
+        #   details.
+        #
+        #   Issued when a payment method 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 payload_style [Symbol, Orb::Models::Webhooks::PaymentMethodCreatedStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
+        #
+        #   @param payment_method [Orb::Models::Webhooks::PaymentMethodCreatedStandardWebhookEvent::PaymentMethod] A payment method represents a customer's stored payment instrument held with an
+        #
+        #   @param properties [Object]
+        #
+        #   @param type [Symbol, Orb::Models::Webhooks::PaymentMethodCreatedStandardWebhookEvent::Type] The event this payload describes.
+
+        # The serialization style this payload was rendered in, as configured on the
+        # endpoint.
+        #
+        # @see Orb::Models::Webhooks::PaymentMethodCreatedStandardWebhookEvent#payload_style
+        module PayloadStyle
+          extend Orb::Internal::Type::Enum
+
+          EXPANDED = :expanded
+          STANDARD = :standard
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Orb::Models::Webhooks::PaymentMethodCreatedStandardWebhookEvent#payment_method
+        class PaymentMethod < Orb::Internal::Type::BaseModel
+          # @!attribute id
+          #   The Orb-assigned unique identifier for the payment method.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute created_at
+          #   The time at which the payment method was created.
+          #
+          #   @return [Time]
+          required :created_at, Time
+
+          # @!attribute customer_id
+          #   The ID of the Orb customer this payment method is attached to.
+          #
+          #   @return [String]
+          required :customer_id, String
+
+          # @!attribute default
+          #   Whether this is the customer's default payment method.
+          #
+          #   @return [Boolean]
+          required :default, Orb::Internal::Type::Boolean
+
+          # @!attribute external_payment_method_id
+          #   The identifier of this payment method in the external payment provider.
+          #
+          #   @return [String]
+          required :external_payment_method_id, String
+
+          # @!attribute payment_method_type
+          #   The type of the underlying payment instrument, e.g. `card` or `us_bank_account`.
+          #
+          #   @return [Symbol, Orb::Models::Webhooks::PaymentMethodCreatedStandardWebhookEvent::PaymentMethod::PaymentMethodType]
+          required :payment_method_type,
+                   enum: -> { Orb::Webhooks::PaymentMethodCreatedStandardWebhookEvent::PaymentMethod::PaymentMethodType }
+
+          # @!attribute provider_type
+          #   The external payment provider this method belongs to, derived from the linked
+          #   payment gateway connection (e.g. `adyen` or `stripe`). Null if the connection
+          #   has been removed.
+          #
+          #   @return [String, nil]
+          required :provider_type, String, nil?: true
+
+          # @!method initialize(id:, created_at:, customer_id:, default:, external_payment_method_id:, payment_method_type:, provider_type:)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::Webhooks::PaymentMethodCreatedStandardWebhookEvent::PaymentMethod}
+          #   for more details.
+          #
+          #   A payment method represents a customer's stored payment instrument held with an
+          #   external payment provider (such as Adyen or Stripe).
+          #
+          #   The serialization is intentionally minimal for now; provider-pulled details
+          #   (e.g. card display metadata) will be added over time.
+          #
+          #   @param id [String] The Orb-assigned unique identifier for the payment method.
+          #
+          #   @param created_at [Time] The time at which the payment method was created.
+          #
+          #   @param customer_id [String] The ID of the Orb customer this payment method is attached to.
+          #
+          #   @param default [Boolean] Whether this is the customer's default payment method.
+          #
+          #   @param external_payment_method_id [String] The identifier of this payment method in the external payment provider.
+          #
+          #   @param payment_method_type [Symbol, Orb::Models::Webhooks::PaymentMethodCreatedStandardWebhookEvent::PaymentMethod::PaymentMethodType] The type of the underlying payment instrument, e.g. `card` or `us_bank_account`.
+          #
+          #   @param provider_type [String, nil] The external payment provider this method belongs to, derived from the linked pa
+
+          # The type of the underlying payment instrument, e.g. `card` or `us_bank_account`.
+          #
+          # @see Orb::Models::Webhooks::PaymentMethodCreatedStandardWebhookEvent::PaymentMethod#payment_method_type
+          module PaymentMethodType
+            extend Orb::Internal::Type::Enum
+
+            CARD = :card
+            US_BANK_ACCOUNT = :us_bank_account
+            LINK = :link
+            AMAZON_PAY = :amazon_pay
+            CRYPTO = :crypto
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # The event this payload describes.
+        #
+        # @see Orb::Models::Webhooks::PaymentMethodCreatedStandardWebhookEvent#type
+        module Type
+          extend Orb::Internal::Type::Enum
+
+          PAYMENT_METHOD_CREATED = :"payment_method.created"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Webhooks
+      class PaymentMethodDeletedStandardWebhookEvent < 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::PaymentMethodDeletedStandardWebhookEvent::PayloadStyle]
+        required :payload_style,
+                 enum: -> { Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent::PayloadStyle }
+
+        # @!attribute payment_method
+        #   A payment method represents a customer's stored payment instrument held with an
+        #   external payment provider (such as Adyen or Stripe).
+        #
+        #   The serialization is intentionally minimal for now; provider-pulled details
+        #   (e.g. card display metadata) will be added over time.
+        #
+        #   @return [Orb::Models::Webhooks::PaymentMethodDeletedStandardWebhookEvent::PaymentMethod]
+        required :payment_method, -> { Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent::PaymentMethod }
+
+        # @!attribute properties
+        #
+        #   @return [Object]
+        required :properties, Orb::Internal::Type::Unknown
+
+        # @!attribute type
+        #   The event this payload describes.
+        #
+        #   @return [Symbol, Orb::Models::Webhooks::PaymentMethodDeletedStandardWebhookEvent::Type]
+        required :type, enum: -> { Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent::Type }
+
+        # @!method initialize(id:, created_at:, payload_style:, payment_method:, properties:, type:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Webhooks::PaymentMethodDeletedStandardWebhookEvent} for more
+        #   details.
+        #
+        #   Issued when a payment method is deleted.
+        #
+        #   @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::PaymentMethodDeletedStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
+        #
+        #   @param payment_method [Orb::Models::Webhooks::PaymentMethodDeletedStandardWebhookEvent::PaymentMethod] A payment method represents a customer's stored payment instrument held with an
+        #
+        #   @param properties [Object]
+        #
+        #   @param type [Symbol, Orb::Models::Webhooks::PaymentMethodDeletedStandardWebhookEvent::Type] The event this payload describes.
+
+        # The serialization style this payload was rendered in, as configured on the
+        # endpoint.
+        #
+        # @see Orb::Models::Webhooks::PaymentMethodDeletedStandardWebhookEvent#payload_style
+        module PayloadStyle
+          extend Orb::Internal::Type::Enum
+
+          EXPANDED = :expanded
+          STANDARD = :standard
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Orb::Models::Webhooks::PaymentMethodDeletedStandardWebhookEvent#payment_method
+        class PaymentMethod < Orb::Internal::Type::BaseModel
+          # @!attribute id
+          #   The Orb-assigned unique identifier for the payment method.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute created_at
+          #   The time at which the payment method was created.
+          #
+          #   @return [Time]
+          required :created_at, Time
+
+          # @!attribute customer_id
+          #   The ID of the Orb customer this payment method is attached to.
+          #
+          #   @return [String]
+          required :customer_id, String
+
+          # @!attribute default
+          #   Whether this is the customer's default payment method.
+          #
+          #   @return [Boolean]
+          required :default, Orb::Internal::Type::Boolean
+
+          # @!attribute external_payment_method_id
+          #   The identifier of this payment method in the external payment provider.
+          #
+          #   @return [String]
+          required :external_payment_method_id, String
+
+          # @!attribute payment_method_type
+          #   The type of the underlying payment instrument, e.g. `card` or `us_bank_account`.
+          #
+          #   @return [Symbol, Orb::Models::Webhooks::PaymentMethodDeletedStandardWebhookEvent::PaymentMethod::PaymentMethodType]
+          required :payment_method_type,
+                   enum: -> { Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent::PaymentMethod::PaymentMethodType }
+
+          # @!attribute provider_type
+          #   The external payment provider this method belongs to, derived from the linked
+          #   payment gateway connection (e.g. `adyen` or `stripe`). Null if the connection
+          #   has been removed.
+          #
+          #   @return [String, nil]
+          required :provider_type, String, nil?: true
+
+          # @!method initialize(id:, created_at:, customer_id:, default:, external_payment_method_id:, payment_method_type:, provider_type:)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::Webhooks::PaymentMethodDeletedStandardWebhookEvent::PaymentMethod}
+          #   for more details.
+          #
+          #   A payment method represents a customer's stored payment instrument held with an
+          #   external payment provider (such as Adyen or Stripe).
+          #
+          #   The serialization is intentionally minimal for now; provider-pulled details
+          #   (e.g. card display metadata) will be added over time.
+          #
+          #   @param id [String] The Orb-assigned unique identifier for the payment method.
+          #
+          #   @param created_at [Time] The time at which the payment method was created.
+          #
+          #   @param customer_id [String] The ID of the Orb customer this payment method is attached to.
+          #
+          #   @param default [Boolean] Whether this is the customer's default payment method.
+          #
+          #   @param external_payment_method_id [String] The identifier of this payment method in the external payment provider.
+          #
+          #   @param payment_method_type [Symbol, Orb::Models::Webhooks::PaymentMethodDeletedStandardWebhookEvent::PaymentMethod::PaymentMethodType] The type of the underlying payment instrument, e.g. `card` or `us_bank_account`.
+          #
+          #   @param provider_type [String, nil] The external payment provider this method belongs to, derived from the linked pa
+
+          # The type of the underlying payment instrument, e.g. `card` or `us_bank_account`.
+          #
+          # @see Orb::Models::Webhooks::PaymentMethodDeletedStandardWebhookEvent::PaymentMethod#payment_method_type
+          module PaymentMethodType
+            extend Orb::Internal::Type::Enum
+
+            CARD = :card
+            US_BANK_ACCOUNT = :us_bank_account
+            LINK = :link
+            AMAZON_PAY = :amazon_pay
+            CRYPTO = :crypto
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # The event this payload describes.
+        #
+        # @see Orb::Models::Webhooks::PaymentMethodDeletedStandardWebhookEvent#type
+        module Type
+          extend Orb::Internal::Type::Enum
+
+          PAYMENT_METHOD_DELETED = :"payment_method.deleted"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Webhooks
+      class PlanCreatedStandardWebhookEvent < 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::PlanCreatedStandardWebhookEvent::PayloadStyle]
+        required :payload_style, enum: -> { Orb::Webhooks::PlanCreatedStandardWebhookEvent::PayloadStyle }
+
+        # @!attribute plan
+        #
+        #   @return [Orb::Models::Webhooks::PlanCreatedStandardWebhookEvent::Plan]
+        required :plan, -> { Orb::Webhooks::PlanCreatedStandardWebhookEvent::Plan }
+
+        # @!attribute properties
+        #
+        #   @return [Object]
+        required :properties, Orb::Internal::Type::Unknown
+
+        # @!attribute type
+        #   The event this payload describes.
+        #
+        #   @return [Symbol, Orb::Models::Webhooks::PlanCreatedStandardWebhookEvent::Type]
+        required :type, enum: -> { Orb::Webhooks::PlanCreatedStandardWebhookEvent::Type }
+
+        # @!method initialize(id:, created_at:, payload_style:, plan:, properties:, type:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Webhooks::PlanCreatedStandardWebhookEvent} for more details.
+        #
+        #   Issued when a plan is created, or when a draft plan is published.
+        #
+        #   @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::PlanCreatedStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
+        #
+        #   @param plan [Orb::Models::Webhooks::PlanCreatedStandardWebhookEvent::Plan]
+        #
+        #   @param properties [Object]
+        #
+        #   @param type [Symbol, Orb::Models::Webhooks::PlanCreatedStandardWebhookEvent::Type] The event this payload describes.
+
+        # The serialization style this payload was rendered in, as configured on the
+        # endpoint.
+        #
+        # @see Orb::Models::Webhooks::PlanCreatedStandardWebhookEvent#payload_style
+        module PayloadStyle
+          extend Orb::Internal::Type::Enum
+
+          EXPANDED = :expanded
+          STANDARD = :standard
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Orb::Models::Webhooks::PlanCreatedStandardWebhookEvent#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::PlanCreatedStandardWebhookEvent::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
+
+        # The event this payload describes.
+        #
+        # @see Orb::Models::Webhooks::PlanCreatedStandardWebhookEvent#type
+        module Type
+          extend Orb::Internal::Type::Enum
+
+          PLAN_CREATED = :"plan.created"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end