orb-billing 0.12.0 → 1.0.0

data/lib/orb/models/billable_metric_tiny.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class BillableMetricTiny < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:)
+      #   @param id [String]
+    end
+  end
+end

data/lib/orb/models/billing_cycle_anchor_configuration.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel
+      # @!attribute day
+      #   The day of the month on which the billing cycle is anchored. If the maximum
+      #   number of days in a month is greater than this value, the last day of the month
+      #   is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
+      #   period begins on the 30th.
+      #
+      #   @return [Integer]
+      required :day, Integer
+
+      # @!attribute month
+      #   The month on which the billing cycle is anchored (e.g. a quarterly price
+      #   anchored in February would have cycles starting February, May, August, and
+      #   November).
+      #
+      #   @return [Integer, nil]
+      optional :month, Integer, nil?: true
+
+      # @!attribute year
+      #   The year on which the billing cycle is anchored (e.g. a 2 year billing cycle
+      #   anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.).
+      #
+      #   @return [Integer, nil]
+      optional :year, Integer, nil?: true
+
+      # @!method initialize(day:, month: nil, year: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::BillingCycleAnchorConfiguration} for more details.
+      #
+      #   @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
+      #
+      #   @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore
+      #
+      #   @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc
+    end
+  end
+end

data/lib/orb/models/billing_cycle_configuration.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
+      # @!attribute duration
+      #
+      #   @return [Integer]
+      required :duration, Integer
+
+      # @!attribute duration_unit
+      #
+      #   @return [Symbol, Orb::Models::BillingCycleConfiguration::DurationUnit]
+      required :duration_unit, enum: -> { Orb::BillingCycleConfiguration::DurationUnit }
+
+      # @!method initialize(duration:, duration_unit:)
+      #   @param duration [Integer]
+      #   @param duration_unit [Symbol, Orb::Models::BillingCycleConfiguration::DurationUnit]
+
+      # @see Orb::Models::BillingCycleConfiguration#duration_unit
+      module DurationUnit
+        extend Orb::Internal::Type::Enum
+
+        DAY = :day
+        MONTH = :month
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/bps_config.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class BPSConfig < Orb::Internal::Type::BaseModel
+      # @!attribute bps
+      #   Basis point take rate per event
+      #
+      #   @return [Float]
+      required :bps, Float
+
+      # @!attribute per_unit_maximum
+      #   Optional currency amount maximum to cap spend per event
+      #
+      #   @return [String, nil]
+      optional :per_unit_maximum, String, nil?: true
+
+      # @!method initialize(bps:, per_unit_maximum: nil)
+      #   @param bps [Float] Basis point take rate per event
+      #
+      #   @param per_unit_maximum [String, nil] Optional currency amount maximum to cap spend per event
+    end
+  end
+end

data/lib/orb/models/bps_tier.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class BPSTier < Orb::Internal::Type::BaseModel
+      # @!attribute bps
+      #   Per-event basis point rate
+      #
+      #   @return [Float]
+      required :bps, Float
+
+      # @!attribute minimum_amount
+      #   Exclusive tier starting value
+      #
+      #   @return [String]
+      required :minimum_amount, String
+
+      # @!attribute maximum_amount
+      #   Inclusive tier ending value
+      #
+      #   @return [String, nil]
+      optional :maximum_amount, String, nil?: true
+
+      # @!attribute per_unit_maximum
+      #   Per unit maximum to charge
+      #
+      #   @return [String, nil]
+      optional :per_unit_maximum, String, nil?: true
+
+      # @!method initialize(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil)
+      #   @param bps [Float] Per-event basis point rate
+      #
+      #   @param minimum_amount [String] Exclusive tier starting value
+      #
+      #   @param maximum_amount [String, nil] Inclusive tier ending value
+      #
+      #   @param per_unit_maximum [String, nil] Per unit maximum to charge
+    end
+  end
+end

data/lib/orb/models/bulk_bps_config.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class BulkBPSConfig < Orb::Internal::Type::BaseModel
+      # @!attribute tiers
+      #   Tiers for a bulk BPS pricing model where all usage is aggregated to a single
+      #   tier based on total volume
+      #
+      #   @return [Array<Orb::Models::BulkBPSTier>]
+      required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::BulkBPSTier] }
+
+      # @!method initialize(tiers:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::BulkBPSConfig} for more details.
+      #
+      #   @param tiers [Array<Orb::Models::BulkBPSTier>] Tiers for a bulk BPS pricing model where all usage is aggregated to a single tie
+    end
+  end
+end

data/lib/orb/models/bulk_bps_tier.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class BulkBPSTier < Orb::Internal::Type::BaseModel
+      # @!attribute bps
+      #   Basis points to rate on
+      #
+      #   @return [Float]
+      required :bps, Float
+
+      # @!attribute maximum_amount
+      #   Upper bound for tier
+      #
+      #   @return [String, nil]
+      optional :maximum_amount, String, nil?: true
+
+      # @!attribute per_unit_maximum
+      #   The maximum amount to charge for any one event
+      #
+      #   @return [String, nil]
+      optional :per_unit_maximum, String, nil?: true
+
+      # @!method initialize(bps:, maximum_amount: nil, per_unit_maximum: nil)
+      #   @param bps [Float] Basis points to rate on
+      #
+      #   @param maximum_amount [String, nil] Upper bound for tier
+      #
+      #   @param per_unit_maximum [String, nil] The maximum amount to charge for any one event
+    end
+  end
+end

