metronome-sdk 0.1.0.pre.alpha.1

data/rbi/metronome_sdk/models/v1/custom_field_list_keys_params.rbi

@@ -0,0 +1,91 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class CustomFieldListKeysParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        # Cursor that indicates where the next page of results should start.
+        sig { returns(T.nilable(String)) }
+        attr_reader :next_page
+
+        sig { params(next_page: String).void }
+        attr_writer :next_page
+
+        # Optional list of entity types to return keys for
+        sig { returns(T.nilable(T::Array[MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity::OrSymbol])) }
+        attr_reader :entities
+
+        sig { params(entities: T::Array[MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity::OrSymbol]).void }
+        attr_writer :entities
+
+        sig do
+          params(
+            next_page: String,
+            entities: T::Array[MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity::OrSymbol],
+            request_options: T.any(MetronomeSDK::RequestOptions, MetronomeSDK::Internal::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # Cursor that indicates where the next page of results should start.
+          next_page: nil,
+          # Optional list of entity types to return keys for
+          entities: nil,
+          request_options: {}
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                next_page: String,
+                entities: T::Array[MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity::OrSymbol],
+                request_options: MetronomeSDK::RequestOptions
+              }
+            )
+        end
+        def to_hash; end
+
+        module Entity
+          extend MetronomeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ALERT = T.let(:alert, MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity::TaggedSymbol)
+          BILLABLE_METRIC =
+            T.let(:billable_metric, MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity::TaggedSymbol)
+          CHARGE = T.let(:charge, MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity::TaggedSymbol)
+          COMMIT = T.let(:commit, MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity::TaggedSymbol)
+          CONTRACT_CREDIT =
+            T.let(:contract_credit, MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity::TaggedSymbol)
+          CONTRACT_PRODUCT =
+            T.let(:contract_product, MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity::TaggedSymbol)
+          CONTRACT = T.let(:contract, MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity::TaggedSymbol)
+          CREDIT_GRANT =
+            T.let(:credit_grant, MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity::TaggedSymbol)
+          CUSTOMER_PLAN =
+            T.let(:customer_plan, MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity::TaggedSymbol)
+          CUSTOMER = T.let(:customer, MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity::TaggedSymbol)
+          DISCOUNT = T.let(:discount, MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity::TaggedSymbol)
+          INVOICE = T.let(:invoice, MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity::TaggedSymbol)
+          PLAN = T.let(:plan, MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity::TaggedSymbol)
+          PROFESSIONAL_SERVICE =
+            T.let(:professional_service, MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity::TaggedSymbol)
+          PRODUCT = T.let(:product, MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity::TaggedSymbol)
+          RATE_CARD = T.let(:rate_card, MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity::TaggedSymbol)
+          SCHEDULED_CHARGE =
+            T.let(:scheduled_charge, MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity::TaggedSymbol)
+          SUBSCRIPTION =
+            T.let(:subscription, MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity::TaggedSymbol)
+
+          sig { override.returns(T::Array[MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity::TaggedSymbol]) }
+          def self.values; end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/custom_field_list_keys_response.rbi

