metronome-sdk 3.5.0 → 3.7.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metronome-sdk
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.7.0
 platform: ruby
 authors:
 - Metronome
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-21 00:00:00.000000000 Z
+date: 2026-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi
@@ -137,6 +137,8 @@ files:
 - lib/metronome_sdk/models/v1/contract_list_balances_response.rb
 - lib/metronome_sdk/models/v1/contract_list_params.rb
 - lib/metronome_sdk/models/v1/contract_list_response.rb
+- lib/metronome_sdk/models/v1/contract_list_seat_balances_params.rb
+- lib/metronome_sdk/models/v1/contract_list_seat_balances_response.rb
 - lib/metronome_sdk/models/v1/contract_retrieve_params.rb
 - lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rb
 - lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rb
@@ -286,13 +288,6 @@ files:
 - lib/metronome_sdk/models/v1/package_list_response.rb
 - lib/metronome_sdk/models/v1/package_retrieve_params.rb
 - lib/metronome_sdk/models/v1/package_retrieve_response.rb
-- lib/metronome_sdk/models/v1/payment.rb
-- lib/metronome_sdk/models/v1/payment_attempt_params.rb
-- lib/metronome_sdk/models/v1/payment_attempt_response.rb
-- lib/metronome_sdk/models/v1/payment_cancel_params.rb
-- lib/metronome_sdk/models/v1/payment_cancel_response.rb
-- lib/metronome_sdk/models/v1/payment_list_params.rb
-- lib/metronome_sdk/models/v1/payment_status.rb
 - lib/metronome_sdk/models/v1/plan_detail.rb
 - lib/metronome_sdk/models/v1/plan_get_details_params.rb
 - lib/metronome_sdk/models/v1/plan_get_details_response.rb
@@ -358,7 +353,6 @@ files:
 - lib/metronome_sdk/resources/v1/dashboards.rb
 - lib/metronome_sdk/resources/v1/invoices.rb
 - lib/metronome_sdk/resources/v1/packages.rb
-- lib/metronome_sdk/resources/v1/payments.rb
 - lib/metronome_sdk/resources/v1/plans.rb
 - lib/metronome_sdk/resources/v1/pricing_units.rb
 - lib/metronome_sdk/resources/v1/services.rb
@@ -456,6 +450,8 @@ files:
 - rbi/metronome_sdk/models/v1/contract_list_balances_response.rbi
 - rbi/metronome_sdk/models/v1/contract_list_params.rbi
 - rbi/metronome_sdk/models/v1/contract_list_response.rbi
+- rbi/metronome_sdk/models/v1/contract_list_seat_balances_params.rbi
+- rbi/metronome_sdk/models/v1/contract_list_seat_balances_response.rbi
 - rbi/metronome_sdk/models/v1/contract_retrieve_params.rbi
 - rbi/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rbi
 - rbi/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbi
@@ -605,13 +601,6 @@ files:
 - rbi/metronome_sdk/models/v1/package_list_response.rbi
 - rbi/metronome_sdk/models/v1/package_retrieve_params.rbi
 - rbi/metronome_sdk/models/v1/package_retrieve_response.rbi
-- rbi/metronome_sdk/models/v1/payment.rbi
-- rbi/metronome_sdk/models/v1/payment_attempt_params.rbi
-- rbi/metronome_sdk/models/v1/payment_attempt_response.rbi
-- rbi/metronome_sdk/models/v1/payment_cancel_params.rbi
-- rbi/metronome_sdk/models/v1/payment_cancel_response.rbi
-- rbi/metronome_sdk/models/v1/payment_list_params.rbi
-- rbi/metronome_sdk/models/v1/payment_status.rbi
 - rbi/metronome_sdk/models/v1/plan_detail.rbi
 - rbi/metronome_sdk/models/v1/plan_get_details_params.rbi
 - rbi/metronome_sdk/models/v1/plan_get_details_response.rbi
@@ -677,7 +666,6 @@ files:
 - rbi/metronome_sdk/resources/v1/dashboards.rbi
 - rbi/metronome_sdk/resources/v1/invoices.rbi
 - rbi/metronome_sdk/resources/v1/packages.rbi
