metronome-sdk 0.3.0 → 2.0.0

data/rbi/metronome_sdk/models/hierarchy_configuration.rbi

@@ -0,0 +1,424 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    # Either a **parent** configuration with a list of children or a **child**
+    # configuration with a single parent.
+    module HierarchyConfiguration
+      extend MetronomeSDK::Internal::Type::Union
+
+      Variants =
+        T.type_alias do
+          T.any(
+            MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration,
+            MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration
+          )
+        end
+
+      class ParentHierarchyConfiguration < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        # List of contracts that belong to this parent.
+        sig do
+          returns(
+            T::Array[
+              MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::Child
+            ]
+          )
+        end
+        attr_accessor :children
+
+        sig do
+          returns(
+            T.nilable(
+              MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior
+            )
+          )
+        end
+        attr_reader :parent_behavior
+
+        sig do
+          params(
+            parent_behavior:
+              MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::OrHash
+          ).void
+        end
+        attr_writer :parent_behavior
+
+        sig do
+          params(
+            children:
+              T::Array[
+                MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::Child::OrHash
+              ],
+            parent_behavior:
+              MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # List of contracts that belong to this parent.
+          children:,
+          parent_behavior: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              children:
+                T::Array[
+                  MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::Child
+                ],
+              parent_behavior:
+                MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Child < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::Child,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :contract_id
+
+          sig { returns(String) }
+          attr_accessor :customer_id
+
+          sig do
+            params(contract_id: String, customer_id: String).returns(
+              T.attached_class
+            )
+          end
+          def self.new(contract_id:, customer_id:)
+          end
+
+          sig { override.returns({ contract_id: String, customer_id: String }) }
+          def to_hash
+          end
+        end
+
+        class ParentBehavior < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          # Indicates the desired behavior of consolidated invoices generated by the parent
+          # in a customer hierarchy **CONCATENATE**: Statements on the invoices of child
+          # customers will be appended to the consolidated invoice **NONE**: Do not generate
+          # consolidated invoices
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::InvoiceConsolidationType::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :invoice_consolidation_type
+
+          sig do
+            params(
+              invoice_consolidation_type:
+                MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::InvoiceConsolidationType::OrSymbol
+            ).void
+          end
+          attr_writer :invoice_consolidation_type
+
+          sig do
+            params(
+              invoice_consolidation_type:
+                MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::InvoiceConsolidationType::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Indicates the desired behavior of consolidated invoices generated by the parent
+            # in a customer hierarchy **CONCATENATE**: Statements on the invoices of child
+            # customers will be appended to the consolidated invoice **NONE**: Do not generate
+            # consolidated invoices
+            invoice_consolidation_type: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                invoice_consolidation_type:
+                  MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::InvoiceConsolidationType::TaggedSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Indicates the desired behavior of consolidated invoices generated by the parent
+          # in a customer hierarchy **CONCATENATE**: Statements on the invoices of child
+          # customers will be appended to the consolidated invoice **NONE**: Do not generate
+          # consolidated invoices
+          module InvoiceConsolidationType
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::InvoiceConsolidationType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            CONCATENATE =
+              T.let(
+                :CONCATENATE,
+                MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::InvoiceConsolidationType::TaggedSymbol
+              )
+            NONE =
+              T.let(
+                :NONE,
+                MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::InvoiceConsolidationType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::InvoiceConsolidationType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+
+      class ChildHierarchyConfiguration < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        # The single parent contract/customer for this child.
+        sig do
+          returns(
+            MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Parent
+          )
+        end
+        attr_reader :parent
+
+        sig do
+          params(
+            parent:
+              MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Parent::OrHash
+          ).void
+        end
+        attr_writer :parent
+
+        # Indicates whether the parent should pay for the child's invoice charges
+        sig do
+          returns(
+            T.nilable(
+              MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Payer::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :payer
+
+        sig do
+          params(
+            payer:
+              MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Payer::OrSymbol
+          ).void
+        end
+        attr_writer :payer
+
+        # Indicates the behavior of the child's invoice statements on the parent's
+        # invoices **CONSOLIDATE**: Child's invoice statements will be added to parent's
+        # consolidated invoices **SEPARATE**: Child's invoice statements will appear not
+        # appear on parent's consolidated invoices
+        sig do
+          returns(
+            T.nilable(
+              MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::UsageStatementBehavior::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :usage_statement_behavior
+
+        sig do
+          params(
+            usage_statement_behavior:
+              MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::UsageStatementBehavior::OrSymbol
+          ).void
+        end
+        attr_writer :usage_statement_behavior
+
+        sig do
+          params(
+            parent:
+              MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Parent::OrHash,
+            payer:
+              MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Payer::OrSymbol,
+            usage_statement_behavior:
+              MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::UsageStatementBehavior::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The single parent contract/customer for this child.
+          parent:,
+          # Indicates whether the parent should pay for the child's invoice charges
+          payer: nil,
+          # Indicates the behavior of the child's invoice statements on the parent's
+          # invoices **CONSOLIDATE**: Child's invoice statements will be added to parent's
+          # consolidated invoices **SEPARATE**: Child's invoice statements will appear not
+          # appear on parent's consolidated invoices
+          usage_statement_behavior: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              parent:
+                MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Parent,
+              payer:
+                MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Payer::TaggedSymbol,
+              usage_statement_behavior:
+                MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::UsageStatementBehavior::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Parent < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Parent,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :contract_id
+
+          sig { returns(String) }
+          attr_accessor :customer_id
+
+          # The single parent contract/customer for this child.
+          sig do
+            params(contract_id: String, customer_id: String).returns(
+              T.attached_class
+            )
+          end
+          def self.new(contract_id:, customer_id:)
+          end
+
+          sig { override.returns({ contract_id: String, customer_id: String }) }
+          def to_hash
+          end
+        end
+
+        # Indicates whether the parent should pay for the child's invoice charges
+        module Payer
+          extend MetronomeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Payer
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SELF =
+            T.let(
+              :SELF,
+              MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Payer::TaggedSymbol
+            )
+          PARENT =
+            T.let(
+              :PARENT,
+              MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Payer::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Payer::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Indicates the behavior of the child's invoice statements on the parent's
+        # invoices **CONSOLIDATE**: Child's invoice statements will be added to parent's
+        # consolidated invoices **SEPARATE**: Child's invoice statements will appear not
+        # appear on parent's consolidated invoices
+        module UsageStatementBehavior
+          extend MetronomeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::UsageStatementBehavior
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          CONSOLIDATE =
+            T.let(
+              :CONSOLIDATE,
+              MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::UsageStatementBehavior::TaggedSymbol
+            )
+          SEPARATE =
+            T.let(
+              :SEPARATE,
+              MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::UsageStatementBehavior::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::UsageStatementBehavior::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      sig do
+        override.returns(
+          T::Array[MetronomeSDK::HierarchyConfiguration::Variants]
+        )
+      end
+      def self.variants
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/override.rbi

@@ -71,24 +71,20 @@ module MetronomeSDK
       end
       attr_writer :override_specifiers
 
-      sig { returns(T.nilable(T::Array[MetronomeSDK::Override::OverrideTier])) }
+      sig { returns(T.nilable(T::Array[MetronomeSDK::OverrideTier])) }
       attr_reader :override_tiers
 
       sig do
         params(
-          override_tiers: T::Array[MetronomeSDK::Override::OverrideTier::OrHash]
+          override_tiers: T::Array[MetronomeSDK::OverrideTier::OrHash]
         ).void
       end
       attr_writer :override_tiers
 
-      sig { returns(T.nilable(MetronomeSDK::Override::OverwriteRate)) }
+      sig { returns(T.nilable(MetronomeSDK::OverwriteRate)) }
       attr_reader :overwrite_rate
 
-      sig do
-        params(
-          overwrite_rate: MetronomeSDK::Override::OverwriteRate::OrHash
-        ).void
-      end
+      sig { params(overwrite_rate: MetronomeSDK::OverwriteRate::OrHash).void }
       attr_writer :overwrite_rate
 
       # Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type,
@@ -164,9 +160,8 @@ module MetronomeSDK
           multiplier: Float,
           override_specifiers:
             T::Array[MetronomeSDK::Override::OverrideSpecifier::OrHash],
-          override_tiers:
-            T::Array[MetronomeSDK::Override::OverrideTier::OrHash],
-          overwrite_rate: MetronomeSDK::Override::OverwriteRate::OrHash,
+          override_tiers: T::Array[MetronomeSDK::OverrideTier::OrHash],
+          overwrite_rate: MetronomeSDK::OverwriteRate::OrHash,
           price: Float,
           priority: Float,
           product: MetronomeSDK::Override::Product::OrHash,
@@ -225,8 +220,8 @@ module MetronomeSDK
             multiplier: Float,
             override_specifiers:
               T::Array[MetronomeSDK::Override::OverrideSpecifier],
-            override_tiers: T::Array[MetronomeSDK::Override::OverrideTier],
-            overwrite_rate: MetronomeSDK::Override::OverwriteRate,
+            override_tiers: T::Array[MetronomeSDK::OverrideTier],
+            overwrite_rate: MetronomeSDK::OverwriteRate,
             price: Float,
             priority: Float,
             product: MetronomeSDK::Override::Product,
@@ -402,186 +397,6 @@ module MetronomeSDK
         end
       end
 
-      class OverrideTier < MetronomeSDK::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              MetronomeSDK::Override::OverrideTier,
-              MetronomeSDK::Internal::AnyHash
-            )
-          end
-
-        sig { returns(Float) }
-        attr_accessor :multiplier
-
-        sig { returns(T.nilable(Float)) }
-        attr_reader :size
-
-        sig { params(size: Float).void }
-        attr_writer :size
-
-        sig { params(multiplier: Float, size: Float).returns(T.attached_class) }
-        def self.new(multiplier:, size: nil)
-        end
-
-        sig { override.returns({ multiplier: Float, size: Float }) }
-        def to_hash
-        end
-      end
-
-      class OverwriteRate < MetronomeSDK::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              MetronomeSDK::Override::OverwriteRate,
-              MetronomeSDK::Internal::AnyHash
-            )
-          end
-
-        sig do
-          returns(MetronomeSDK::Override::OverwriteRate::RateType::TaggedSymbol)
-        end
-        attr_accessor :rate_type
-
-        sig { returns(T.nilable(MetronomeSDK::CreditTypeData)) }
-        attr_reader :credit_type
-
-        sig { params(credit_type: MetronomeSDK::CreditTypeData::OrHash).void }
-        attr_writer :credit_type
-
-        # Only set for CUSTOM rate_type. This field is interpreted by custom rate
-        # processors.
-        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
-        attr_reader :custom_rate
-
-        sig { params(custom_rate: T::Hash[Symbol, T.anything]).void }
-        attr_writer :custom_rate
-
-        # Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
-        # set to true.
-        sig { returns(T.nilable(T::Boolean)) }
-        attr_reader :is_prorated
-
-        sig { params(is_prorated: T::Boolean).void }
-        attr_writer :is_prorated
-
-        # Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type,
-        # this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1.
-        sig { returns(T.nilable(Float)) }
-        attr_reader :price
-
-        sig { params(price: Float).void }
-        attr_writer :price
-
-        # Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
-        sig { returns(T.nilable(Float)) }
-        attr_reader :quantity
-
-        sig { params(quantity: Float).void }
-        attr_writer :quantity
-
-        # Only set for TIERED rate_type.
-        sig { returns(T.nilable(T::Array[MetronomeSDK::Tier])) }
-        attr_reader :tiers
-
-        sig { params(tiers: T::Array[MetronomeSDK::Tier::OrHash]).void }
-        attr_writer :tiers
-
-        sig do
-          params(
-            rate_type:
-              MetronomeSDK::Override::OverwriteRate::RateType::OrSymbol,
-            credit_type: MetronomeSDK::CreditTypeData::OrHash,
-            custom_rate: T::Hash[Symbol, T.anything],
-            is_prorated: T::Boolean,
-            price: Float,
-            quantity: Float,
-            tiers: T::Array[MetronomeSDK::Tier::OrHash]
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          rate_type:,
-          credit_type: nil,
-          # Only set for CUSTOM rate_type. This field is interpreted by custom rate
-          # processors.
-          custom_rate: nil,
-          # Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
-          # set to true.
-          is_prorated: nil,
-          # Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type,
-          # this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1.
-          price: nil,
-          # Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
-          quantity: nil,
-          # Only set for TIERED rate_type.
-          tiers: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              rate_type:
-                MetronomeSDK::Override::OverwriteRate::RateType::TaggedSymbol,
-              credit_type: MetronomeSDK::CreditTypeData,
-              custom_rate: T::Hash[Symbol, T.anything],
-              is_prorated: T::Boolean,
-              price: Float,
-              quantity: Float,
-              tiers: T::Array[MetronomeSDK::Tier]
-            }
-          )
-        end
-        def to_hash
-        end
-
-        module RateType
-          extend MetronomeSDK::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(Symbol, MetronomeSDK::Override::OverwriteRate::RateType)
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          FLAT =
-            T.let(
-              :FLAT,
-              MetronomeSDK::Override::OverwriteRate::RateType::TaggedSymbol
-            )
-          PERCENTAGE =
-            T.let(
-              :PERCENTAGE,
-              MetronomeSDK::Override::OverwriteRate::RateType::TaggedSymbol
-            )
-          SUBSCRIPTION =
-            T.let(
-              :SUBSCRIPTION,
-              MetronomeSDK::Override::OverwriteRate::RateType::TaggedSymbol
-            )
-          TIERED =
-            T.let(
-              :TIERED,
-              MetronomeSDK::Override::OverwriteRate::RateType::TaggedSymbol
-            )
-          CUSTOM =
-            T.let(
-              :CUSTOM,
-              MetronomeSDK::Override::OverwriteRate::RateType::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                MetronomeSDK::Override::OverwriteRate::RateType::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
-
       class Product < MetronomeSDK::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/metronome_sdk/models/override_tier.rbi

@@ -0,0 +1,29 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    class OverrideTier < MetronomeSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(MetronomeSDK::OverrideTier, MetronomeSDK::Internal::AnyHash)
+        end
+
+      sig { returns(Float) }
+      attr_accessor :multiplier
+
+      sig { returns(T.nilable(Float)) }
+      attr_reader :size
+
+      sig { params(size: Float).void }
+      attr_writer :size
+
+      sig { params(multiplier: Float, size: Float).returns(T.attached_class) }
+      def self.new(multiplier:, size: nil)
+      end
+
+      sig { override.returns({ multiplier: Float, size: Float }) }
+      def to_hash
+      end
+    end
+  end
+end