metronome-sdk 1.0.0 → 2.0.0

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Payments#cancel
+      class PaymentCancelParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        # @!attribute customer_id
+        #
+        #   @return [String]
+        required :customer_id, String
+
+        # @!attribute invoice_id
+        #
+        #   @return [String]
+        required :invoice_id, String
+
+        # @!method initialize(customer_id:, invoice_id:, request_options: {})
+        #   @param customer_id [String]
+        #   @param invoice_id [String]
+        #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Payments#cancel
+      class PaymentCancelResponse < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [MetronomeSDK::Models::V1::Payment]
+        required :data, -> { MetronomeSDK::V1::Payment }
+
+        # @!method initialize(data:)
+        #   @param data [MetronomeSDK::Models::V1::Payment]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Payments#list
+      class PaymentListParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        # @!attribute customer_id
+        #
+        #   @return [String]
+        required :customer_id, String
+
+        # @!attribute invoice_id
+        #
+        #   @return [String]
+        required :invoice_id, String
+
+        # @!attribute limit
+        #   The maximum number of payments to return. Defaults to 25.
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!attribute next_page
+        #   The next page token from a previous response.
+        #
+        #   @return [String, nil]
+        optional :next_page, String
+
+        # @!attribute statuses
+        #
+        #   @return [Array<Symbol, MetronomeSDK::Models::V1::PaymentStatus>, nil]
+        optional :statuses, -> { MetronomeSDK::Internal::Type::ArrayOf[enum: MetronomeSDK::V1::PaymentStatus] }
+
+        # @!method initialize(customer_id:, invoice_id:, limit: nil, next_page: nil, statuses: nil, request_options: {})
+        #   @param customer_id [String]
+        #
+        #   @param invoice_id [String]
+        #
+        #   @param limit [Integer] The maximum number of payments to return. Defaults to 25.
+        #
+        #   @param next_page [String] The next page token from a previous response.
+        #
+        #   @param statuses [Array<Symbol, MetronomeSDK::Models::V1::PaymentStatus>]
+        #
+        #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module PaymentStatus
+        extend MetronomeSDK::Internal::Type::Enum
+
+        PENDING = :pending
+        REQUIRES_INTERVENTION = :requires_intervention
+        PAID = :paid
+        CANCELED = :canceled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

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

@@ -41,6 +41,12 @@ module MetronomeSDK
         #   @return [Array<String>, nil]
         optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String], nil?: true
 
+        # @!attribute hierarchy_configuration
+        #   Optional configuration for commit hierarchy access control
+        #
+        #   @return [MetronomeSDK::Models::CommitHierarchyConfiguration, nil]
+        optional :hierarchy_configuration, -> { MetronomeSDK::CommitHierarchyConfiguration }
+
         # @!attribute invoice_contract_id
         #   ID of contract to use for invoicing
         #
@@ -85,7 +91,7 @@ module MetronomeSDK
                  -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifierInput] },
                  nil?: true
 
-        # @!method initialize(commit_id:, customer_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, invoice_contract_id: nil, invoice_schedule: nil, priority: nil, product_id: nil, rate_type: nil, specifiers: nil, request_options: {})
+        # @!method initialize(commit_id:, customer_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, hierarchy_configuration: nil, invoice_contract_id: nil, invoice_schedule: nil, priority: nil, product_id: nil, rate_type: nil, specifiers: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {MetronomeSDK::Models::V2::ContractEditCommitParams} for more details.
         #
@@ -99,6 +105,8 @@ module MetronomeSDK
         #
         #   @param applicable_product_tags [Array<String>, nil] Which tags the commit applies to. If applicable*product_ids, applicable_product*
         #
+        #   @param hierarchy_configuration [MetronomeSDK::Models::CommitHierarchyConfiguration] Optional configuration for commit hierarchy access control
+        #
         #   @param invoice_contract_id [String] ID of contract to use for invoicing
         #
         #   @param invoice_schedule [MetronomeSDK::Models::V2::ContractEditCommitParams::InvoiceSchedule]

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

