metronome-sdk 2.1.0 → 2.2.0

data/lib/metronome_sdk/models/v1/customers/customer_alert.rb

@@ -118,6 +118,13 @@ module MetronomeSDK
             #   @return [Array<String>, nil]
             optional :invoice_types_filter, MetronomeSDK::Internal::Type::ArrayOf[String]
 
+            # @!attribute seat_filter
+            #   Only present for low_remaining_seat_balance_reached notifications. The seat
+            #   group key or seat group key-value pair the alert is scoped to.
+            #
+            #   @return [MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::SeatFilter, nil]
+            optional :seat_filter, -> { MetronomeSDK::V1::Customers::CustomerAlert::Alert::SeatFilter }
+
             # @!attribute uniqueness_key
             #   Prevents the creation of duplicates. If a request to create a record is made
             #   with a previously used uniqueness key, a new record will not be created and the
@@ -126,7 +133,7 @@ module MetronomeSDK
             #   @return [String, nil]
             optional :uniqueness_key, String
 
-            # @!method initialize(id:, name:, status:, threshold:, type:, updated_at:, credit_grant_type_filters: nil, credit_type: nil, custom_field_filters: nil, group_key_filter: nil, group_values: nil, invoice_types_filter: nil, uniqueness_key: nil)
+            # @!method initialize(id:, name:, status:, threshold:, type:, updated_at:, credit_grant_type_filters: nil, credit_type: nil, custom_field_filters: nil, group_key_filter: nil, group_values: nil, invoice_types_filter: nil, seat_filter: nil, uniqueness_key: nil)
             #   Some parameter documentations has been truncated, see
             #   {MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert} for more details.
             #
@@ -154,6 +161,8 @@ module MetronomeSDK
             #
             #   @param invoice_types_filter [Array<String>] Only supported for invoice_total_reached threshold notifications. A list of invo
             #
+            #   @param seat_filter [MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::SeatFilter] Only present for low_remaining_seat_balance_reached notifications. The seat grou
+            #
             #   @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
 
             # Status of the threshold notification
@@ -268,6 +277,29 @@ module MetronomeSDK
               #   @param key [String]
               #   @param value [String]
             end
+
+            # @see MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert#seat_filter
+            class SeatFilter < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute seat_group_key
+              #   The seat group key (e.g., "seat_id", "user_id") that the alert is scoped to.
+              #
+              #   @return [String]
+              required :seat_group_key, String
+
+              # @!attribute seat_group_value
+              #   The seat group value that the alert is scoped to.
+              #
+              #   @return [String, nil]
+              optional :seat_group_value, String
+
+              # @!method initialize(seat_group_key:, seat_group_value: nil)
+              #   Only present for low_remaining_seat_balance_reached notifications. The seat
+              #   group key or seat group key-value pair the alert is scoped to.
+              #
+              #   @param seat_group_key [String] The seat group key (e.g., "seat_id", "user_id") that the alert is scoped to.
+              #
+              #   @param seat_group_value [String] The seat group value that the alert is scoped to.
+            end
           end
 
           # The status of the threshold notification. If the notification is archived, null

data/lib/metronome_sdk/models/v1/customers/invoice.rb

@@ -932,6 +932,12 @@ module MetronomeSDK
               #   @return [String, nil]
               optional :billing_provider_error, String
 
+              # @!attribute external_payment_id
+              #   The ID of the payment in the external system, if available.
+              #
+              #   @return [String, nil]
+              optional :external_payment_id, String
+
               # @!attribute external_status
               #
               #   @return [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::ExternalStatus, nil]
@@ -973,11 +979,13 @@ module MetronomeSDK
               optional :tax,
                        -> { MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::Tax }
 
-              # @!method initialize(billing_provider_type:, billing_provider_error: nil, external_status: nil, invoice_id: nil, invoiced_sub_total: nil, invoiced_total: nil, issued_at_timestamp: nil, pdf_url: nil, tax: nil)
+              # @!method initialize(billing_provider_type:, billing_provider_error: nil, external_payment_id: nil, external_status: nil, invoice_id: nil, invoiced_sub_total: nil, invoiced_total: nil, issued_at_timestamp: nil, pdf_url: nil, tax: nil)
               #   @param billing_provider_type [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::BillingProviderType]
               #
               #   @param billing_provider_error [String] Error message from the billing provider, if available.
               #
+              #   @param external_payment_id [String] The ID of the payment in the external system, if available.
+              #
               #   @param external_status [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::ExternalStatus]
               #
               #   @param invoice_id [String]
@@ -1017,6 +1025,7 @@ module MetronomeSDK
                 DRAFT = :DRAFT
                 FINALIZED = :FINALIZED
                 PAID = :PAID
