orb-billing 0.12.0 → 1.0.0

data/sig/orb/models/mutated_subscription.rbs

@@ -0,0 +1,178 @@
+module Orb
+  module Models
+    type mutated_subscription =
+      {
+        id: String,
+        active_plan_phase_order: Integer?,
+        adjustment_intervals: ::Array[Orb::AdjustmentInterval],
+        auto_collection: bool?,
+        billing_cycle_anchor_configuration: Orb::BillingCycleAnchorConfiguration,
+        billing_cycle_day: Integer,
+        created_at: Time,
+        current_billing_period_end_date: Time?,
+        current_billing_period_start_date: Time?,
+        customer: Orb::Customer,
+        default_invoice_memo: String?,
+        discount_intervals: ::Array[Orb::Models::MutatedSubscription::discount_interval],
+        end_date: Time?,
+        fixed_fee_quantity_schedule: ::Array[Orb::FixedFeeQuantityScheduleEntry],
+        invoicing_threshold: String?,
+        maximum_intervals: ::Array[Orb::MaximumInterval],
+        metadata: ::Hash[Symbol, String],
+        minimum_intervals: ::Array[Orb::MinimumInterval],
+        name: String,
+        net_terms: Integer,
+        pending_subscription_change: Orb::SubscriptionChangeMinified?,
+        plan: Orb::Plan?,
+        price_intervals: ::Array[Orb::PriceInterval],
+        redeemed_coupon: Orb::CouponRedemption?,
+        start_date: Time,
+        status: Orb::Models::MutatedSubscription::status,
+        trial_info: Orb::SubscriptionTrialInfo,
+        changed_resources: Orb::ChangedSubscriptionResources?
+      }
+
+    class MutatedSubscription < Orb::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor active_plan_phase_order: Integer?
+
+      attr_accessor adjustment_intervals: ::Array[Orb::AdjustmentInterval]
+
+      attr_accessor auto_collection: bool?
+
+      attr_accessor billing_cycle_anchor_configuration: Orb::BillingCycleAnchorConfiguration
+
+      attr_accessor billing_cycle_day: Integer
+
+      attr_accessor created_at: Time
+
+      attr_accessor current_billing_period_end_date: Time?
+
+      attr_accessor current_billing_period_start_date: Time?
+
+      attr_accessor customer: Orb::Customer
+
+      attr_accessor default_invoice_memo: String?
+
+      attr_accessor discount_intervals: ::Array[Orb::Models::MutatedSubscription::discount_interval]
+
+      attr_accessor end_date: Time?
+
+      attr_accessor fixed_fee_quantity_schedule: ::Array[Orb::FixedFeeQuantityScheduleEntry]
+
+      attr_accessor invoicing_threshold: String?
+
+      attr_accessor maximum_intervals: ::Array[Orb::MaximumInterval]
+
+      attr_accessor metadata: ::Hash[Symbol, String]
+
+      attr_accessor minimum_intervals: ::Array[Orb::MinimumInterval]
+
+      attr_accessor name: String
+
+      attr_accessor net_terms: Integer
+
+      attr_accessor pending_subscription_change: Orb::SubscriptionChangeMinified?
+
+      attr_accessor plan: Orb::Plan?
+
+      attr_accessor price_intervals: ::Array[Orb::PriceInterval]
+
+      attr_accessor redeemed_coupon: Orb::CouponRedemption?
+
+      attr_accessor start_date: Time
+
+      attr_accessor status: Orb::Models::MutatedSubscription::status
+
+      attr_accessor trial_info: Orb::SubscriptionTrialInfo
+
+      attr_accessor changed_resources: Orb::ChangedSubscriptionResources?
+
+      def initialize: (
+        id: String,
+        active_plan_phase_order: Integer?,
+        adjustment_intervals: ::Array[Orb::AdjustmentInterval],
+        auto_collection: bool?,
+        billing_cycle_anchor_configuration: Orb::BillingCycleAnchorConfiguration,
+        billing_cycle_day: Integer,
+        created_at: Time,
+        current_billing_period_end_date: Time?,
+        current_billing_period_start_date: Time?,
+        customer: Orb::Customer,
+        default_invoice_memo: String?,
+        discount_intervals: ::Array[Orb::Models::MutatedSubscription::discount_interval],
+        end_date: Time?,
+        fixed_fee_quantity_schedule: ::Array[Orb::FixedFeeQuantityScheduleEntry],
+        invoicing_threshold: String?,
+        maximum_intervals: ::Array[Orb::MaximumInterval],
+        metadata: ::Hash[Symbol, String],
+        minimum_intervals: ::Array[Orb::MinimumInterval],
+        name: String,
+        net_terms: Integer,
+        pending_subscription_change: Orb::SubscriptionChangeMinified?,
+        plan: Orb::Plan?,
+        price_intervals: ::Array[Orb::PriceInterval],
+        redeemed_coupon: Orb::CouponRedemption?,
+        start_date: Time,
+        status: Orb::Models::MutatedSubscription::status,
+        trial_info: Orb::SubscriptionTrialInfo,
+        ?changed_resources: Orb::ChangedSubscriptionResources?
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        active_plan_phase_order: Integer?,
+        adjustment_intervals: ::Array[Orb::AdjustmentInterval],
+        auto_collection: bool?,
+        billing_cycle_anchor_configuration: Orb::BillingCycleAnchorConfiguration,
+        billing_cycle_day: Integer,
+        created_at: Time,
+        current_billing_period_end_date: Time?,
+        current_billing_period_start_date: Time?,
+        customer: Orb::Customer,
+        default_invoice_memo: String?,
+        discount_intervals: ::Array[Orb::Models::MutatedSubscription::discount_interval],
+        end_date: Time?,
+        fixed_fee_quantity_schedule: ::Array[Orb::FixedFeeQuantityScheduleEntry],
+        invoicing_threshold: String?,
+        maximum_intervals: ::Array[Orb::MaximumInterval],
+        metadata: ::Hash[Symbol, String],
+        minimum_intervals: ::Array[Orb::MinimumInterval],
+        name: String,
+        net_terms: Integer,
+        pending_subscription_change: Orb::SubscriptionChangeMinified?,
+        plan: Orb::Plan?,
+        price_intervals: ::Array[Orb::PriceInterval],
+        redeemed_coupon: Orb::CouponRedemption?,
+        start_date: Time,
+        status: Orb::Models::MutatedSubscription::status,
+        trial_info: Orb::SubscriptionTrialInfo,
+        changed_resources: Orb::ChangedSubscriptionResources?
+      }
+
+      type discount_interval =
+        Orb::AmountDiscountInterval
+        | Orb::PercentageDiscountInterval
+        | Orb::UsageDiscountInterval
+
+      module DiscountInterval
+        extend Orb::Internal::Type::Union
+
+        def self?.variants: -> ::Array[Orb::Models::MutatedSubscription::discount_interval]
+      end
+
+      type status = :active | :ended | :upcoming
+
+      module Status
+        extend Orb::Internal::Type::Enum
+
+        ACTIVE: :active
+        ENDED: :ended
+        UPCOMING: :upcoming
+
+        def self?.values: -> ::Array[Orb::Models::MutatedSubscription::status]
+      end
+    end
+  end
+end