@@ -39,6 +39,12 @@ module MetronomeSDK
         #   @return [Array<String>, nil]
         optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String], nil?: true
 
+        # @!attribute hierarchy_configuration
+        #   Optional configuration for credit hierarchy access control
+        #
+        #   @return [MetronomeSDK::Models::CommitHierarchyConfiguration, nil]
+        optional :hierarchy_configuration, -> { MetronomeSDK::CommitHierarchyConfiguration }
+
         # @!attribute priority
         #   If multiple commits are applicable, the one with the lower priority will apply
         #   first.
@@ -72,7 +78,7 @@ module MetronomeSDK
                  -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifierInput] },
                  nil?: true
 
-        # @!method initialize(credit_id:, customer_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, priority: nil, product_id: nil, rate_type: nil, specifiers: nil, request_options: {})
+        # @!method initialize(credit_id:, customer_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, hierarchy_configuration: nil, priority: nil, product_id: nil, rate_type: nil, specifiers: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {MetronomeSDK::Models::V2::ContractEditCreditParams} for more details.
         #
@@ -86,6 +92,8 @@ module MetronomeSDK
         #
         #   @param applicable_product_tags [Array<String>, nil] Which tags the credit applies to. If both applicable*product_ids and applicable*
         #
+        #   @param hierarchy_configuration [MetronomeSDK::Models::CommitHierarchyConfiguration] Optional configuration for credit hierarchy access control
+        #
         #   @param priority [Float, nil] If multiple commits are applicable, the one with the lower priority will apply f
         #
         #   @param product_id [String]

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

@@ -20,6 +20,15 @@ module MetronomeSDK
         #   @return [String]
         required :customer_id, String
 
+        # @!attribute add_billing_provider_configuration_update
+        #   Update the billing provider configuration on the contract. Currently only
+        #   supports adding a billing provider configuration to a contract that does not
+        #   already have one.
+        #
+        #   @return [MetronomeSDK::Models::V2::ContractEditParams::AddBillingProviderConfigurationUpdate, nil]
+        optional :add_billing_provider_configuration_update,
+                 -> { MetronomeSDK::V2::ContractEditParams::AddBillingProviderConfigurationUpdate }
+
         # @!attribute add_commits
         #
         #   @return [Array<MetronomeSDK::Models::V2::ContractEditParams::AddCommit>, nil]
@@ -206,7 +215,7 @@ module MetronomeSDK
         optional :update_subscriptions,
                  -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::UpdateSubscription] }
 
-        # @!method initialize(contract_id:, customer_id:, add_commits: nil, add_credits: nil, add_discounts: nil, add_overrides: nil, add_prepaid_balance_threshold_configuration: nil, add_professional_services: nil, add_recurring_commits: nil, add_recurring_credits: nil, add_reseller_royalties: nil, add_scheduled_charges: nil, add_spend_threshold_configuration: nil, add_subscriptions: nil, allow_contract_ending_before_finalized_invoice: nil, archive_commits: nil, archive_credits: nil, archive_scheduled_charges: nil, remove_overrides: nil, uniqueness_key: nil, update_commits: nil, update_contract_end_date: nil, update_contract_name: nil, update_credits: nil, update_prepaid_balance_threshold_configuration: nil, update_recurring_commits: nil, update_recurring_credits: nil, update_scheduled_charges: nil, update_spend_threshold_configuration: nil, update_subscriptions: nil, request_options: {})
+        # @!method initialize(contract_id:, customer_id:, add_billing_provider_configuration_update: nil, add_commits: nil, add_credits: nil, add_discounts: nil, add_overrides: nil, add_prepaid_balance_threshold_configuration: nil, add_professional_services: nil, add_recurring_commits: nil, add_recurring_credits: nil, add_reseller_royalties: nil, add_scheduled_charges: nil, add_spend_threshold_configuration: nil, add_subscriptions: nil, allow_contract_ending_before_finalized_invoice: nil, archive_commits: nil, archive_credits: nil, archive_scheduled_charges: nil, remove_overrides: nil, uniqueness_key: nil, update_commits: nil, update_contract_end_date: nil, update_contract_name: nil, update_credits: nil, update_prepaid_balance_threshold_configuration: nil, update_recurring_commits: nil, update_recurring_credits: nil, update_scheduled_charges: nil, update_spend_threshold_configuration: nil, update_subscriptions: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {MetronomeSDK::Models::V2::ContractEditParams} for more details.
         #