+                PARTIALLY_PAID = :PARTIALLY_PAID
                 UNCOLLECTIBLE = :UNCOLLECTIBLE
                 VOID = :VOID
                 DELETED = :DELETED
@@ -1076,6 +1085,12 @@ module MetronomeSDK
             #   @return [String, nil]
             optional :billing_provider_error, String
 
+            # @!attribute external_payment_id
+            #   The ID of the payment in the external system, if available.
+            #
+            #   @return [String, nil]
+            optional :external_payment_id, String
+
             # @!attribute external_status
             #
             #   @return [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::ExternalStatus, nil]
@@ -1116,11 +1131,13 @@ module MetronomeSDK
             #   @return [MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::Tax, nil]
             optional :tax, -> { MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::Tax }
 
-            # @!method initialize(billing_provider_type:, billing_provider_error: nil, external_status: nil, invoice_id: nil, invoiced_sub_total: nil, invoiced_total: nil, issued_at_timestamp: nil, pdf_url: nil, tax: nil)
+            # @!method initialize(billing_provider_type:, billing_provider_error: nil, external_payment_id: nil, external_status: nil, invoice_id: nil, invoiced_sub_total: nil, invoiced_total: nil, issued_at_timestamp: nil, pdf_url: nil, tax: nil)
             #   @param billing_provider_type [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::BillingProviderType]
             #
             #   @param billing_provider_error [String] Error message from the billing provider, if available.
             #
+            #   @param external_payment_id [String] The ID of the payment in the external system, if available.
+            #
             #   @param external_status [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::ExternalStatus]
             #
             #   @param invoice_id [String]
@@ -1160,6 +1177,7 @@ module MetronomeSDK
               DRAFT = :DRAFT
               FINALIZED = :FINALIZED
               PAID = :PAID
+              PARTIALLY_PAID = :PARTIALLY_PAID
               UNCOLLECTIBLE = :UNCOLLECTIBLE
               VOID = :VOID
               DELETED = :DELETED

data/lib/metronome_sdk/models/v1/customers/plan_list_price_adjustments_response.rb

@@ -62,6 +62,11 @@ module MetronomeSDK
             required :adjustment_type,
                      enum: -> { MetronomeSDK::Models::V1::Customers::PlanListPriceAdjustmentsResponse::Price::AdjustmentType }
 
+            # @!attribute quantity
+            #
+            #   @return [Float, nil]
+            optional :quantity, Float
+
             # @!attribute tier
             #   Used in pricing tiers. Indicates at what metric value the price applies.
             #
@@ -73,9 +78,11 @@ module MetronomeSDK
             #   @return [Float, nil]
             optional :value, Float
 
-            # @!method initialize(adjustment_type:, tier: nil, value: nil)
+            # @!method initialize(adjustment_type:, quantity: nil, tier: nil, value: nil)
             #   @param adjustment_type [Symbol, MetronomeSDK::Models::V1::Customers::PlanListPriceAdjustmentsResponse::Price::AdjustmentType] Determines how the value will be applied.
             #
+            #   @param quantity [Float]
+            #
             #   @param tier [Float] Used in pricing tiers. Indicates at what metric value the price applies.
             #
             #   @param value [Float]

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

@@ -34,7 +34,14 @@ module MetronomeSDK
         #   @return [Array<String>]
         required :delivery_method_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
 
-        # @!method initialize(avalara_environment:, avalara_password:, avalara_username:, delivery_method_ids:, request_options: {})
+        # @!attribute commit_transactions
+        #   Commit transactions if you want Metronome tax calculations used for reporting
+        #   and tax filings.
+        #
+        #   @return [Boolean, nil]
+        optional :commit_transactions, MetronomeSDK::Internal::Type::Boolean
+
+        # @!method initialize(avalara_environment:, avalara_password:, avalara_username:, delivery_method_ids:, commit_transactions: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {MetronomeSDK::Models::V1::SettingUpsertAvalaraCredentialsParams} for more
         #   details.
@@ -47,6 +54,8 @@ module MetronomeSDK
         #
         #   @param delivery_method_ids [Array<String>] The delivery method IDs of the billing provider configurations to update, can be
         #
+        #   @param commit_transactions [Boolean] Commit transactions if you want Metronome tax calculations used for reporting an
+        #
         #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
 
         # The Avalara environment to use (SANDBOX or PRODUCTION).

data/lib/metronome_sdk/models/v1/settings/billing_provider_create_params.rb

@@ -50,6 +50,7 @@ module MetronomeSDK
 
             AWS_MARKETPLACE = :aws_marketplace
             AZURE_MARKETPLACE = :azure_marketplace
+            GCP_MARKETPLACE = :gcp_marketplace
 
             # @!method self.values
             #   @return [Array<Symbol>]

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

