metronome-sdk 3.8.0 → 3.9.0

data/lib/metronome_sdk/models/v1/contract_create_response.rb

@@ -103,7 +103,6 @@ module MetronomeSDK
             optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
 
             # @!attribute customer_billing_provider_configuration
-            #   The billing provider configuration associated with the contract.
             #
             #   @return [MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::CustomerBillingProviderConfiguration, nil]
             optional :customer_billing_provider_configuration,
@@ -238,7 +237,7 @@ module MetronomeSDK
             #
             #   @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             #
-            #   @param customer_billing_provider_configuration [MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::CustomerBillingProviderConfiguration] The billing provider configuration associated with the contract.
+            #   @param customer_billing_provider_configuration [MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::CustomerBillingProviderConfiguration]
             #
             #   @param ending_before [Time]
             #
@@ -368,29 +367,80 @@ module MetronomeSDK
             # @see MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract#customer_billing_provider_configuration
             class CustomerBillingProviderConfiguration < MetronomeSDK::Internal::Type::BaseModel
               # @!attribute id
+              #   ID of this configuration; can be provided as the
+              #   billing_provider_configuration_id when creating a contract.
               #
-              #   @return [String, nil]
-              optional :id, String
+              #   @return [String]
+              required :id, String
+
+              # @!attribute archived_at
+              #
+              #   @return [Time, nil]
+              required :archived_at, Time, nil?: true
 
               # @!attribute billing_provider
+              #   The billing provider set for this configuration.
               #
-              #   @return [Symbol, MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::CustomerBillingProviderConfiguration::BillingProvider, nil]
-              optional :billing_provider,
+              #   @return [Symbol, MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::CustomerBillingProviderConfiguration::BillingProvider]
+              required :billing_provider,
                        enum: -> { MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::CustomerBillingProviderConfiguration::BillingProvider }
 
+              # @!attribute configuration
+              #   Configuration for the billing provider. The structure of this object is specific
+              #   to the billing provider.
+              #
+              #   @return [Hash{Symbol=>Object}]
+              required :configuration, MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]
+
+              # @!attribute customer_id
+              #
+              #   @return [String]
+              required :customer_id, String
+
               # @!attribute delivery_method
+              #   The method to use for delivering invoices to this customer.
               #
-              #   @return [Symbol, MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::CustomerBillingProviderConfiguration::DeliveryMethod, nil]
-              optional :delivery_method,
+              #   @return [Symbol, MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::CustomerBillingProviderConfiguration::DeliveryMethod]
+              required :delivery_method,
                        enum: -> { MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::CustomerBillingProviderConfiguration::DeliveryMethod }
 
-              # @!method initialize(id: nil, billing_provider: nil, delivery_method: nil)
-              #   The billing provider configuration associated with the contract.
+              # @!attribute delivery_method_configuration
+              #   Configuration for the delivery method. The structure of this object is specific
+              #   to the delivery method.
               #
-              #   @param id [String]
-              #   @param billing_provider [Symbol, MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::CustomerBillingProviderConfiguration::BillingProvider]
-              #   @param delivery_method [Symbol, MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::CustomerBillingProviderConfiguration::DeliveryMethod]
+              #   @return [Hash{Symbol=>Object}]
+              required :delivery_method_configuration,
+                       MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]
+
+              # @!attribute delivery_method_id
+              #   ID of the delivery method to use for this customer.
+              #
+              #   @return [String]
+              required :delivery_method_id, String
+
+              # @!method initialize(id:, archived_at:, billing_provider:, configuration:, customer_id:, delivery_method:, delivery_method_configuration:, delivery_method_id:)
+              #   Some parameter documentations has been truncated, see
+              #   {MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::CustomerBillingProviderConfiguration}
+              #   for more details.
+              #
+              #   @param id [String] ID of this configuration; can be provided as the billing*provider_configuration*
+              #
+              #   @param archived_at [Time, nil]
+              #
+              #   @param billing_provider [Symbol, MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::CustomerBillingProviderConfiguration::BillingProvider] The billing provider set for this configuration.
+              #
+              #   @param configuration [Hash{Symbol=>Object}] Configuration for the billing provider. The structure of this object is specific
+              #
+              #   @param customer_id [String]
+              #
+              #   @param delivery_method [Symbol, MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::CustomerBillingProviderConfiguration::DeliveryMethod] The method to use for delivering invoices to this customer.
+              #
+              #   @param delivery_method_configuration [Hash{Symbol=>Object}] Configuration for the delivery method. The structure of this object is specific
+              #
+              #   @param delivery_method_id [String] ID of the delivery method to use for this customer.
 
+              # The billing provider set for this configuration.
+              #
               # @see MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::CustomerBillingProviderConfiguration#billing_provider
               module BillingProvider
                 extend MetronomeSDK::Internal::Type::Enum
@@ -409,6 +459,8 @@ module MetronomeSDK
                 #   @return [Array<Symbol>]
               end
 
+              # The method to use for delivering invoices to this customer.
+              #
               # @see MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::CustomerBillingProviderConfiguration#delivery_method
               module DeliveryMethod
                 extend MetronomeSDK::Internal::Type::Enum

data/lib/metronome_sdk/models/v2/contract_edit_params.rb

@@ -427,6 +427,7 @@ module MetronomeSDK
               extend MetronomeSDK::Internal::Type::Enum
 
               START_OF_CURRENT_PERIOD = :START_OF_CURRENT_PERIOD
+              START_OF_NEXT_PERIOD = :START_OF_NEXT_PERIOD
 
               # @!method self.values
               #   @return [Array<Symbol>]