@@ -214,6 +223,8 @@ module MetronomeSDK
         #
         #   @param customer_id [String] ID of the customer whose contract is being edited
         #
+        #   @param add_billing_provider_configuration_update [MetronomeSDK::Models::V2::ContractEditParams::AddBillingProviderConfigurationUpdate] Update the billing provider configuration on the contract. Currently only suppor
+        #
         #   @param add_commits [Array<MetronomeSDK::Models::V2::ContractEditParams::AddCommit>]
         #
         #   @param add_credits [Array<MetronomeSDK::Models::V2::ContractEditParams::AddCredit>]
@@ -272,6 +283,118 @@ module MetronomeSDK
         #
         #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
 
+        class AddBillingProviderConfigurationUpdate < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute billing_provider_configuration
+          #
+          #   @return [MetronomeSDK::Models::V2::ContractEditParams::AddBillingProviderConfigurationUpdate::BillingProviderConfiguration]
+          required :billing_provider_configuration,
+                   -> { MetronomeSDK::V2::ContractEditParams::AddBillingProviderConfigurationUpdate::BillingProviderConfiguration }
+
+          # @!attribute schedule
+          #   Indicates when the billing provider will be active on the contract. Any charges
+          #   accrued during the schedule will be billed to the indicated billing provider.
+          #
+          #   @return [MetronomeSDK::Models::V2::ContractEditParams::AddBillingProviderConfigurationUpdate::Schedule]
+          required :schedule,
+                   -> { MetronomeSDK::V2::ContractEditParams::AddBillingProviderConfigurationUpdate::Schedule }
+
+          # @!method initialize(billing_provider_configuration:, schedule:)
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::V2::ContractEditParams::AddBillingProviderConfigurationUpdate}
+          #   for more details.
+          #
+          #   Update the billing provider configuration on the contract. Currently only
+          #   supports adding a billing provider configuration to a contract that does not
+          #   already have one.
+          #
+          #   @param billing_provider_configuration [MetronomeSDK::Models::V2::ContractEditParams::AddBillingProviderConfigurationUpdate::BillingProviderConfiguration]
+          #
+          #   @param schedule [MetronomeSDK::Models::V2::ContractEditParams::AddBillingProviderConfigurationUpdate::Schedule] Indicates when the billing provider will be active on the contract. Any charges
+
+          # @see MetronomeSDK::Models::V2::ContractEditParams::AddBillingProviderConfigurationUpdate#billing_provider_configuration
+          class BillingProviderConfiguration < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute billing_provider
+            #
+            #   @return [Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddBillingProviderConfigurationUpdate::BillingProviderConfiguration::BillingProvider, nil]
+            optional :billing_provider,
+                     enum: -> { MetronomeSDK::V2::ContractEditParams::AddBillingProviderConfigurationUpdate::BillingProviderConfiguration::BillingProvider }
+
+            # @!attribute billing_provider_configuration_id
+            #
+            #   @return [String, nil]
+            optional :billing_provider_configuration_id, String
+
+            # @!attribute delivery_method
+            #
+            #   @return [Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddBillingProviderConfigurationUpdate::BillingProviderConfiguration::DeliveryMethod, nil]
+            optional :delivery_method,
+                     enum: -> { MetronomeSDK::V2::ContractEditParams::AddBillingProviderConfigurationUpdate::BillingProviderConfiguration::DeliveryMethod }
+
+            # @!method initialize(billing_provider: nil, billing_provider_configuration_id: nil, delivery_method: nil)
+            #   @param billing_provider [Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddBillingProviderConfigurationUpdate::BillingProviderConfiguration::BillingProvider]
+            #   @param billing_provider_configuration_id [String]
+            #   @param delivery_method [Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddBillingProviderConfigurationUpdate::BillingProviderConfiguration::DeliveryMethod]
+
+            # @see MetronomeSDK::Models::V2::ContractEditParams::AddBillingProviderConfigurationUpdate::BillingProviderConfiguration#billing_provider
+            module BillingProvider
+              extend MetronomeSDK::Internal::Type::Enum
+
+              AWS_MARKETPLACE = :aws_marketplace
+              STRIPE = :stripe
+              NETSUITE = :netsuite
+              CUSTOM = :custom
+              AZURE_MARKETPLACE = :azure_marketplace
+              QUICKBOOKS_ONLINE = :quickbooks_online
+              WORKDAY = :workday
+              GCP_MARKETPLACE = :gcp_marketplace
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # @see MetronomeSDK::Models::V2::ContractEditParams::AddBillingProviderConfigurationUpdate::BillingProviderConfiguration#delivery_method
+            module DeliveryMethod
+              extend MetronomeSDK::Internal::Type::Enum
+
+              DIRECT_TO_BILLING_PROVIDER = :direct_to_billing_provider
+              AWS_SQS = :aws_sqs
+              TACKLE = :tackle
+              AWS_SNS = :aws_sns
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # @see MetronomeSDK::Models::V2::ContractEditParams::AddBillingProviderConfigurationUpdate#schedule
+          class Schedule < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute effective_at
+            #   When the billing provider update will take effect.
+            #
+            #   @return [Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddBillingProviderConfigurationUpdate::Schedule::EffectiveAt]
+            required :effective_at,
+                     enum: -> { MetronomeSDK::V2::ContractEditParams::AddBillingProviderConfigurationUpdate::Schedule::EffectiveAt }
+
+            # @!method initialize(effective_at:)
+            #   Indicates when the billing provider will be active on the contract. Any charges
+            #   accrued during the schedule will be billed to the indicated billing provider.
+            #
+            #   @param effective_at [Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddBillingProviderConfigurationUpdate::Schedule::EffectiveAt] When the billing provider update will take effect.
+
+            # When the billing provider update will take effect.
+            #
+            # @see MetronomeSDK::Models::V2::ContractEditParams::AddBillingProviderConfigurationUpdate::Schedule#effective_at
+            module EffectiveAt
+              extend MetronomeSDK::Internal::Type::Enum
+
+              START_OF_CURRENT_PERIOD = :START_OF_CURRENT_PERIOD
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+
         class AddCommit < MetronomeSDK::Internal::Type::BaseModel
           # @!attribute product_id
           #
