orb-billing 0.5.5 → 0.7.0

data/lib/orb/models/beta_fetch_plan_version_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Beta#fetch_plan_version
+    class BetaFetchPlanVersionParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      # @!attribute plan_id
+      #
+      #   @return [String]
+      required :plan_id, String
+
+      # @!method initialize(plan_id:, request_options: {})
+      #   @param plan_id [String]
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/orb/models/beta_set_default_plan_version_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Beta#set_default_plan_version
+    class BetaSetDefaultPlanVersionParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      # @!attribute version
+      #   Plan version to set as the default.
+      #
+      #   @return [Integer]
+      required :version, Integer
+
+      # @!method initialize(version:, request_options: {})
+      #   @param version [Integer] Plan version to set as the default.
+      #
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/orb/models/credit_note_create_params.rb

@@ -12,24 +12,24 @@ module Orb
       #   @return [Array<Orb::Models::CreditNoteCreateParams::LineItem>]
       required :line_items, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNoteCreateParams::LineItem] }
 
+      # @!attribute reason
+      #   An optional reason for the credit note.
+      #
+      #   @return [Symbol, Orb::Models::CreditNoteCreateParams::Reason]
+      required :reason, enum: -> { Orb::CreditNoteCreateParams::Reason }
+
       # @!attribute memo
       #   An optional memo to attach to the credit note.
       #
       #   @return [String, nil]
       optional :memo, String, nil?: true
 
-      # @!attribute reason
-      #   An optional reason for the credit note.
-      #
-      #   @return [Symbol, Orb::Models::CreditNoteCreateParams::Reason, nil]
-      optional :reason, enum: -> { Orb::CreditNoteCreateParams::Reason }, nil?: true
-
-      # @!method initialize(line_items:, memo: nil, reason: nil, request_options: {})
+      # @!method initialize(line_items:, reason:, memo: nil, request_options: {})
       #   @param line_items [Array<Orb::Models::CreditNoteCreateParams::LineItem>]
       #
-      #   @param memo [String, nil] An optional memo to attach to the credit note.
+      #   @param reason [Symbol, Orb::Models::CreditNoteCreateParams::Reason] An optional reason for the credit note.
       #
-      #   @param reason [Symbol, Orb::Models::CreditNoteCreateParams::Reason, nil] An optional reason for the credit note.
+      #   @param memo [String, nil] An optional memo to attach to the credit note.
       #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 

data/lib/orb/models/customer_create_params.rb

@@ -109,7 +109,7 @@ module Orb
 
       # @!attribute tax_configuration
       #
-      #   @return [Orb::Models::CustomerCreateParams::TaxConfiguration::Avalara, Orb::Models::CustomerCreateParams::TaxConfiguration::Taxjar, nil]
+      #   @return [Orb::Models::CustomerCreateParams::TaxConfiguration::Avalara, Orb::Models::CustomerCreateParams::TaxConfiguration::Taxjar, Orb::Models::CustomerCreateParams::TaxConfiguration::Sphere, nil]
       optional :tax_configuration, union: -> { Orb::CustomerCreateParams::TaxConfiguration }, nil?: true
 
       # @!attribute tax_id
@@ -264,7 +264,7 @@ module Orb
       #
       #   @param shipping_address [Orb::Models::CustomerCreateParams::ShippingAddress, nil]
       #
-      #   @param tax_configuration [Orb::Models::CustomerCreateParams::TaxConfiguration::Avalara, Orb::Models::CustomerCreateParams::TaxConfiguration::Taxjar, nil]
+      #   @param tax_configuration [Orb::Models::CustomerCreateParams::TaxConfiguration::Avalara, Orb::Models::CustomerCreateParams::TaxConfiguration::Taxjar, Orb::Models::CustomerCreateParams::TaxConfiguration::Sphere, nil]
       #
       #   @param tax_id [Orb::Models::CustomerCreateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
       #
@@ -449,6 +449,8 @@ module Orb
 
         variant :taxjar, -> { Orb::CustomerCreateParams::TaxConfiguration::Taxjar }
 
+        variant :sphere, -> { Orb::CustomerCreateParams::TaxConfiguration::Sphere }
+
         class Avalara < Orb::Internal::Type::BaseModel
           # @!attribute tax_exempt
           #
@@ -487,8 +489,24 @@ module Orb
           #   @param tax_provider [Symbol, :taxjar]
         end
 
+        class Sphere < Orb::Internal::Type::BaseModel
+          # @!attribute tax_exempt
+          #
+          #   @return [Boolean]
+          required :tax_exempt, Orb::Internal::Type::Boolean
+
+          # @!attribute tax_provider
+          #
+          #   @return [Symbol, :sphere]
+          required :tax_provider, const: :sphere
+
+          # @!method initialize(tax_exempt:, tax_provider: :sphere)
+          #   @param tax_exempt [Boolean]
+          #   @param tax_provider [Symbol, :sphere]
+        end
+
         # @!method self.variants
