orb-billing 1.35.0 → 1.36.0

data/sig/orb/models/subscription_trial_ended_webhook_event.rbs

@@ -0,0 +1,50 @@
+module Orb
+  module Models
+    type subscription_trial_ended_webhook_event =
+      {
+        id: String,
+        created_at: Time,
+        properties: top,
+        subscription: Orb::Subscription,
+        type: Orb::Models::SubscriptionTrialEndedWebhookEvent::type_
+      }
+
+    class SubscriptionTrialEndedWebhookEvent < Orb::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created_at: Time
+
+      attr_accessor properties: top
+
+      attr_accessor subscription: Orb::Subscription
+
+      attr_accessor type: Orb::Models::SubscriptionTrialEndedWebhookEvent::type_
+
+      def initialize: (
+        id: String,
+        created_at: Time,
+        properties: top,
+        subscription: Orb::Subscription,
+        type: Orb::Models::SubscriptionTrialEndedWebhookEvent::type_
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        created_at: Time,
+        properties: top,
+        subscription: Orb::Subscription,
+        type: Orb::Models::SubscriptionTrialEndedWebhookEvent::type_
+      }
+
+      type type_ = :"subscription.trial_ended"
+
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        SUBSCRIPTION_TRIAL_ENDED: :"subscription.trial_ended"
+
+        def self?.values: -> ::Array[Orb::Models::SubscriptionTrialEndedWebhookEvent::type_]
+      end
+    end
+  end
+end

data/sig/orb/models/subscription_usage_exceeded_webhook_event.rbs

