metronome-sdk 2.0.0 → 2.2.0

data/rbi/metronome_sdk/models/v1/settings/billing_provider_create_params.rbi

@@ -0,0 +1,162 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Settings
+        class BillingProviderCreateParams < MetronomeSDK::Internal::Type::BaseModel
+          extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+          include MetronomeSDK::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::V1::Settings::BillingProviderCreateParams,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          # The billing provider set for this configuration.
+          sig do
+            returns(
+              MetronomeSDK::V1::Settings::BillingProviderCreateParams::BillingProvider::OrSymbol
+            )
+          end
+          attr_accessor :billing_provider
+
+          # Account-level configuration for the billing provider. The structure of this
+          # object is specific to the billing provider and delivery provider combination.
+          # See examples below.
+          sig { returns(T::Hash[Symbol, T.anything]) }
+          attr_accessor :configuration
+
+          # The method to use for delivering invoices for this configuration.
+          sig do
+            returns(
+              MetronomeSDK::V1::Settings::BillingProviderCreateParams::DeliveryMethod::OrSymbol
+            )
+          end
+          attr_accessor :delivery_method
+
+          sig do
+            params(
+              billing_provider:
+                MetronomeSDK::V1::Settings::BillingProviderCreateParams::BillingProvider::OrSymbol,
+              configuration: T::Hash[Symbol, T.anything],
+              delivery_method:
+                MetronomeSDK::V1::Settings::BillingProviderCreateParams::DeliveryMethod::OrSymbol,
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The billing provider set for this configuration.
+            billing_provider:,
+            # Account-level configuration for the billing provider. The structure of this
+            # object is specific to the billing provider and delivery provider combination.
+            # See examples below.
+            configuration:,
+            # The method to use for delivering invoices for this configuration.
+            delivery_method:,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                billing_provider:
+                  MetronomeSDK::V1::Settings::BillingProviderCreateParams::BillingProvider::OrSymbol,
+                configuration: T::Hash[Symbol, T.anything],
+                delivery_method:
+                  MetronomeSDK::V1::Settings::BillingProviderCreateParams::DeliveryMethod::OrSymbol,
+                request_options: MetronomeSDK::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The billing provider set for this configuration.
+          module BillingProvider
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::V1::Settings::BillingProviderCreateParams::BillingProvider
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            AWS_MARKETPLACE =
+              T.let(
+                :aws_marketplace,
+                MetronomeSDK::V1::Settings::BillingProviderCreateParams::BillingProvider::TaggedSymbol
+              )
+            AZURE_MARKETPLACE =
+              T.let(
+                :azure_marketplace,
+                MetronomeSDK::V1::Settings::BillingProviderCreateParams::BillingProvider::TaggedSymbol
+              )
+            GCP_MARKETPLACE =
+              T.let(
+                :gcp_marketplace,
+                MetronomeSDK::V1::Settings::BillingProviderCreateParams::BillingProvider::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::V1::Settings::BillingProviderCreateParams::BillingProvider::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # The method to use for delivering invoices for this configuration.
+          module DeliveryMethod
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::V1::Settings::BillingProviderCreateParams::DeliveryMethod
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            DIRECT_TO_BILLING_PROVIDER =
+              T.let(
+                :direct_to_billing_provider,
+                MetronomeSDK::V1::Settings::BillingProviderCreateParams::DeliveryMethod::TaggedSymbol
+              )
+            AWS_SQS =
+              T.let(
+                :aws_sqs,
+                MetronomeSDK::V1::Settings::BillingProviderCreateParams::DeliveryMethod::TaggedSymbol
+              )
+            AWS_SNS =
+              T.let(
+                :aws_sns,
+                MetronomeSDK::V1::Settings::BillingProviderCreateParams::DeliveryMethod::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::V1::Settings::BillingProviderCreateParams::DeliveryMethod::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/settings/billing_provider_create_response.rbi

@@ -0,0 +1,75 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Settings
+        class BillingProviderCreateResponse < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::Models::V1::Settings::BillingProviderCreateResponse,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig do
+            returns(
+              MetronomeSDK::Models::V1::Settings::BillingProviderCreateResponse::Data
+            )
+          end
+          attr_reader :data
+
+          sig do
+            params(
+              data:
+                MetronomeSDK::Models::V1::Settings::BillingProviderCreateResponse::Data::OrHash
+            ).void
+          end
+          attr_writer :data
+
+          sig do
+            params(
+              data:
+                MetronomeSDK::Models::V1::Settings::BillingProviderCreateResponse::Data::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(data:)
+          end
+
+          sig do
+            override.returns(
+              {
+                data:
+                  MetronomeSDK::Models::V1::Settings::BillingProviderCreateResponse::Data
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Data < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::Models::V1::Settings::BillingProviderCreateResponse::Data,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            sig { returns(String) }
+            attr_accessor :delivery_method_id
+
+            sig { params(delivery_method_id: String).returns(T.attached_class) }
+            def self.new(delivery_method_id:)
+            end
+
+            sig { override.returns({ delivery_method_id: String }) }
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/settings/billing_provider_list_params.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Settings
+        class BillingProviderListParams < MetronomeSDK::Internal::Type::BaseModel
+          extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+          include MetronomeSDK::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::V1::Settings::BillingProviderListParams,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          # The cursor to the next page of results
+          sig { returns(T.nilable(String)) }
+          attr_accessor :next_page
+
+          sig do
+            params(
+              next_page: T.nilable(String),
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The cursor to the next page of results
+            next_page: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                next_page: T.nilable(String),
+                request_options: MetronomeSDK::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/settings/billing_provider_list_response.rbi

@@ -0,0 +1,245 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Settings
+        class BillingProviderListResponse < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::Models::V1::Settings::BillingProviderListResponse,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig do
+            returns(
+              T::Array[
+                MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data
+              ]
+            )
+          end
+          attr_accessor :data
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :next_page
+
+          sig do
+            params(
+              data:
+                T::Array[
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::OrHash
+                ],
+              next_page: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(data:, next_page: nil)
+          end
+
+          sig do
+            override.returns(
+              {
+                data:
+                  T::Array[
+                    MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data
+                  ],
+                next_page: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Data < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            # The billing provider set for this configuration.
+            sig do
+              returns(
+                MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider::TaggedSymbol
+              )
+            end
+            attr_accessor :billing_provider
+
+            # The method to use for delivering invoices to this customer.
+            sig do
+              returns(
+                MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::DeliveryMethod::TaggedSymbol
+              )
+            end
+            attr_accessor :delivery_method
+
+            # Configuration for the delivery method. The structure of this object is specific
+            # to the delivery method. Some configuration may be omitted for security reasons.
+            sig { returns(T::Hash[Symbol, T.anything]) }
+            attr_accessor :delivery_method_configuration
+
+            # ID of the delivery method to use for this customer.
+            sig { returns(String) }
+            attr_accessor :delivery_method_id
+
+            sig do
+              params(
+                billing_provider:
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider::OrSymbol,
+                delivery_method:
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::DeliveryMethod::OrSymbol,
+                delivery_method_configuration: T::Hash[Symbol, T.anything],
+                delivery_method_id: String
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The billing provider set for this configuration.
+              billing_provider:,
+              # 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. Some configuration may be omitted for security reasons.
+              delivery_method_configuration:,
+              # ID of the delivery method to use for this customer.
+              delivery_method_id:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  billing_provider:
+                    MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider::TaggedSymbol,
+                  delivery_method:
+                    MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::DeliveryMethod::TaggedSymbol,
+                  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
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              AWS_MARKETPLACE =
+                T.let(
+                  :aws_marketplace,
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider::TaggedSymbol
+                )
+              STRIPE =
+                T.let(
+                  :stripe,
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider::TaggedSymbol
+                )
+              NETSUITE =
+                T.let(
+                  :netsuite,
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider::TaggedSymbol
+                )
+              CUSTOM =
+                T.let(
+                  :custom,
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider::TaggedSymbol
+                )
+              AZURE_MARKETPLACE =
+                T.let(
+                  :azure_marketplace,
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider::TaggedSymbol
+                )
+              QUICKBOOKS_ONLINE =
+                T.let(
+                  :quickbooks_online,
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider::TaggedSymbol
+                )
+              WORKDAY =
+                T.let(
+                  :workday,
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider::TaggedSymbol
+                )
+              GCP_MARKETPLACE =
+                T.let(
+                  :gcp_marketplace,
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider::TaggedSymbol
+                )
+              METRONOME =
+                T.let(
+                  :metronome,
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+
+            # The method to use for delivering invoices to this customer.
+            module DeliveryMethod
+              extend MetronomeSDK::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::DeliveryMethod
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              DIRECT_TO_BILLING_PROVIDER =
+                T.let(
+                  :direct_to_billing_provider,
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::DeliveryMethod::TaggedSymbol
+                )
+              AWS_SQS =
+                T.let(
+                  :aws_sqs,
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::DeliveryMethod::TaggedSymbol
+                )
+              TACKLE =
+                T.let(
+                  :tackle,
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::DeliveryMethod::TaggedSymbol
+                )
+              AWS_SNS =
+                T.let(
+                  :aws_sns,
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::DeliveryMethod::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::DeliveryMethod::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/usage_search_response.rbi

@@ -180,7 +180,8 @@ module MetronomeSDK
           sig { params(aggregation_key: String).void }
           attr_writer :aggregation_key
 
-          # 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.
           sig do
             returns(
               T.nilable(
@@ -296,7 +297,8 @@ module MetronomeSDK
             # key must be one of the property filter names and is not applicable when the
             # aggregation type is 'count'.
             aggregation_key: nil,
-            # 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.
             aggregation_type: nil,
             # RFC 3339 timestamp indicating when the billable metric was archived. If not
             # provided, the billable metric is not archived.
@@ -345,7 +347,8 @@ module MetronomeSDK
           def to_hash
           end
 
-          # 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.
           module AggregationType
             extend MetronomeSDK::Internal::Type::Enum
 
@@ -383,6 +386,11 @@ module MetronomeSDK
                 :UNIQUE,
                 MetronomeSDK::Models::V1::UsageSearchResponseItem::MatchedBillableMetric::AggregationType::TaggedSymbol
               )
+            CUSTOM_SQL =
+              T.let(
+                :custom_sql,
+                MetronomeSDK::Models::V1::UsageSearchResponseItem::MatchedBillableMetric::AggregationType::TaggedSymbol
+              )
 
             sig do
               override.returns(

data/rbi/metronome_sdk/models/v2/contract_edit_commit_params.rbi

@@ -52,6 +52,13 @@ module MetronomeSDK
         sig { returns(T.nilable(T::Array[String])) }
         attr_accessor :applicable_product_tags
 
+        # Updated description for the commit
+        sig { returns(T.nilable(String)) }
+        attr_reader :description
+
+        sig { params(description: String).void }
+        attr_writer :description
+
         # Optional configuration for commit hierarchy access control
         sig { returns(T.nilable(MetronomeSDK::CommitHierarchyConfiguration)) }
         attr_reader :hierarchy_configuration
@@ -88,6 +95,13 @@ module MetronomeSDK
         end
         attr_writer :invoice_schedule
 
+        # Updated name for the commit
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
         # If multiple commits are applicable, the one with the lower priority will apply
         # first.
         sig { returns(T.nilable(Float)) }
@@ -136,11 +150,13 @@ module MetronomeSDK
               MetronomeSDK::V2::ContractEditCommitParams::AccessSchedule::OrHash,
             applicable_product_ids: T.nilable(T::Array[String]),
             applicable_product_tags: T.nilable(T::Array[String]),
+            description: String,
             hierarchy_configuration:
               MetronomeSDK::CommitHierarchyConfiguration::OrHash,
             invoice_contract_id: String,
             invoice_schedule:
               MetronomeSDK::V2::ContractEditCommitParams::InvoiceSchedule::OrHash,
+            name: String,
             priority: T.nilable(Float),
             product_id: String,
             rate_type:
@@ -164,11 +180,15 @@ module MetronomeSDK
           # applicable_product_tags or specifiers are not provided, the commit applies to
           # all products.
           applicable_product_tags: nil,
+          # Updated description for the commit
+          description: nil,
           # Optional configuration for commit hierarchy access control
           hierarchy_configuration: nil,
           # ID of contract to use for invoicing
           invoice_contract_id: nil,
           invoice_schedule: nil,
+          # Updated name for the commit
+          name: nil,
           # If multiple commits are applicable, the one with the lower priority will apply
           # first.
           priority: nil,
@@ -197,11 +217,13 @@ module MetronomeSDK
                 MetronomeSDK::V2::ContractEditCommitParams::AccessSchedule,
               applicable_product_ids: T.nilable(T::Array[String]),
               applicable_product_tags: T.nilable(T::Array[String]),
+              description: String,
               hierarchy_configuration:
                 MetronomeSDK::CommitHierarchyConfiguration,
               invoice_contract_id: String,
               invoice_schedule:
                 MetronomeSDK::V2::ContractEditCommitParams::InvoiceSchedule,
+              name: String,
               priority: T.nilable(Float),
               product_id: String,
               rate_type: