orb-billing 0.5.4 → 0.6.0

data/rbi/orb/resources/subscriptions.rbi

@@ -278,6 +278,7 @@ module Orb
             ),
           coupon_redemption_code: T.nilable(String),
           credits_overage_rate: T.nilable(Float),
+          currency: T.nilable(String),
           customer_id: T.nilable(String),
           default_invoice_memo: T.nilable(String),
           end_date: T.nilable(Time),
@@ -292,6 +293,7 @@ module Orb
           initial_phase_order: T.nilable(Integer),
           invoicing_threshold: T.nilable(String),
           metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+          name: T.nilable(String),
           net_terms: T.nilable(Integer),
           per_credit_overage_amount: T.nilable(Float),
           plan_id: T.nilable(String),
@@ -338,6 +340,9 @@ module Orb
         # returned and the subscription creation or plan change will not be scheduled.
         coupon_redemption_code: nil,
         credits_overage_rate: nil,
+        # The currency to use for the subscription. If not specified, the invoicing
+        # currency for the plan will be used.
+        currency: nil,
         customer_id: nil,
         # Determines the default memo on this subscription's invoices. Note that if this
         # is not provided, it is determined by the plan configuration.
@@ -364,6 +369,9 @@ module Orb
         # by setting the value to `null`, and the entire metadata mapping can be cleared
         # by setting `metadata` to `null`.
         metadata: nil,
+        # The name to use for the subscription. If not specified, the plan name will be
+        # used.
+        name: nil,
         # The net terms determines the difference between the invoice date and the issue
         # date for the invoice. If you intend the invoice to be due on issue, set this
         # to 0. If not provided, this defaults to the value specified in the plan.
@@ -1450,7 +1458,7 @@ module Orb
         # `immediate` unless it's explicitly set to `upcoming_invoice`.
         change_option: nil,
         # The date that the quantity change should take effect, localized to the
-        # customer's timezone. Ifthis parameter is not passed in, the quantity change is
+        # customer's timezone. If this parameter is not passed in, the quantity change is
         # effective according to `change_option`.
         effective_date: nil,
         request_options: {}

data/sig/orb/models/alert.rbs

@@ -11,7 +11,8 @@ module Orb
         plan: Orb::Alert::Plan?,
         subscription: Orb::Alert::Subscription?,
         thresholds: ::Array[Orb::Alert::Threshold]?,
-        type: Orb::Models::Alert::type_
+        type: Orb::Models::Alert::type_,
+        balance_alert_status: ::Array[Orb::Alert::BalanceAlertStatus]?
       }
 
     class Alert < Orb::Internal::Type::BaseModel
@@ -35,6 +36,8 @@ module Orb
 
       attr_accessor type: Orb::Models::Alert::type_
 
+      attr_accessor balance_alert_status: ::Array[Orb::Alert::BalanceAlertStatus]?
+
       def initialize: (
         id: String,
         created_at: Time,
@@ -45,7 +48,8 @@ module Orb
         plan: Orb::Alert::Plan?,
         subscription: Orb::Alert::Subscription?,
         thresholds: ::Array[Orb::Alert::Threshold]?,
-        type: Orb::Models::Alert::type_
+        type: Orb::Models::Alert::type_,
+        ?balance_alert_status: ::Array[Orb::Alert::BalanceAlertStatus]?
       ) -> void
 
       def to_hash: -> {
@@ -58,7 +62,8 @@ module Orb
         plan: Orb::Alert::Plan?,
         subscription: Orb::Alert::Subscription?,
         thresholds: ::Array[Orb::Alert::Threshold]?,
-        type: Orb::Models::Alert::type_
+        type: Orb::Models::Alert::type_,
+        balance_alert_status: ::Array[Orb::Alert::BalanceAlertStatus]?
       }
 
       type customer = { id: String, external_customer_id: String? }
@@ -153,6 +158,18 @@ module Orb
 
         def self?.values: -> ::Array[Orb::Models::Alert::type_]
       end
+
+      type balance_alert_status = { in_alert: bool, threshold_value: Float }
+
+      class BalanceAlertStatus < Orb::Internal::Type::BaseModel
+        attr_accessor in_alert: bool
+
+        attr_accessor threshold_value: Float
+
+        def initialize: (in_alert: bool, threshold_value: Float) -> void
+
+        def to_hash: -> { in_alert: bool, threshold_value: Float }
+      end
     end
   end
 end

data/sig/orb/models/amount_discount.rbs

@@ -3,31 +3,31 @@ module Orb
     type amount_discount =
       {
         amount_discount: String,
-        applies_to_price_ids: ::Array[String],
         discount_type: Orb::Models::AmountDiscount::discount_type,
+        applies_to_price_ids: ::Array[String]?,
         reason: String?
       }
 
     class AmountDiscount < Orb::Internal::Type::BaseModel
       attr_accessor amount_discount: String
 
-      attr_accessor applies_to_price_ids: ::Array[String]
-
       attr_accessor discount_type: Orb::Models::AmountDiscount::discount_type
 