data/lib/orb/models/bulk_config.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class BulkConfig < Orb::Internal::Type::BaseModel
+      # @!attribute tiers
+      #   Bulk tiers for rating based on total usage volume
+      #
+      #   @return [Array<Orb::Models::BulkTier>]
+      required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::BulkTier] }
+
+      # @!method initialize(tiers:)
+      #   @param tiers [Array<Orb::Models::BulkTier>] Bulk tiers for rating based on total usage volume
+    end
+  end
+end

data/lib/orb/models/bulk_tier.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class BulkTier < Orb::Internal::Type::BaseModel
+      # @!attribute unit_amount
+      #   Amount per unit
+      #
+      #   @return [String]
+      required :unit_amount, String
+
+      # @!attribute maximum_units
+      #   Upper bound for this tier
+      #
+      #   @return [Float, nil]
+      optional :maximum_units, Float, nil?: true
+
+      # @!method initialize(unit_amount:, maximum_units: nil)
+      #   @param unit_amount [String] Amount per unit
+      #
+      #   @param maximum_units [Float, nil] Upper bound for this tier
+    end
+  end
+end

data/lib/orb/models/changed_subscription_resources.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class ChangedSubscriptionResources < Orb::Internal::Type::BaseModel
+      # @!attribute created_credit_notes
+      #   The credit notes that were created as part of this operation.
+      #
+      #   @return [Array<Orb::Models::CreditNote>]
+      required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
+
+      # @!attribute created_invoices
+      #   The invoices that were created as part of this operation.
+      #
+      #   @return [Array<Orb::Models::Invoice>]
+      required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
+
+      # @!attribute voided_credit_notes
+      #   The credit notes that were voided as part of this operation.
+      #
+      #   @return [Array<Orb::Models::CreditNote>]
+      required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
+
+      # @!attribute voided_invoices
+      #   The invoices that were voided as part of this operation.
+      #
+      #   @return [Array<Orb::Models::Invoice>]
+      required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
+
+      # @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:)
+      #   @param created_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were created as part of this operation.
+      #
+      #   @param created_invoices [Array<Orb::Models::Invoice>] The invoices that were created as part of this operation.
+      #
+      #   @param voided_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were voided as part of this operation.
+      #
+      #   @param voided_invoices [Array<Orb::Models::Invoice>] The invoices that were voided as part of this operation.
+    end
+  end
+end

data/lib/orb/models/conversion_rate_tier.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class ConversionRateTier < Orb::Internal::Type::BaseModel
+      # @!attribute first_unit
+      #   Exclusive tier starting value
+      #
+      #   @return [Float]
+      required :first_unit, Float
+
+      # @!attribute unit_amount
+      #   Amount per unit of overage
+      #
+      #   @return [String]
+      required :unit_amount, String
+
+      # @!attribute last_unit
+      #   Inclusive tier ending value. If null, this is treated as the last tier
+      #
+      #   @return [Float, nil]
+      optional :last_unit, Float, nil?: true
+
+      # @!method initialize(first_unit:, unit_amount:, last_unit: nil)
+      #   @param first_unit [Float] Exclusive tier starting value
+      #
+      #   @param unit_amount [String] Amount per unit of overage
+      #
+      #   @param last_unit [Float, nil] Inclusive tier ending value. If null, this is treated as the last tier
+    end
+  end
+end

data/lib/orb/models/conversion_rate_tiered_config.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class ConversionRateTieredConfig < Orb::Internal::Type::BaseModel
+      # @!attribute tiers
+      #   Tiers for rating based on total usage quantities into the specified tier
+      #
+      #   @return [Array<Orb::Models::ConversionRateTier>]
+      required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::ConversionRateTier] }
+
+      # @!method initialize(tiers:)
+      #   @param tiers [Array<Orb::Models::ConversionRateTier>] Tiers for rating based on total usage quantities into the specified tier
+    end
+  end
+end

data/lib/orb/models/conversion_rate_unit_config.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class ConversionRateUnitConfig < Orb::Internal::Type::BaseModel
+      # @!attribute unit_amount
+      #   Amount per unit of overage
+      #
+      #   @return [String]
+      required :unit_amount, String
+
+      # @!method initialize(unit_amount:)
+      #   @param unit_amount [String] Amount per unit of overage
+    end
+  end
+end

data/lib/orb/models/coupon_redemption.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class CouponRedemption < Orb::Internal::Type::BaseModel
+      # @!attribute coupon_id
+      #
+      #   @return [String]
+      required :coupon_id, String
+
+      # @!attribute end_date
+      #
+      #   @return [Time, nil]
+      required :end_date, Time, nil?: true
+
+      # @!attribute start_date
+      #
+      #   @return [Time]
+      required :start_date, Time
+
+      # @!method initialize(coupon_id:, end_date:, start_date:)
+      #   @param coupon_id [String]
+      #   @param end_date [Time, nil]
+      #   @param start_date [Time]
+    end
+  end
+end

