orb-billing 0.5.5 → 0.7.0

data/rbi/orb/models/beta_fetch_plan_version_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Orb
+  module Models
+    class BetaFetchPlanVersionParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Orb::BetaFetchPlanVersionParams, Orb::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :plan_id
+
+      sig do
+        params(
+          plan_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(plan_id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { plan_id: String, request_options: Orb::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/orb/models/beta_set_default_plan_version_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Orb
+  module Models
+    class BetaSetDefaultPlanVersionParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Orb::BetaSetDefaultPlanVersionParams, Orb::Internal::AnyHash)
+        end
+
+      # Plan version to set as the default.
+      sig { returns(Integer) }
+      attr_accessor :version
+
+      sig do
+        params(
+          version: Integer,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Plan version to set as the default.
+        version:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { version: Integer, request_options: Orb::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/orb/models/credit_note_create_params.rbi

@@ -14,28 +14,28 @@ module Orb
       sig { returns(T::Array[Orb::CreditNoteCreateParams::LineItem]) }
       attr_accessor :line_items
 
+      # An optional reason for the credit note.
+      sig { returns(Orb::CreditNoteCreateParams::Reason::OrSymbol) }
+      attr_accessor :reason
+
       # An optional memo to attach to the credit note.
       sig { returns(T.nilable(String)) }
       attr_accessor :memo
 
-      # An optional reason for the credit note.
-      sig { returns(T.nilable(Orb::CreditNoteCreateParams::Reason::OrSymbol)) }
-      attr_accessor :reason
-
       sig do
         params(
           line_items: T::Array[Orb::CreditNoteCreateParams::LineItem::OrHash],
+          reason: Orb::CreditNoteCreateParams::Reason::OrSymbol,
           memo: T.nilable(String),
-          reason: T.nilable(Orb::CreditNoteCreateParams::Reason::OrSymbol),
           request_options: Orb::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
         line_items:,
+        # An optional reason for the credit note.
+        reason:,
         # An optional memo to attach to the credit note.
         memo: nil,
-        # An optional reason for the credit note.
-        reason: nil,
         request_options: {}
       )
       end
@@ -44,8 +44,8 @@ module Orb
         override.returns(
           {
             line_items: T::Array[Orb::CreditNoteCreateParams::LineItem],
+            reason: Orb::CreditNoteCreateParams::Reason::OrSymbol,
             memo: T.nilable(String),
-            reason: T.nilable(Orb::CreditNoteCreateParams::Reason::OrSymbol),
             request_options: Orb::RequestOptions
           }
         )

data/rbi/orb/models/customer_create_params.rbi

@@ -133,7 +133,8 @@ module Orb
           T.nilable(
             T.any(
               Orb::CustomerCreateParams::TaxConfiguration::Avalara,
-              Orb::CustomerCreateParams::TaxConfiguration::Taxjar
+              Orb::CustomerCreateParams::TaxConfiguration::Taxjar,
+              Orb::CustomerCreateParams::TaxConfiguration::Sphere
             )
           )
         )
@@ -289,7 +290,8 @@ module Orb
             T.nilable(
               T.any(
                 Orb::CustomerCreateParams::TaxConfiguration::Avalara::OrHash,
-                Orb::CustomerCreateParams::TaxConfiguration::Taxjar::OrHash
+                Orb::CustomerCreateParams::TaxConfiguration::Taxjar::OrHash,
+                Orb::CustomerCreateParams::TaxConfiguration::Sphere::OrHash
               )
             ),
           tax_id: T.nilable(Orb::CustomerCreateParams::TaxID::OrHash),
@@ -478,7 +480,8 @@ module Orb
               T.nilable(
                 T.any(
                   Orb::CustomerCreateParams::TaxConfiguration::Avalara,
-                  Orb::CustomerCreateParams::TaxConfiguration::Taxjar
+                  Orb::CustomerCreateParams::TaxConfiguration::Taxjar,
+                  Orb::CustomerCreateParams::TaxConfiguration::Sphere
                 )
               ),
             tax_id: T.nilable(Orb::CustomerCreateParams::TaxID),
@@ -825,7 +828,8 @@ module Orb
           T.type_alias do
             T.any(
               Orb::CustomerCreateParams::TaxConfiguration::Avalara,
-              Orb::CustomerCreateParams::TaxConfiguration::Taxjar
+              Orb::CustomerCreateParams::TaxConfiguration::Taxjar,
+              Orb::CustomerCreateParams::TaxConfiguration::Sphere
             )
           end
 
@@ -904,6 +908,36 @@ module Orb
           end
         end
 
+        class Sphere < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::CustomerCreateParams::TaxConfiguration::Sphere,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T::Boolean) }
+          attr_accessor :tax_exempt
+
+          sig { returns(Symbol) }
+          attr_accessor :tax_provider
+
+          sig do
+            params(tax_exempt: T::Boolean, tax_provider: Symbol).returns(
+              T.attached_class
+            )
+          end
+          def self.new(tax_exempt:, tax_provider: :sphere)
+          end
+
+          sig do
+            override.returns({ tax_exempt: T::Boolean, tax_provider: Symbol })
+          end
+          def to_hash
+          end
+        end
+
         sig do
           override.returns(
             T::Array[Orb::CustomerCreateParams::TaxConfiguration::Variants]

data/rbi/orb/models/customer_update_by_external_id_params.rbi

@@ -161,7 +161,8 @@ module Orb
           T.nilable(
             T.any(
               Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara,
-              Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar
+              Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar,
+              Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Sphere
             )
           )
         )
@@ -321,7 +322,8 @@ module Orb
             T.nilable(
               T.any(
                 Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara::OrHash,
-                Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar::OrHash
+                Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar::OrHash,
+                Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Sphere::OrHash
               )
             ),
           tax_id:
@@ -514,7 +516,8 @@ module Orb
               T.nilable(
                 T.any(
                   Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara,
-                  Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar
+                  Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar,
+                  Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Sphere
                 )
               ),
             tax_id: T.nilable(Orb::CustomerUpdateByExternalIDParams::TaxID),
@@ -872,7 +875,8 @@ module Orb
           T.type_alias do
             T.any(
               Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara,
-              Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar
+              Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar,
+              Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Sphere
             )
           end
 
@@ -951,6 +955,36 @@ module Orb
           end
         end
 
+        class Sphere < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Sphere,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T::Boolean) }
+          attr_accessor :tax_exempt
+
+          sig { returns(Symbol) }
+          attr_accessor :tax_provider
+
+          sig do
+            params(tax_exempt: T::Boolean, tax_provider: Symbol).returns(
+              T.attached_class
+            )
+          end
+          def self.new(tax_exempt:, tax_provider: :sphere)
+          end
+
+          sig do
+            override.returns({ tax_exempt: T::Boolean, tax_provider: Symbol })
+          end
+          def to_hash
+          end
+        end
+
         sig do
           override.returns(
             T::Array[

data/rbi/orb/models/customer_update_params.rbi

@@ -134,7 +134,8 @@ module Orb
           T.nilable(
             T.any(
               Orb::CustomerUpdateParams::TaxConfiguration::Avalara,
-              Orb::CustomerUpdateParams::TaxConfiguration::Taxjar
+              Orb::CustomerUpdateParams::TaxConfiguration::Taxjar,
+              Orb::CustomerUpdateParams::TaxConfiguration::Sphere
             )
           )
         )
@@ -284,7 +285,8 @@ module Orb
             T.nilable(
               T.any(
                 Orb::CustomerUpdateParams::TaxConfiguration::Avalara::OrHash,
-                Orb::CustomerUpdateParams::TaxConfiguration::Taxjar::OrHash
+                Orb::CustomerUpdateParams::TaxConfiguration::Taxjar::OrHash,
+                Orb::CustomerUpdateParams::TaxConfiguration::Sphere::OrHash
               )
             ),
           tax_id: T.nilable(Orb::CustomerUpdateParams::TaxID::OrHash),
@@ -469,7 +471,8 @@ module Orb
               T.nilable(
                 T.any(
                   Orb::CustomerUpdateParams::TaxConfiguration::Avalara,
-                  Orb::CustomerUpdateParams::TaxConfiguration::Taxjar
+                  Orb::CustomerUpdateParams::TaxConfiguration::Taxjar,
+                  Orb::CustomerUpdateParams::TaxConfiguration::Sphere
                 )
               ),
             tax_id: T.nilable(Orb::CustomerUpdateParams::TaxID),
@@ -819,7 +822,8 @@ module Orb
           T.type_alias do
             T.any(
               Orb::CustomerUpdateParams::TaxConfiguration::Avalara,
-              Orb::CustomerUpdateParams::TaxConfiguration::Taxjar
+              Orb::CustomerUpdateParams::TaxConfiguration::Taxjar,
+              Orb::CustomerUpdateParams::TaxConfiguration::Sphere
             )
           end
 
@@ -898,6 +902,36 @@ module Orb
           end
         end
 
+        class Sphere < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::CustomerUpdateParams::TaxConfiguration::Sphere,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T::Boolean) }
+          attr_accessor :tax_exempt
+
+          sig { returns(Symbol) }
+          attr_accessor :tax_provider
+
+          sig do
+            params(tax_exempt: T::Boolean, tax_provider: Symbol).returns(
+              T.attached_class
+            )
+          end
+          def self.new(tax_exempt:, tax_provider: :sphere)
+          end
+
+          sig do
+            override.returns({ tax_exempt: T::Boolean, tax_provider: Symbol })
+          end
+          def to_hash
+          end
+        end
+
         sig do
           override.returns(
             T::Array[Orb::CustomerUpdateParams::TaxConfiguration::Variants]

data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi

@@ -102,6 +102,10 @@ module Orb
             sig { returns(Float) }
             attr_accessor :starting_balance
 
+            # If the increment resulted in invoice creation, the list of created invoices
+            sig { returns(T.nilable(T::Array[Orb::Invoice])) }
+            attr_accessor :created_invoices
+
             sig do
               params(
                 id: String,
@@ -119,6 +123,7 @@ module Orb
                 ledger_sequence_number: Integer,
                 metadata: T::Hash[Symbol, String],
                 starting_balance: Float,
+                created_invoices: T.nilable(T::Array[Orb::Invoice::OrHash]),
                 entry_type: Symbol
               ).returns(T.attached_class)
             end
@@ -139,6 +144,8 @@ module Orb
               # `null`.
               metadata:,
               starting_balance:,
+              # If the increment resulted in invoice creation, the list of created invoices
+              created_invoices: nil,
               entry_type: :increment
             )
             end