@@ -0,0 +1,367 @@
+module Orb
+  module Models
+    type subscription_usage_exceeded_webhook_event =
+      {
+        id: String,
+        created_at: Time,
+        properties: Orb::SubscriptionUsageExceededWebhookEvent::Properties,
+        subscription: Orb::Subscription,
+        type: Orb::Models::SubscriptionUsageExceededWebhookEvent::type_
+      }
+
+    class SubscriptionUsageExceededWebhookEvent < Orb::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created_at: Time
+
+      attr_accessor properties: Orb::SubscriptionUsageExceededWebhookEvent::Properties
+
+      attr_accessor subscription: Orb::Subscription
+
+      attr_accessor type: Orb::Models::SubscriptionUsageExceededWebhookEvent::type_
+
+      def initialize: (
+        id: String,
+        created_at: Time,
+        properties: Orb::SubscriptionUsageExceededWebhookEvent::Properties,
+        subscription: Orb::Subscription,
+        type: Orb::Models::SubscriptionUsageExceededWebhookEvent::type_
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        created_at: Time,
+        properties: Orb::SubscriptionUsageExceededWebhookEvent::Properties,
+        subscription: Orb::Subscription,
+        type: Orb::Models::SubscriptionUsageExceededWebhookEvent::type_
+      }
+
+      type properties =
+        {
+          alert_configuration: Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration,
+          billable_metric_id: String,
+          evaluated_quantity: Float?,
+          quantity_threshold: Float?,
+          timeframe_end: Time,
+          timeframe_start: Time
+        }
+
+      class Properties < Orb::Internal::Type::BaseModel
+        attr_accessor alert_configuration: Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration
+
+        attr_accessor billable_metric_id: String
+
+        attr_accessor evaluated_quantity: Float?
+
+        attr_accessor quantity_threshold: Float?
+
+        attr_accessor timeframe_end: Time
+
+        attr_accessor timeframe_start: Time
+
+        def initialize: (
+          alert_configuration: Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration,
+          billable_metric_id: String,
+          evaluated_quantity: Float?,
+          quantity_threshold: Float?,
+          timeframe_end: Time,
+          timeframe_start: Time
+        ) -> void
+
+        def to_hash: -> {
+          alert_configuration: Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration,
+          billable_metric_id: String,
+          evaluated_quantity: Float?,
+          quantity_threshold: Float?,
+          timeframe_end: Time,
+          timeframe_start: Time
+        }
+
+        type alert_configuration =
+          {
+            id: String,
+            created_at: Time,
+            currency: String?,
+            customer: Orb::CustomerMinified?,
+            enabled: bool,
+            metric: Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::Metric?,
+            plan: Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::Plan?,
+            subscription: Orb::SubscriptionMinified?,
+            thresholds: ::Array[Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::Threshold]?,
+            type: Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::type_,
+            balance_alert_status: ::Array[Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::BalanceAlertStatus]?,
+            grouping_keys: ::Array[String]?,
+            license_type: Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::LicenseType?,
+            price_filters: ::Array[Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::PriceFilter]?,
+            threshold_overrides: ::Array[Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::ThresholdOverride]?
+          }
+
+        class AlertConfiguration < Orb::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          attr_accessor created_at: Time
+
+          attr_accessor currency: String?
+
+          attr_accessor customer: Orb::CustomerMinified?
+
+          attr_accessor enabled: bool
+
+          attr_accessor metric: Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::Metric?
+
+          attr_accessor plan: Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::Plan?
+
+          attr_accessor subscription: Orb::SubscriptionMinified?
+
+          attr_accessor thresholds: ::Array[Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::Threshold]?
+
+          attr_accessor type: Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::type_
+
+          attr_accessor balance_alert_status: ::Array[Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::BalanceAlertStatus]?
+
+          attr_accessor grouping_keys: ::Array[String]?
+
+          attr_accessor license_type: Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::LicenseType?
+
+          attr_accessor price_filters: ::Array[Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::PriceFilter]?
+
+          attr_accessor threshold_overrides: ::Array[Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::ThresholdOverride]?
+
+          def initialize: (
+            id: String,
+            created_at: Time,
+            currency: String?,
+            customer: Orb::CustomerMinified?,
+            enabled: bool,
+            metric: Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::Metric?,
+            plan: Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::Plan?,
+            subscription: Orb::SubscriptionMinified?,
+            thresholds: ::Array[Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::Threshold]?,
+            type: Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::type_,
+            ?balance_alert_status: ::Array[Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::BalanceAlertStatus]?,
+            ?grouping_keys: ::Array[String]?,
+            ?license_type: Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::LicenseType?,
+            ?price_filters: ::Array[Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::PriceFilter]?,
+            ?threshold_overrides: ::Array[Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::ThresholdOverride]?
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            created_at: Time,
+            currency: String?,
+            customer: Orb::CustomerMinified?,
+            enabled: bool,
+            metric: Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::Metric?,
+            plan: Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::Plan?,
+            subscription: Orb::SubscriptionMinified?,
+            thresholds: ::Array[Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::Threshold]?,
+            type: Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::type_,
+            balance_alert_status: ::Array[Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::BalanceAlertStatus]?,
+            grouping_keys: ::Array[String]?,
+            license_type: Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::LicenseType?,
+            price_filters: ::Array[Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::PriceFilter]?,
+            threshold_overrides: ::Array[Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::ThresholdOverride]?
+          }
+
+          type metric = { id: String }
+
+          class Metric < Orb::Internal::Type::BaseModel
+            attr_accessor id: String
+
+            def initialize: (id: String) -> void
+
+            def to_hash: -> { id: String }
+          end
+
+          type plan =
+            {
+              id: String?,
+              external_plan_id: String?,
+              name: String?,
+              plan_version: String
+            }
+
+          class Plan < Orb::Internal::Type::BaseModel
+            attr_accessor id: String?
+
+            attr_accessor external_plan_id: String?
+
+            attr_accessor name: String?
+
+            attr_accessor plan_version: String
+
+            def initialize: (
+              id: String?,
+              external_plan_id: String?,
+              name: String?,
+              plan_version: String
+            ) -> void
+
+            def to_hash: -> {
+              id: String?,
+              external_plan_id: String?,
+              name: String?,
+              plan_version: String
+            }
+          end
+
+          type threshold = { value: String }
+
+          class Threshold < Orb::Internal::Type::BaseModel
+            attr_accessor value: String
+
+            def initialize: (value: String) -> void
+
+            def to_hash: -> { value: String }
+          end
+
+          type type_ =
+            :credit_balance_depleted
+            | :credit_balance_dropped
+            | :credit_balance_recovered
+            | :usage_exceeded
+            | :cost_exceeded
+            | :spend_exceeded
+            | :license_balance_threshold_reached
+
+          module Type
+            extend Orb::Internal::Type::Enum
+
+            CREDIT_BALANCE_DEPLETED: :credit_balance_depleted
+            CREDIT_BALANCE_DROPPED: :credit_balance_dropped
+            CREDIT_BALANCE_RECOVERED: :credit_balance_recovered
+            USAGE_EXCEEDED: :usage_exceeded
+            COST_EXCEEDED: :cost_exceeded
+            SPEND_EXCEEDED: :spend_exceeded
+            LICENSE_BALANCE_THRESHOLD_REACHED: :license_balance_threshold_reached
+
+            def self?.values: -> ::Array[Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::type_]
+          end
+
+          type balance_alert_status =
+            { in_alert: bool, threshold_value: String }
+
+          class BalanceAlertStatus < Orb::Internal::Type::BaseModel
+            attr_accessor in_alert: bool
+
+            attr_accessor threshold_value: String
+
+            def initialize: (in_alert: bool, threshold_value: String) -> void
+
+            def to_hash: -> { in_alert: bool, threshold_value: String }
+          end
+
+          type license_type = { id: String }
+
+          class LicenseType < Orb::Internal::Type::BaseModel
+            attr_accessor id: String
+
+            def initialize: (id: String) -> void
+
+            def to_hash: -> { id: String }
+          end
+
+          type price_filter =
+            {
+              field: Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::PriceFilter::field,
+              operator: Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::PriceFilter::operator,
+              values: ::Array[String]
+            }
+
+          class PriceFilter < Orb::Internal::Type::BaseModel
+            attr_accessor field: Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::PriceFilter::field
+
+            attr_accessor operator: Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::PriceFilter::operator
+
+            attr_accessor values: ::Array[String]
+
+            def initialize: (
+              field: Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::PriceFilter::field,
+              operator: Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::PriceFilter::operator,
+              values: ::Array[String]
+            ) -> void
+
+            def to_hash: -> {
+              field: Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::PriceFilter::field,
+              operator: Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::PriceFilter::operator,
+              values: ::Array[String]
+            }
+
+            type field =
+              :price_id | :item_id | :price_type | :currency | :pricing_unit_id
+
+            module Field
+              extend Orb::Internal::Type::Enum
+
+              PRICE_ID: :price_id
+              ITEM_ID: :item_id
+              PRICE_TYPE: :price_type
+              CURRENCY: :currency
+              PRICING_UNIT_ID: :pricing_unit_id
+
+              def self?.values: -> ::Array[Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::PriceFilter::field]
+            end
+
+            type operator = :includes | :excludes
+
+            module Operator
+              extend Orb::Internal::Type::Enum
+
+              INCLUDES: :includes
+              EXCLUDES: :excludes
+
+              def self?.values: -> ::Array[Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::PriceFilter::operator]
+            end
+          end
+
+          type threshold_override =
+            {
+              group_values: ::Array[String],
+              thresholds: ::Array[Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::ThresholdOverride::Threshold],
+              group_keys: ::Array[String]?
+            }
+
+          class ThresholdOverride < Orb::Internal::Type::BaseModel
+            attr_accessor group_values: ::Array[String]
+
+            attr_accessor thresholds: ::Array[Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::ThresholdOverride::Threshold]
+
+            attr_accessor group_keys: ::Array[String]?
+
+            def initialize: (
+              group_values: ::Array[String],
+              thresholds: ::Array[Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::ThresholdOverride::Threshold],
+              ?group_keys: ::Array[String]?
+            ) -> void
+
+            def to_hash: -> {
+              group_values: ::Array[String],
+              thresholds: ::Array[Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::ThresholdOverride::Threshold],
+              group_keys: ::Array[String]?
+            }
+
+            type threshold = { value: String }
+
+            class Threshold < Orb::Internal::Type::BaseModel
+              attr_accessor value: String
+
+              def initialize: (value: String) -> void
+
+              def to_hash: -> { value: String }
+            end
+          end
+        end
+      end
+
+      type type_ = :"subscription.usage_exceeded"
+
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        SUBSCRIPTION_USAGE_EXCEEDED: :"subscription.usage_exceeded"
+
+        def self?.values: -> ::Array[Orb::Models::SubscriptionUsageExceededWebhookEvent::type_]
+      end
+    end
+  end
+end