@@ -850,6 +973,7 @@ module MetronomeSDK
               NONE = :NONE
               STRIPE = :STRIPE
               ANROK = :ANROK
+              AVALARA = :AVALARA
               PRECALCULATED = :PRECALCULATED
 
               # @!method self.values
@@ -3607,11 +3731,27 @@ module MetronomeSDK
           optional :invoice_amount,
                    -> { MetronomeSDK::V2::ContractEditParams::UpdateRecurringCommit::InvoiceAmount }
 
-          # @!method initialize(recurring_commit_id:, access_amount: nil, ending_before: nil, invoice_amount: nil)
+          # @!attribute rate_type
+          #   If provided, updates the recurring commit to use the specified rate type when
+          #   generating future commits.
+          #
+          #   @return [Symbol, MetronomeSDK::Models::V2::ContractEditParams::UpdateRecurringCommit::RateType, nil]
+          optional :rate_type, enum: -> { MetronomeSDK::V2::ContractEditParams::UpdateRecurringCommit::RateType }
+
+          # @!method initialize(recurring_commit_id:, access_amount: nil, ending_before: nil, invoice_amount: nil, rate_type: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::V2::ContractEditParams::UpdateRecurringCommit} for more
+          #   details.
+          #
           #   @param recurring_commit_id [String]