@@ -161,7 +168,8 @@ module Orb
                   entry_type: Symbol,
                   ledger_sequence_number: Integer,
                   metadata: T::Hash[Symbol, String],
-                  starting_balance: Float
+                  starting_balance: Float,
+                  created_invoices: T.nilable(T::Array[Orb::Invoice])
                 }
               )
             end

data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi

@@ -102,6 +102,10 @@ module Orb
             sig { returns(Float) }
             attr_accessor :starting_balance
 
+            # If the increment resulted in invoice creation, the list of created invoices
+            sig { returns(T.nilable(T::Array[Orb::Invoice])) }
+            attr_accessor :created_invoices
+
             sig do
               params(
                 id: String,
@@ -119,6 +123,7 @@ module Orb
                 ledger_sequence_number: Integer,
                 metadata: T::Hash[Symbol, String],
                 starting_balance: Float,
+                created_invoices: T.nilable(T::Array[Orb::Invoice::OrHash]),
                 entry_type: Symbol
               ).returns(T.attached_class)
             end
@@ -139,6 +144,8 @@ module Orb
               # `null`.
               metadata:,
               starting_balance:,
+              # If the increment resulted in invoice creation, the list of created invoices
+              created_invoices: nil,
               entry_type: :increment
             )
             end
@@ -161,7 +168,8 @@ module Orb
                   entry_type: Symbol,
                   ledger_sequence_number: Integer,
                   metadata: T::Hash[Symbol, String],