data/sig/orb/models/transaction_accounting_sync_failed_webhook_event.rbs

@@ -0,0 +1,205 @@
+module Orb
+  module Models
+    type transaction_accounting_sync_failed_webhook_event =
+      {
+        id: String,
+        accounting_sync_record: Orb::TransactionAccountingSyncFailedWebhookEvent::AccountingSyncRecord,
+        created_at: Time,
+        properties: Orb::TransactionAccountingSyncFailedWebhookEvent::Properties,
+        transaction: Orb::TransactionAccountingSyncFailedWebhookEvent::Transaction,
+        type: Orb::Models::TransactionAccountingSyncFailedWebhookEvent::type_
+      }
+
+    class TransactionAccountingSyncFailedWebhookEvent < Orb::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor accounting_sync_record: Orb::TransactionAccountingSyncFailedWebhookEvent::AccountingSyncRecord
+
+      attr_accessor created_at: Time
+
+      attr_accessor properties: Orb::TransactionAccountingSyncFailedWebhookEvent::Properties
+
+      attr_accessor transaction: Orb::TransactionAccountingSyncFailedWebhookEvent::Transaction
+
+      attr_accessor type: Orb::Models::TransactionAccountingSyncFailedWebhookEvent::type_
+
+      def initialize: (
+        id: String,
+        accounting_sync_record: Orb::TransactionAccountingSyncFailedWebhookEvent::AccountingSyncRecord,
+        created_at: Time,
+        properties: Orb::TransactionAccountingSyncFailedWebhookEvent::Properties,
+        transaction: Orb::TransactionAccountingSyncFailedWebhookEvent::Transaction,
+        type: Orb::Models::TransactionAccountingSyncFailedWebhookEvent::type_
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        accounting_sync_record: Orb::TransactionAccountingSyncFailedWebhookEvent::AccountingSyncRecord,
+        created_at: Time,
+        properties: Orb::TransactionAccountingSyncFailedWebhookEvent::Properties,
+        transaction: Orb::TransactionAccountingSyncFailedWebhookEvent::Transaction,
+        type: Orb::Models::TransactionAccountingSyncFailedWebhookEvent::type_
+      }
+
+      type accounting_sync_record =
+        {
+          id: String,
+          customer_id: String,
+          record_type: Orb::Models::TransactionAccountingSyncFailedWebhookEvent::AccountingSyncRecord::record_type,
+          error_details: ::Hash[Symbol, top]?,
+          provider_customer_id: String?,
+          status: String?,
+          sync_action: String?,
+          transaction_record_id: String?
+        }
+
+      class AccountingSyncRecord < Orb::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor customer_id: String
+
+        attr_accessor record_type: Orb::Models::TransactionAccountingSyncFailedWebhookEvent::AccountingSyncRecord::record_type
+
+        attr_accessor error_details: ::Hash[Symbol, top]?
+
+        attr_accessor provider_customer_id: String?
+
+        attr_accessor status: String?
+
+        attr_accessor sync_action: String?
+
+        attr_accessor transaction_record_id: String?
+
+        def initialize: (
+          id: String,
+          customer_id: String,
+          record_type: Orb::Models::TransactionAccountingSyncFailedWebhookEvent::AccountingSyncRecord::record_type,
+          ?error_details: ::Hash[Symbol, top]?,
+          ?provider_customer_id: String?,
+          ?status: String?,
+          ?sync_action: String?,
+          ?transaction_record_id: String?
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          customer_id: String,
+          record_type: Orb::Models::TransactionAccountingSyncFailedWebhookEvent::AccountingSyncRecord::record_type,
+          error_details: ::Hash[Symbol, top]?,
+          provider_customer_id: String?,
+          status: String?,
+          sync_action: String?,
+          transaction_record_id: String?
+        }
+
+        type record_type =
+          :customer
+          | :invoice
+          | :transaction
+          | :customer_balance_transaction
+          | :credit_note
+          | :subscription
+          | :sales_order
+          | :block
+
+        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
+
+          def self?.values: -> ::Array[Orb::Models::TransactionAccountingSyncFailedWebhookEvent::AccountingSyncRecord::record_type]
+        end
+      end
+
+      type properties = { connection_type: String, failure_reason: String }
+
+      class Properties < Orb::Internal::Type::BaseModel
+        attr_accessor connection_type: String
+
+        attr_accessor failure_reason: String
+
+        def initialize: (
+          connection_type: String,
+          failure_reason: String
+        ) -> void
+
+        def to_hash: -> { connection_type: String, failure_reason: String }
+      end
+
+      type transaction =
+        {
+          id: String,
+          amount: String,
+          created_at: Time,
+          payment_provider: Orb::Models::TransactionAccountingSyncFailedWebhookEvent::Transaction::payment_provider?,
+          payment_provider_id: String?,
+          receipt_pdf: String?,
+          succeeded: bool
+        }
+
+      class Transaction < Orb::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor amount: String
+
+        attr_accessor created_at: Time
+
+        attr_accessor payment_provider: Orb::Models::TransactionAccountingSyncFailedWebhookEvent::Transaction::payment_provider?
+
+        attr_accessor payment_provider_id: String?
+
+        attr_accessor receipt_pdf: String?
+
+        attr_accessor succeeded: bool
+
+        def initialize: (
+          id: String,
+          amount: String,
+          created_at: Time,
+          payment_provider: Orb::Models::TransactionAccountingSyncFailedWebhookEvent::Transaction::payment_provider?,
+          payment_provider_id: String?,
+          receipt_pdf: String?,
+          succeeded: bool
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          amount: String,
+          created_at: Time,
+          payment_provider: Orb::Models::TransactionAccountingSyncFailedWebhookEvent::Transaction::payment_provider?,
+          payment_provider_id: String?,
+          receipt_pdf: String?,
+          succeeded: bool
+        }
+
+        type payment_provider = :stripe | :adyen
+
+        module PaymentProvider
+          extend Orb::Internal::Type::Enum
+
+          STRIPE: :stripe
+          ADYEN: :adyen
+
+          def self?.values: -> ::Array[Orb::Models::TransactionAccountingSyncFailedWebhookEvent::Transaction::payment_provider]
+        end
+      end
+
+      type type_ = :"transaction.accounting_sync_failed"
+
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        TRANSACTION_ACCOUNTING_SYNC_FAILED: :"transaction.accounting_sync_failed"
+
+        def self?.values: -> ::Array[Orb::Models::TransactionAccountingSyncFailedWebhookEvent::type_]
+      end
+    end
+  end
+end