data/sig/orb/models/new_accounting_sync_configuration.rbs

@@ -0,0 +1,25 @@
+module Orb
+  module Models
+    type new_accounting_sync_configuration =
+      {
+        accounting_providers: ::Array[Orb::AccountingProviderConfig]?,
+        excluded: bool?
+      }
+
+    class NewAccountingSyncConfiguration < Orb::Internal::Type::BaseModel
+      attr_accessor accounting_providers: ::Array[Orb::AccountingProviderConfig]?
+
+      attr_accessor excluded: bool?
+
+      def initialize: (
+        ?accounting_providers: ::Array[Orb::AccountingProviderConfig]?,
+        ?excluded: bool?
+      ) -> void
+
+      def to_hash: -> {
+        accounting_providers: ::Array[Orb::AccountingProviderConfig]?,
+        excluded: bool?
+      }
+    end
+  end
+end

data/sig/orb/models/new_allocation_price.rbs

@@ -0,0 +1,56 @@
+module Orb
+  module Models
+    type new_allocation_price =
+      {
+        amount: String,
+        cadence: Orb::Models::NewAllocationPrice::cadence,
+        currency: String,
+        custom_expiration: Orb::CustomExpiration?,
+        expires_at_end_of_cadence: bool?
+      }
+
+    class NewAllocationPrice < Orb::Internal::Type::BaseModel
+      attr_accessor amount: String
+
+      attr_accessor cadence: Orb::Models::NewAllocationPrice::cadence
+
+      attr_accessor currency: String
+
+      attr_accessor custom_expiration: Orb::CustomExpiration?
+
+      attr_accessor expires_at_end_of_cadence: bool?
+
+      def initialize: (
+        amount: String,
+        cadence: Orb::Models::NewAllocationPrice::cadence,
+        currency: String,
+        ?custom_expiration: Orb::CustomExpiration?,
+        ?expires_at_end_of_cadence: bool?
+      ) -> void
+
+      def to_hash: -> {
+        amount: String,
+        cadence: Orb::Models::NewAllocationPrice::cadence,
+        currency: String,
+        custom_expiration: Orb::CustomExpiration?,
+        expires_at_end_of_cadence: bool?
+      }
+
+      type cadence =
+        :one_time | :monthly | :quarterly | :semi_annual | :annual | :custom
+
+      module Cadence
+        extend Orb::Internal::Type::Enum
+
+        ONE_TIME: :one_time
+        MONTHLY: :monthly
+        QUARTERLY: :quarterly
+        SEMI_ANNUAL: :semi_annual
+        ANNUAL: :annual
+        CUSTOM: :custom
+
+        def self?.values: -> ::Array[Orb::Models::NewAllocationPrice::cadence]
+      end
+    end
+  end
+end