-        #   @return [Array(Orb::Models::CustomerCreateParams::TaxConfiguration::Avalara, Orb::Models::CustomerCreateParams::TaxConfiguration::Taxjar)]
+        #   @return [Array(Orb::Models::CustomerCreateParams::TaxConfiguration::Avalara, Orb::Models::CustomerCreateParams::TaxConfiguration::Taxjar, Orb::Models::CustomerCreateParams::TaxConfiguration::Sphere)]
       end
 
       class TaxID < Orb::Internal::Type::BaseModel

data/lib/orb/models/customer_update_by_external_id_params.rb

@@ -114,7 +114,7 @@ module Orb
 
       # @!attribute tax_configuration
       #
-      #   @return [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar, nil]
+      #   @return [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Sphere, nil]
       optional :tax_configuration,
                union: -> { Orb::CustomerUpdateByExternalIDParams::TaxConfiguration },
                nil?: true
@@ -263,7 +263,7 @@ module Orb
       #
       #   @param shipping_address [Orb::Models::CustomerUpdateByExternalIDParams::ShippingAddress, nil]
       #
-      #   @param tax_configuration [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar, nil]
+      #   @param tax_configuration [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Sphere, nil]
       #
       #   @param tax_id [Orb::Models::CustomerUpdateByExternalIDParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
       #
@@ -450,6 +450,8 @@ module Orb
 
         variant :taxjar, -> { Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar }
 
+        variant :sphere, -> { Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Sphere }
+
         class Avalara < Orb::Internal::Type::BaseModel
           # @!attribute tax_exempt
           #
@@ -488,8 +490,24 @@ module Orb
           #   @param tax_provider [Symbol, :taxjar]
         end
 
+        class Sphere < Orb::Internal::Type::BaseModel
+          # @!attribute tax_exempt
+          #
+          #   @return [Boolean]
+          required :tax_exempt, Orb::Internal::Type::Boolean
+
+          # @!attribute tax_provider
+          #
+          #   @return [Symbol, :sphere]
+          required :tax_provider, const: :sphere
+
+          # @!method initialize(tax_exempt:, tax_provider: :sphere)
+          #   @param tax_exempt [Boolean]
+          #   @param tax_provider [Symbol, :sphere]
+        end
+
         # @!method self.variants
-        #   @return [Array(Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar)]
+        #   @return [Array(Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Sphere)]
       end
 
       class TaxID < Orb::Internal::Type::BaseModel

data/lib/orb/models/customer_update_params.rb

@@ -110,7 +110,7 @@ module Orb
 
       # @!attribute tax_configuration
       #
-      #   @return [Orb::Models::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateParams::TaxConfiguration::Taxjar, nil]
+      #   @return [Orb::Models::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateParams::TaxConfiguration::Taxjar, Orb::Models::CustomerUpdateParams::TaxConfiguration::Sphere, nil]
       optional :tax_configuration, union: -> { Orb::CustomerUpdateParams::TaxConfiguration }, nil?: true
 
       # @!attribute tax_id
@@ -257,7 +257,7 @@ module Orb
       #
       #   @param shipping_address [Orb::Models::CustomerUpdateParams::ShippingAddress, nil]
       #
-      #   @param tax_configuration [Orb::Models::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateParams::TaxConfiguration::Taxjar, nil]
+      #   @param tax_configuration [Orb::Models::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateParams::TaxConfiguration::Taxjar, Orb::Models::CustomerUpdateParams::TaxConfiguration::Sphere, nil]
       #
       #   @param tax_id [Orb::Models::CustomerUpdateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
       #
@@ -444,6 +444,8 @@ module Orb
 
         variant :taxjar, -> { Orb::CustomerUpdateParams::TaxConfiguration::Taxjar }
 
+        variant :sphere, -> { Orb::CustomerUpdateParams::TaxConfiguration::Sphere }
+
         class Avalara < Orb::Internal::Type::BaseModel
           # @!attribute tax_exempt
           #
@@ -482,8 +484,24 @@ module Orb
           #   @param tax_provider [Symbol, :taxjar]
         end
 
+        class Sphere < Orb::Internal::Type::BaseModel
+          # @!attribute tax_exempt
+          #
+          #   @return [Boolean]
+          required :tax_exempt, Orb::Internal::Type::Boolean
+
+          # @!attribute tax_provider
+          #
+          #   @return [Symbol, :sphere]
+          required :tax_provider, const: :sphere
+
+          # @!method initialize(tax_exempt:, tax_provider: :sphere)
+          #   @param tax_exempt [Boolean]
+          #   @param tax_provider [Symbol, :sphere]
+        end
+
         # @!method self.variants