+      attr_accessor applies_to_price_ids: ::Array[String]?
+
       attr_accessor reason: String?
 
       def initialize: (
         amount_discount: String,
-        applies_to_price_ids: ::Array[String],
         discount_type: Orb::Models::AmountDiscount::discount_type,
+        ?applies_to_price_ids: ::Array[String]?,
         ?reason: String?
       ) -> void
 
       def to_hash: -> {
         amount_discount: String,
-        applies_to_price_ids: ::Array[String],
         discount_type: Orb::Models::AmountDiscount::discount_type,
+        applies_to_price_ids: ::Array[String]?,
         reason: String?
       }
 

data/sig/orb/models/credit_note_create_params.rbs

@@ -3,8 +3,8 @@ module Orb
     type credit_note_create_params =
       {
         line_items: ::Array[Orb::CreditNoteCreateParams::LineItem],
-        memo: String?,
-        reason: Orb::Models::CreditNoteCreateParams::reason?
+        reason: Orb::Models::CreditNoteCreateParams::reason,
+        memo: String?
       }
       & Orb::Internal::Type::request_parameters
 
@@ -14,21 +14,21 @@ module Orb
 
       attr_accessor line_items: ::Array[Orb::CreditNoteCreateParams::LineItem]
 
-      attr_accessor memo: String?
+      attr_accessor reason: Orb::Models::CreditNoteCreateParams::reason
 
-      attr_accessor reason: Orb::Models::CreditNoteCreateParams::reason?
+      attr_accessor memo: String?
 
       def initialize: (
         line_items: ::Array[Orb::CreditNoteCreateParams::LineItem],
+        reason: Orb::Models::CreditNoteCreateParams::reason,
         ?memo: String?,
-        ?reason: Orb::Models::CreditNoteCreateParams::reason?,
         ?request_options: Orb::request_opts
       ) -> void
 
       def to_hash: -> {
         line_items: ::Array[Orb::CreditNoteCreateParams::LineItem],
+        reason: Orb::Models::CreditNoteCreateParams::reason,
         memo: String?,
-        reason: Orb::Models::CreditNoteCreateParams::reason?,
         request_options: Orb::RequestOptions
       }
 

data/sig/orb/models/customer_create_params.rbs

@@ -281,6 +281,7 @@ module Orb
       type tax_configuration =
         Orb::CustomerCreateParams::TaxConfiguration::Avalara
         | Orb::CustomerCreateParams::TaxConfiguration::Taxjar
+        | Orb::CustomerCreateParams::TaxConfiguration::Sphere
 
       module TaxConfiguration
         extend Orb::Internal::Type::Union
@@ -324,6 +325,18 @@ module Orb
           def to_hash: -> { tax_exempt: bool, tax_provider: :taxjar }
         end
 
+        type sphere = { tax_exempt: bool, tax_provider: :sphere }
+
+        class Sphere < Orb::Internal::Type::BaseModel
+          attr_accessor tax_exempt: bool
+
+          attr_accessor tax_provider: :sphere
+
+          def initialize: (tax_exempt: bool, ?tax_provider: :sphere) -> void
+
+          def to_hash: -> { tax_exempt: bool, tax_provider: :sphere }
+        end
+
         def self?.variants: -> ::Array[Orb::Models::CustomerCreateParams::tax_configuration]
       end
 

data/sig/orb/models/customer_update_by_external_id_params.rbs

@@ -276,6 +276,7 @@ module Orb
       type tax_configuration =
         Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara
         | Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar
+        | Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Sphere
 
       module TaxConfiguration
         extend Orb::Internal::Type::Union
@@ -319,6 +320,18 @@ module Orb
           def to_hash: -> { tax_exempt: bool, tax_provider: :taxjar }
         end
 
+        type sphere = { tax_exempt: bool, tax_provider: :sphere }
+
+        class Sphere < Orb::Internal::Type::BaseModel
+          attr_accessor tax_exempt: bool
+
+          attr_accessor tax_provider: :sphere
+
+          def initialize: (tax_exempt: bool, ?tax_provider: :sphere) -> void
+
+          def to_hash: -> { tax_exempt: bool, tax_provider: :sphere }
+        end
+
         def self?.variants: -> ::Array[Orb::Models::CustomerUpdateByExternalIDParams::tax_configuration]
       end
 

data/sig/orb/models/customer_update_params.rbs

@@ -276,6 +276,7 @@ module Orb
       type tax_configuration =
         Orb::CustomerUpdateParams::TaxConfiguration::Avalara
         | Orb::CustomerUpdateParams::TaxConfiguration::Taxjar
+        | Orb::CustomerUpdateParams::TaxConfiguration::Sphere
 
       module TaxConfiguration
         extend Orb::Internal::Type::Union
@@ -319,6 +320,18 @@ module Orb
           def to_hash: -> { tax_exempt: bool, tax_provider: :taxjar }
         end
 
+        type sphere = { tax_exempt: bool, tax_provider: :sphere }
+
+        class Sphere < Orb::Internal::Type::BaseModel
+          attr_accessor tax_exempt: bool
+
+          attr_accessor tax_provider: :sphere
+
+          def initialize: (tax_exempt: bool, ?tax_provider: :sphere) -> void
+
+          def to_hash: -> { tax_exempt: bool, tax_provider: :sphere }
+        end
+
         def self?.variants: -> ::Array[Orb::Models::CustomerUpdateParams::tax_configuration]
       end
 