-                  starting_balance: Float
+                  starting_balance: Float,
+                  created_invoices: T.nilable(T::Array[Orb::Invoice])
                 }
               )
             end

data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi

@@ -102,6 +102,10 @@ module Orb
             sig { returns(Float) }
             attr_accessor :starting_balance
 
+            # If the increment resulted in invoice creation, the list of created invoices
+            sig { returns(T.nilable(T::Array[Orb::Invoice])) }
+            attr_accessor :created_invoices
+
             sig do
               params(
                 id: String,
@@ -119,6 +123,7 @@ module Orb
                 ledger_sequence_number: Integer,
                 metadata: T::Hash[Symbol, String],
                 starting_balance: Float,
+                created_invoices: T.nilable(T::Array[Orb::Invoice::OrHash]),
                 entry_type: Symbol
               ).returns(T.attached_class)
             end
@@ -139,6 +144,8 @@ module Orb
               # `null`.
               metadata:,
               starting_balance:,
+              # If the increment resulted in invoice creation, the list of created invoices
+              created_invoices: nil,
               entry_type: :increment
             )
             end
@@ -161,7 +168,8 @@ module Orb
                   entry_type: Symbol,
                   ledger_sequence_number: Integer,
                   metadata: T::Hash[Symbol, String],
-                  starting_balance: Float
+                  starting_balance: Float,
+                  created_invoices: T.nilable(T::Array[Orb::Invoice])
                 }
               )
             end