data/sig/orb/models/new_amount_discount.rbs

@@ -0,0 +1,97 @@
+module Orb
+  module Models
+    type new_amount_discount =
+      {
+        adjustment_type: Orb::Models::NewAmountDiscount::adjustment_type,
+        amount_discount: String,
+        applies_to_all: Orb::Models::NewAmountDiscount::applies_to_all?,
+        applies_to_item_ids: ::Array[String]?,
+        applies_to_price_ids: ::Array[String]?,
+        currency: String?,
+        filters: ::Array[Orb::TransformPriceFilter]?,
+        is_invoice_level: bool,
+        price_type: Orb::Models::NewAmountDiscount::price_type?
+      }
+
+    class NewAmountDiscount < Orb::Internal::Type::BaseModel
+      attr_accessor adjustment_type: Orb::Models::NewAmountDiscount::adjustment_type
+
+      attr_accessor amount_discount: String
+
+      attr_accessor applies_to_all: Orb::Models::NewAmountDiscount::applies_to_all?
+
+      attr_accessor applies_to_item_ids: ::Array[String]?
+
+      attr_accessor applies_to_price_ids: ::Array[String]?
+
+      attr_accessor currency: String?
+
+      attr_accessor filters: ::Array[Orb::TransformPriceFilter]?
+
+      attr_reader is_invoice_level: bool?
+
+      def is_invoice_level=: (bool) -> bool
+
+      attr_accessor price_type: Orb::Models::NewAmountDiscount::price_type?
+
+      def initialize: (
+        adjustment_type: Orb::Models::NewAmountDiscount::adjustment_type,
+        amount_discount: String,
+        ?applies_to_all: Orb::Models::NewAmountDiscount::applies_to_all?,
+        ?applies_to_item_ids: ::Array[String]?,
+        ?applies_to_price_ids: ::Array[String]?,
+        ?currency: String?,
+        ?filters: ::Array[Orb::TransformPriceFilter]?,
+        ?is_invoice_level: bool,
+        ?price_type: Orb::Models::NewAmountDiscount::price_type?
+      ) -> void
+
+      def to_hash: -> {
+        adjustment_type: Orb::Models::NewAmountDiscount::adjustment_type,
+        amount_discount: String,
+        applies_to_all: Orb::Models::NewAmountDiscount::applies_to_all?,
+        applies_to_item_ids: ::Array[String]?,
+        applies_to_price_ids: ::Array[String]?,
+        currency: String?,
+        filters: ::Array[Orb::TransformPriceFilter]?,
+        is_invoice_level: bool,
+        price_type: Orb::Models::NewAmountDiscount::price_type?
+      }
+
+      type adjustment_type = :amount_discount
+
+      module AdjustmentType
+        extend Orb::Internal::Type::Enum
+
+        AMOUNT_DISCOUNT: :amount_discount
+
+        def self?.values: -> ::Array[Orb::Models::NewAmountDiscount::adjustment_type]
+      end
+
+      type applies_to_all = true
+
+      module AppliesToAll
+        extend Orb::Internal::Type::Enum
+
+        TRUE: true
+
+        def self?.values: -> ::Array[Orb::Models::NewAmountDiscount::applies_to_all]
+      end
+
+      type price_type =
+        :usage | :fixed_in_advance | :fixed_in_arrears | :fixed | :in_arrears
+
+      module PriceType
+        extend Orb::Internal::Type::Enum
+
+        USAGE: :usage
+        FIXED_IN_ADVANCE: :fixed_in_advance
+        FIXED_IN_ARREARS: :fixed_in_arrears
+        FIXED: :fixed
+        IN_ARREARS: :in_arrears
+
+        def self?.values: -> ::Array[Orb::Models::NewAmountDiscount::price_type]
+      end
+    end
+  end
+end

