orb-billing 1.13.0 → 1.15.0

data/rbi/orb/models/invoice_issue_summary_response.rbi

@@ -122,11 +122,13 @@ module Orb
       # | Estonia                | `eu_vat`     | European VAT Number                                                                                     |
       # | Ethiopia               | `et_tin`     | Ethiopia Tax Identification Number                                                                      |
       # | European Union         | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme                                                  |
+      # | Faroe Islands          | `fo_vat`     | Faroe Islands VAT Number                                                                                |
       # | Finland                | `eu_vat`     | European VAT Number                                                                                     |
       # | France                 | `eu_vat`     | European VAT Number                                                                                     |
       # | Georgia                | `ge_vat`     | Georgian VAT                                                                                            |
       # | Germany                | `de_stn`     | German Tax Number (Steuernummer)                                                                        |
       # | Germany                | `eu_vat`     | European VAT Number                                                                                     |
+      # | Gibraltar              | `gi_tin`     | Gibraltar Tax Identification Number                                                                     |
       # | Greece                 | `eu_vat`     | European VAT Number                                                                                     |
       # | Guinea                 | `gn_nif`     | Guinea Tax Identification Number (Número de Identificação Fiscal)                                       |
       # | Hong Kong              | `hk_br`      | Hong Kong BR Number                                                                                     |
@@ -138,6 +140,7 @@ module Orb
       # | Ireland                | `eu_vat`     | European VAT Number                                                                                     |
       # | Israel                 | `il_vat`     | Israel VAT                                                                                              |
       # | Italy                  | `eu_vat`     | European VAT Number                                                                                     |
+      # | Italy                  | `it_cf`      | Italian Codice Fiscale Number                                                                           |
       # | Japan                  | `jp_cn`      | Japanese Corporate Number (_Hōjin Bangō_)                                                               |
       # | Japan                  | `jp_rn`      | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
       # | Japan                  | `jp_trn`     | Japanese Tax Registration Number (_Tōroku Bangō_)                                                       |
@@ -168,6 +171,7 @@ module Orb
       # | Norway                 | `no_vat`     | Norwegian VAT Number                                                                                    |
       # | Norway                 | `no_voec`    | Norwegian VAT on e-commerce Number                                                                      |
       # | Oman                   | `om_vat`     | Omani VAT Number                                                                                        |
+      # | Paraguay               | `py_ruc`     | Paraguayan RUC Number                                                                                   |
       # | Peru                   | `pe_ruc`     | Peruvian RUC Number                                                                                     |
       # | Philippines            | `ph_tin`     | Philippines Tax Identification Number                                                                   |
       # | Poland                 | `eu_vat`     | European VAT Number                                                                                     |
@@ -189,6 +193,7 @@ module Orb
       # | South Korea            | `kr_brn`     | Korean BRN                                                                                              |
       # | Spain                  | `es_cif`     | Spanish NIF Number (previously Spanish CIF Number)                                                      |
       # | Spain                  | `eu_vat`     | European VAT Number                                                                                     |
+      # | Sri Lanka              | `lk_vat`     | Sri Lanka VAT Number                                                                                    |
       # | Suriname               | `sr_fin`     | Suriname FIN Number                                                                                     |
       # | Sweden                 | `eu_vat`     | European VAT Number                                                                                     |
       # | Switzerland            | `ch_uid`     | Switzerland UID Number                                                                                  |
@@ -229,8 +234,8 @@ module Orb
       sig { returns(T.nilable(Time)) }
       attr_accessor :eligible_to_issue_at
 
-      # A URL for the customer-facing invoice portal. This URL expires 30 days after the
-      # invoice's due date, or 60 days after being re-generated through the UI.
+      # A URL for the customer-facing invoice portal. This URL expires 60 days after the
+      # link is generated, or 30 days after the invoice's due date — whichever is later.
       sig { returns(T.nilable(String)) }
       attr_accessor :hosted_invoice_url
 
@@ -465,11 +470,13 @@ module Orb
         # | Estonia                | `eu_vat`     | European VAT Number                                                                                     |
         # | Ethiopia               | `et_tin`     | Ethiopia Tax Identification Number                                                                      |
         # | European Union         | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme                                                  |
+        # | Faroe Islands          | `fo_vat`     | Faroe Islands VAT Number                                                                                |
         # | Finland                | `eu_vat`     | European VAT Number                                                                                     |
         # | France                 | `eu_vat`     | European VAT Number                                                                                     |
         # | Georgia                | `ge_vat`     | Georgian VAT                                                                                            |
         # | Germany                | `de_stn`     | German Tax Number (Steuernummer)                                                                        |
         # | Germany                | `eu_vat`     | European VAT Number                                                                                     |