data/lib/orb/models/credit_note.rb

@@ -2,7 +2,6 @@
 
 module Orb
   module Models
-    # @see Orb::Resources::CreditNotes#create
     class CreditNote < Orb::Internal::Type::BaseModel
       # @!attribute id
       #   The Orb id of this credit note.
@@ -30,8 +29,8 @@ module Orb
 
       # @!attribute customer
       #
-      #   @return [Orb::Models::CreditNote::Customer]
-      required :customer, -> { Orb::CreditNote::Customer }
+      #   @return [Orb::Models::CustomerMinified]
+      required :customer, -> { Orb::CustomerMinified }
 
       # @!attribute invoice_id
       #   The id of the invoice resource that this credit note is applied to.
@@ -109,7 +108,7 @@ module Orb
       #
       #   @param credit_note_pdf [String, nil] A URL to a PDF of the credit note.
       #
-      #   @param customer [Orb::Models::CreditNote::Customer]
+      #   @param customer [Orb::Models::CustomerMinified]
       #
       #   @param invoice_id [String] The id of the invoice resource that this credit note is applied to.
       #
@@ -133,23 +132,6 @@ module Orb
       #
       #   @param discounts [Array<Orb::Models::CreditNote::Discount>] Any discounts applied on the original invoice.
 
-      # @see Orb::Models::CreditNote#customer
-      class Customer < Orb::Internal::Type::BaseModel
-        # @!attribute id
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute external_customer_id
-        #
-        #   @return [String, nil]
-        required :external_customer_id, String, nil?: true
-
-        # @!method initialize(id:, external_customer_id:)
-        #   @param id [String]
-        #   @param external_customer_id [String, nil]
-      end
-
       class LineItem < Orb::Internal::Type::BaseModel
         # @!attribute id
         #   The Orb id of this resource.
@@ -190,8 +172,8 @@ module Orb
         # @!attribute tax_amounts
         #   Any tax amounts applied onto the line item.
         #
-        #   @return [Array<Orb::Models::CreditNote::LineItem::TaxAmount>]
-        required :tax_amounts, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote::LineItem::TaxAmount] }
+        #   @return [Array<Orb::Models::TaxAmount>]
+        required :tax_amounts, -> { Orb::Internal::Type::ArrayOf[Orb::TaxAmount] }
 
         # @!attribute discounts
         #   Any line item discounts from the invoice's line item.
@@ -212,37 +194,10 @@ module Orb
         #
         #   @param subtotal [String] The amount of the line item, excluding any line item minimums and discounts.
         #
-        #   @param tax_amounts [Array<Orb::Models::CreditNote::LineItem::TaxAmount>] Any tax amounts applied onto the line item.
+        #   @param tax_amounts [Array<Orb::Models::TaxAmount>] Any tax amounts applied onto the line item.
         #
         #   @param discounts [Array<Orb::Models::CreditNote::LineItem::Discount>] Any line item discounts from the invoice's line item.
 
-        class TaxAmount < Orb::Internal::Type::BaseModel
-          # @!attribute amount
-          #   The amount of additional tax incurred by this tax rate.
-          #
-          #   @return [String]
-          required :amount, String
-
-          # @!attribute tax_rate_description
-          #   The human-readable description of the applied tax rate.
-          #
-          #   @return [String]
-          required :tax_rate_description, String
-
-          # @!attribute tax_rate_percentage
-          #   The tax rate percentage, out of 100.
-          #
-          #   @return [String, nil]
-          required :tax_rate_percentage, String, nil?: true
-
-          # @!method initialize(amount:, tax_rate_description:, tax_rate_percentage:)
-          #   @param amount [String] The amount of additional tax incurred by this tax rate.
-          #
-          #   @param tax_rate_description [String] The human-readable description of the applied tax rate.
-          #
-          #   @param tax_rate_percentage [String, nil] The tax rate percentage, out of 100.
-        end
-
         class Discount < Orb::Internal::Type::BaseModel
           # @!attribute id
           #

data/lib/orb/models/credit_note_tiny.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class CreditNoteTiny < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #   The id of the Credit note
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:)
+      #   @param id [String] The id of the Credit note
+    end
+  end
+end

data/lib/orb/models/custom_expiration.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class CustomExpiration < Orb::Internal::Type::BaseModel
+      # @!attribute duration
+      #
+      #   @return [Integer]
+      required :duration, Integer
+
+      # @!attribute duration_unit
+      #
+      #   @return [Symbol, Orb::Models::CustomExpiration::DurationUnit]
+      required :duration_unit, enum: -> { Orb::CustomExpiration::DurationUnit }
+
+      # @!method initialize(duration:, duration_unit:)
+      #   @param duration [Integer]
+      #   @param duration_unit [Symbol, Orb::Models::CustomExpiration::DurationUnit]
+
+      # @see Orb::Models::CustomExpiration#duration_unit
+      module DurationUnit
+        extend Orb::Internal::Type::Enum
+
+        DAY = :day
+        MONTH = :month
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end