data/rbi/orb/models/customers/credits/ledger_list_response.rbi

@@ -102,6 +102,10 @@ module Orb
             sig { returns(Float) }
             attr_accessor :starting_balance
 
+            # If the increment resulted in invoice creation, the list of created invoices
+            sig { returns(T.nilable(T::Array[Orb::Invoice])) }
+            attr_accessor :created_invoices
+
             sig do
               params(
                 id: String,
@@ -119,6 +123,7 @@ module Orb
                 ledger_sequence_number: Integer,
                 metadata: T::Hash[Symbol, String],
                 starting_balance: Float,
+                created_invoices: T.nilable(T::Array[Orb::Invoice::OrHash]),
                 entry_type: Symbol
               ).returns(T.attached_class)
             end
@@ -139,6 +144,8 @@ module Orb
               # `null`.
               metadata:,
               starting_balance:,
+              # If the increment resulted in invoice creation, the list of created invoices
+              created_invoices: nil,
               entry_type: :increment
             )
             end
@@ -161,7 +168,8 @@ module Orb
                   entry_type: Symbol,
                   ledger_sequence_number: Integer,
                   metadata: T::Hash[Symbol, String],
-                  starting_balance: Float
+                  starting_balance: Float,
+                  created_invoices: T.nilable(T::Array[Orb::Invoice])
                 }
               )
             end

data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi

@@ -51,7 +51,7 @@ module Orb
           attr_accessor :threshold
 
           # The date from which the top-up is active. If unspecified, the top-up is active
-          # immediately.
+          # immediately. This should not be more than 10 days in the past.
           sig { returns(T.nilable(Time)) }
           attr_accessor :active_from
 
@@ -101,7 +101,7 @@ module Orb
             # threshold, the top-up will be triggered.
             threshold:,
             # The date from which the top-up is active. If unspecified, the top-up is active
-            # immediately.
+            # immediately. This should not be more than 10 days in the past.
             active_from: nil,
             # The number of days or months after which the top-up expires. If unspecified, it
             # does not expire.

data/rbi/orb/models/customers/credits/top_up_create_params.rbi

@@ -49,7 +49,7 @@ module Orb
           attr_accessor :threshold
 
           # The date from which the top-up is active. If unspecified, the top-up is active
-          # immediately.
+          # immediately. This should not be more than 10 days in the past.
           sig { returns(T.nilable(Time)) }
           attr_accessor :active_from
 
@@ -99,7 +99,7 @@ module Orb
             # threshold, the top-up will be triggered.
             threshold:,
             # The date from which the top-up is active. If unspecified, the top-up is active
-            # immediately.
+            # immediately. This should not be more than 10 days in the past.
             active_from: nil,
             # The number of days or months after which the top-up expires. If unspecified, it
             # does not expire.