-        #   @return [Array(Orb::Models::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateParams::TaxConfiguration::Taxjar)]
+        #   @return [Array(Orb::Models::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateParams::TaxConfiguration::Taxjar, Orb::Models::CustomerUpdateParams::TaxConfiguration::Sphere)]
       end
 
       class TaxID < Orb::Internal::Type::BaseModel

data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb

@@ -106,7 +106,13 @@ module Orb
             #   @return [Float]
             required :starting_balance, Float
 
-            # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :increment)
+            # @!attribute created_invoices
+            #   If the increment resulted in invoice creation, the list of created invoices
+            #
+            #   @return [Array<Orb::Models::Invoice>, nil]
+            optional :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }, nil?: true
+
+            # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, created_invoices: nil, entry_type: :increment)
             #   Some parameter documentations has been truncated, see
             #   {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Increment}
             #   for more details.
@@ -135,6 +141,8 @@ module Orb
             #
             #   @param starting_balance [Float]
             #
+            #   @param created_invoices [Array<Orb::Models::Invoice>, nil] If the increment resulted in invoice creation, the list of created invoices
+            #
             #   @param entry_type [Symbol, :increment]
 
             # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Increment#credit_block

data/lib/orb/models/customers/credits/ledger_create_entry_response.rb

@@ -101,7 +101,13 @@ module Orb
             #   @return [Float]
             required :starting_balance, Float
 
-            # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :increment)
+            # @!attribute created_invoices
+            #   If the increment resulted in invoice creation, the list of created invoices
+            #
+            #   @return [Array<Orb::Models::Invoice>, nil]
+            optional :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }, nil?: true
+
+            # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, created_invoices: nil, entry_type: :increment)
             #   Some parameter documentations has been truncated, see
             #   {Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Increment} for more
             #   details.
@@ -130,6 +136,8 @@ module Orb
             #
             #   @param starting_balance [Float]
             #
+            #   @param created_invoices [Array<Orb::Models::Invoice>, nil] If the increment resulted in invoice creation, the list of created invoices
+            #
             #   @param entry_type [Symbol, :increment]
 
             # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Increment#credit_block

data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb

@@ -103,7 +103,13 @@ module Orb
             #   @return [Float]
             required :starting_balance, Float
 
-            # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :increment)
+            # @!attribute created_invoices
+            #   If the increment resulted in invoice creation, the list of created invoices
+            #
+            #   @return [Array<Orb::Models::Invoice>, nil]
+            optional :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }, nil?: true
+
+            # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, created_invoices: nil, entry_type: :increment)
             #   Some parameter documentations has been truncated, see
             #   {Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Increment} for
             #   more details.
@@ -132,6 +138,8 @@ module Orb
             #
             #   @param starting_balance [Float]
             #
+            #   @param created_invoices [Array<Orb::Models::Invoice>, nil] If the increment resulted in invoice creation, the list of created invoices
+            #
             #   @param entry_type [Symbol, :increment]
 
             # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Increment#credit_block

data/lib/orb/models/customers/credits/ledger_list_response.rb

@@ -99,7 +99,13 @@ module Orb
             #   @return [Float]
             required :starting_balance, Float
 
-            # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :increment)
+            # @!attribute created_invoices
+            #   If the increment resulted in invoice creation, the list of created invoices
+            #
+            #   @return [Array<Orb::Models::Invoice>, nil]
+            optional :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }, nil?: true
+
+            # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, created_invoices: nil, entry_type: :increment)
             #   Some parameter documentations has been truncated, see
             #   {Orb::Models::Customers::Credits::LedgerListResponse::Increment} for more
             #   details.
@@ -128,6 +134,8 @@ module Orb
             #
             #   @param starting_balance [Float]
             #
+            #   @param created_invoices [Array<Orb::Models::Invoice>, nil] If the increment resulted in invoice creation, the list of created invoices
+            #
             #   @param entry_type [Symbol, :increment]
 
             # @see Orb::Models::Customers::Credits::LedgerListResponse::Increment#credit_block

data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb

@@ -46,7 +46,7 @@ module Orb
 
           # @!attribute active_from
           #   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.
           #
           #   @return [Time, nil]
           optional :active_from, Time, nil?: true

data/lib/orb/models/customers/credits/top_up_create_params.rb

@@ -43,7 +43,7 @@ module Orb
 
           # @!attribute active_from
           #   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.
           #
           #   @return [Time, nil]
           optional :active_from, Time, nil?: true