+        # | Gibraltar              | `gi_tin`     | Gibraltar Tax Identification Number                                                                     |
         # | Greece                 | `eu_vat`     | European VAT Number                                                                                     |
         # | Guinea                 | `gn_nif`     | Guinea Tax Identification Number (Número de Identificação Fiscal)                                       |
         # | Hong Kong              | `hk_br`      | Hong Kong BR Number                                                                                     |
@@ -481,6 +488,7 @@ module Orb
         # | Ireland                | `eu_vat`     | European VAT Number                                                                                     |
         # | Israel                 | `il_vat`     | Israel VAT                                                                                              |
         # | Italy                  | `eu_vat`     | European VAT Number                                                                                     |
+        # | Italy                  | `it_cf`      | Italian Codice Fiscale Number                                                                           |
         # | Japan                  | `jp_cn`      | Japanese Corporate Number (_Hōjin Bangō_)                                                               |
         # | Japan                  | `jp_rn`      | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
         # | Japan                  | `jp_trn`     | Japanese Tax Registration Number (_Tōroku Bangō_)                                                       |
@@ -511,6 +519,7 @@ module Orb
         # | Norway                 | `no_vat`     | Norwegian VAT Number                                                                                    |
         # | Norway                 | `no_voec`    | Norwegian VAT on e-commerce Number                                                                      |
         # | Oman                   | `om_vat`     | Omani VAT Number                                                                                        |
+        # | Paraguay               | `py_ruc`     | Paraguayan RUC Number                                                                                   |
         # | Peru                   | `pe_ruc`     | Peruvian RUC Number                                                                                     |
         # | Philippines            | `ph_tin`     | Philippines Tax Identification Number                                                                   |
         # | Poland                 | `eu_vat`     | European VAT Number                                                                                     |
@@ -532,6 +541,7 @@ module Orb
         # | South Korea            | `kr_brn`     | Korean BRN                                                                                              |
         # | Spain                  | `es_cif`     | Spanish NIF Number (previously Spanish CIF Number)                                                      |
         # | Spain                  | `eu_vat`     | European VAT Number                                                                                     |
+        # | Sri Lanka              | `lk_vat`     | Sri Lanka VAT Number                                                                                    |
         # | Suriname               | `sr_fin`     | Suriname FIN Number                                                                                     |
         # | Sweden                 | `eu_vat`     | European VAT Number                                                                                     |
         # | Switzerland            | `ch_uid`     | Switzerland UID Number                                                                                  |
@@ -561,8 +571,8 @@ module Orb
         # will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is
         # true, the invoice will automatically begin issuing at this time.
         eligible_to_issue_at:,
-        # A URL for the customer-facing invoice portal. This URL expires 30 days after the
-        # invoice's due date, or 60 days after being re-generated through the UI.
+        # A URL for the customer-facing invoice portal. This URL expires 60 days after the
+        # link is generated, or 30 days after the invoice's due date — whichever is later.
         hosted_invoice_url:,
         # The scheduled date of the invoice
         invoice_date:,
@@ -1201,6 +1211,11 @@ module Orb
               :stripe,
               Orb::Models::InvoiceIssueSummaryResponse::PaymentAttempt::PaymentProvider::TaggedSymbol
             )