+          #
           #   @param access_amount [MetronomeSDK::Models::V2::ContractEditParams::UpdateRecurringCommit::AccessAmount]
+          #
           #   @param ending_before [Time, nil]
+          #
           #   @param invoice_amount [MetronomeSDK::Models::V2::ContractEditParams::UpdateRecurringCommit::InvoiceAmount]
+          #
+          #   @param rate_type [Symbol, MetronomeSDK::Models::V2::ContractEditParams::UpdateRecurringCommit::RateType] If provided, updates the recurring commit to use the specified rate type when ge
 
           # @see MetronomeSDK::Models::V2::ContractEditParams::UpdateRecurringCommit#access_amount
           class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
@@ -3646,6 +3786,20 @@ module MetronomeSDK
             #   @param quantity [Float]
             #   @param unit_price [Float]
           end
+
+          # If provided, updates the recurring commit to use the specified rate type when
+          # generating future commits.
+          #
+          # @see MetronomeSDK::Models::V2::ContractEditParams::UpdateRecurringCommit#rate_type
+          module RateType
+            extend MetronomeSDK::Internal::Type::Enum
+
+            LIST_RATE = :LIST_RATE
+            COMMIT_RATE = :COMMIT_RATE
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
         end
 
         class UpdateRecurringCredit < MetronomeSDK::Internal::Type::BaseModel
@@ -3664,10 +3818,25 @@ module MetronomeSDK
           #   @return [Time, nil]
           optional :ending_before, Time, nil?: true
 
-          # @!method initialize(recurring_credit_id:, access_amount: nil, ending_before: nil)
+          # @!attribute rate_type
+          #   If provided, updates the recurring credit to use the specified rate type when
+          #   generating future credits.
+          #
+          #   @return [Symbol, MetronomeSDK::Models::V2::ContractEditParams::UpdateRecurringCredit::RateType, nil]
+          optional :rate_type, enum: -> { MetronomeSDK::V2::ContractEditParams::UpdateRecurringCredit::RateType }
+
+          # @!method initialize(recurring_credit_id:, access_amount: nil, ending_before: nil, rate_type: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::V2::ContractEditParams::UpdateRecurringCredit} for more
+          #   details.
+          #
           #   @param recurring_credit_id [String]
+          #
           #   @param access_amount [MetronomeSDK::Models::V2::ContractEditParams::UpdateRecurringCredit::AccessAmount]
+          #
           #   @param ending_before [Time, nil]
+          #
+          #   @param rate_type [Symbol, MetronomeSDK::Models::V2::ContractEditParams::UpdateRecurringCredit::RateType] If provided, updates the recurring credit to use the specified rate type when ge
 
           # @see MetronomeSDK::Models::V2::ContractEditParams::UpdateRecurringCredit#access_amount
           class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
@@ -3685,6 +3854,20 @@ module MetronomeSDK
             #   @param quantity [Float]
             #   @param unit_price [Float]
           end
+
+          # If provided, updates the recurring credit to use the specified rate type when
+          # generating future credits.
+          #
+          # @see MetronomeSDK::Models::V2::ContractEditParams::UpdateRecurringCredit#rate_type
+          module RateType
+            extend MetronomeSDK::Internal::Type::Enum
+
+            LIST_RATE = :LIST_RATE
+            COMMIT_RATE = :COMMIT_RATE
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
         end
 
         class UpdateScheduledCharge < MetronomeSDK::Internal::Type::BaseModel