@@ -2998,6 +2999,7 @@ module MetronomeSDK
               extend MetronomeSDK::Internal::Type::Enum
 
               START_OF_CURRENT_PERIOD = :START_OF_CURRENT_PERIOD
+              START_OF_NEXT_PERIOD = :START_OF_NEXT_PERIOD
 
               # @!method self.values
               #   @return [Array<Symbol>]

data/lib/metronome_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MetronomeSDK
-  VERSION = "3.8.0"
+  VERSION = "3.9.0"
 end

data/rbi/metronome_sdk/models/contract.rbi

@@ -48,7 +48,6 @@ module MetronomeSDK
       sig { params(custom_fields: T::Hash[Symbol, String]).void }
       attr_writer :custom_fields
 
-      # The billing provider configuration associated with a contract.
       sig do
         returns(
           T.nilable(
@@ -183,7 +182,6 @@ module MetronomeSDK
         archived_at: nil,
         # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
         custom_fields: nil,
-        # The billing provider configuration associated with a contract.
         customer_billing_provider_configuration: nil,
         # ID of the package this contract was created from, if applicable.
         package_id: nil,
@@ -567,9 +565,15 @@ module MetronomeSDK
             )
           end
 
+        # ID of this configuration; can be provided as the
+        # billing_provider_configuration_id when creating a contract.
+        sig { returns(String) }
+        attr_accessor :id
+
         sig { returns(T.nilable(Time)) }
         attr_accessor :archived_at
 
+        # The billing provider set for this configuration.
         sig do
           returns(
             MetronomeSDK::Contract::CustomerBillingProviderConfiguration::BillingProvider::TaggedSymbol
@@ -577,6 +581,15 @@ module MetronomeSDK
         end
         attr_accessor :billing_provider
 
+        # Configuration for the billing provider. The structure of this object is specific
+        # to the billing provider.
+        sig { returns(T::Hash[Symbol, T.anything]) }
+        attr_accessor :configuration
+
+        sig { returns(String) }
+        attr_accessor :customer_id
+
+        # The method to use for delivering invoices to this customer.
         sig do
           returns(
             MetronomeSDK::Contract::CustomerBillingProviderConfiguration::DeliveryMethod::TaggedSymbol
@@ -584,59 +597,70 @@ module MetronomeSDK
         end
         attr_accessor :delivery_method
 
-        sig { returns(T.nilable(String)) }
-        attr_reader :id
-
-        sig { params(id: String).void }
-        attr_writer :id
-
-        # Configuration for the billing provider. The structure of this object is specific
-        # to the billing provider.
-        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
-        attr_reader :configuration
+        # Configuration for the delivery method. The structure of this object is specific
+        # to the delivery method.
+        sig { returns(T::Hash[Symbol, T.anything]) }
+        attr_accessor :delivery_method_configuration
 
-        sig { params(configuration: T::Hash[Symbol, T.anything]).void }
-        attr_writer :configuration
+        # ID of the delivery method to use for this customer.
+        sig { returns(String) }
+        attr_accessor :delivery_method_id
 
-        # The billing provider configuration associated with a contract.
         sig do
           params(
+            id: String,
             archived_at: T.nilable(Time),
             billing_provider:
               MetronomeSDK::Contract::CustomerBillingProviderConfiguration::BillingProvider::OrSymbol,
+            configuration: T::Hash[Symbol, T.anything],
+            customer_id: String,
             delivery_method:
               MetronomeSDK::Contract::CustomerBillingProviderConfiguration::DeliveryMethod::OrSymbol,
-            id: String,
-            configuration: T::Hash[Symbol, T.anything]
+            delivery_method_configuration: T::Hash[Symbol, T.anything],
+            delivery_method_id: String
           ).returns(T.attached_class)
         end
         def self.new(
+          # ID of this configuration; can be provided as the
+          # billing_provider_configuration_id when creating a contract.
+          id:,
           archived_at:,
+          # The billing provider set for this configuration.
           billing_provider:,
-          delivery_method:,
-          id: nil,
           # Configuration for the billing provider. The structure of this object is specific
           # to the billing provider.
-          configuration: nil
+          configuration:,
+          customer_id:,
+          # The method to use for delivering invoices to this customer.
+          delivery_method:,
+          # Configuration for the delivery method. The structure of this object is specific
+          # to the delivery method.
+          delivery_method_configuration:,
+          # ID of the delivery method to use for this customer.
+          delivery_method_id:
         )
         end
 
         sig do
           override.returns(
             {
+              id: String,
               archived_at: T.nilable(Time),
               billing_provider:
                 MetronomeSDK::Contract::CustomerBillingProviderConfiguration::BillingProvider::TaggedSymbol,
+              configuration: T::Hash[Symbol, T.anything],
+              customer_id: String,
               delivery_method:
                 MetronomeSDK::Contract::CustomerBillingProviderConfiguration::DeliveryMethod::TaggedSymbol,
-              id: String,
-              configuration: T::Hash[Symbol, T.anything]
+              delivery_method_configuration: T::Hash[Symbol, T.anything],
+              delivery_method_id: String
             }
           )
         end
         def to_hash
         end
 
+        # The billing provider set for this configuration.
         module BillingProvider
           extend MetronomeSDK::Internal::Type::Enum
 
@@ -706,6 +730,7 @@ module MetronomeSDK
           end
         end
 
+        # The method to use for delivering invoices to this customer.
         module DeliveryMethod
           extend MetronomeSDK::Internal::Type::Enum