@@ -0,0 +1,123 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class CustomFieldListKeysResponse < MetronomeSDK::Internal::Type::BaseModel
+        sig { returns(T::Array[MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data]) }
+        attr_accessor :data
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :next_page
+
+        sig do
+          params(
+            data: T::Array[T.any(MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data, MetronomeSDK::Internal::AnyHash)],
+            next_page: T.nilable(String)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(data:, next_page:); end
+
+        sig do
+          override
+            .returns(
+              {data: T::Array[MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data], next_page: T.nilable(String)}
+            )
+        end
+        def to_hash; end
+
+        class Data < MetronomeSDK::Internal::Type::BaseModel
+          sig { returns(T::Boolean) }
+          attr_accessor :enforce_uniqueness
+
+          sig { returns(MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol) }
+          attr_accessor :entity
+
+          sig { returns(String) }
+          attr_accessor :key
+
+          sig do
+            params(
+              enforce_uniqueness: T::Boolean,
+              entity: MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::OrSymbol,
+              key: String
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(enforce_uniqueness:, entity:, key:); end
+
+          sig do
+            override
+              .returns(
+                {
+                  enforce_uniqueness: T::Boolean,
+                  entity: MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol,
+                  key: String
+                }
+              )
+          end
+          def to_hash; end
+
+          module Entity
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias { T.all(Symbol, MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ALERT = T.let(:alert, MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol)
+            BILLABLE_METRIC =
+              T.let(:billable_metric, MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol)
+            CHARGE =
+              T.let(:charge, MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol)
+            COMMIT =
+              T.let(:commit, MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol)
+            CONTRACT_CREDIT =
+              T.let(:contract_credit, MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol)
+            CONTRACT_PRODUCT =
+              T.let(
+                :contract_product,
+                MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol
+              )
+            CONTRACT =
+              T.let(:contract, MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol)
+            CREDIT_GRANT =
+              T.let(:credit_grant, MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol)
+            CUSTOMER_PLAN =
+              T.let(:customer_plan, MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol)
+            CUSTOMER =
+              T.let(:customer, MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol)
+            DISCOUNT =
+              T.let(:discount, MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol)
+            INVOICE =
+              T.let(:invoice, MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol)
+            PLAN = T.let(:plan, MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol)
+            PROFESSIONAL_SERVICE =
+              T.let(
+                :professional_service,
+                MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol
+              )
+            PRODUCT =
+              T.let(:product, MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol)
+            RATE_CARD =
+              T.let(:rate_card, MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol)
+            SCHEDULED_CHARGE =
+              T.let(
+                :scheduled_charge,
+                MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol
+              )
+            SUBSCRIPTION =
+              T.let(:subscription, MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol)
+
+            sig do
+              override
+                .returns(T::Array[MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol])
+            end
+            def self.values; end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/custom_field_remove_key_params.rbi

@@ -0,0 +1,78 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class CustomFieldRemoveKeyParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        sig { returns(MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::Entity::OrSymbol) }
+        attr_accessor :entity
+
+        sig { returns(String) }
+        attr_accessor :key
+
+        sig do
+          params(
+            entity: MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::Entity::OrSymbol,
+            key: String,
+            request_options: T.any(MetronomeSDK::RequestOptions, MetronomeSDK::Internal::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(entity:, key:, request_options: {}); end
+
+        sig do
+          override
+            .returns(
+              {
+                entity: MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::Entity::OrSymbol,
+                key: String,
+                request_options: MetronomeSDK::RequestOptions
+              }
+            )
+        end
+        def to_hash; end
+
+        module Entity
+          extend MetronomeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::Entity) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ALERT = T.let(:alert, MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::Entity::TaggedSymbol)
+          BILLABLE_METRIC =
+            T.let(:billable_metric, MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::Entity::TaggedSymbol)
+          CHARGE = T.let(:charge, MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::Entity::TaggedSymbol)
+          COMMIT = T.let(:commit, MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::Entity::TaggedSymbol)
+          CONTRACT_CREDIT =
+            T.let(:contract_credit, MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::Entity::TaggedSymbol)
+          CONTRACT_PRODUCT =
+            T.let(:contract_product, MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::Entity::TaggedSymbol)
+          CONTRACT = T.let(:contract, MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::Entity::TaggedSymbol)
+          CREDIT_GRANT =
+            T.let(:credit_grant, MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::Entity::TaggedSymbol)
+          CUSTOMER_PLAN =
+            T.let(:customer_plan, MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::Entity::TaggedSymbol)
+          CUSTOMER = T.let(:customer, MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::Entity::TaggedSymbol)
+          DISCOUNT = T.let(:discount, MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::Entity::TaggedSymbol)
+          INVOICE = T.let(:invoice, MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::Entity::TaggedSymbol)
+          PLAN = T.let(:plan, MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::Entity::TaggedSymbol)
+          PROFESSIONAL_SERVICE =
+            T.let(:professional_service, MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::Entity::TaggedSymbol)
+          PRODUCT = T.let(:product, MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::Entity::TaggedSymbol)
+          RATE_CARD = T.let(:rate_card, MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::Entity::TaggedSymbol)
+          SCHEDULED_CHARGE =
+            T.let(:scheduled_charge, MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::Entity::TaggedSymbol)
+          SUBSCRIPTION =
+            T.let(:subscription, MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::Entity::TaggedSymbol)
+
+          sig { override.returns(T::Array[MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::Entity::TaggedSymbol]) }
+          def self.values; end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/custom_field_set_values_params.rbi

@@ -0,0 +1,83 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class CustomFieldSetValuesParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        sig { returns(T::Hash[Symbol, String]) }
+        attr_accessor :custom_fields
+
+        sig { returns(MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity::OrSymbol) }
+        attr_accessor :entity
+
+        sig { returns(String) }
+        attr_accessor :entity_id
+
+        sig do
+          params(
+            custom_fields: T::Hash[Symbol, String],
+            entity: MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity::OrSymbol,
+            entity_id: String,
+            request_options: T.any(MetronomeSDK::RequestOptions, MetronomeSDK::Internal::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(custom_fields:, entity:, entity_id:, request_options: {}); end
+
+        sig do
+          override
+            .returns(
+              {
+                custom_fields: T::Hash[Symbol, String],
+                entity: MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity::OrSymbol,
+                entity_id: String,
+                request_options: MetronomeSDK::RequestOptions
+              }
+            )
+        end
+        def to_hash; end
+
+        module Entity
+          extend MetronomeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ALERT = T.let(:alert, MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity::TaggedSymbol)
+          BILLABLE_METRIC =
+            T.let(:billable_metric, MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity::TaggedSymbol)
+          CHARGE = T.let(:charge, MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity::TaggedSymbol)
+          COMMIT = T.let(:commit, MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity::TaggedSymbol)
+          CONTRACT_CREDIT =
+            T.let(:contract_credit, MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity::TaggedSymbol)
+          CONTRACT_PRODUCT =
+            T.let(:contract_product, MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity::TaggedSymbol)
+          CONTRACT = T.let(:contract, MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity::TaggedSymbol)
+          CREDIT_GRANT =
+            T.let(:credit_grant, MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity::TaggedSymbol)
+          CUSTOMER_PLAN =
+            T.let(:customer_plan, MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity::TaggedSymbol)
+          CUSTOMER = T.let(:customer, MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity::TaggedSymbol)
+          DISCOUNT = T.let(:discount, MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity::TaggedSymbol)
+          INVOICE = T.let(:invoice, MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity::TaggedSymbol)
+          PLAN = T.let(:plan, MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity::TaggedSymbol)
+          PROFESSIONAL_SERVICE =
+            T.let(:professional_service, MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity::TaggedSymbol)
+          PRODUCT = T.let(:product, MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity::TaggedSymbol)
+          RATE_CARD = T.let(:rate_card, MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity::TaggedSymbol)
+          SCHEDULED_CHARGE =
+            T.let(:scheduled_charge, MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity::TaggedSymbol)
+          SUBSCRIPTION =
+            T.let(:subscription, MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity::TaggedSymbol)
+
+          sig { override.returns(T::Array[MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity::TaggedSymbol]) }
+          def self.values; end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/customer.rbi

@@ -0,0 +1,68 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class Customer < MetronomeSDK::Internal::Type::BaseModel
+        # the Metronome ID of the customer
+        sig { returns(String) }
+        attr_accessor :id
+
+        # (deprecated, use ingest_aliases instead) the first ID (Metronome or ingest
+        # alias) that can be used in usage events
+        sig { returns(String) }
+        attr_accessor :external_id
+
+        # aliases for this customer that can be used instead of the Metronome customer ID
+        # in usage events
+        sig { returns(T::Array[String]) }
+        attr_accessor :ingest_aliases
+
+        sig { returns(String) }
+        attr_accessor :name
+
+        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        attr_reader :custom_fields
+
+        sig { params(custom_fields: T::Hash[Symbol, String]).void }
+        attr_writer :custom_fields
+
+        sig do
+          params(
+            id: String,
+            external_id: String,
+            ingest_aliases: T::Array[String],
+            name: String,
+            custom_fields: T::Hash[Symbol, String]
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # the Metronome ID of the customer
+          id:,
+          # (deprecated, use ingest_aliases instead) the first ID (Metronome or ingest
+          # alias) that can be used in usage events
+          external_id:,
+          # aliases for this customer that can be used instead of the Metronome customer ID
+          # in usage events
+          ingest_aliases:,
+          name:,
+          custom_fields: nil
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                id: String,
+                external_id: String,
+                ingest_aliases: T::Array[String],
+                name: String,
+                custom_fields: T::Hash[Symbol, String]
+              }
+            )
+        end
+        def to_hash; end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/customer_archive_params.rbi

@@ -0,0 +1,21 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class CustomerArchiveParams < MetronomeSDK::Models::ID
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        sig do
+          params(request_options: T.any(MetronomeSDK::RequestOptions, MetronomeSDK::Internal::AnyHash))
+            .returns(T.attached_class)
+        end
+        def self.new(request_options: {}); end
+
+        sig { override.returns({request_options: MetronomeSDK::RequestOptions}) }
+        def to_hash; end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/customer_archive_response.rbi

@@ -0,0 +1,21 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class CustomerArchiveResponse < MetronomeSDK::Internal::Type::BaseModel
+        sig { returns(MetronomeSDK::Models::ID) }
+        attr_reader :data
+
+        sig { params(data: T.any(MetronomeSDK::Models::ID, MetronomeSDK::Internal::AnyHash)).void }
+        attr_writer :data
+
+        sig { params(data: T.any(MetronomeSDK::Models::ID, MetronomeSDK::Internal::AnyHash)).returns(T.attached_class) }
+        def self.new(data:); end
+
+        sig { override.returns({data: MetronomeSDK::Models::ID}) }
+        def to_hash; end
+      end
+    end
+  end
+end