data/sig/orb/models/new_avalara_tax_configuration.rbs

@@ -0,0 +1,40 @@
+module Orb
+  module Models
+    type new_avalara_tax_configuration =
+      {
+        tax_exempt: bool,
+        tax_provider: Orb::Models::NewAvalaraTaxConfiguration::tax_provider,
+        tax_exemption_code: String?
+      }
+
+    class NewAvalaraTaxConfiguration < Orb::Internal::Type::BaseModel
+      attr_accessor tax_exempt: bool
+
+      attr_accessor tax_provider: Orb::Models::NewAvalaraTaxConfiguration::tax_provider
+
+      attr_accessor tax_exemption_code: String?
+
+      def initialize: (
+        tax_exempt: bool,
+        tax_provider: Orb::Models::NewAvalaraTaxConfiguration::tax_provider,
+        ?tax_exemption_code: String?
+      ) -> void
+
+      def to_hash: -> {
+        tax_exempt: bool,
+        tax_provider: Orb::Models::NewAvalaraTaxConfiguration::tax_provider,
+        tax_exemption_code: String?
+      }
+
+      type tax_provider = :avalara
+
+      module TaxProvider
+        extend Orb::Internal::Type::Enum
+
+        AVALARA: :avalara
+
+        def self?.values: -> ::Array[Orb::Models::NewAvalaraTaxConfiguration::tax_provider]
+      end
+    end
+  end
+end

data/sig/orb/models/new_billing_cycle_configuration.rbs

@@ -0,0 +1,36 @@
+module Orb
+  module Models
+    type new_billing_cycle_configuration =
+      {
+        duration: Integer,
+        duration_unit: Orb::Models::NewBillingCycleConfiguration::duration_unit
+      }
+
+    class NewBillingCycleConfiguration < Orb::Internal::Type::BaseModel
+      attr_accessor duration: Integer
+
+      attr_accessor duration_unit: Orb::Models::NewBillingCycleConfiguration::duration_unit
+
+      def initialize: (
+        duration: Integer,
+        duration_unit: Orb::Models::NewBillingCycleConfiguration::duration_unit
+      ) -> void
+
+      def to_hash: -> {
+        duration: Integer,
+        duration_unit: Orb::Models::NewBillingCycleConfiguration::duration_unit
+      }
+
+      type duration_unit = :day | :month
+
+      module DurationUnit
+        extend Orb::Internal::Type::Enum
+
+        DAY: :day
+        MONTH: :month
+
+        def self?.values: -> ::Array[Orb::Models::NewBillingCycleConfiguration::duration_unit]
+      end
+    end
+  end
+end

data/sig/orb/models/new_dimensional_price_configuration.rbs

@@ -0,0 +1,30 @@
+module Orb
+  module Models
+    type new_dimensional_price_configuration =
+      {
+        dimension_values: ::Array[String],
+        dimensional_price_group_id: String?,
+        external_dimensional_price_group_id: String?
+      }
+
+    class NewDimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
+      attr_accessor dimension_values: ::Array[String]
+
+      attr_accessor dimensional_price_group_id: String?
+
+      attr_accessor external_dimensional_price_group_id: String?
+
+      def initialize: (
+        dimension_values: ::Array[String],
+        ?dimensional_price_group_id: String?,
+        ?external_dimensional_price_group_id: String?
+      ) -> void
+
+      def to_hash: -> {
+        dimension_values: ::Array[String],
+        dimensional_price_group_id: String?,
+        external_dimensional_price_group_id: String?
+      }
+    end
+  end
+end

data/sig/orb/models/new_floating_bps_price.rbs

@@ -0,0 +1,135 @@
+module Orb
+  module Models
+    type new_floating_bps_price =
+      {
+        bps_config: Orb::BPSConfig,
+        cadence: Orb::Models::NewFloatingBPSPrice::cadence,
+        currency: String,
+        item_id: String,
+        model_type: Orb::Models::NewFloatingBPSPrice::model_type,
+        name: String,
+        billable_metric_id: String?,
+        billed_in_advance: bool?,
+        billing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
+        conversion_rate: Float?,
+        conversion_rate_config: Orb::Models::NewFloatingBPSPrice::conversion_rate_config?,
+        dimensional_price_configuration: Orb::NewDimensionalPriceConfiguration?,
+        external_price_id: String?,
+        fixed_price_quantity: Float?,
+        invoice_grouping_key: String?,
+        invoicing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
+        metadata: ::Hash[Symbol, String?]?
+      }
+
+    class NewFloatingBPSPrice < Orb::Internal::Type::BaseModel
+      attr_accessor bps_config: Orb::BPSConfig
+
+      attr_accessor cadence: Orb::Models::NewFloatingBPSPrice::cadence
+
+      attr_accessor currency: String
+
+      attr_accessor item_id: String
+
+      attr_accessor model_type: Orb::Models::NewFloatingBPSPrice::model_type
+
+      attr_accessor name: String
+
+      attr_accessor billable_metric_id: String?
+
+      attr_accessor billed_in_advance: bool?
+
+      attr_accessor billing_cycle_configuration: Orb::NewBillingCycleConfiguration?
+
+      attr_accessor conversion_rate: Float?
+
+      attr_accessor conversion_rate_config: Orb::Models::NewFloatingBPSPrice::conversion_rate_config?
+
+      attr_accessor dimensional_price_configuration: Orb::NewDimensionalPriceConfiguration?
+
+      attr_accessor external_price_id: String?
+
+      attr_accessor fixed_price_quantity: Float?
+
+      attr_accessor invoice_grouping_key: String?
+
+      attr_accessor invoicing_cycle_configuration: Orb::NewBillingCycleConfiguration?
+
+      attr_accessor metadata: ::Hash[Symbol, String?]?
+
+      def initialize: (
+        bps_config: Orb::BPSConfig,
+        cadence: Orb::Models::NewFloatingBPSPrice::cadence,
+        currency: String,
+        item_id: String,
+        model_type: Orb::Models::NewFloatingBPSPrice::model_type,
+        name: String,
+        ?billable_metric_id: String?,
+        ?billed_in_advance: bool?,
+        ?billing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
+        ?conversion_rate: Float?,
+        ?conversion_rate_config: Orb::Models::NewFloatingBPSPrice::conversion_rate_config?,
+        ?dimensional_price_configuration: Orb::NewDimensionalPriceConfiguration?,
+        ?external_price_id: String?,
+        ?fixed_price_quantity: Float?,
+        ?invoice_grouping_key: String?,
+        ?invoicing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
+        ?metadata: ::Hash[Symbol, String?]?
+      ) -> void
+
+      def to_hash: -> {
+        bps_config: Orb::BPSConfig,
+        cadence: Orb::Models::NewFloatingBPSPrice::cadence,
+        currency: String,
+        item_id: String,
+        model_type: Orb::Models::NewFloatingBPSPrice::model_type,
+        name: String,
+        billable_metric_id: String?,
+        billed_in_advance: bool?,
+        billing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
+        conversion_rate: Float?,
+        conversion_rate_config: Orb::Models::NewFloatingBPSPrice::conversion_rate_config?,
+        dimensional_price_configuration: Orb::NewDimensionalPriceConfiguration?,
+        external_price_id: String?,
+        fixed_price_quantity: Float?,
+        invoice_grouping_key: String?,
+        invoicing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
+        metadata: ::Hash[Symbol, String?]?
+      }
+
+      type cadence =
+        :annual | :semi_annual | :monthly | :quarterly | :one_time | :custom
+
+      module Cadence
+        extend Orb::Internal::Type::Enum
+
+        ANNUAL: :annual
+        SEMI_ANNUAL: :semi_annual
+        MONTHLY: :monthly
+        QUARTERLY: :quarterly
+        ONE_TIME: :one_time
+        CUSTOM: :custom
+
+        def self?.values: -> ::Array[Orb::Models::NewFloatingBPSPrice::cadence]
+      end
+
+      type model_type = :bps
+
+      module ModelType
+        extend Orb::Internal::Type::Enum
+
+        BPS: :bps
+
+        def self?.values: -> ::Array[Orb::Models::NewFloatingBPSPrice::model_type]
+      end
+
+      type conversion_rate_config =
+        Orb::UnitConversionRateConfig | Orb::TieredConversionRateConfig
+
+      module ConversionRateConfig
+        extend Orb::Internal::Type::Union
+
+        def self?.variants: -> ::Array[Orb::Models::NewFloatingBPSPrice::conversion_rate_config]
+      end
+    end
+  end
+end