-- rbi/metronome_sdk/resources/v1/payments.rbi
 - rbi/metronome_sdk/resources/v1/plans.rbi
 - rbi/metronome_sdk/resources/v1/pricing_units.rbi
 - rbi/metronome_sdk/resources/v1/services.rbi
@@ -774,6 +762,8 @@ files:
 - sig/metronome_sdk/models/v1/contract_list_balances_response.rbs
 - sig/metronome_sdk/models/v1/contract_list_params.rbs
 - sig/metronome_sdk/models/v1/contract_list_response.rbs
+- sig/metronome_sdk/models/v1/contract_list_seat_balances_params.rbs
+- sig/metronome_sdk/models/v1/contract_list_seat_balances_response.rbs
 - sig/metronome_sdk/models/v1/contract_retrieve_params.rbs
 - sig/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rbs
 - sig/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbs
@@ -923,13 +913,6 @@ files:
 - sig/metronome_sdk/models/v1/package_list_response.rbs
 - sig/metronome_sdk/models/v1/package_retrieve_params.rbs
 - sig/metronome_sdk/models/v1/package_retrieve_response.rbs
-- sig/metronome_sdk/models/v1/payment.rbs
-- sig/metronome_sdk/models/v1/payment_attempt_params.rbs
-- sig/metronome_sdk/models/v1/payment_attempt_response.rbs
-- sig/metronome_sdk/models/v1/payment_cancel_params.rbs
-- sig/metronome_sdk/models/v1/payment_cancel_response.rbs
-- sig/metronome_sdk/models/v1/payment_list_params.rbs
-- sig/metronome_sdk/models/v1/payment_status.rbs
 - sig/metronome_sdk/models/v1/plan_detail.rbs
 - sig/metronome_sdk/models/v1/plan_get_details_params.rbs
 - sig/metronome_sdk/models/v1/plan_get_details_response.rbs
@@ -995,7 +978,6 @@ files:
 - sig/metronome_sdk/resources/v1/dashboards.rbs
 - sig/metronome_sdk/resources/v1/invoices.rbs
 - sig/metronome_sdk/resources/v1/packages.rbs
-- sig/metronome_sdk/resources/v1/payments.rbs
 - sig/metronome_sdk/resources/v1/plans.rbs
 - sig/metronome_sdk/resources/v1/pricing_units.rbs
 - sig/metronome_sdk/resources/v1/services.rbs

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