@@ -110,7 +110,8 @@ module MetronomeSDK
           optional :aggregation_key, String
 
           # @!attribute aggregation_type
-          #   Specifies the type of aggregation performed on matching events.
+          #   Specifies the type of aggregation performed on matching events. Includes
+          #   "custom_sql" for events search endpoint responses.
           #
           #   @return [Symbol, MetronomeSDK::Models::V1::UsageSearchResponseItem::MatchedBillableMetric::AggregationType, nil]
           optional :aggregation_type,
@@ -183,7 +184,7 @@ module MetronomeSDK
           #
           #   @param aggregation_key [String] A key that specifies which property of the event is used to aggregate data. This
           #
-          #   @param aggregation_type [Symbol, MetronomeSDK::Models::V1::UsageSearchResponseItem::MatchedBillableMetric::AggregationType] Specifies the type of aggregation performed on matching events.
+          #   @param aggregation_type [Symbol, MetronomeSDK::Models::V1::UsageSearchResponseItem::MatchedBillableMetric::AggregationType] Specifies the type of aggregation performed on matching events. Includes "custom
           #
           #   @param archived_at [Time] RFC 3339 timestamp indicating when the billable metric was archived. If not prov
           #
@@ -201,7 +202,8 @@ module MetronomeSDK
           #
           #   @param sql [String] The SQL query associated with the billable metric
 
-          # Specifies the type of aggregation performed on matching events.
+          # Specifies the type of aggregation performed on matching events. Includes
+          # "custom_sql" for events search endpoint responses.
           #
           # @see MetronomeSDK::Models::V1::UsageSearchResponseItem::MatchedBillableMetric#aggregation_type
           module AggregationType
@@ -212,6 +214,7 @@ module MetronomeSDK
             MAX = :MAX
             SUM = :SUM
             UNIQUE = :UNIQUE
+            CUSTOM_SQL = :custom_sql
 
             # @!method self.values
             #   @return [Array<Symbol>]

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 description
+        #   Updated description for the commit
+        #
+        #   @return [String, nil]
+        optional :description, String
+
         # @!attribute hierarchy_configuration
         #   Optional configuration for commit hierarchy access control
         #
@@ -58,6 +64,12 @@ module MetronomeSDK
         #   @return [MetronomeSDK::Models::V2::ContractEditCommitParams::InvoiceSchedule, nil]
         optional :invoice_schedule, -> { MetronomeSDK::V2::ContractEditCommitParams::InvoiceSchedule }
 
+        # @!attribute name
+        #   Updated name for the commit
+        #
+        #   @return [String, nil]
+        optional :name, String
+
         # @!attribute priority
         #   If multiple commits are applicable, the one with the lower priority will apply
         #   first.
@@ -91,7 +103,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, hierarchy_configuration: 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, description: nil, hierarchy_configuration: nil, invoice_contract_id: nil, invoice_schedule: nil, name: 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.
         #
@@ -105,12 +117,16 @@ module MetronomeSDK
         #
         #   @param applicable_product_tags [Array<String>, nil] Which tags the commit applies to. If applicable*product_ids, applicable_product*
         #
+        #   @param description [String] Updated description for the commit
+        #
         #   @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]
         #
+        #   @param name [String] Updated name for the commit
+        #
         #   @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_credit_params.rb

@@ -39,12 +39,24 @@ module MetronomeSDK
         #   @return [Array<String>, nil]
         optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String], nil?: true
 
+        # @!attribute description
+        #   Updated description for the credit
+        #
+        #   @return [String, nil]
+        optional :description, String
+
         # @!attribute hierarchy_configuration
         #   Optional configuration for credit hierarchy access control
         #
         #   @return [MetronomeSDK::Models::CommitHierarchyConfiguration, nil]
         optional :hierarchy_configuration, -> { MetronomeSDK::CommitHierarchyConfiguration }
 
+        # @!attribute name
+        #   Updated name for the credit
+        #
+        #   @return [String, nil]
+        optional :name, String
+
         # @!attribute priority
         #   If multiple commits are applicable, the one with the lower priority will apply
         #   first.
@@ -78,7 +90,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, hierarchy_configuration: 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, description: nil, hierarchy_configuration: nil, name: 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.
         #
@@ -92,8 +104,12 @@ module MetronomeSDK
         #
         #   @param applicable_product_tags [Array<String>, nil] Which tags the credit applies to. If both applicable*product_ids and applicable*
         #
+        #   @param description [String] Updated description for the credit
+        #
         #   @param hierarchy_configuration [MetronomeSDK::Models::CommitHierarchyConfiguration] Optional configuration for credit hierarchy access control
         #
+        #   @param name [String] Updated name for the credit
+        #
         #   @param priority [Float, nil] If multiple commits are applicable, the one with the lower priority will apply f
         #
         #   @param product_id [String]