+          ADYEN =
+            T.let(
+              :adyen,
+              Orb::Models::InvoiceIssueSummaryResponse::PaymentAttempt::PaymentProvider::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/orb/models/invoice_level_discount.rbi

@@ -10,10 +10,307 @@ module Orb
           T.any(
             Orb::PercentageDiscount,
             Orb::AmountDiscount,
-            Orb::TrialDiscount
+            Orb::TrialDiscount,
+            Orb::InvoiceLevelDiscount::TieredPercentage
           )
         end
 
+      class TieredPercentage < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::InvoiceLevelDiscount::TieredPercentage,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Symbol) }
+        attr_accessor :discount_type
+
+        # Only available if discount_type is `tiered_percentage`. The ordered, contiguous
+        # bands of cumulative eligible spend, each discounted at its own percentage
+        # (progressive fill-a-tier).
+        sig do
+          returns(T::Array[Orb::InvoiceLevelDiscount::TieredPercentage::Tier])
+        end
+        attr_accessor :tiers
+
+        # List of price_ids that this discount applies to. For plan/plan phase discounts,
+        # this can be a subset of prices.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :applies_to_price_ids
+
+        # The filters that determine which prices to apply this discount to.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[Orb::InvoiceLevelDiscount::TieredPercentage::Filter]
+            )
+          )
+        end
+        attr_accessor :filters
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :reason
+
+        sig do
+          params(
+            tiers:
+              T::Array[
+                Orb::InvoiceLevelDiscount::TieredPercentage::Tier::OrHash
+              ],
+            applies_to_price_ids: T.nilable(T::Array[String]),
+            filters:
+              T.nilable(
+                T::Array[
+                  Orb::InvoiceLevelDiscount::TieredPercentage::Filter::OrHash
+                ]
+              ),
+            reason: T.nilable(String),
+            discount_type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Only available if discount_type is `tiered_percentage`. The ordered, contiguous
+          # bands of cumulative eligible spend, each discounted at its own percentage
+          # (progressive fill-a-tier).
+          tiers:,
+          # List of price_ids that this discount applies to. For plan/plan phase discounts,
+          # this can be a subset of prices.
+          applies_to_price_ids: nil,
+          # The filters that determine which prices to apply this discount to.
+          filters: nil,
+          reason: nil,
+          discount_type: :tiered_percentage
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              discount_type: Symbol,
+              tiers:
+                T::Array[Orb::InvoiceLevelDiscount::TieredPercentage::Tier],
+              applies_to_price_ids: T.nilable(T::Array[String]),
+              filters:
+                T.nilable(
+                  T::Array[Orb::InvoiceLevelDiscount::TieredPercentage::Filter]
+                ),
+              reason: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Tier < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::InvoiceLevelDiscount::TieredPercentage::Tier,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          # Exclusive lower bound of cumulative spend for this tier.
+          sig { returns(Float) }
+          attr_accessor :lower_bound
+
+          # The percentage (between 0 and 1) discounted from spend that falls within this
+          # tier.
+          sig { returns(Float) }
+          attr_accessor :percentage
+
+          # Inclusive upper bound of cumulative spend for this tier; null for the final
+          # open-ended tier.
+          sig { returns(T.nilable(Float)) }
+          attr_accessor :upper_bound
+
+          # One band of a tiered percentage discount. Bounds are denominated in the
+          # discount's currency. `lower_bound` is the exclusive start of the band and
+          # `upper_bound` is the inclusive end; `upper_bound` is null only for the
+          # open-ended final tier.
+          sig do
+            params(
+              lower_bound: Float,
+              percentage: Float,
+              upper_bound: T.nilable(Float)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Exclusive lower bound of cumulative spend for this tier.
+            lower_bound:,
+            # The percentage (between 0 and 1) discounted from spend that falls within this
+            # tier.
+            percentage:,
+            # Inclusive upper bound of cumulative spend for this tier; null for the final
+            # open-ended tier.
+            upper_bound: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                lower_bound: Float,
+                percentage: Float,
+                upper_bound: T.nilable(Float)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        class Filter < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::InvoiceLevelDiscount::TieredPercentage::Filter,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          # The property of the price to filter on.
+          sig do
+            returns(
+              Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Field::TaggedSymbol
+            )
+          end
+          attr_accessor :field
+
+          # Should prices that match the filter be included or excluded.
+          sig do
+            returns(
+              Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Operator::TaggedSymbol
+            )
+          end
+          attr_accessor :operator
+
+          # The IDs or values that match this filter.
+          sig { returns(T::Array[String]) }
+          attr_accessor :values
+
+          sig do
+            params(
+              field:
+                Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Field::OrSymbol,
+              operator:
+                Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Operator::OrSymbol,
+              values: T::Array[String]
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The property of the price to filter on.
+            field:,
+            # Should prices that match the filter be included or excluded.
+            operator:,
+            # The IDs or values that match this filter.
+            values:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                field:
+                  Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Field::TaggedSymbol,
+                operator:
+                  Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Operator::TaggedSymbol,
+                values: T::Array[String]
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The property of the price to filter on.
+          module Field
+            extend Orb::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Field
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PRICE_ID =
+              T.let(
+                :price_id,
+                Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Field::TaggedSymbol
+              )
+            ITEM_ID =
+              T.let(
+                :item_id,
+                Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Field::TaggedSymbol
+              )
+            PRICE_TYPE =
+              T.let(
+                :price_type,
+                Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Field::TaggedSymbol
+              )
+            CURRENCY =
+              T.let(
+                :currency,
+                Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Field::TaggedSymbol
+              )
+            PRICING_UNIT_ID =
+              T.let(
+                :pricing_unit_id,
+                Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Field::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Field::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # Should prices that match the filter be included or excluded.
+          module Operator
+            extend Orb::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Operator
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            INCLUDES =
+              T.let(
+                :includes,
+                Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Operator::TaggedSymbol
+              )
+            EXCLUDES =
+              T.let(
+                :excludes,
+                Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Operator::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Operator::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+
       sig { override.returns(T::Array[Orb::InvoiceLevelDiscount::Variants]) }
       def self.variants
       end