data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs

@@ -28,7 +28,8 @@ module Orb
               entry_type: :increment,
               ledger_sequence_number: Integer,
               metadata: ::Hash[Symbol, String],
-              starting_balance: Float
+              starting_balance: Float,
+              created_invoices: ::Array[Orb::Invoice]?
             }
 
           class Increment < Orb::Internal::Type::BaseModel
@@ -58,6 +59,8 @@ module Orb
 
             attr_accessor starting_balance: Float
 
+            attr_accessor created_invoices: ::Array[Orb::Invoice]?
+
             def initialize: (
               id: String,
               amount: Float,
@@ -71,6 +74,7 @@ module Orb
               ledger_sequence_number: Integer,
               metadata: ::Hash[Symbol, String],
               starting_balance: Float,
+              ?created_invoices: ::Array[Orb::Invoice]?,
               ?entry_type: :increment
             ) -> void
 
@@ -87,7 +91,8 @@ module Orb
               entry_type: :increment,
               ledger_sequence_number: Integer,
               metadata: ::Hash[Symbol, String],
-              starting_balance: Float
+              starting_balance: Float,
+              created_invoices: ::Array[Orb::Invoice]?
             }
 
             type credit_block =

data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs

@@ -28,7 +28,8 @@ module Orb
               entry_type: :increment,
               ledger_sequence_number: Integer,
               metadata: ::Hash[Symbol, String],
-              starting_balance: Float
+              starting_balance: Float,
+              created_invoices: ::Array[Orb::Invoice]?
             }
 
           class Increment < Orb::Internal::Type::BaseModel
@@ -58,6 +59,8 @@ module Orb
 
             attr_accessor starting_balance: Float
 
+            attr_accessor created_invoices: ::Array[Orb::Invoice]?
+
             def initialize: (
               id: String,
               amount: Float,
@@ -71,6 +74,7 @@ module Orb
               ledger_sequence_number: Integer,
               metadata: ::Hash[Symbol, String],
               starting_balance: Float,
+              ?created_invoices: ::Array[Orb::Invoice]?,
               ?entry_type: :increment
             ) -> void
 
@@ -87,7 +91,8 @@ module Orb
               entry_type: :increment,
               ledger_sequence_number: Integer,
               metadata: ::Hash[Symbol, String],
-              starting_balance: Float
+              starting_balance: Float,
+              created_invoices: ::Array[Orb::Invoice]?
             }
 
             type credit_block =

data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs

@@ -28,7 +28,8 @@ module Orb
               entry_type: :increment,
               ledger_sequence_number: Integer,
               metadata: ::Hash[Symbol, String],
-              starting_balance: Float
+              starting_balance: Float,
+              created_invoices: ::Array[Orb::Invoice]?
             }
 
           class Increment < Orb::Internal::Type::BaseModel
@@ -58,6 +59,8 @@ module Orb
 
             attr_accessor starting_balance: Float
 
+            attr_accessor created_invoices: ::Array[Orb::Invoice]?
+
             def initialize: (
               id: String,
               amount: Float,
@@ -71,6 +74,7 @@ module Orb
               ledger_sequence_number: Integer,
               metadata: ::Hash[Symbol, String],
               starting_balance: Float,
+              ?created_invoices: ::Array[Orb::Invoice]?,
               ?entry_type: :increment
             ) -> void
 
@@ -87,7 +91,8 @@ module Orb
               entry_type: :increment,
               ledger_sequence_number: Integer,
               metadata: ::Hash[Symbol, String],
-              starting_balance: Float
+              starting_balance: Float,
+              created_invoices: ::Array[Orb::Invoice]?
             }
 
             type credit_block =

data/sig/orb/models/customers/credits/ledger_list_response.rbs

@@ -28,7 +28,8 @@ module Orb
               entry_type: :increment,
               ledger_sequence_number: Integer,
               metadata: ::Hash[Symbol, String],
-              starting_balance: Float
+              starting_balance: Float,
+              created_invoices: ::Array[Orb::Invoice]?
             }
 
           class Increment < Orb::Internal::Type::BaseModel
@@ -58,6 +59,8 @@ module Orb
 
             attr_accessor starting_balance: Float
 
+            attr_accessor created_invoices: ::Array[Orb::Invoice]?
+
             def initialize: (
               id: String,
               amount: Float,
@@ -71,6 +74,7 @@ module Orb
               ledger_sequence_number: Integer,
               metadata: ::Hash[Symbol, String],
               starting_balance: Float,
+              ?created_invoices: ::Array[Orb::Invoice]?,
               ?entry_type: :increment
             ) -> void
 
@@ -87,7 +91,8 @@ module Orb
               entry_type: :increment,
               ledger_sequence_number: Integer,
               metadata: ::Hash[Symbol, String],
-              starting_balance: Float
+              starting_balance: Float,
+              created_invoices: ::Array[Orb::Invoice]?
             }
 
             type credit_block =