@@ -1,196 +0,0 @@
-# frozen_string_literal: true
-
-module MetronomeSDK
-  module Models
-    module V1
-      # @see MetronomeSDK::Resources::V1::Payments#list
-      class Payment < MetronomeSDK::Internal::Type::BaseModel
-        # @!attribute id
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute amount
-        #
-        #   @return [Float, nil]
-        optional :amount, Float
-
-        # @!attribute amount_paid
-        #
-        #   @return [Float, nil]
-        optional :amount_paid, Float
-
-        # @!attribute contract_id
-        #
-        #   @return [String, nil]
-        optional :contract_id, String
-
-        # @!attribute created_at
-        #
-        #   @return [Time, nil]
-        optional :created_at, Time
-
-        # @!attribute customer_id
-        #
-        #   @return [String, nil]
-        optional :customer_id, String
-
-        # @!attribute error_message
-        #
-        #   @return [String, nil]
-        optional :error_message, String
-
-        # @!attribute fiat_credit_type
-        #
-        #   @return [MetronomeSDK::Models::CreditTypeData, nil]
-        optional :fiat_credit_type, -> { MetronomeSDK::CreditTypeData }
-
-        # @!attribute invoice_id
-        #
-        #   @return [String, nil]
-        optional :invoice_id, String
-
-        # @!attribute payment_gateway
-        #
-        #   @return [MetronomeSDK::Models::V1::Payment::PaymentGateway, nil]
-        optional :payment_gateway, -> { MetronomeSDK::V1::Payment::PaymentGateway }
-
-        # @!attribute revenue_system_payments
-        #
-        #   @return [Array<MetronomeSDK::Models::V1::Payment::RevenueSystemPayment>, nil]
-        optional :revenue_system_payments,
-                 -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Payment::RevenueSystemPayment] }
-
-        # @!attribute status
-        #
-        #   @return [Symbol, MetronomeSDK::Models::V1::PaymentStatus, nil]
-        optional :status, enum: -> { MetronomeSDK::V1::PaymentStatus }
-
-        # @!attribute updated_at
-        #
-        #   @return [Time, nil]
-        optional :updated_at, Time
-
-        # @!method initialize(id:, amount: nil, amount_paid: nil, contract_id: nil, created_at: nil, customer_id: nil, error_message: nil, fiat_credit_type: nil, invoice_id: nil, payment_gateway: nil, revenue_system_payments: nil, status: nil, updated_at: nil)
-        #   @param id [String]
-        #   @param amount [Float]
-        #   @param amount_paid [Float]
-        #   @param contract_id [String]
-        #   @param created_at [Time]
-        #   @param customer_id [String]
-        #   @param error_message [String]
-        #   @param fiat_credit_type [MetronomeSDK::Models::CreditTypeData]
-        #   @param invoice_id [String]
-        #   @param payment_gateway [MetronomeSDK::Models::V1::Payment::PaymentGateway]
-        #   @param revenue_system_payments [Array<MetronomeSDK::Models::V1::Payment::RevenueSystemPayment>]
-        #   @param status [Symbol, MetronomeSDK::Models::V1::PaymentStatus]
-        #   @param updated_at [Time]
-
-        # @see MetronomeSDK::Models::V1::Payment#payment_gateway
-        class PaymentGateway < MetronomeSDK::Internal::Type::BaseModel
-          # @!attribute stripe
-          #
-          #   @return [MetronomeSDK::Models::V1::Payment::PaymentGateway::Stripe]
-          required :stripe, -> { MetronomeSDK::V1::Payment::PaymentGateway::Stripe }
-
-          # @!attribute type
-          #
-          #   @return [Symbol, MetronomeSDK::Models::V1::Payment::PaymentGateway::Type]
-          required :type, enum: -> { MetronomeSDK::V1::Payment::PaymentGateway::Type }
-
-          # @!method initialize(stripe:, type:)
-          #   @param stripe [MetronomeSDK::Models::V1::Payment::PaymentGateway::Stripe]
-          #   @param type [Symbol, MetronomeSDK::Models::V1::Payment::PaymentGateway::Type]
-
-          # @see MetronomeSDK::Models::V1::Payment::PaymentGateway#stripe
-          class Stripe < MetronomeSDK::Internal::Type::BaseModel
-            # @!attribute payment_intent_id
-            #
-            #   @return [String]
-            required :payment_intent_id, String
-
-            # @!attribute error
-            #
-            #   @return [MetronomeSDK::Models::V1::Payment::PaymentGateway::Stripe::Error, nil]
-            optional :error, -> { MetronomeSDK::V1::Payment::PaymentGateway::Stripe::Error }
-
-            # @!attribute payment_method_id
-            #
-            #   @return [String, nil]
-            optional :payment_method_id, String
-
-            # @!method initialize(payment_intent_id:, error: nil, payment_method_id: nil)
-            #   @param payment_intent_id [String]
-            #   @param error [MetronomeSDK::Models::V1::Payment::PaymentGateway::Stripe::Error]
-            #   @param payment_method_id [String]
-
-            # @see MetronomeSDK::Models::V1::Payment::PaymentGateway::Stripe#error
-            class Error < MetronomeSDK::Internal::Type::BaseModel
-              # @!attribute code
-              #
-              #   @return [String, nil]
-              optional :code, String
-
-              # @!attribute decline_code
-              #
-              #   @return [String, nil]
-              optional :decline_code, String
-
-              # @!attribute type
-              #
-              #   @return [String, nil]
-              optional :type, String
-
-              # @!method initialize(code: nil, decline_code: nil, type: nil)
-              #   @param code [String]
-              #   @param decline_code [String]
-              #   @param type [String]
-            end
-          end
-
-          # @see MetronomeSDK::Models::V1::Payment::PaymentGateway#type
-          module Type
-            extend MetronomeSDK::Internal::Type::Enum
-
-            STRIPE = :stripe
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-        end
-
-        class RevenueSystemPayment < MetronomeSDK::Internal::Type::BaseModel
-          # @!attribute revenue_system_provider
-          #
-          #   @return [String]
-          required :revenue_system_provider, String
-
-          # @!attribute sync_status
-          #
-          #   @return [String]
-          required :sync_status, String
-
-          # @!attribute error_message
-          #   The error message from the revenue system, if available.
-          #
-          #   @return [String, nil]
-          optional :error_message, String
-
-          # @!attribute revenue_system_external_payment_id
-          #
-          #   @return [String, nil]
-          optional :revenue_system_external_payment_id, String
-
-          # @!method initialize(revenue_system_provider:, sync_status:, error_message: nil, revenue_system_external_payment_id: nil)
-          #   @param revenue_system_provider [String]
-          #
-          #   @param sync_status [String]
-          #
-          #   @param error_message [String] The error message from the revenue system, if available.
-          #
-          #   @param revenue_system_external_payment_id [String]
-        end
-      end
-    end
-  end
-end

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

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module MetronomeSDK
-  module Models
-    module V1
-      # @see MetronomeSDK::Resources::V1::Payments#attempt
-      class PaymentAttemptParams < 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_attempt_response.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module MetronomeSDK
-  module Models
-    module V1
-      # @see MetronomeSDK::Resources::V1::Payments#attempt
-      class PaymentAttemptResponse < 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_cancel_params.rb

@@ -1,28 +0,0 @@
-# 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

@@ -1,18 +0,0 @@
-# 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

@@ -1,53 +0,0 @@
-# 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

@@ -1,19 +0,0 @@
-# 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/resources/v1/payments.rb

@@ -1,102 +0,0 @@
-# frozen_string_literal: true
-
-module MetronomeSDK
-  module Resources
-    class V1
-      class Payments
-        # Fetch all payment attempts for the given invoice.
-        #
-        # @overload list(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}, nil]
-        #
-        # @return [MetronomeSDK::Internal::BodyCursorPage<MetronomeSDK::Models::V1::Payment>]
-        #
-        # @see MetronomeSDK::Models::V1::PaymentListParams
-        def list(params)
-          parsed, options = MetronomeSDK::V1::PaymentListParams.dump_request(params)
-          @client.request(
-            method: :post,
-            path: "v1/payments/list",
-            body: parsed,
-            page: MetronomeSDK::Internal::BodyCursorPage,
-            model: MetronomeSDK::V1::Payment,
-            options: options
-          )
-        end
-
-        # Trigger a new attempt by canceling any existing attempts for this invoice and
-        # creating a new Payment. This will trigger another attempt to charge the
-        # Customer's configured Payment Gateway. Payment can only be attempted if all of
-        # the following are true:
-        #
-        # - The Metronome Invoice is finalized
-        # - PLG Invoicing is configured for the Customer
-        # - You cannot attempt payments for invoices that have already been `paid` or
-        #   `voided`.
-        #
-        # Attempting to payment on an ineligible Invoice or Customer will result in a
-        # `400` response.
-        #
-        # @overload attempt(customer_id:, invoice_id:, request_options: {})
-        #
-        # @param customer_id [String]
-        # @param invoice_id [String]
-        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
-        #
-        # @return [MetronomeSDK::Models::V1::PaymentAttemptResponse]
-        #
-        # @see MetronomeSDK::Models::V1::PaymentAttemptParams
-        def attempt(params)
-          parsed, options = MetronomeSDK::V1::PaymentAttemptParams.dump_request(params)
-          @client.request(
-            method: :post,
-            path: "v1/payments/attempt",
-            body: parsed,
-            model: MetronomeSDK::Models::V1::PaymentAttemptResponse,
-            options: options
-          )
-        end
-
-        # Cancel an existing payment attempt for an invoice.
-        #
-        # @overload cancel(customer_id:, invoice_id:, request_options: {})
-        #
-        # @param customer_id [String]
-        # @param invoice_id [String]
-        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
-        #
-        # @return [MetronomeSDK::Models::V1::PaymentCancelResponse]
-        #
-        # @see MetronomeSDK::Models::V1::PaymentCancelParams
-        def cancel(params)
-          parsed, options = MetronomeSDK::V1::PaymentCancelParams.dump_request(params)
-          @client.request(
-            method: :post,
-            path: "v1/payments/cancel",
-            body: parsed,
-            model: MetronomeSDK::Models::V1::PaymentCancelResponse,
-            options: options
-          )
-        end
-
-        # @api private
-        #
-        # @param client [MetronomeSDK::Client]
-        def initialize(client:)
-          @client = client
-        end
-      end
-    end
-  end
-end